<!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>Crystal Space 1.2.1: csConfigDocument Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>csConfigDocument Class Reference</h1><!-- doxytag: class="csConfigDocument" --><!-- doxytag: inherits="scfImplementation1< csConfigDocument, iConfigFile >" --><a class="el" href="structiConfigFile.html" title="Configuration file interface.">iConfigFile</a> implementation for configurations stored in documents.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="cfgdoc_8h-source.html">csutil/cfgdoc.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for csConfigDocument:</div>
<div class="dynsection">
<p><center><img src="classcsConfigDocument__inherit__graph.png" border="0" usemap="#csConfigDocument__inherit__map" alt="Inheritance graph"></center>
<map name="csConfigDocument__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csConfigDocument, iConfigFile \>" alt="" coords="72,161,448,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\< csConfigDocument \>" alt="" coords="5,84,301,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="313,7,369,33"><area shape="rect" href="structiConfigFile.html" title="Configuration file interface." alt="" coords="325,84,411,111"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="43,7,264,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classcsConfigDocument-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#b55461e66f03529809c3dded055ceb10">Clear</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete all options and rewind all iterators. <a href="#b55461e66f03529809c3dded055ceb10"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#8d9e991d7ad5573724a7b33bc57f5131">DeleteKey</a> (const char *Key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete a key and its value and comment. <a href="#8d9e991d7ad5573724a7b33bc57f5131"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsPtr.html">csPtr</a><br>
< <a class="el" href="structiConfigIterator.html">iConfigIterator</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#7d5b7af4ccc465571c7d298406d6b38b">Enumerate</a> (const char *Subsection=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enumerate selected keys. <a href="#7d5b7af4ccc465571c7d298406d6b38b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#3769ac0113adc9100192e35cf7253876">GetBool</a> (const char *Key, bool Def=false) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a boolean value from the configuration. <a href="#3769ac0113adc9100192e35cf7253876"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#5cf83d6805cab6e510142bdaae54c2c2">GetComment</a> (const char *Key) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the comment of the given key, or 0 if no comment exists. <a href="#5cf83d6805cab6e510142bdaae54c2c2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#641b3678813f048b77c9f52dbf1cf351">GetEOFComment</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the final comment at the end of the configuration file <a href="#641b3678813f048b77c9f52dbf1cf351"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#ed78a9af7beb8ca100114ffd9eacab10">GetFileName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get configuration file name. <a href="#ed78a9af7beb8ca100114ffd9eacab10"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#e41a8fb03a2f8835c808962765ca80eb">GetFloat</a> (const char *Key, float Def=0.0) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a float value from the configuration. <a href="#e41a8fb03a2f8835c808962765ca80eb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#2a78abfdecf67de8f38ddb6dd58e2363">GetInt</a> (const char *Key, int Def=0) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an integer value from the configuration. <a href="#2a78abfdecf67de8f38ddb6dd58e2363"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#baadb6f7762e6e4d139f937888928e87">GetStr</a> (const char *Key, const char *Def="") const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a string value from the configuration. <a href="#baadb6f7762e6e4d139f937888928e87"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsPtr.html">csPtr</a><br>
< <a class="el" href="structiStringArray.html">iStringArray</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#d48577696d0919c0538e57921919c97a">GetTuple</a> (const char *Key) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a tuple set from the configuration. <a href="#d48577696d0919c0538e57921919c97a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiVFS.html">iVFS</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#54c442a7b7e4515a1f04239be412749d">GetVFS</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the VFS object on which this file is stored (if any). <a href="#54c442a7b7e4515a1f04239be412749d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#68ffd081f6a5c8b52b8392337f5ce181">KeyExists</a> (const char *Key) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if a key exists. <a href="#68ffd081f6a5c8b52b8392337f5ce181"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#69c9563509de9808a933f112d04688d8">Load</a> (const char *iFileName, <a class="el" href="structiVFS.html">iVFS</a> *=0, bool Merge=false, bool NewWins=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load a configuration file. <a href="#69c9563509de9808a933f112d04688d8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#2b60fc041e5db05fedfa3280cf470e8b">Save</a> (const char *iFileName, <a class="el" href="structiVFS.html">iVFS</a> *=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save configuration into the given file (on VFS or on the physical filesystem). <a href="#2b60fc041e5db05fedfa3280cf470e8b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#c5a631484a168eda72e2c97c6b1205a6">Save</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save configuration to the same place from which it was loaded. <a href="#c5a631484a168eda72e2c97c6b1205a6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#25ba3d450ad400086d95c08484689031">SetBool</a> (const char *Key, bool Value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a boolean value. <a href="#25ba3d450ad400086d95c08484689031"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#6b2957a2bba8322122c689aabc6b8ba5">SetComment</a> (const char *Key, const char *Text)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the comment for given key. <a href="#6b2957a2bba8322122c689aabc6b8ba5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#258e6d4e309361fcc9f1d1ea9abbc830">SetEOFComment</a> (const char *Text)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set the final comment at the end of the configuration file <a href="#258e6d4e309361fcc9f1d1ea9abbc830"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#ab298a9fef921cc09d792d895a41834b">SetFileName</a> (const char *, <a class="el" href="structiVFS.html">iVFS</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set config file name. <a href="#ab298a9fef921cc09d792d895a41834b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#c3e47f1649084d08d261839e501afabc">SetFloat</a> (const char *Key, float Value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a floating-point value. <a href="#c3e47f1649084d08d261839e501afabc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#c114a34be1fd6d6df8c574f75ed1ec3e">SetInt</a> (const char *Key, int Value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an integer value. <a href="#c114a34be1fd6d6df8c574f75ed1ec3e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#eda4ec9a09c275793814a5b624e66d3b">SetStr</a> (const char *Key, const char *Val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an null-terminated string value. <a href="#eda4ec9a09c275793814a5b624e66d3b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#b7e7f6422b3f59fa3c05228b3c9b41ff">SetTuple</a> (const char *Key, <a class="el" href="structiStringArray.html">iStringArray</a> *Value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a tuple value. <a href="#b7e7f6422b3f59fa3c05228b3c9b41ff"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#f327ccb56ae680e16a4f63744ff9af50">SubsectionExists</a> (const char *Subsection) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if at least one key exists with the given Subsection prefix. <a href="#f327ccb56ae680e16a4f63744ff9af50"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="40b56b4fed8981bee67e66ee7d5c9110"></a><!-- doxytag: member="csConfigDocument::csConfigDocumentIterator" ref="40b56b4fed8981bee67e66ee7d5c9110" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigDocument.html#40b56b4fed8981bee67e66ee7d5c9110">csConfigDocumentIterator</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="structiConfigFile.html" title="Configuration file interface.">iConfigFile</a> implementation for configurations stored in documents.
<p>
<dl compact><dt><b><a class="el" href="todo.html#_todo000006">Todo:</a></b></dt><dd>Write support </dd></dl>
<p>Definition at line <a class="el" href="cfgdoc_8h-source.html#l00040">40</a> of file <a class="el" href="cfgdoc_8h-source.html">cfgdoc.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b55461e66f03529809c3dded055ceb10"></a><!-- doxytag: member="csConfigDocument::Clear" ref="b55461e66f03529809c3dded055ceb10" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csConfigDocument::Clear </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Delete all options and rewind all iterators.
<p>
<p>Implements <a class="el" href="structiConfigFile.html#2f9ffafeb0fb141317ccd4bcdf27a4c5">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="8d9e991d7ad5573724a7b33bc57f5131"></a><!-- doxytag: member="csConfigDocument::DeleteKey" ref="8d9e991d7ad5573724a7b33bc57f5131" args="(const char *Key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csConfigDocument::DeleteKey </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Key</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Delete a key and its value and comment.
<p>
<p>Implements <a class="el" href="structiConfigFile.html#be5a3cd2a0008b2b1a1d0bf6fadf26c3">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="7d5b7af4ccc465571c7d298406d6b38b"></a><!-- doxytag: member="csConfigDocument::Enumerate" ref="7d5b7af4ccc465571c7d298406d6b38b" args="(const char *Subsection=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsPtr.html">csPtr</a><<a class="el" href="structiConfigIterator.html">iConfigIterator</a>> csConfigDocument::Enumerate </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Subsection</em> = <code>0</code> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Enumerate selected keys.
<p>
If a subsection is given, only those keys which are prefixed by the subsection string will be enumerated. The returned iterator does not yet point to a valid key. You must call Next() to set it to the first key.
<p>Implements <a class="el" href="structiConfigFile.html#b7c4701d439cecfa848ee2d2d3069b53">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="3769ac0113adc9100192e35cf7253876"></a><!-- doxytag: member="csConfigDocument::GetBool" ref="3769ac0113adc9100192e35cf7253876" args="(const char *Key, bool Def=false) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool csConfigDocument::GetBool </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>Def</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a boolean value from the configuration.
<p>
The optional default value (Def parameter) will be used if the key was not found.
<p>Implements <a class="el" href="structiConfigFile.html#571a6754e0628698e00939db8e978aab">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="5cf83d6805cab6e510142bdaae54c2c2"></a><!-- doxytag: member="csConfigDocument::GetComment" ref="5cf83d6805cab6e510142bdaae54c2c2" args="(const char *Key) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* csConfigDocument::GetComment </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Key</em> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the comment of the given key, or 0 if no comment exists.
<p>
<p>Implements <a class="el" href="structiConfigFile.html#1340a49a3b842a014efddfee86046b24">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="641b3678813f048b77c9f52dbf1cf351"></a><!-- doxytag: member="csConfigDocument::GetEOFComment" ref="641b3678813f048b77c9f52dbf1cf351" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* csConfigDocument::GetEOFComment </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
return the final comment at the end of the configuration file
<p>
<p>Implements <a class="el" href="structiConfigFile.html#db1a8f5c2ac5fdcce859df5538a4d654">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="ed78a9af7beb8ca100114ffd9eacab10"></a><!-- doxytag: member="csConfigDocument::GetFileName" ref="ed78a9af7beb8ca100114ffd9eacab10" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* csConfigDocument::GetFileName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get configuration file name.
<p>
<p>Implements <a class="el" href="structiConfigFile.html#2183db4f11cdcaf8b9dd8b92618585e6">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="e41a8fb03a2f8835c808962765ca80eb"></a><!-- doxytag: member="csConfigDocument::GetFloat" ref="e41a8fb03a2f8835c808962765ca80eb" args="(const char *Key, float Def=0.0) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual float csConfigDocument::GetFloat </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>Def</em> = <code>0.0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a float value from the configuration.
<p>
The optional default value (Def parameter) will be used if the key was not found.
<p>Implements <a class="el" href="structiConfigFile.html#c829e1af3a2a530eef875a969c9b24ac">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="2a78abfdecf67de8f38ddb6dd58e2363"></a><!-- doxytag: member="csConfigDocument::GetInt" ref="2a78abfdecf67de8f38ddb6dd58e2363" args="(const char *Key, int Def=0) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int csConfigDocument::GetInt </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>Def</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get an integer value from the configuration.
<p>
The optional default value (Def parameter) will be used if the key was not found.
<p>Implements <a class="el" href="structiConfigFile.html#058ef45008514b8fab06e5b3bf126238">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="baadb6f7762e6e4d139f937888928e87"></a><!-- doxytag: member="csConfigDocument::GetStr" ref="baadb6f7762e6e4d139f937888928e87" args="(const char *Key, const char *Def="") const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* csConfigDocument::GetStr </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Def</em> = <code>""</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a string value from the configuration.
<p>
The optional default value (Def parameter) will be used if the key was not found.
<p>Implements <a class="el" href="structiConfigFile.html#f1907f764a4fd50addec669a214491a6">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="d48577696d0919c0538e57921919c97a"></a><!-- doxytag: member="csConfigDocument::GetTuple" ref="d48577696d0919c0538e57921919c97a" args="(const char *Key) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsPtr.html">csPtr</a><<a class="el" href="structiStringArray.html">iStringArray</a>> csConfigDocument::GetTuple </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Key</em> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a tuple set from the configuration.
<p>
<p>Implements <a class="el" href="structiConfigFile.html#502760e45145e28b475c9217399c39a3">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="54c442a7b7e4515a1f04239be412749d"></a><!-- doxytag: member="csConfigDocument::GetVFS" ref="54c442a7b7e4515a1f04239be412749d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiVFS.html">iVFS</a>* csConfigDocument::GetVFS </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the VFS object on which this file is stored (if any).
<p>
Returns 0 if this file resides within the real (non-VFS) filesystem.
<p>Implements <a class="el" href="structiConfigFile.html#6d13df20f0442c1fbf65f59e4daac67a">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="68ffd081f6a5c8b52b8392337f5ce181"></a><!-- doxytag: member="csConfigDocument::KeyExists" ref="68ffd081f6a5c8b52b8392337f5ce181" args="(const char *Key) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool csConfigDocument::KeyExists </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Key</em> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Test if a key exists.
<p>
<p>Implements <a class="el" href="structiConfigFile.html#ea44c9e9825898dffa3024247e247e6f">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="69c9563509de9808a933f112d04688d8"></a><!-- doxytag: member="csConfigDocument::Load" ref="69c9563509de9808a933f112d04688d8" args="(const char *iFileName, iVFS *=0, bool Merge=false, bool NewWins=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool csConfigDocument::Load </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>iFileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiVFS.html">iVFS</a> * </td>
<td class="paramname"> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>Merge</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>NewWins</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Load a configuration file.
<p>
If the file resides in a real filesystem, rather than a VFS filesystem, then pass 0 for the VFS argument. <p>
You can set the Merge flag to merge the newly loaded configuration information into the existing information. If you do so, nothing will happen if the named file doesn't exist. The NewWins flag determines the behavior in case of configuration key conflicts. If true, then the new configuration value replaces the old for that key. If false, then the old value is kept, and the new value is ignored. The recorded file name will be set to the name of the newly loaded file if the Merge flag is false; otherwise it will retain the old name.
<p>Implements <a class="el" href="structiConfigFile.html#0b1a3f6ebd3ccaa9be019fb616156ad7">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="2b60fc041e5db05fedfa3280cf470e8b"></a><!-- doxytag: member="csConfigDocument::Save" ref="2b60fc041e5db05fedfa3280cf470e8b" args="(const char *iFileName, iVFS *=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool csConfigDocument::Save </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>iFileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiVFS.html">iVFS</a> * </td>
<td class="paramname"> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Save configuration into the given file (on VFS or on the physical filesystem).
<p>
If the second parameter is skipped, the file will be written to the physical filesystem, otherwise it is stored on given VFS filesystem. This method does not change the internally stored file name.
<p>Implements <a class="el" href="structiConfigFile.html#cf862ed68d57a0e307e059ac049b8202">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="c5a631484a168eda72e2c97c6b1205a6"></a><!-- doxytag: member="csConfigDocument::Save" ref="c5a631484a168eda72e2c97c6b1205a6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool csConfigDocument::Save </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Save configuration to the same place from which it was loaded.
<p>
Returns true if the save operation succeeded.
<p>Implements <a class="el" href="structiConfigFile.html#e1a3711352a01b8e5611fb6d0d58a351">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="25ba3d450ad400086d95c08484689031"></a><!-- doxytag: member="csConfigDocument::SetBool" ref="25ba3d450ad400086d95c08484689031" args="(const char *Key, bool Value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csConfigDocument::SetBool </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>Value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set a boolean value.
<p>
<p>Implements <a class="el" href="structiConfigFile.html#075259cdd90c949538041f6bd0d98722">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="6b2957a2bba8322122c689aabc6b8ba5"></a><!-- doxytag: member="csConfigDocument::SetComment" ref="6b2957a2bba8322122c689aabc6b8ba5" args="(const char *Key, const char *Text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool csConfigDocument::SetComment </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Text</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the comment for given key.
<p>
In addition to an actual comment, you can use "" for Text to place an empty comment line before this key, or 0 to remove the comment entirely. The comment may contain newline characters. Returns false if the key does not exist.
<p>Implements <a class="el" href="structiConfigFile.html#0c6dd11917647182fb9632264e588c42">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="258e6d4e309361fcc9f1d1ea9abbc830"></a><!-- doxytag: member="csConfigDocument::SetEOFComment" ref="258e6d4e309361fcc9f1d1ea9abbc830" args="(const char *Text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csConfigDocument::SetEOFComment </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Text</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
set the final comment at the end of the configuration file
<p>
<p>Implements <a class="el" href="structiConfigFile.html#0ed1957a7cdd5b9de17c92dd4b7d2a82">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="ab298a9fef921cc09d792d895a41834b"></a><!-- doxytag: member="csConfigDocument::SetFileName" ref="ab298a9fef921cc09d792d895a41834b" args="(const char *, iVFS *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csConfigDocument::SetFileName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiVFS.html">iVFS</a> * </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set config file name.
<p>
You can use this if you want <a class="el" href="classcsConfigDocument.html#c5a631484a168eda72e2c97c6b1205a6" title="Save configuration to the same place from which it was loaded.">Save()</a> to write to another file. This will set the dirty flag.
<p>Implements <a class="el" href="structiConfigFile.html#020ae0fa1c3ce264bd46ed90561c4dbd">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="c3e47f1649084d08d261839e501afabc"></a><!-- doxytag: member="csConfigDocument::SetFloat" ref="c3e47f1649084d08d261839e501afabc" args="(const char *Key, float Value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csConfigDocument::SetFloat </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>Value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set a floating-point value.
<p>
<p>Implements <a class="el" href="structiConfigFile.html#d6fddd5fd6223bd179c1da1f101464a6">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="c114a34be1fd6d6df8c574f75ed1ec3e"></a><!-- doxytag: member="csConfigDocument::SetInt" ref="c114a34be1fd6d6df8c574f75ed1ec3e" args="(const char *Key, int Value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csConfigDocument::SetInt </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>Value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set an integer value.
<p>
<p>Implements <a class="el" href="structiConfigFile.html#16d2d2c324f71e232fd86ccc42b678f0">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="eda4ec9a09c275793814a5b624e66d3b"></a><!-- doxytag: member="csConfigDocument::SetStr" ref="eda4ec9a09c275793814a5b624e66d3b" args="(const char *Key, const char *Val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csConfigDocument::SetStr </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Val</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set an null-terminated string value.
<p>
<p>Implements <a class="el" href="structiConfigFile.html#98cd57c950aa067f5ffa51e7b22a8f6e">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="b7e7f6422b3f59fa3c05228b3c9b41ff"></a><!-- doxytag: member="csConfigDocument::SetTuple" ref="b7e7f6422b3f59fa3c05228b3c9b41ff" args="(const char *Key, iStringArray *Value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csConfigDocument::SetTuple </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiStringArray.html">iStringArray</a> * </td>
<td class="paramname"> <em>Value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set a tuple value.
<p>
<p>Implements <a class="el" href="structiConfigFile.html#5ceeff4b4cdcf00c38d1a4ed7a1a92b7">iConfigFile</a>.</p>
</div>
</div><p>
<a class="anchor" name="f327ccb56ae680e16a4f63744ff9af50"></a><!-- doxytag: member="csConfigDocument::SubsectionExists" ref="f327ccb56ae680e16a4f63744ff9af50" args="(const char *Subsection) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool csConfigDocument::SubsectionExists </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Subsection</em> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Test if at least one key exists with the given Subsection prefix.
<p>
<p>Implements <a class="el" href="structiConfigFile.html#aa086cbf83a800a3e9ed9fc88740b376">iConfigFile</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="cfgdoc_8h-source.html">cfgdoc.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
389
