Uranium
Application Framework
|
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. More... | |
"Preferences" | getInstance (cls) |
This method is still used by some external plugins and it needs to be kept as deprecated. | |
Static Public Attributes | |
int | Version = 6 |
preferenceChanged = Signal() | |
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
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
None UM.Preferences.Preferences.deserialize | ( | self, | |
str | serialized | ||
) |
Extract data from string and store it in the Configuration parser.
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.
key | The key of the preference to set the default of. |
default_value | The new default value of the preference. |