Class for quickly loading settings from a text file. More...
#include <OgreConfigFile.h>

Public Types | |
| typedef multimap< String, String >::type | SettingsMultiMap |
| typedef MapIterator < SettingsMultiMap > | SettingsIterator |
| typedef map< String, SettingsMultiMap * >::type | 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 String &defaultValue=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. | |
| void * | operator new (size_t sz, const char *file, int line, const char *func) |
| operator new, with debug line info | |
| void * | operator new (size_t sz) |
| void * | operator new (size_t sz, void *ptr) |
| placement operator new | |
| void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
| array operator new, with debug line info | |
| void * | operator new[] (size_t sz) |
| void | operator delete (void *ptr) |
| void | operator delete (void *ptr, void *) |
| void | operator delete (void *ptr, const char *, int, const char *) |
| void | operator delete[] (void *ptr) |
| void | operator delete[] (void *ptr, const char *, int, const char *) |
Protected Attributes | |
| SettingsBySection | mSettings |
Class for quickly loading settings from a text file.
Definition at line 61 of file OgreConfigFile.h.
Definition at line 91 of file OgreConfigFile.h.
| typedef map<String, SettingsMultiMap*>::type Ogre::ConfigFile::SettingsBySection |
Gets an iterator for stepping through all the keys / values in the file.
Definition at line 90 of file OgreConfigFile.h.
Definition at line 88 of file OgreConfigFile.h.
| typedef multimap<String, String>::type Ogre::ConfigFile::SettingsMultiMap |
Definition at line 87 of file OgreConfigFile.h.
| virtual Ogre::ConfigFile::~ConfigFile | ( | ) | [virtual] |
| void Ogre::ConfigFile::clear | ( | void | ) |
Clear the settings.
| StringVector Ogre::ConfigFile::getMultiSetting | ( | const String & | key, |
| const String & | section = StringUtil::BLANK |
||
| ) | const |
Gets all settings from the file with the named key.
Get an iterator over all the available sections in the config file.
| String Ogre::ConfigFile::getSetting | ( | const String & | key, |
| const String & | section = StringUtil::BLANK, |
||
| const String & | defaultValue = 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) |
| defaultValue | The value to return if the setting is not found |
| SettingsIterator Ogre::ConfigFile::getSettingsIterator | ( | const String & | section = StringUtil::BLANK | ) |
Get an iterator over all the available settings in a section.
| 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)
| void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | [inherited] |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
| void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, |
| void * | |||
| ) | [inherited] |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
| void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, |
| const char * | , | ||
| int | , | ||
| const char * | |||
| ) | [inherited] |
Definition at line 107 of file OgreMemoryAllocatedObject.h.
| void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | [inherited] |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
| void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr, |
| const char * | , | ||
| int | , | ||
| const char * | |||
| ) | [inherited] |
Definition at line 118 of file OgreMemoryAllocatedObject.h.
| void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, |
| const char * | file, | ||
| int | line, | ||
| const char * | func | ||
| ) | [inherited] |
operator new, with debug line info
Definition at line 67 of file OgreMemoryAllocatedObject.h.
| void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | [inherited] |
Definition at line 72 of file OgreMemoryAllocatedObject.h.
| void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, |
| void * | ptr | ||
| ) | [inherited] |
placement operator new
Definition at line 78 of file OgreMemoryAllocatedObject.h.
| void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz, |
| const char * | file, | ||
| int | line, | ||
| const char * | func | ||
| ) | [inherited] |
array operator new, with debug line info
Definition at line 85 of file OgreMemoryAllocatedObject.h.
| void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | [inherited] |
Definition at line 90 of file OgreMemoryAllocatedObject.h.
SettingsBySection Ogre::ConfigFile::mSettings [protected] |
Definition at line 102 of file OgreConfigFile.h.
Copyright © 2012 Torus Knot Software Ltd

This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sun Sep 2 2012 07:27:27