Home | Namespaces | Hierarchy | Alphabetical List | Class list | Files | Namespace Members | Class members | File members
nge::io::IIniFileReader

nge::io::IIniFileReader Class Reference

Interface for reading/writing INI files. More...

#include <IIniFileReader.hpp>

Inheritance diagram for nge::io::IIniFileReader:

irr::IReferenceCounted

List of all members.

Public Member Functions

virtual void addKeyToSection (const c8 *section, const c8 *name, const c8 *value=0)=0
virtual void addSection (const c8 *name)=0
 Adds a new section with the name 'name' to the file.
virtual array< SSection * > getAllSections ()=0
 Returns all sections stored in the file.
virtual SSection * getSection (const c8 *name)=0
 Returns the section with the name 'name' or 0 if no section with this name exist.
virtual c8 * getValue (const c8 *section, const c8 *key)=0
 returns the value assigned to the section-key-pair as an ASCII-string.
virtual SValue2Df getValue2Df (const c8 *section, const c8 *key)=0
 returns the value assigned to the section-key-pair as a 2 dimensional value of floats.
virtual SValue2Di getValue2Di (const c8 *section, const c8 *key)=0
 returns the value assigned to the section-key-pair as a 2 dimensional value of integers.
virtual SValue3Df getValue3Df (const c8 *section, const c8 *key)=0
 returns the value assigned to the section-key-pair as a 3 dimensional value of floats.
virtual SValue3Di getValue3Di (const c8 *section, const c8 *key)=0
 returns the value assigned to the section-key-pair as a 3 dimensional value of integers.
virtual SValue4Df getValue4Df (const c8 *section, const c8 *key)=0
 returns the value assigned to the section-key-pair as a 4 dimensional value of floats.
virtual SValue4Di getValue4Di (const c8 *section, const c8 *key)=0
 returns the value assigned to the section-key-pair as a 4 dimensional value of integers
virtual E_AUDIO_DEVICE getValueAudioDev (const c8 *section, const c8 *key)=0
virtual bool getValueB (const c8 *section, const c8 *key)=0
 returns the value assigned to the section-key-pair as a boolean.
virtual E_DRIVER_TYPE getValueDrv (const c8 *section, const c8 *key)=0
virtual float getValueF (const c8 *section, const c8 *key)=0
 returns the value assigned to the section-key-pair as a floating point value.
virtual int getValueI (const c8 *section, const c8 *key)=0
 returns the value assigned to the section-key-pair as an integer.
virtual EKEY_CODE getValueK (const c8 *section, const c8 *key)=0
 returns the value assigned to the section-key-pair as an Irrlicht key code.
virtual u32 getValueU32 (const c8 *section, const c8 *key)=0
 returns the value assigned to the section-key-pair as an unsigned 32bit integer
virtual const wchar_t * getValueW (const c8 *section, const c8 *key)=0
 returns the value assigned to the section-key-pair as an UNICODE-string.
virtual bool load ()=0
 loads the data into the class
virtual void removeAll ()=0
 Removes all sections and keys from the file.
virtual bool save ()=0
 saves the data into a file
virtual void setSaveFileName (stringc fileName)=0
 Sets a filename to save the data in.
virtual void setSaveOnDestroy (bool enabled)=0
 Sets if the data should be saved when the object is destroyed.
virtual void setValue (const c8 *section, const c8 *key, u32 value)=0
 Assigns a new unsigned 32bit integer value to the section-key-pair.
virtual void setValue (const c8 *section, const c8 *key, E_AUDIO_DEVICE value)=0
virtual void setValue (const c8 *section, const c8 *key, E_DRIVER_TYPE value)=0
 Assigns a new Irrlicht driver type value to the section-key-pair.
virtual void setValue (const c8 *section, const c8 *key, EKEY_CODE value)=0
 Assigns a new Irrlicht key code value to the section-key-pair.
virtual void setValue (const c8 *section, const c8 *key, SValue4Df value)=0
 Assigns a new 4 dimensional floating point value to the section-key-pair.
virtual void setValue (const c8 *section, const c8 *key, SValue4Di value)=0
 Assigns a new 4 dimensional integer value to the section-key-pair.
virtual void setValue (const c8 *section, const c8 *key, SValue3Df value)=0
 Assigns a new 3 dimensional floating point value to the section-key-pair.
virtual void setValue (const c8 *section, const c8 *key, SValue3Di value)=0
 Assigns a new 3 dimensional integer value to the section-key-pair.
virtual void setValue (const c8 *section, const c8 *key, SValue2Df value)=0
 Assigns a new 2 dimensional floating point value to the section-key-pair.
virtual void setValue (const c8 *section, const c8 *key, SValue2Di value)=0
 Assigns a new 2 dimensional integer value to the section-key-pair.
virtual void setValue (const c8 *section, const c8 *key, bool value)=0
 Assigns a new boolean value to the section-key-pair.
virtual void setValue (const c8 *section, const c8 *key, float value)=0
 Assigns a new floating point value to the section-key-pair.
virtual void setValue (const c8 *section, const c8 *key, int value)=0
 Assigns a new integer value to the section-key-pair.
virtual void setValue (const c8 *section, const c8 *key, const wchar_t *value)=0
 Assigns a new UNICODE-string value to the section-key-pair.
virtual void setValue (const c8 *section, const c8 *key, const c8 *value)=0
 Assigns a new ASCII-string value to the section-key-pair.
virtual ~IIniFileReader ()
 Destructor.

Classes

struct  SKey
 Structure for holding data about a key. More...
struct  SSection
 Structure for holding data about a section. More...
class  SValue2Df
 Class for holding a 2 dimensional float values. More...
class  SValue2Di
 Class for holding a 2 dimensional integer values. More...
class  SValue3Df
 Class for holding a 3 dimensional float values. More...
class  SValue3Di
 Class for holding a 3 dimensional integer values. More...
class  SValue4Df
 Class for holding a 4 dimensional float values. More...
class  SValue4Di
 Class for holding a 4 dimensional integer values. More...

Detailed Description

Interface for reading/writing INI files.

Thank you Matthias Specht aka Sylence for your INI file parser.

Definition at line 25 of file IIniFileReader.hpp.

Constructor & Destructor Documentation

virtual nge::io::IIniFileReader::~IIniFileReader (  )  [inline, virtual]

Destructor.

Definition at line 39 of file IIniFileReader.hpp.

Member Function Documentation

virtual void nge::io::IIniFileReader::addKeyToSection ( const c8 *  section,
const c8 *  name,
const c8 *  value = 0 
) [pure virtual]

Adds the key 'name' to the section 'section' and assigns the value 'value' to it. If a section with the given name does not exist, the function does nothing. If a key with the given name already exists the value of this key will be updated.

virtual void nge::io::IIniFileReader::addSection ( const c8 *  name  )  [pure virtual]

Adds a new section with the name 'name' to the file.

virtual array<SSection*> nge::io::IIniFileReader::getAllSections (  )  [pure virtual]

Returns all sections stored in the file.

virtual SSection* nge::io::IIniFileReader::getSection ( const c8 *  name  )  [pure virtual]

Returns the section with the name 'name' or 0 if no section with this name exist.

virtual c8* nge::io::IIniFileReader::getValue ( const c8 *  section,
const c8 *  key 
) [pure virtual]

returns the value assigned to the section-key-pair as an ASCII-string.

virtual SValue2Df nge::io::IIniFileReader::getValue2Df ( const c8 *  section,
const c8 *  key 
) [pure virtual]

returns the value assigned to the section-key-pair as a 2 dimensional value of floats.

virtual SValue2Di nge::io::IIniFileReader::getValue2Di ( const c8 *  section,
const c8 *  key 
) [pure virtual]

returns the value assigned to the section-key-pair as a 2 dimensional value of integers.

virtual SValue3Df nge::io::IIniFileReader::getValue3Df ( const c8 *  section,
const c8 *  key 
) [pure virtual]

returns the value assigned to the section-key-pair as a 3 dimensional value of floats.

virtual SValue3Di nge::io::IIniFileReader::getValue3Di ( const c8 *  section,
const c8 *  key 
) [pure virtual]

returns the value assigned to the section-key-pair as a 3 dimensional value of integers.

virtual SValue4Df nge::io::IIniFileReader::getValue4Df ( const c8 *  section,
const c8 *  key 
) [pure virtual]

returns the value assigned to the section-key-pair as a 4 dimensional value of floats.

virtual SValue4Di nge::io::IIniFileReader::getValue4Di ( const c8 *  section,
const c8 *  key 
) [pure virtual]

returns the value assigned to the section-key-pair as a 4 dimensional value of integers

virtual E_AUDIO_DEVICE nge::io::IIniFileReader::getValueAudioDev ( const c8 *  section,
const c8 *  key 
) [pure virtual]

virtual bool nge::io::IIniFileReader::getValueB ( const c8 *  section,
const c8 *  key 
) [pure virtual]

returns the value assigned to the section-key-pair as a boolean.

virtual E_DRIVER_TYPE nge::io::IIniFileReader::getValueDrv ( const c8 *  section,
const c8 *  key 
) [pure virtual]

returns the value as an E_DRIVER_TYPE value. The string should have the same identifiers as the values. For example a string 'edt_null' will be converted to EDT_NULL (which is also the default)

virtual float nge::io::IIniFileReader::getValueF ( const c8 *  section,
const c8 *  key 
) [pure virtual]

returns the value assigned to the section-key-pair as a floating point value.

virtual int nge::io::IIniFileReader::getValueI ( const c8 *  section,
const c8 *  key 
) [pure virtual]

returns the value assigned to the section-key-pair as an integer.

virtual EKEY_CODE nge::io::IIniFileReader::getValueK ( const c8 *  section,
const c8 *  key 
) [pure virtual]

returns the value assigned to the section-key-pair as an Irrlicht key code.

virtual u32 nge::io::IIniFileReader::getValueU32 ( const c8 *  section,
const c8 *  key 
) [pure virtual]

returns the value assigned to the section-key-pair as an unsigned 32bit integer

virtual const wchar_t* nge::io::IIniFileReader::getValueW ( const c8 *  section,
const c8 *  key 
) [pure virtual]

returns the value assigned to the section-key-pair as an UNICODE-string.

virtual bool nge::io::IIniFileReader::load (  )  [pure virtual]

loads the data into the class

virtual void nge::io::IIniFileReader::removeAll (  )  [pure virtual]

Removes all sections and keys from the file.

virtual bool nge::io::IIniFileReader::save (  )  [pure virtual]

saves the data into a file

virtual void nge::io::IIniFileReader::setSaveFileName ( stringc  fileName  )  [pure virtual]

Sets a filename to save the data in.

virtual void nge::io::IIniFileReader::setSaveOnDestroy ( bool  enabled  )  [pure virtual]

Sets if the data should be saved when the object is destroyed.

virtual void nge::io::IIniFileReader::setValue ( const c8 *  section,
const c8 *  key,
u32  value 
) [pure virtual]

Assigns a new unsigned 32bit integer value to the section-key-pair.

virtual void nge::io::IIniFileReader::setValue ( const c8 *  section,
const c8 *  key,
E_AUDIO_DEVICE  value 
) [pure virtual]

virtual void nge::io::IIniFileReader::setValue ( const c8 *  section,
const c8 *  key,
E_DRIVER_TYPE  value 
) [pure virtual]

Assigns a new Irrlicht driver type value to the section-key-pair.

virtual void nge::io::IIniFileReader::setValue ( const c8 *  section,
const c8 *  key,
EKEY_CODE  value 
) [pure virtual]

Assigns a new Irrlicht key code value to the section-key-pair.

virtual void nge::io::IIniFileReader::setValue ( const c8 *  section,
const c8 *  key,
SValue4Df  value 
) [pure virtual]

Assigns a new 4 dimensional floating point value to the section-key-pair.

virtual void nge::io::IIniFileReader::setValue ( const c8 *  section,
const c8 *  key,
SValue4Di  value 
) [pure virtual]

Assigns a new 4 dimensional integer value to the section-key-pair.

virtual void nge::io::IIniFileReader::setValue ( const c8 *  section,
const c8 *  key,
SValue3Df  value 
) [pure virtual]

Assigns a new 3 dimensional floating point value to the section-key-pair.

virtual void nge::io::IIniFileReader::setValue ( const c8 *  section,
const c8 *  key,
SValue3Di  value 
) [pure virtual]

Assigns a new 3 dimensional integer value to the section-key-pair.

virtual void nge::io::IIniFileReader::setValue ( const c8 *  section,
const c8 *  key,
SValue2Df  value 
) [pure virtual]

Assigns a new 2 dimensional floating point value to the section-key-pair.

virtual void nge::io::IIniFileReader::setValue ( const c8 *  section,
const c8 *  key,
SValue2Di  value 
) [pure virtual]

Assigns a new 2 dimensional integer value to the section-key-pair.

virtual void nge::io::IIniFileReader::setValue ( const c8 *  section,
const c8 *  key,
bool  value 
) [pure virtual]

Assigns a new boolean value to the section-key-pair.

virtual void nge::io::IIniFileReader::setValue ( const c8 *  section,
const c8 *  key,
float  value 
) [pure virtual]

Assigns a new floating point value to the section-key-pair.

virtual void nge::io::IIniFileReader::setValue ( const c8 *  section,
const c8 *  key,
int  value 
) [pure virtual]

Assigns a new integer value to the section-key-pair.

virtual void nge::io::IIniFileReader::setValue ( const c8 *  section,
const c8 *  key,
const wchar_t *  value 
) [pure virtual]

Assigns a new UNICODE-string value to the section-key-pair.

virtual void nge::io::IIniFileReader::setValue ( const c8 *  section,
const c8 *  key,
const c8 *  value 
) [pure virtual]

Assigns a new ASCII-string value to the section-key-pair.

The documentation for this class was generated from the following file:
The NUSoftware Game Engine
The NUSoftware Game Engine Documentation © 2007-2008 by Tomer Nosrati. Generated on Sat Apr 26 16:52:36 2008 by Doxygen (1.5.5)