#include <OgreConfigFile.h>
Public Types | |
typedef std::multimap < String, String > | SettingsMultiMap |
typedef MapIterator < SettingsMultiMap > | SettingsIterator |
typedef std::map < String, SettingsMultiMap * > | SettingsBySection |
Gets an iterator for stepping through all the keys / values in the file. | |
typedef MapIterator < SettingsBySection > | SectionIterator |
Public Member Functions | |
ConfigFile () | |
virtual | ~ConfigFile () |
void | load (const String &filename, const String &separators="\t:=", bool trimWhitespace=true) |
load from a filename (not using resource group locations) | |
void | load (const String &filename, const String &resourceGroup, const String &separators="\t:=", bool trimWhitespace=true) |
load from a filename (using resource group locations) | |
void | load (const DataStreamPtr &stream, const String &separators="\t:=", bool trimWhitespace=true) |
load from a data stream | |
void | loadDirect (const String &filename, const String &separators="\t:=", bool trimWhitespace=true) |
load from a filename (not using resource group locations) | |
void | loadFromResourceSystem (const String &filename, const String &resourceGroup, const String &separators="\t:=", bool trimWhitespace=true) |
load from a filename (using resource group locations) | |
String | getSetting (const String &key, const String §ion=StringUtil::BLANK) const |
Gets the first setting from the file with the named key. | |
StringVector | getMultiSetting (const String &key, const String §ion=StringUtil::BLANK) const |
Gets all settings from the file with the named key. | |
SectionIterator | getSectionIterator (void) |
Get an iterator over all the available sections in the config file. | |
SettingsIterator | getSettingsIterator (const String §ion=StringUtil::BLANK) |
Get an iterator over all the available settings in a section. | |
void | clear (void) |
Clear the settings. | |
Protected Attributes | |
SettingsBySection | mSettings |
Definition at line 56 of file OgreConfigFile.h.
typedef std::multimap<String, String> Ogre::ConfigFile::SettingsMultiMap |
Definition at line 81 of file OgreConfigFile.h.
Definition at line 82 of file OgreConfigFile.h.
typedef std::map<String, SettingsMultiMap*> Ogre::ConfigFile::SettingsBySection |
Gets an iterator for stepping through all the keys / values in the file.
Definition at line 84 of file OgreConfigFile.h.
Definition at line 85 of file OgreConfigFile.h.
Ogre::ConfigFile::ConfigFile | ( | ) |
virtual Ogre::ConfigFile::~ConfigFile | ( | ) | [virtual] |
void Ogre::ConfigFile::load | ( | const String & | filename, | |
const String & | separators = "\t:=" , |
|||
bool | trimWhitespace = true | |||
) |
load from a filename (not using resource group locations)
void Ogre::ConfigFile::load | ( | const String & | filename, | |
const String & | resourceGroup, | |||
const String & | separators = "\t:=" , |
|||
bool | trimWhitespace = true | |||
) |
load from a filename (using resource group locations)
void Ogre::ConfigFile::load | ( | const DataStreamPtr & | stream, | |
const String & | separators = "\t:=" , |
|||
bool | trimWhitespace = true | |||
) |
load from a data stream
void Ogre::ConfigFile::loadDirect | ( | const String & | filename, | |
const String & | separators = "\t:=" , |
|||
bool | trimWhitespace = true | |||
) |
load from a filename (not using resource group locations)
void Ogre::ConfigFile::loadFromResourceSystem | ( | const String & | filename, | |
const String & | resourceGroup, | |||
const String & | separators = "\t:=" , |
|||
bool | trimWhitespace = true | |||
) |
load from a filename (using resource group locations)
String Ogre::ConfigFile::getSetting | ( | const String & | key, | |
const String & | section = StringUtil::BLANK | |||
) | const |
Gets the first setting from the file with the named key.
key | The name of the setting | |
section | The name of the section it must be in (if any) |
StringVector Ogre::ConfigFile::getMultiSetting | ( | const String & | key, | |
const String & | section = StringUtil::BLANK | |||
) | const |
Gets all settings from the file with the named key.
SectionIterator Ogre::ConfigFile::getSectionIterator | ( | void | ) |
Get an iterator over all the available sections in the config file.
SettingsIterator Ogre::ConfigFile::getSettingsIterator | ( | const String & | section = StringUtil::BLANK |
) |
Get an iterator over all the available settings in a section.
void Ogre::ConfigFile::clear | ( | void | ) |
Clear the settings.
SettingsBySection Ogre::ConfigFile::mSettings [protected] |
Definition at line 96 of file OgreConfigFile.h.
Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sat May 10 16:25:35 2008