Settings::Manager Class Reference

Settings management (can change during runtime) More...

#include <settings.hpp>

List of all members.

Public Member Functions
void	loadDefault (const std::string &file)
	load file as the default settings (can be overridden by user settings)
void	loadUser (const std::string &file)
	load file as user settings
void	saveUser (const std::string &file)
	save user settings to file
Static Public Member Functions
static const CategorySettingVector	apply ()
	returns the list of changed settings and then clears it
static const int	getInt (const std::string &setting, const std::string &category)
static const float	getFloat (const std::string &setting, const std::string &category)
static const std::string	getString (const std::string &setting, const std::string &category)
static const bool	getBool (const std::string &setting, const std::string &category)
static void	setInt (const std::string &setting, const std::string &category, const int value)
static void	setFloat (const std::string &setting, const std::string &category, const float value)
static void	setString (const std::string &setting, const std::string &category, const std::string &value)
static void	setBool (const std::string &setting, const std::string &category, const bool value)
Static Public Attributes
static Ogre::ConfigFile	mFile = Ogre::ConfigFile()
static Ogre::ConfigFile	mDefaultFile = Ogre::ConfigFile()
static CategorySettingVector	mChangedSettings = CategorySettingVector()
	tracks all the settings that were changed since the last apply() call
static CategorySettingValueMap	mNewSettings = CategorySettingValueMap()
	tracks all the settings that are in the default file, but not in user file yet

---

Detailed Description

Settings management (can change during runtime)

---

Member Function Documentation

const CategorySettingVector Manager::apply

(

)

[static]

returns the list of changed settings and then clears it

const bool Manager::getBool	(	const std::string &	setting,
		const std::string &	category
	)		[static]

const float Manager::getFloat	(	const std::string &	setting,
		const std::string &	category
	)		[static]

const int Manager::getInt	(	const std::string &	setting,
		const std::string &	category
	)		[static]

const std::string Manager::getString	(	const std::string &	setting,
		const std::string &	category
	)		[static]

void Manager::loadDefault

(

const std::string &

file

)

load file as the default settings (can be overridden by user settings)

void Manager::loadUser

(

const std::string &

file

)

load file as user settings

void Manager::saveUser

(

const std::string &

file

)

save user settings to file

void Manager::setBool	(	const std::string &	setting,
		const std::string &	category,
		const bool	value
	)		[static]

void Manager::setFloat	(	const std::string &	setting,
		const std::string &	category,
		const float	value
	)		[static]

void Manager::setInt	(	const std::string &	setting,
		const std::string &	category,
		const int	value
	)		[static]

void Manager::setString	(	const std::string &	setting,
		const std::string &	category,
		const std::string &	value
	)		[static]

---

Member Data Documentation

CategorySettingVector Manager::mChangedSettings = CategorySettingVector() [static]

tracks all the settings that were changed since the last apply() call

Ogre::ConfigFile Manager::mDefaultFile = Ogre::ConfigFile() [static]

Ogre::ConfigFile Manager::mFile = Ogre::ConfigFile() [static]

CategorySettingValueMap Manager::mNewSettings = CategorySettingValueMap() [static]

tracks all the settings that are in the default file, but not in user file yet

---

The documentation for this class was generated from the following files:

• components/settings/settings.hpp
• components/settings/settings.cpp