Uranium
Application Framework
 All Classes Namespaces Files Functions Variables Pages
UM.Settings.SettingInstance.SettingInstance Class Reference

Encapsulates all state of a setting. More...

Public Member Functions

def __init__
 Constructor. More...
 
def getPropertyNames
 Get a list of all supported property names.
 
def __deepcopy__
 Copies the setting instance and all its properties and state. More...
 
def __eq__
 
def __ne__
 
def __getattr__
 
def setProperty
 
def updateProperty
 
def definition
 The SettingDefinition this instance maintains state for. More...
 
def container
 The container of this instance. More...
 
def validationState
 Get the state of validation of this instance. More...
 
def state
 
def resetState
 
def __repr__
 
def updateRelations
 protected:
 

Static Public Attributes

tuple propertyChanged = Signal()
 Emitted whenever a property of this instance changes. More...
 

Detailed Description

Encapsulates all state of a setting.

The SettingInstance class contains all state related to a setting.

Constructor & Destructor Documentation

def UM.Settings.SettingInstance.SettingInstance.__init__ (   self,
  definition 
)

Constructor.

Parameters
definitionThe SettingDefinition object this is an instance of.
containerThe container of this instance. Needed for relation handling.

Member Function Documentation

def UM.Settings.SettingInstance.SettingInstance.__deepcopy__ (   self,
  memo 
)

Copies the setting instance and all its properties and state.

The definition and the instance container containing this instance are not deep-copied but just taken over from the original, since they are seen as back-links. Please set them correctly after deep-copying this instance.

def UM.Settings.SettingInstance.SettingInstance.container (   self,
  ContainerInterface 
)

The container of this instance.

def UM.Settings.SettingInstance.SettingInstance.definition (   self,
  SettingDefinition 
)

The SettingDefinition this instance maintains state for.

def UM.Settings.SettingInstance.SettingInstance.validationState (   self,
  Optional,
  Validator 
)

Get the state of validation of this instance.

Member Data Documentation

tuple UM.Settings.SettingInstance.SettingInstance.propertyChanged = Signal()
static

Emitted whenever a property of this instance changes.

Parameters
instanceThe instance that reported the property change (usually self).
propertyThe name of the property that changed.

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