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

Public Member Functions

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
 

Static Public Attributes

 propertyChanged = None
 
 metaDataChanged = None
 

Detailed Description

Shared interface between setting container types

Member Function Documentation

def UM.Settings.Interfaces.ContainerInterface.getAllKeys (   self,
  Set,
  str 
)
Get all the setting keys known to this container.

:return: Set of keys.
def UM.Settings.Interfaces.ContainerInterface.getId (   self,
  str 
)
Get the ID of the container.

The ID should be unique, machine readable and machine writable. It is
intended to be used for example when referencing the container in
configuration files or when writing a file to disk.

:return: The unique ID of this container.
def UM.Settings.Interfaces.ContainerInterface.getMetaData (   self,
  Dict,
  str,
  Any 
)
Get all metadata of this container.

This returns a dictionary containing all the metadata for this container.
How this metadata is used depends on the application.

:return: The metadata for this container.
def UM.Settings.Interfaces.ContainerInterface.getName (   self,
  str 
)
Get the human-readable name of this container.

This should return a human-readable name for the container, that can be
used in the interface.

:return: The name of this container.
def UM.Settings.Interfaces.ContainerInterface.getPath (   self,
  str 
)
Get the path used to create this InstanceContainer.

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