CSkinSettings Class Reference

#include <SkinSettings.h>

Inheritance diagram for CSkinSettings:

Public Member Functions
bool	Load (const TiXmlNode *settings) override
	Load settings from the given XML node.
bool	Save (TiXmlNode *settings) const override
	Save settings to the given XML node.
void	Clear () override
	Clear any loaded setting values.
void	MigrateSettings (const std::shared_ptr< ADDON::CSkinInfo > &skin)
int	TranslateString (const std::string &setting) const
const std::string &	GetString (int setting) const
void	SetString (int setting, const std::string &label) const
int	TranslateBool (const std::string &setting) const
bool	GetBool (int setting) const
void	SetBool (int setting, bool set) const
int	GetInt (int setting) const
	Get the skin setting value as an integer value.
std::set< ADDON::CSkinSettingPtr >	GetSettings () const
ADDON::CSkinSettingPtr	GetSetting (const std::string &settingId)
std::shared_ptr< const ADDON::CSkinSetting >	GetSetting (const std::string &settingId) const
void	Reset (const std::string &setting) const
void	Reset () const
Public Member Functions inherited from ISubSettings
virtual	~ISubSettings ()=default

Static Public Member Functions
static CSkinSettings &	GetInstance ()

Protected Member Functions
	CSkinSettings ()
	CSkinSettings (const CSkinSettings &)=delete
CSkinSettings &	operator= (CSkinSettings const &)=delete
	~CSkinSettings () override

Constructor & Destructor Documentation

CSkinSettings() [1/2]

CSkinSettings::CSkinSettings ( )

protected

CSkinSettings() [2/2]

CSkinSettings::CSkinSettings ( const CSkinSettings & )

protecteddelete

~CSkinSettings()

CSkinSettings::~CSkinSettings ( )

overrideprotecteddefault

Member Function Documentation

Clear()

void CSkinSettings::Clear ( )

overridevirtual

Clear any loaded setting values.

Reimplemented from ISubSettings.

GetBool()

bool CSkinSettings::GetBool

(

int

setting

)

const

GetInstance()

CSkinSettings & CSkinSettings::GetInstance ( )

static

GetInt()

int CSkinSettings::GetInt

(

int

setting

)

const

Get the skin setting value as an integer value.

Parameters

setting

- the setting id

Returns

the setting value as an integer, -1 if no conversion is possible

GetSetting() [1/2]

ADDON::CSkinSettingPtr CSkinSettings::GetSetting

(

const std::string &

settingId

)

GetSetting() [2/2]

std::shared_ptr< const ADDON::CSkinSetting > CSkinSettings::GetSetting

(

const std::string &

settingId

)

const

GetSettings()

std::set< ADDON::CSkinSettingPtr > CSkinSettings::GetSettings

(

)

const

GetString()

const std::string & CSkinSettings::GetString

(

int

setting

)

const

Load()

bool CSkinSettings::Load ( const TiXmlNode * settings )

overridevirtual

Load settings from the given XML node.

Parameters

settings

XML node containing setting values

Returns

True if loading the settings was successful, false otherwise.

Reimplemented from ISubSettings.

MigrateSettings()

void CSkinSettings::MigrateSettings

(

const std::shared_ptr< ADDON::CSkinInfo > &

skin

)

operator=()

CSkinSettings & CSkinSettings::operator= ( CSkinSettings const & )

protecteddelete

Reset() [1/2]

void CSkinSettings::Reset

(

)

const

Reset() [2/2]

void CSkinSettings::Reset

(

const std::string &

setting

)

const

Save()

bool CSkinSettings::Save ( TiXmlNode * settings ) const

overridevirtual

Save settings to the given XML node.

Parameters

settings

XML node in which the settings will be saved

Returns

True if saving the settings was successful, false otherwise.

Reimplemented from ISubSettings.

SetBool()

void CSkinSettings::SetBool	(	int	setting,
		bool	set ) const

SetString()

void CSkinSettings::SetString	(	int	setting,
		const std::string &	label ) const

TranslateBool()

int CSkinSettings::TranslateBool

(

const std::string &

setting

)

const

TranslateString()

int CSkinSettings::TranslateString

(

const std::string &

setting

)

const

---

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

• SkinSettings.h
• SkinSettings.cpp