diff options
Diffstat (limited to 'doc/api-documentation/html/class_s_w_config.html')
| -rw-r--r-- | doc/api-documentation/html/class_s_w_config.html | 173 |
1 files changed, 173 insertions, 0 deletions
diff --git a/doc/api-documentation/html/class_s_w_config.html b/doc/api-documentation/html/class_s_w_config.html new file mode 100644 index 0000000..2284e58 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_config.html @@ -0,0 +1,173 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWConfig class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWConfig Class Reference</h1>The class to read and save settings using a file on disk. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swconfig_8h-source.html">swconfig.h</a>></code> +<p> +<a href="class_s_w_config-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_s_w_config.html#a0">SWConfig</a> (const char *ifilename)</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor of SWConfig.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWConfig::~SWConfig"></a> +virtual </td><td valign=bottom><b>~SWConfig</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="SWConfig::Load"></a> +virtual void </td><td valign=bottom><a class="el" href="class_s_w_config.html#a2">Load</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Load from disk Load the contzent from disk.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="SWConfig::Save"></a> +virtual void </td><td valign=bottom><a class="el" href="class_s_w_config.html#a3">Save</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Save to disk Save the content of this config object to disk.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWConfig & </td><td valign=bottom><a class="el" href="class_s_w_config.html#a4">operator+=</a> (SWConfig &addFrom)</td></tr> +<tr><td> </td><td><font size=-1><em>Merges the values of addFrom.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual ConfigEntMap & </td><td valign=bottom><a class="el" href="class_s_w_config.html#a5">operator[]</a> (const char *section)</td></tr> +<tr><td> </td><td><font size=-1><em>Get a section This is an easy way to get and store config values.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="m0" doxytag="SWConfig::filename"></a> +string </td><td valign=bottom><a class="el" href="class_s_w_config.html#m0">filename</a></td></tr> +<tr><td> </td><td><font size=-1><em>The filename used by this SWConfig object.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="m1" doxytag="SWConfig::Sections"></a> +SectionMap </td><td valign=bottom><a class="el" href="class_s_w_config.html#m1">Sections</a></td></tr> +<tr><td> </td><td><font size=-1><em>Map of available sections The map of available sections.</em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="c0" doxytag="SWConfig::getline"></a> +char </td><td valign=bottom><b>getline</b> (FILE *fp, string &line)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The class to read and save settings using a file on disk. +<p> + +<p> +Definition at line <a class="el" href="swconfig_8h-source.html#l00056">56</a> of file <a class="el" href="swconfig_8h-source.html">swconfig.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="SWConfig::SWConfig"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +SWConfig::SWConfig + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>ifilename</em> </td> + <td class="md">) </td> + <td class="md"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor of SWConfig. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ifilename +</em> </td><td> +The file, which should be used for this config. </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a4" doxytag="SWConfig::operator+="></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWConfig& SWConfig::operator+= + </td> + <td class="md">( </td> + <td class="md">SWConfig & </td> + <td class="mdname"> <em>addFrom</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Merges the values of addFrom. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>The +</em> </td><td> +config which values should be merged to this config object. Already existing values will be overwritten. </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a5" doxytag="SWConfig::operator[]"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual ConfigEntMap& SWConfig::operator[] + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>section</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get a section This is an easy way to get and store config values. +<p> +The following will work:<br> + +<p> +<div class="fragment"><pre> <a class="code" href="class_s_w_config.html">SWConfig</a> config(<font class="stringliteral">"/home/user/.setttings"</font>); + config[<font class="stringliteral">"Colors"</font>][<font class="stringliteral">"Background"</font>] = <font class="stringliteral">"red"</font>;</pre></div> </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swconfig_8h-source.html">swconfig.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> |