Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 387

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!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: csConfigAccess 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&nbsp;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&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>csConfigAccess Class Reference</h1><!-- doxytag: class="csConfigAccess" -->This is a simple convenience class that can be used to deal with the sytem config manager.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="cfgacc_8h-source.html">csutil/cfgacc.h</a>&gt;</code>
<p>

<p>
<a href="classcsConfigAccess-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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigAccess.html#6de3b63b4b2d394ddf15a31771ac14a5">AddConfig</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *object_reg, <a class="el" href="structiConfigFile.html">iConfigFile</a> *file, int Priority=iConfigManager::ConfigPriorityPlugin)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">add a config object  <a href="#6de3b63b4b2d394ddf15a31771ac14a5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigAccess.html#a1b90ee14b0e5ee357782de39d443712">AddConfig</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *object_reg, const char *Filename, bool vfs=true, int Priority=iConfigManager::ConfigPriorityPlugin)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">add a config file  <a href="#a1b90ee14b0e5ee357782de39d443712"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigAccess.html#6506a74b637bdbd2899592e2d7167a23">csConfigAccess</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *object_reg, <a class="el" href="structiConfigFile.html">iConfigFile</a> *file, int Priority=iConfigManager::ConfigPriorityPlugin)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">constructor (also adds a config object)  <a href="#6506a74b637bdbd2899592e2d7167a23"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigAccess.html#c8b6ae94bf283251fe60719afe1fd337">csConfigAccess</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *object_reg, const char *Filename, bool vfs=true, int Priority=iConfigManager::ConfigPriorityPlugin)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">constructor (also adds a config file)  <a href="#c8b6ae94bf283251fe60719afe1fd337"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigAccess.html#0c452ed7c13eae98f0e1906e1d35c488">csConfigAccess</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *object_reg)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">constructor (provides access to config manager, but doesn't add file)  <a href="#0c452ed7c13eae98f0e1906e1d35c488"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigAccess.html#50ec22f7e34f2d1587e6e230d2c73574">csConfigAccess</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">constructor  <a href="#50ec22f7e34f2d1587e6e230d2c73574"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigAccess.html#0745e0f708e0a6b0d2a9884f7ab87399">operator iConfigFile *</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access to system configuration  <a href="#0745e0f708e0a6b0d2a9884f7ab87399"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structiConfigFile.html">iConfigFile</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigAccess.html#56fd9d61a0be5f5cfb87be6a9b7ffe7f">operator-&gt;</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access to system configuration  <a href="#56fd9d61a0be5f5cfb87be6a9b7ffe7f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsConfigAccess.html#408bcb95b92e001e3d965e3cc86cbf2f">~csConfigAccess</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">destructor  <a href="#408bcb95b92e001e3d965e3cc86cbf2f"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This is a simple convenience class that can be used to deal with the sytem config manager. 
<p>
It adds config files to the manager on demand and automatically removes them when destroyed. In addition, you can use the '-&gt;' operator to access the system configuration. Note that you must use the same <a class="el" href="structiObjectRegistry.html" title="This interface serves as a registry of other objects.">iObjectRegistry</a> for all config files you add. 
<p>Definition at line <a class="el" href="cfgacc_8h-source.html#l00040">40</a> of file <a class="el" href="cfgacc_8h-source.html">cfgacc.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="50ec22f7e34f2d1587e6e230d2c73574"></a><!-- doxytag: member="csConfigAccess::csConfigAccess" ref="50ec22f7e34f2d1587e6e230d2c73574" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csConfigAccess::csConfigAccess           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
constructor 
<p>

</div>
</div><p>
<a class="anchor" name="0c452ed7c13eae98f0e1906e1d35c488"></a><!-- doxytag: member="csConfigAccess::csConfigAccess" ref="0c452ed7c13eae98f0e1906e1d35c488" args="(iObjectRegistry *object_reg)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csConfigAccess::csConfigAccess           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *&nbsp;</td>
          <td class="paramname"> <em>object_reg</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
constructor (provides access to config manager, but doesn't add file) 
<p>

</div>
</div><p>
<a class="anchor" name="c8b6ae94bf283251fe60719afe1fd337"></a><!-- doxytag: member="csConfigAccess::csConfigAccess" ref="c8b6ae94bf283251fe60719afe1fd337" args="(iObjectRegistry *object_reg, const char *Filename, bool vfs=true, int Priority=iConfigManager::ConfigPriorityPlugin)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csConfigAccess::csConfigAccess           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *&nbsp;</td>
          <td class="paramname"> <em>object_reg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>Filename</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>vfs</em> = <code>true</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>Priority</em> = <code>iConfigManager::ConfigPriorityPlugin</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
constructor (also adds a config file) 
<p>

</div>
</div><p>
<a class="anchor" name="6506a74b637bdbd2899592e2d7167a23"></a><!-- doxytag: member="csConfigAccess::csConfigAccess" ref="6506a74b637bdbd2899592e2d7167a23" args="(iObjectRegistry *object_reg, iConfigFile *file, int Priority=iConfigManager::ConfigPriorityPlugin)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csConfigAccess::csConfigAccess           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *&nbsp;</td>
          <td class="paramname"> <em>object_reg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structiConfigFile.html">iConfigFile</a> *&nbsp;</td>
          <td class="paramname"> <em>file</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>Priority</em> = <code>iConfigManager::ConfigPriorityPlugin</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
constructor (also adds a config object) 
<p>

</div>
</div><p>
<a class="anchor" name="408bcb95b92e001e3d965e3cc86cbf2f"></a><!-- doxytag: member="csConfigAccess::~csConfigAccess" ref="408bcb95b92e001e3d965e3cc86cbf2f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csConfigAccess::~csConfigAccess           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
destructor 
<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6de3b63b4b2d394ddf15a31771ac14a5"></a><!-- doxytag: member="csConfigAccess::AddConfig" ref="6de3b63b4b2d394ddf15a31771ac14a5" args="(iObjectRegistry *object_reg, iConfigFile *file, int Priority=iConfigManager::ConfigPriorityPlugin)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csConfigAccess::AddConfig           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *&nbsp;</td>
          <td class="paramname"> <em>object_reg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structiConfigFile.html">iConfigFile</a> *&nbsp;</td>
          <td class="paramname"> <em>file</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>Priority</em> = <code>iConfigManager::ConfigPriorityPlugin</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
add a config object 
<p>

</div>
</div><p>
<a class="anchor" name="a1b90ee14b0e5ee357782de39d443712"></a><!-- doxytag: member="csConfigAccess::AddConfig" ref="a1b90ee14b0e5ee357782de39d443712" args="(iObjectRegistry *object_reg, const char *Filename, bool vfs=true, int Priority=iConfigManager::ConfigPriorityPlugin)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csConfigAccess::AddConfig           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *&nbsp;</td>
          <td class="paramname"> <em>object_reg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>Filename</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>vfs</em> = <code>true</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>Priority</em> = <code>iConfigManager::ConfigPriorityPlugin</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
add a config file 
<p>

<p>Referenced by <a class="el" href="glextmanager_8h-source.html#l17464">csGLExtensionManager::Initialize()</a>.</p>

</div>
</div><p>
<a class="anchor" name="0745e0f708e0a6b0d2a9884f7ab87399"></a><!-- doxytag: member="csConfigAccess::operator iConfigFile *" ref="0745e0f708e0a6b0d2a9884f7ab87399" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csConfigAccess::operator <a class="el" href="structiConfigFile.html">iConfigFile</a> *           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
access to system configuration 
<p>

</div>
</div><p>
<a class="anchor" name="56fd9d61a0be5f5cfb87be6a9b7ffe7f"></a><!-- doxytag: member="csConfigAccess::operator-&gt;" ref="56fd9d61a0be5f5cfb87be6a9b7ffe7f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structiConfigFile.html">iConfigFile</a>* csConfigAccess::operator-&gt;           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
access to system configuration 
<p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="cfgacc_8h-source.html">cfgacc.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>