<!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: iConfigIterator Struct 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>iConfigIterator Struct Reference<br>
<small>
[<a class="el" href="group__util.html">Utilities</a>]</small>
</h1><!-- doxytag: class="iConfigIterator" --><!-- doxytag: inherits="iBase" -->Iterator which allows sequential access to configuration information contained in an <a class="el" href="structiConfigFile.html" title="Configuration file interface.">iConfigFile</a> object.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="iutil_2cfgfile_8h-source.html">iutil/cfgfile.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iConfigIterator:</div>
<div class="dynsection">
<p><center><img src="structiConfigIterator__inherit__graph.png" border="0" usemap="#iConfigIterator__inherit__map" alt="Inheritance graph"></center>
<map name="iConfigIterator__inherit__map">
<area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="35,7,91,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiConfigIterator-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 bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiConfigIterator.html#354ece7957e771b8fa0e616c99409d08">GetBool</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a boolean value from the configuration. <a href="#354ece7957e771b8fa0e616c99409d08"></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="structiConfigIterator.html#55dc4809718fb2e1d205bf1cf3be59f9">GetComment</a> () const =0</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="#55dc4809718fb2e1d205bf1cf3be59f9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiConfigFile.html">iConfigFile</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiConfigIterator.html#7408c25ed5507f5b5cfb331873385e76">GetConfigFile</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the configuration object for this iterator. <a href="#7408c25ed5507f5b5cfb331873385e76"></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="structiConfigIterator.html#81d2d906f24123bf2af46c963fe40058">GetFloat</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a float value from the configuration. <a href="#81d2d906f24123bf2af46c963fe40058"></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="structiConfigIterator.html#2dc4b11a259b1e9afc586554f7bf0bcd">GetInt</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an integer value from the configuration. <a href="#2dc4b11a259b1e9afc586554f7bf0bcd"></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="structiConfigIterator.html#2fc96577deafa1c4b73ebc6736503b73">GetKey</a> (bool Local=false) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current key name. <a href="#2fc96577deafa1c4b73ebc6736503b73"></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="structiConfigIterator.html#2d49f0489da4d331978d54c2791bbdb9">GetStr</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a string value from the configuration. <a href="#2d49f0489da4d331978d54c2791bbdb9"></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="structiConfigIterator.html#4fee237b80c2c9d56003e54e6bf66097">GetSubsection</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the subsection in the configuration. <a href="#4fee237b80c2c9d56003e54e6bf66097"></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="structiConfigIterator.html#3f3727e1b89edc96744c4847aed66c9a">GetTuple</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a tuple set from the configuration. <a href="#3f3727e1b89edc96744c4847aed66c9a"></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="structiConfigIterator.html#c452088aeafb8b132d2b99bd700f6fea">HasNext</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether there is another valid key. <a href="#c452088aeafb8b132d2b99bd700f6fea"></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="structiConfigIterator.html#5be26e40e64e7a13b156431fb54e0d25">Next</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Move to the next valid key. Returns false if no more keys exist. <a href="#5be26e40e64e7a13b156431fb54e0d25"></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="structiConfigIterator.html#f1398cfdc4aeb4c85c36263035c16c11">Rewind</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Rewind the iterator (points to nowhere after this). <a href="#f1398cfdc4aeb4c85c36263035c16c11"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Iterator which allows sequential access to configuration information contained in an <a class="el" href="structiConfigFile.html" title="Configuration file interface.">iConfigFile</a> object.
<p>Definition at line <a class="el" href="iutil_2cfgfile_8h-source.html#l00157">157</a> of file <a class="el" href="iutil_2cfgfile_8h-source.html">cfgfile.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="354ece7957e771b8fa0e616c99409d08"></a><!-- doxytag: member="iConfigIterator::GetBool" ref="354ece7957e771b8fa0e616c99409d08" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iConfigIterator::GetBool </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a boolean value from the configuration.
<p>
</div>
</div><p>
<a class="anchor" name="55dc4809718fb2e1d205bf1cf3be59f9"></a><!-- doxytag: member="iConfigIterator::GetComment" ref="55dc4809718fb2e1d205bf1cf3be59f9" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* iConfigIterator::GetComment </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the comment of the given key, or 0 if no comment exists.
<p>
</div>
</div><p>
<a class="anchor" name="7408c25ed5507f5b5cfb331873385e76"></a><!-- doxytag: member="iConfigIterator::GetConfigFile" ref="7408c25ed5507f5b5cfb331873385e76" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiConfigFile.html">iConfigFile</a>* iConfigIterator::GetConfigFile </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the configuration object for this iterator.
<p>
</div>
</div><p>
<a class="anchor" name="81d2d906f24123bf2af46c963fe40058"></a><!-- doxytag: member="iConfigIterator::GetFloat" ref="81d2d906f24123bf2af46c963fe40058" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual float iConfigIterator::GetFloat </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a float value from the configuration.
<p>
</div>
</div><p>
<a class="anchor" name="2dc4b11a259b1e9afc586554f7bf0bcd"></a><!-- doxytag: member="iConfigIterator::GetInt" ref="2dc4b11a259b1e9afc586554f7bf0bcd" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iConfigIterator::GetInt </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get an integer value from the configuration.
<p>
</div>
</div><p>
<a class="anchor" name="2fc96577deafa1c4b73ebc6736503b73"></a><!-- doxytag: member="iConfigIterator::GetKey" ref="2fc96577deafa1c4b73ebc6736503b73" args="(bool Local=false) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* iConfigIterator::GetKey </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>Local</em> = <code>false</code> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the current key name.
<p>
Set Local to true to return only the local name inside the iterated subsection. This is the portion of the key string which follows the subsection prefix which was used to create this iterator.
</div>
</div><p>
<a class="anchor" name="2d49f0489da4d331978d54c2791bbdb9"></a><!-- doxytag: member="iConfigIterator::GetStr" ref="2d49f0489da4d331978d54c2791bbdb9" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* iConfigIterator::GetStr </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a string value from the configuration.
<p>
</div>
</div><p>
<a class="anchor" name="4fee237b80c2c9d56003e54e6bf66097"></a><!-- doxytag: member="iConfigIterator::GetSubsection" ref="4fee237b80c2c9d56003e54e6bf66097" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* iConfigIterator::GetSubsection </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the subsection in the configuration.
<p>
</div>
</div><p>
<a class="anchor" name="3f3727e1b89edc96744c4847aed66c9a"></a><!-- doxytag: member="iConfigIterator::GetTuple" ref="3f3727e1b89edc96744c4847aed66c9a" args="() const =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="structiStringArray.html">iStringArray</a>> iConfigIterator::GetTuple </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a tuple set from the configuration.
<p>
</div>
</div><p>
<a class="anchor" name="c452088aeafb8b132d2b99bd700f6fea"></a><!-- doxytag: member="iConfigIterator::HasNext" ref="c452088aeafb8b132d2b99bd700f6fea" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iConfigIterator::HasNext </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return whether there is another valid key.
<p>
</div>
</div><p>
<a class="anchor" name="5be26e40e64e7a13b156431fb54e0d25"></a><!-- doxytag: member="iConfigIterator::Next" ref="5be26e40e64e7a13b156431fb54e0d25" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iConfigIterator::Next </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Move to the next valid key. Returns false if no more keys exist.
<p>
</div>
</div><p>
<a class="anchor" name="f1398cfdc4aeb4c85c36263035c16c11"></a><!-- doxytag: member="iConfigIterator::Rewind" ref="f1398cfdc4aeb4c85c36263035c16c11" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iConfigIterator::Rewind </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Rewind the iterator (points to nowhere after this).
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>iutil/<a class="el" href="iutil_2cfgfile_8h-source.html">cfgfile.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
>
2848
