Uranium
Application Framework
UM.Preferences.Preferences Class Reference

Preferences are application based settings that are saved for future use. More...

Public Member Functions

None __init__ (self)
 
None addPreference (self, str key, Any default_value)
 Add a new preference to the list. More...
 
None removePreference (self, str key)
 
None setDefault (self, str key, Any default_value)
 Changes the default value of a preference. More...
 
None setValue (self, str key, Any value)
 
Any getValue (self, str key)
 
None resetPreference (self, str key)
 
None readFromFile (self, Union[str, IO[str]] file)
 
None writeToFile (self, Union[str, IO[str]] file)
 
None deserialize (self, str serialized)
 Extract data from string and store it in the Configuration parser.
 

Static Public Attributes

int Version = 6
 
 preferenceChanged = Signal()
 

Detailed Description

Preferences are application based settings that are saved for future use.

Typical preferences would be window size, standard machine, etc. The application preferences can be gotten from the getPreferences() function in Application

Member Function Documentation

◆ addPreference()

None UM.Preferences.Preferences.addPreference (   self,
str  key,
Any  default_value 
)

Add a new preference to the list.

If the preference was already added, it's default is set to whatever is provided

◆ setDefault()

None UM.Preferences.Preferences.setDefault (   self,
str  key,
Any  default_value 
)

Changes the default value of a preference.

If the preference is currently set to the old default, the value of the preference will be set to the new default.

Parameters
keyThe key of the preference to set the default of.
default_valueThe new default value of the preference.

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