summaryrefslogtreecommitdiff
path: root/doc/api-documentation/man/man3/swconfig.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api-documentation/man/man3/swconfig.3')
-rw-r--r--doc/api-documentation/man/man3/swconfig.3100
1 files changed, 0 insertions, 100 deletions
diff --git a/doc/api-documentation/man/man3/swconfig.3 b/doc/api-documentation/man/man3/swconfig.3
deleted file mode 100644
index 8750b79..0000000
--- a/doc/api-documentation/man/man3/swconfig.3
+++ /dev/null
@@ -1,100 +0,0 @@
-.TH "SWConfig" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*-
-.ad l
-.nh
-.SH NAME
-SWConfig \- The class to read and save settings using a file on disk.
-.SH SYNOPSIS
-.br
-.PP
-\fC#include <swconfig.h>\fR
-.PP
-.SS Public Methods
-
-.in +1c
-.ti -1c
-.RI "\fBSWConfig\fR (const char *ifilename)"
-.br
-.RI "\fIConstructor of SWConfig.\fR"
-.ti -1c
-.RI "virtual \fB~SWConfig\fR ()"
-.br
-.ti -1c
-.RI "virtual void \fBLoad\fR ()"
-.br
-.RI "\fILoad from disk Load the contzent from disk.\fR"
-.ti -1c
-.RI "virtual void \fBSave\fR ()"
-.br
-.RI "\fISave to disk Save the content of this config object to disk.\fR"
-.ti -1c
-.RI "virtual SWConfig& \fBoperator+=\fR (SWConfig &addFrom)"
-.br
-.RI "\fIMerges the values of addFrom.\fR"
-.ti -1c
-.RI "virtual ConfigEntMap& \fBoperator[]\fR (const char *section)"
-.br
-.RI "\fIGet a section This is an easy way to get and store config values.\fR"
-.in -1c
-.SS Public Attributes
-
-.in +1c
-.ti -1c
-.RI "string \fBfilename\fR"
-.br
-.RI "\fIThe filename used by this SWConfig object.\fR"
-.ti -1c
-.RI "SectionMap \fBSections\fR"
-.br
-.RI "\fIMap of available sections The map of available sections.\fR"
-.in -1c
-.SS Private Methods
-
-.in +1c
-.ti -1c
-.RI "char \fBgetline\fR (FILE *fp, string &line)"
-.br
-.in -1c
-.SH DETAILED DESCRIPTION
-.PP
-The class to read and save settings using a file on disk.
-.PP
-Definition at line 56 of file swconfig.h.
-.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
-.PP
-.SS SWConfig::SWConfig (const char * ifilename)
-.PP
-Constructor of SWConfig.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIifilename\fR\fR
-The file, which should be used for this config.
-.SH MEMBER FUNCTION DOCUMENTATION
-.PP
-.SS SWConfig & SWConfig::operator+= (SWConfig & addFrom)\fC [virtual]\fR
-.PP
-Merges the values of addFrom.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIThe\fR\fR
-config which values should be merged to this config object. Already existing values will be overwritten.
-.SS ConfigEntMap & SWConfig::operator[] (const char * section)\fC [virtual]\fR
-.PP
-Get a section This is an easy way to get and store config values.
-.PP
-The following will work:
-.br
-
-.PP
-.nf
- SWConfig config("/home/user/.setttings");
- config["Colors"]["Background"] = "red";
-.fi
-
-
-.SH AUTHOR
-.PP
-Generated automatically by Doxygen for The Sword Project from the source code. \ No newline at end of file