A container for SettingDefinition objects.
More...
|
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() |
|
A container for SettingDefinition objects.
def UM.Settings.DefinitionContainer.DefinitionContainer.__init__ |
( |
|
self, |
|
|
|
container_id, |
|
|
|
i18n_catalog = None , |
|
|
|
args, |
|
|
|
kwargs |
|
) |
| |
Constructor.
- Parameters
-
container_id | A unique, machine readable/writable ID for this container. |
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
-
kwargs | dict 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
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:
- UM/Settings/DefinitionContainer.py