![]() |
OGRE 14.3
Object-Oriented Graphics Rendering Engine
|
Class for quickly loading settings from a text file. More...
#include <OgreConfigFile.h>
Inheritance diagram for Ogre::ConfigFile:Public Types | |
| typedef MapIterator< SettingsBySection > | SectionIterator |
| typedef std::map< String, SettingsMultiMap * > | SettingsBySection |
| Gets an iterator for stepping through all the keys / values in the file. | |
| typedef std::map< String, SettingsMultiMap > | SettingsBySection_ |
| typedef MapIterator< SettingsMultiMap > | SettingsIterator |
| typedef std::multimap< String, String > | SettingsMultiMap |
Public Member Functions | |
| ConfigFile () | |
| void | clear (void) |
| Clear the settings. | |
| StringVector | getMultiSetting (const String &key, const String §ion=BLANKSTRING) const |
| Gets all settings from the file with the named key. | |
| SectionIterator | getSectionIterator (void) |
| String | getSetting (const String &key, const String §ion=BLANKSTRING, const String &defaultValue=BLANKSTRING) const |
| Gets the first setting from the file with the named key. | |
| const SettingsMultiMap & | getSettings (const String §ion=BLANKSTRING) const |
| Get all the available settings in a section. | |
| const SettingsBySection_ & | getSettingsBySection () const |
| Get all the available settings grouped by sections. | |
| SettingsIterator | getSettingsIterator (const String §ion=BLANKSTRING) |
| void | load (const DataStreamPtr &stream, const String &separators="\t:=", bool trimWhitespace=true) |
| load from a data stream | |
| 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 String &filename, const String &separators="\t:=", bool trimWhitespace=true) |
| load from a filename (not using resource group locations) | |
| 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) | |
Class for quickly loading settings from a text file.
This class is designed to quickly parse a simple file containing key/value pairs, mainly for use in configuration settings.
| typedef std::multimap<String, String> Ogre::ConfigFile::SettingsMultiMap |
| typedef std::map<String, SettingsMultiMap*> Ogre::ConfigFile::SettingsBySection |
Gets an iterator for stepping through all the keys / values in the file.
| typedef std::map<String, SettingsMultiMap> Ogre::ConfigFile::SettingsBySection_ |
| Ogre::ConfigFile::ConfigFile | ( | ) |
| 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 = BLANKSTRING, | ||
| const String & | defaultValue = BLANKSTRING ) 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) |
| defaultValue | The value to return if the setting is not found |
References Ogre::BLANKSTRING.
| StringVector Ogre::ConfigFile::getMultiSetting | ( | const String & | key, |
| const String & | section = BLANKSTRING ) const |
Gets all settings from the file with the named key.
References Ogre::BLANKSTRING.
| SectionIterator Ogre::ConfigFile::getSectionIterator | ( | void | ) |
|
inline |
Get all the available settings grouped by sections.
| SettingsIterator Ogre::ConfigFile::getSettingsIterator | ( | const String & | section = BLANKSTRING | ) |
References Ogre::BLANKSTRING.
| const SettingsMultiMap & Ogre::ConfigFile::getSettings | ( | const String & | section = BLANKSTRING | ) | const |
Get all the available settings in a section.
References Ogre::BLANKSTRING.
| void Ogre::ConfigFile::clear | ( | void | ) |
Clear the settings.