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

A container for SettingDefinition objects. More...

Inheritance diagram for UM.Settings.DefinitionContainer.DefinitionContainer:
UM.PluginObject.PluginObject

Public Member Functions

def __init__
 Constructor. More...
 
def __setattr__
 Reimplement setattr so we can make sure the definition remains unchanged after creation. More...
 
def getId
 
def getName
 
def isReadOnly
 
def setReadOnly
 
def getPath
 
def setPath
 
def getMetaData
 
def definitions
 
def getInheritedFiles
 Gets all ancestors of this definition container. More...
 
def getAllKeys
 Gets all keys of settings in this container. More...
 
def getMetaDataEntry
 
def getProperty
 
def hasProperty
 
def serialize
 
def deserialize
 
def findDefinitions
 Find definitions matching certain criteria. More...
 
- Public Member Functions inherited from UM.PluginObject.PluginObject
def __init__
 
def getPluginId
 
def setPluginId
 

Static Public Attributes

int Version = 2
 
tuple propertyChanged = Signal()
 This signal is unused since the definition container is immutable, but is provided for API consistency. More...
 
tuple metaDataChanged = Signal()
 

Properties

 id = property(getId)
 
 name = property(getName)
 
 metaData = property(getMetaData)
 

Detailed Description

A container for SettingDefinition objects.

Constructor & Destructor Documentation

def UM.Settings.DefinitionContainer.DefinitionContainer.__init__ (   self,
  container_id,
  i18n_catalog = None,
  args,
  kwargs 
)

Constructor.

Parameters
container_idA unique, machine readable/writable ID for this container.

Member Function Documentation

def UM.Settings.DefinitionContainer.DefinitionContainer.__setattr__ (   self,
  name,
  value 
)

Reimplement setattr so we can make sure the definition remains unchanged after creation.

def UM.Settings.DefinitionContainer.DefinitionContainer.deserialize (   self,
  serialized 
)

Reimplemented from ContainerInterface

def UM.Settings.DefinitionContainer.DefinitionContainer.findDefinitions (   self,
  kwargs 
)

Find definitions matching certain criteria.

Parameters
kwargsdict A dictionary of keyword arguments containing key-value pairs which should match properties of the definition.
def UM.Settings.DefinitionContainer.DefinitionContainer.getAllKeys (   self)

Gets all keys of settings in this container.

Returns
A set of all keys of settings in this container.
def UM.Settings.DefinitionContainer.DefinitionContainer.getId (   self,
  str 
)

Reimplemented from ContainerInterface

def UM.Settings.DefinitionContainer.DefinitionContainer.getInheritedFiles (   self)

Gets all ancestors of this definition container.

This returns the definition in the "inherits" property of this container, and the definition in its "inherits" property, and so on. The ancestors are returned in order from parent to grand-grand-grand-...-grandparent, normally ending in a "root" container.

Returns
A list of ancestors, in order from near ancestor to the root.
def UM.Settings.DefinitionContainer.DefinitionContainer.getMetaData (   self)

Reimplemented from ContainerInterface

def UM.Settings.DefinitionContainer.DefinitionContainer.getMetaDataEntry (   self,
  entry,
  default = None 
)

Reimplemented from ContainerInterface

def UM.Settings.DefinitionContainer.DefinitionContainer.getName (   self,
  str 
)

Reimplemented from ContainerInterface

def UM.Settings.DefinitionContainer.DefinitionContainer.getPath (   self)

Reimplemented from ContainerInterface

def UM.Settings.DefinitionContainer.DefinitionContainer.getProperty (   self,
  key,
  property_name 
)

Reimplemented from ContainerInterface.

def UM.Settings.DefinitionContainer.DefinitionContainer.hasProperty (   self,
  key,
  property_name 
)

Reimplemented from ContainerInterface

def UM.Settings.DefinitionContainer.DefinitionContainer.isReadOnly (   self,
  bool 
)

Reimplemented from ContainerInterface

def UM.Settings.DefinitionContainer.DefinitionContainer.serialize (   self)

TODO: This implementation flattens the definition container, since the data about inheritance and overrides was lost when deserialising.

Reimplemented from ContainerInterface

def UM.Settings.DefinitionContainer.DefinitionContainer.setPath (   self,
  path 
)

Reimplemented from ContainerInterface

Member Data Documentation

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

This signal is unused since the definition container is immutable, but is provided for API consistency.


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