Settings Class Reference

Handles settings. More...

#include <Settings.hpp>

Inheritance diagram for Settings:

Public Member Functions
bool	GetBool (const std::string &settingName)
	Get a bool setting. More...
void	SetBool (const std::string &settingName, bool value)
	Set a bool setting. More...
long	GetLong (const std::string &settingName)
	Get a long setting. More...
void	SetLong (const std::string &settingName, long value)
	Set a long setting. More...
double	GetDouble (const std::string &settingName)
	Get a double setting. More...
void	SetDouble (const std::string &settingName, double value)
	Set a double setting. More...
std::string	GetString (const std::string &settingName)
	Get a string setting. More...
void	SetString (const std::string &settingName, const std::string &value)
	Set a string setting. More...
virtual void	Save ()=0
	Save the settings to an INI file. More...

Protected Member Functions
void	AddBoolSetting (const std::string &settingName, const std::string &section, const std::string &key, bool defaultValue)
	Add a bool setting. More...
void	AddLongSetting (const std::string &settingName, const std::string &section, const std::string &key, long defaultValue)
	Add a long setting. More...
void	AddDoubleSetting (const std::string &settingName, const std::string &section, const std::string &key, double defaultValue)
	Add a double setting. More...
void	AddStringSetting (const std::string &settingName, const std::string &section, const std::string &key, const std::string &defaultValue)
	Add a string setting. More...

Protected Attributes
CSimpleIni	ini
	Ini file. More...

Detailed Description

Handles settings.

Member Function Documentation

AddBoolSetting()

void Settings::AddBoolSetting ( const std::string &  settingName, const std::string &  section, const std::string &  key, bool  defaultValue  )

protected

Add a bool setting.

Parameters

settingName	Setting name.
section	INI section.
key	INI key.
defaultValue	Default value.

AddDoubleSetting()

void Settings::AddDoubleSetting ( const std::string &  settingName, const std::string &  section, const std::string &  key, double  defaultValue  )

protected

Add a double setting.

Parameters

settingName	Setting name.
section	INI section.
key	INI key.
defaultValue	Default value.

AddLongSetting()

void Settings::AddLongSetting ( const std::string &  settingName, const std::string &  section, const std::string &  key, long  defaultValue  )

protected

Add a long setting.

Parameters

settingName	Setting name.
section	INI section.
key	INI key.
defaultValue	Default value.

AddStringSetting()

void Settings::AddStringSetting ( const std::string &  settingName, const std::string &  section, const std::string &  key, const std::string &  defaultValue  )

protected

Add a string setting.

Parameters

settingName	Setting name.
section	INI section.
key	INI key.
defaultValue	Default value.

GetBool()

bool Settings::GetBool

(

const std::string &

settingName

)

Get a bool setting.

Parameters

settingName

Setting name.

Returns

The value of the setting

GetDouble()

double Settings::GetDouble

(

const std::string &

settingName

)

Get a double setting.

Parameters

settingName

Setting name.

Returns

The value of the setting

GetLong()

long Settings::GetLong

(

const std::string &

settingName

)

Get a long setting.

Parameters

settingName

Setting name.

Returns

The value of the setting

GetString()

string Settings::GetString

(

const std::string &

settingName

)

Get a string setting.

Parameters

settingName

Setting name.

Returns

The value of the setting

Save()

virtual void Settings::Save ( )

pure virtual

Save the settings to an INI file.

Implemented in EditorSettings, and GameSettings.

SetBool()

void Settings::SetBool	(	const std::string &	settingName,
		bool	value
	)

Set a bool setting.

Parameters

settingName	Setting name.
value	Value to set it to.

SetDouble()

void Settings::SetDouble	(	const std::string &	settingName,
		double	value
	)

Set a double setting.

Parameters

settingName	Setting name.
value	Value to set it to.

SetLong()

void Settings::SetLong	(	const std::string &	settingName,
		long	value
	)

Set a long setting.

Parameters

settingName	Setting name.
value	Value to set it to.

SetString()

void Settings::SetString	(	const std::string &	settingName,
		const std::string &	value
	)

Set a string setting.

Parameters

settingName	Setting name.
value	Value to set it to.

Member Data Documentation

ini

CSimpleIni Settings::ini

protected

Ini file.

---

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

• src/Engine/Util/Settings.hpp
• src/Engine/Util/Settings.cpp