Uranium
Application Framework
|
A container for SettingDefinition objects. More...
Public Member Functions | |
def | __init__ |
Constructor. More... | |
def | __setattr__ (self, name, value) |
Reimplement setattr so we can make sure the definition remains unchanged after creation. More... | |
def | __getnewargs__ (self) |
For pickle support. | |
def | __getstate__ (self) |
For pickle support. | |
def | __setstate__ (self, state) |
For pickle support. | |
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, context=None) |
def | hasProperty |
def | serialize |
def | getConfigurationTypeFromSerialized |
def | getVersionFromSerialized |
def | addDefinition |
Add a setting definition instance if it doesn't exist yet. More... | |
def | deserialize |
def | deserializeMetadata |
Gets the metadata of a definition container from a serialised format. More... | |
def | findDefinitions (self, kwargs) |
Find definitions matching certain criteria. More... | |
def | getLoadingPriority (cls) |
def | __str__ (self) |
Simple short string representation for debugging purposes. More... | |
![]() | |
def | __init__ (self) |
def | getPluginId (self) |
def | setPluginId (self, plugin_id) |
def | setVersion |
def | getVersion (self) |
Static Public Attributes | |
int | Version = 2 |
id = pyqtProperty(str, fget = getId, constant = True) | |
name = pyqtProperty(str, fget = getName, constant = True) | |
readOnly = pyqtProperty(bool, fget = isReadOnly, constant = True) | |
metaData = pyqtProperty("QVariantMap", fget = getMetaData, constant = True) | |
propertyChanged = Signal() | |
This signal is unused since the definition container is immutable, but is provided for API consistency. More... | |
metaDataChanged = Signal() | |
A container for SettingDefinition objects.
def UM.Settings.DefinitionContainer.DefinitionContainer.__init__ | ( | self, | |
container_id | |||
) |
Constructor.
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.__str__ | ( | self | ) |
Simple short string representation for debugging purposes.
def UM.Settings.DefinitionContainer.DefinitionContainer.addDefinition | ( | self, | |
definition | |||
) |
Add a setting definition instance if it doesn't exist yet.
Warning: this might not work when there are relationships higher up in the stack.
def UM.Settings.DefinitionContainer.DefinitionContainer.deserialize | ( | self, | |
serialized, | |||
file_name | |||
) |
Reimplemented from ContainerInterface
def UM.Settings.DefinitionContainer.DefinitionContainer.deserializeMetadata | ( | cls, | |
serialized | |||
) |
Gets the metadata of a definition container from a serialised format.
This parses the entire JSON document and only extracts the metadata from it.
serialized | A JSON document, serialised as a string. |
container_id | The ID of the container (as obtained from the file name). |
def UM.Settings.DefinitionContainer.DefinitionContainer.findDefinitions | ( | self, | |
kwargs, | |||
List, | |||
SettingDefinition | |||
) |
Find definitions matching certain criteria.
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, | |
List, | |||
str | |||
) |
Gets 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.
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, | |||
context = None |
|||
) |
Reimplemented from ContainerInterface.
def UM.Settings.DefinitionContainer.DefinitionContainer.hasProperty | ( | self, | |
key, | |||
property_name, | |||
ignore_inherited | |||
) |
Reimplemented from ContainerInterface
def UM.Settings.DefinitionContainer.DefinitionContainer.isReadOnly | ( | self, | |
bool | |||
) |
Reimplemented from ContainerInterface
def UM.Settings.DefinitionContainer.DefinitionContainer.serialize | ( | self, | |
ignored_metadata_keys | |||
) |
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
|
static |
This signal is unused since the definition container is immutable, but is provided for API consistency.