Uranium
Application Framework
UM.Settings.ContainerStack.ContainerStack Class Reference
Inheritance diagram for UM.Settings.ContainerStack.ContainerStack:
UM.Settings.Interfaces.ContainerInterface UM.PluginObject.PluginObject

Public Member Functions

def __init__
 
def __getnewargs__ (self)
 
def __getstate__ (self)
 
def __setstate__
 
def getId (self)
 
def getName (self)
 
def setName
 
def isReadOnly (self)
 
def setReadOnly
 
def getMetaData (self)
 
def setMetaData
 
def getMetaDataEntry
 
def setMetaDataEntry
 
def removeMetaDataEntry
 
def isDirty (self)
 
def setDirty
 
def getProperty
 
def getRawProperty
 
def hasProperty
 
def serialize
 
def getConfigurationTypeFromSerialized
 
def getVersionFromSerialized
 
def deserialize
 
def deserializeMetadata
 
def getAllKeys (self)
 
def getContainers (self)
 
def getContainerIndex
 
def getContainer
 
def getTop (self)
 
def getBottom (self)
 
def getPath (self)
 
def setPath
 
def getSettingDefinition
 
def findContainer
 
def addContainer
 
def insertContainer
 
def replaceContainer
 
def removeContainer
 
def getNextStack (self)
 
def setNextStack
 
def sendPostponedEmits (self)
 
def hasErrors (self)
 
def getErrorKeys (self)
 
def __str__ (self)
 
def __repr__ (self)
 
- Public Member Functions inherited from UM.Settings.Interfaces.ContainerInterface
def __init__ (self, args, kwargs)
 
def getId (self)
 
def getName (self)
 
def getMetaData (self)
 
def getMetaDataEntry
 
def getProperty
 
def hasProperty
 
def getAllKeys (self)
 
def serialize
 
def setProperty
 
def deserialize
 
def deserializeMetadata
 
def getLoadingPriority (cls)
 
def getConfigurationTypeFromSerialized
 
def getVersionFromSerialized
 
def getPath (self)
 
def setPath
 
def isDirty (self)
 
def setDirty
 
- Public Member Functions inherited from UM.PluginObject.PluginObject
def __init__ (self, args, kwags)
 
def getId (self)
 
def setPluginId
 
def setMetaData
 
def getMetaData (self)
 
def getPluginId (self)
 
def setVersion
 
def getVersion (self)
 

Static Public Attributes

int Version = 5
 
 id = pyqtProperty(str, fget = getId, constant = True)
 
 nameChanged = pyqtSignal()
 
 name = pyqtProperty(str, fget = getName, fset = setName, notify = nameChanged)
 
 readOnlyChanged = pyqtSignal()
 
 readOnly = pyqtProperty(bool, fget = isReadOnly, fset = setReadOnly, notify = readOnlyChanged)
 
 metaDataChanged = pyqtSignal(QObject)
 
 metaData = pyqtProperty("QVariantMap", fget = getMetaData, fset = setMetaData, notify = metaDataChanged)
 
 containersChanged = Signal()
 
 propertyChanged = Signal(Signal.Queued)
 
 propertiesChanged = Signal(Signal.Queued)
 
- Static Public Attributes inherited from UM.Settings.Interfaces.ContainerInterface
 propertyChanged = None
 
 metaDataChanged = None
 

Detailed Description

A stack of setting containers to handle setting value retrieval.

Member Function Documentation

◆ __getnewargs__()

def UM.Settings.ContainerStack.ContainerStack.__getnewargs__ (   self,
  Tuple,
  str 
)
For pickle support

◆ __getstate__()

def UM.Settings.ContainerStack.ContainerStack.__getstate__ (   self,
  Dict,
  str,
  Any 
)
For pickle support

◆ getAllKeys()

def UM.Settings.ContainerStack.ContainerStack.getAllKeys (   self,
  Set,
  str 
)
Get all keys known to this container stack.

In combination with getProperty(), you can obtain the current property
values of all settings.

:return: A set of all setting keys in this container stack.

◆ getBottom()

def UM.Settings.ContainerStack.ContainerStack.getBottom (   self,
  Optional,
  ContainerInterface 
)
Get the container at the bottom of the stack.

This is a convenience method that will always return the bottom of the stack.

:return: The container at the bottom of the stack, or None if no containers have been added.

◆ getContainers()

def UM.Settings.ContainerStack.ContainerStack.getContainers (   self,
  List,
  ContainerInterface 
)
Get a list of all containers in this stack.

Note that it returns a shallow copy of the container list, as it's only allowed to change the order or entries
in this list by the proper functions.
:return: A list of all containers in this stack.

◆ getErrorKeys()

def UM.Settings.ContainerStack.ContainerStack.getErrorKeys (   self,
  List,
  str 
)
Get all the keys that are in an error state in this stack

◆ getId()

def UM.Settings.ContainerStack.ContainerStack.getId (   self,
  str 
)
:copydoc ContainerInterface::getId

Reimplemented from ContainerInterface

◆ getMetaData()

def UM.Settings.ContainerStack.ContainerStack.getMetaData (   self,
  Dict,
  str,
  Any 
)
:copydoc ContainerInterface::getMetaData

Reimplemented from ContainerInterface

◆ getName()

def UM.Settings.ContainerStack.ContainerStack.getName (   self,
  str 
)
:copydoc ContainerInterface::getName

Reimplemented from ContainerInterface

◆ getNextStack()

def UM.Settings.ContainerStack.ContainerStack.getNextStack (   self,
  Optional,
  ContainerStack 
)
Get the next stack

The next stack is the stack that is searched for a setting value if the
bottom of the stack is reached when searching for a value.

:return: :type{ContainerStack} The next stack or None if not set.

◆ getPath()

def UM.Settings.ContainerStack.ContainerStack.getPath (   self,
  str 
)
:copydoc ContainerInterface::getPath.

Reimplemented from ContainerInterface

◆ getTop()

def UM.Settings.ContainerStack.ContainerStack.getTop (   self,
  Optional,
  ContainerInterface 
)
Get the container at the top of the stack.

This is a convenience method that will always return the top of the stack.

:return: The container at the top of the stack, or None if no containers have been added.

◆ hasErrors()

def UM.Settings.ContainerStack.ContainerStack.hasErrors (   self,
  bool 
)
Check if the container stack has errors

◆ isReadOnly()

def UM.Settings.ContainerStack.ContainerStack.isReadOnly (   self,
  bool 
)
:copydoc ContainerInterface::isReadOnly

Reimplemented from ContainerInterface

◆ sendPostponedEmits()

def UM.Settings.ContainerStack.ContainerStack.sendPostponedEmits (   self,
  None 
)
Send postponed emits
These emits are collected from the option postpone_emit.
Note: the option can be implemented for all functions modifying the stack.

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