coat.settings Class Reference

Static Public Member Functions
bool	valueExists (str ID)
	returns true if the value in settings exists
bool	getBool (str ID)
	get the boolen value from the settings
str	getString (str ID)
	get the string value from the settings
float	getFloat (str ID)
	get the float value from the settings
int	getInt (str ID)
	get the integer value from the settings
bool	setBool (str ID, bool value)
	set the boolean value to the settings
bool	setString (str ID, str value)
	set the string value to the settings
bool	setFloat (str ID, float value)
	set the float value to the settings
bool	setInt (str ID, int value)
	set the integer value to the settings
	saveSettings ()
	save all changed settings
	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
list	listAllSettings ()
	get the list of all available settings
	pressButton (str button_name)
	triger some action in settings

Member Function Documentation

getBool()

bool coat.settings.getBool ( str 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()

float coat.settings.getFloat ( str 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()

int coat.settings.getInt ( str 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()

str coat.settings.getString ( str 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()

list 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()

coat.settings.pressButton ( str button_name )

static

triger some action in settings

Parameters

button_name

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

resetSettings()

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

saveSettings()

coat.settings.saveSettings ( )

static

save all changed settings

setBool()

bool coat.settings.setBool ( str 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()

bool coat.settings.setFloat ( str 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()

bool coat.settings.setInt ( str ID, int value )

static

set the integer value to the settings

Parameters

value

the value to set

Returns

true if the value was set successfully

setString()

bool coat.settings.setString ( str ID, str 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()

bool coat.settings.valueExists ( str 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:

• doxy/src/coat.py