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
 Add a new preference to the list. More...
 
def removePreference
 
def setDefault
 Changes the default value of a preference. More...
 
def setValue
 
def getValue
 
def resetPreference
 
def readFromFile
 
def writeToFile
 
def deserialize
 Extract data from string and store it in the Configuration parser. More...
 
def 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()
 

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

def UM.Preferences.Preferences.addPreference (   self,
  key 
)

Add a new preference to the list.

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

◆ deserialize()

def UM.Preferences.Preferences.deserialize (   self,
  serialized 
)

Extract data from string and store it in the Configuration parser.

◆ setDefault()

def UM.Preferences.Preferences.setDefault (   self,
  key 
)

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: