Google

Main Page   Class Hierarchy   Compound List   File List   Compound Members  

iConfigIterator Struct Reference

Iterator which allows sequential access to configuration information contained in an iConfigFile object. More...

#include <cfgfile.h>

Inheritance diagram for iConfigIterator:

iBase List of all members.

Public Methods

virtual iConfigFileGetConfigFile () const=0
 Returns the configuration object for this iterator.

virtual const char* GetSubsection () const=0
 Returns the subsection in the configuruation.

virtual void Rewind ()=0
 Rewind the iterator (points to nowhere after this).

virtual bool Next ()=0
 Move to the next valid key. Returns false if no more keys exist.

virtual const char* GetKey (bool Local=false) const=0
 Get the current key name. More...

virtual int GetInt () const=0
 Get an integer value from the configuration.

virtual float GetFloat () const=0
 Get a float value from the configuration.

virtual const char* GetStr () const=0
 Get a string value from the configuration.

virtual bool GetBool () const=0
 Get a boolean value from the configuration.

virtual const char* GetComment () const=0
 Get the comment of the given key, or NULL if no comment exists.


Detailed Description

Iterator which allows sequential access to configuration information contained in an iConfigFile object.


Member Function Documentation

const char * iConfigIterator::GetKey ( bool Local = false ) const [pure virtual]
 

Get the current key name.

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.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.5 written by Dimitri van Heesch, ©1997-2000