Uranium
Application Framework
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__ (self, container_id, i18n_catalog=None, args, kwargs)
 Constructor. More...
 
def __setattr__ (self, name, value)
 Reimplement setattr so we can make sure the definition remains unchanged after creation. More...
 
def getId (self)
 
def getName (self)
 
def isReadOnly (self)
 
def setReadOnly
 
def getPath (self)
 
def setPath (self, path)
 
def getMetaData (self)
 
def definitions (self)
 
def getInheritedFiles (self)
 Gets all ancestors of this definition container. More...
 
def getAllKeys (self)
 Gets all keys of settings in this container. More...
 
def getMetaDataEntry (self, entry, default=None)
 
def getProperty (self, key, property_name)
 
def hasProperty (self, key, property_name)
 
def serialize (self)
 
def deserialize (self, serialized)
 
def findDefinitions (self, kwargs)
 Find definitions matching certain criteria. More...
 
- Public Member Functions inherited from UM.PluginObject.PluginObject
def __init__ (self)
 
def getPluginId (self)
 
def setPluginId (self, plugin_id)
 

Static Public Attributes

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

Properties

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

Detailed Description

A container for SettingDefinition objects.

Constructor & Destructor Documentation

◆ __init__()

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

◆ __setattr__()

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

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

◆ deserialize()

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

Reimplemented from ContainerInterface

◆ findDefinitions()

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.

◆ getAllKeys()

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.

◆ getId()

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

Reimplemented from ContainerInterface

◆ getInheritedFiles()

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.

◆ getMetaData()

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

Reimplemented from ContainerInterface

◆ getMetaDataEntry()

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

Reimplemented from ContainerInterface

◆ getName()

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

Reimplemented from ContainerInterface

◆ getPath()

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

Reimplemented from ContainerInterface

◆ getProperty()

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

Reimplemented from ContainerInterface.

◆ hasProperty()

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

Reimplemented from ContainerInterface

◆ isReadOnly()

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

Reimplemented from ContainerInterface

◆ serialize()

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

◆ setPath()

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

Reimplemented from ContainerInterface

Member Data Documentation

◆ propertyChanged

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: