coat::settings Class Reference

Static Public Member Functions
static bool	valueExists (const char *ID)
	returns true if the value in settings exists
static bool	getBool (const char *ID)
	get the boolen value from the settings
static std::string	getString (const char *ID)
	get the string value from the settings
static float	getFloat (const char *ID)
	get the float value from the settings
static int	getInt (const char *ID)
	get the integer value from the settings
static bool	setBool (const char *ID, bool value)
	set the boolean value to the settings
static bool	setString (const char *ID, const char *value)
	set the string value to the settings
static bool	setFloat (const char *ID, float value)
	set the float value to the settings
static bool	setInt (const char *ID, int value)
	set the integer value to the settings
static void	saveSettings ()
	save all changed settings
static void	resetSettings (bool ResetGeneralSettings=true, bool ResetHiddenSet=true, bool ResetHotkeys=true, bool RestNavigation=true, bool ResetPresets=true, bool ResetTheme=true, bool ResetWindows=true)
	reset all settings to default values, application will restart
static std::vector< std::string >	listAllSettings ()
	get the list of all available settings
static void	pressButton (const char *button_name)
	triger some action in settings

Member Function Documentation

getBool()

static bool coat::settings::getBool ( const char * ID )

static

get the boolen value from the settings

Parameters

ID	the identifier or English text of the option, take identifier from the UI as usual (RMB + MMB)

Returns

the boolean value, false if not exists or casting impossible

getFloat()

static float coat::settings::getFloat ( const char * ID )

static

get the float value from the settings

Parameters

ID	the identifier or English text of the option, take identifier from the UI as usual (RMB + MMB)

Returns

the float value, 0 if not exists or casting impossible

getInt()

static int coat::settings::getInt ( const char * ID )

static

get the integer value from the settings

Parameters

ID	the identifier or English text of the option, take identifier from the UI as usual (RMB + MMB)

Returns

the integer value, 0 if not exists or casting impossible

getString()

static std::string coat::settings::getString ( const char * ID )

static

get the string value from the settings

Parameters

ID	the identifier or English text of the option, take identifier from the UI as usual (RMB + MMB)

Returns

the string value, empty if not exists

listAllSettings()

static std::vector< std::string > coat::settings::listAllSettings ( )

static

get the list of all available settings

Returns

the pairs of strings, first - option identifier, second - the value, pay attention boolean values are "true" and "false" (like in c++)

pressButton()

static void coat::settings::pressButton ( const char * button_name )

static

triger some action in settings

Parameters

button_name

the button name, look the identifier in the listAllSettings() output

resetSettings()

static void coat::settings::resetSettings ( bool ResetGeneralSettings = true, bool ResetHiddenSet = true, bool ResetHotkeys = true, bool RestNavigation = true, bool ResetPresets = true, bool ResetTheme = true, bool ResetWindows = true )

static

reset all settings to default values, application will restart

Parameters

ResetGeneralSettings	reset general settings
ResetHiddenSet	reset the hidden UI elements list
ResetHotkeys	reset the hotkeys
RestNavigation	reset the navigation settings
ResetPresets	reset the presets
ResetTheme	reset the theme
ResetWindows	reset the floating windows placement

setBool()

static bool coat::settings::setBool ( const char * ID, bool value )

static

set the boolean value to the settings

Parameters

ID	the identifier or English text of the option, take identifier from the UI as usual (RMB + MMB)
value	the value to set

Returns

true if the value was set successfully

setFloat()

static bool coat::settings::setFloat ( const char * ID, float value )

static

set the float value to the settings

Parameters

ID	the identifier or English text of the option, take identifier from the UI as usual (RMB + MMB)
value	the value to set

Returns

true if the value was set successfully

setInt()

static bool coat::settings::setInt ( const char * ID, int value )

static

set the integer value to the settings

Parameters

the	identifier or English text of the option, take identifier from the UI as usual (RMB + MMB)
value	the value to set

Returns

true if the value was set successfully

setString()

static bool coat::settings::setString ( const char * ID, const char * value )

static

set the string value to the settings

Parameters

ID	the identifier or English text of the option, take identifier from the UI as usual (RMB + MMB)
value	the value to set

Returns

true if the value was set successfully

valueExists()

static bool coat::settings::valueExists ( const char * ID )

static

returns true if the value in settings exists

Parameters

ID	the identifier or English text of the option, take identifier from the UI as usual (RMB + MMB)

Returns

true if identifier exists

---

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

• include/CoreAPI.h