OGRE
1.9.0
|
Class for quickly loading settings from a text file. More...
#include <OgreConfigFile.h>
Public Types | |
typedef MapIterator< SettingsBySection > | SectionIterator |
typedef map< String, SettingsMultiMap * >::type | SettingsBySection |
Gets an iterator for stepping through all the keys / values in the file. | |
typedef MapIterator< SettingsMultiMap > | SettingsIterator |
typedef multimap< String, String >::type | SettingsMultiMap |
Public Member Functions | |
ConfigFile () | |
virtual | ~ConfigFile () |
void | clear (void) |
Clear the settings. | |
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. | |
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. | |
SettingsIterator | getSettingsIterator (const String §ion=StringUtil::BLANK) |
Get an iterator over all the available settings in a section. | |
void | load (const DataStreamPtr &stream, const String &separators="\t:=", bool trimWhitespace=true) |
load from a data stream | |
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) | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr, void *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz) |
void * | operator new (size_t sz) |
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, const char *file, int line, const char *func) |
operator new, with debug line info | |
void * | operator new (size_t sz, void *ptr) |
placement operator new | |
void * | operator new (size_t sz, void *ptr) |
placement operator new | |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz) |
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, const char *file, int line, const char *func) |
array operator new, with debug line info | |
Protected Attributes | |
SettingsBySection | mSettings |
Class for quickly loading settings from a text file.
Definition at line 62 of file OgreConfigFile.h.
Definition at line 90 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 89 of file OgreConfigFile.h.
Definition at line 87 of file OgreConfigFile.h.
typedef multimap<String,String>::type Ogre::ConfigFile::SettingsMultiMap |
Definition at line 86 of file OgreConfigFile.h.
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.
References Ogre::StringUtil::BLANK.
SectionIterator Ogre::ConfigFile::getSectionIterator | ( | void | ) |
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 |
References Ogre::StringUtil::BLANK.
SettingsIterator Ogre::ConfigFile::getSettingsIterator | ( | const String & | section = StringUtil::BLANK | ) |
Get an iterator over all the available settings in a section.
References Ogre::StringUtil::BLANK.
void Ogre::ConfigFile::load | ( | const DataStreamPtr & | stream, |
const String & | separators = "\t:=", | ||
bool | trimWhitespace = true ) |
load from a data stream
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::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)
|
inherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
inherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
protected |
Definition at line 101 of file OgreConfigFile.h.