Uranium
Application Framework
UM.Preferences.Preferences Class Reference

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

Public Member Functions

def __init__ (self)
 
def addPreference (self, key, default_value)
 
def setDefault (self, key, default_value)
 Changes the default value of a preference. More...
 
def setValue (self, key, value)
 
def getValue (self, key)
 
def resetPreference (self, key)
 
def readFromFile (self, file)
 
def writeToFile (self, file)
 
"Preferences" getInstance (cls)
 
str deserialize (self, str serialized)
 Extract data from string and store it in the Configuration parser.
 

Static Public Attributes

int Version = 5
 
 preferenceChanged = Signal()
 

Detailed Description

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

Typical preferences would be window size, standard machine, etc.

Member Function Documentation

◆ setDefault()

def UM.Preferences.Preferences.setDefault (   self,
  key,
  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: