Uranium
Application Framework
|
A container for SettingDefinition objects. More...
Public Member Functions | |
def | __init__ (self, str 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. | |
def | __getnewargs__ (self) |
For pickle support. | |
def | __getstate__ (self) |
For pickle support. | |
def | __setstate__ (self, state) |
For pickle support. | |
str | getId (self) |
str | getName (self) |
bool | isReadOnly (self) |
None | setReadOnly (self, bool read_only) |
def | getPath (self) |
def | setPath (self, path) |
def | getMetaData (self) |
def | definitions (self) |
def | getInheritedFiles (self) |
Gets all ancestors of this definition container. More... | |
List[str] | 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 (self, key, property_name, bool ignore_inherited=False) |
def | serialize (self, Optional[set] ignored_metadata_keys=None) |
Optional[str] | getConfigurationTypeFromSerialized (cls, str serialized) |
Gets the configuration type of the given serialized data. More... | |
Optional[int] | getVersionFromSerialized (cls, str serialized) |
Gets the version of the given serialized data. More... | |
def | addDefinition (self, SettingDefinition definition) |
Add a setting definition instance if it doesn't exist yet. More... | |
str | deserialize (self, serialized, Optional[str] file_name=None) |
List[Dict[str, Any]] | deserializeMetadata (cls, str serialized, str container_id) |
Gets the metadata of a definition container from a serialised format. More... | |
List[SettingDefinition] | findDefinitions (self, **kwargs) |
Find definitions matching certain criteria. More... | |
int | getLoadingPriority (cls) |
def | __str__ (self) |
Simple short string representation for debugging purposes. | |
![]() | |
def | __init__ (self) |
def | getPluginId (self) |
def | setPluginId (self, plugin_id) |
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. | |
metaDataChanged = Signal() | |
A container for SettingDefinition objects.
def UM.Settings.DefinitionContainer.DefinitionContainer.__init__ | ( | self, | |
str | container_id, | ||
i18n_catalog = None , |
|||
* | args, | ||
** | kwargs | ||
) |
Constructor.
container_id | A unique, machine readable/writable ID for this container. |
def UM.Settings.DefinitionContainer.DefinitionContainer.addDefinition | ( | self, | |
SettingDefinition | 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.
str UM.Settings.DefinitionContainer.DefinitionContainer.deserialize | ( | self, | |
serialized, | |||
Optional[str] | file_name = None |
||
) |
Reimplemented from ContainerInterface
List[Dict[str, Any]] UM.Settings.DefinitionContainer.DefinitionContainer.deserializeMetadata | ( | cls, | |
str | serialized, | ||
str | container_id | ||
) |
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). |
Reimplemented from UM.Settings.Interfaces.ContainerInterface.
List[SettingDefinition] UM.Settings.DefinitionContainer.DefinitionContainer.findDefinitions | ( | self, | |
** | kwargs | ||
) |
Find definitions matching certain criteria.
kwargs | dict A dictionary of keyword arguments containing key-value pairs which should match properties of the definition. |
List[str] UM.Settings.DefinitionContainer.DefinitionContainer.getAllKeys | ( | self | ) |
Gets all keys of settings in this container.
Optional[str] UM.Settings.DefinitionContainer.DefinitionContainer.getConfigurationTypeFromSerialized | ( | cls, | |
str | serialized | ||
) |
Gets the configuration type of the given serialized data.
(used by __updateSerialized())
Reimplemented from UM.Settings.Interfaces.ContainerInterface.
str UM.Settings.DefinitionContainer.DefinitionContainer.getId | ( | self | ) |
Reimplemented from ContainerInterface
Reimplemented from UM.Settings.Interfaces.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
Reimplemented from UM.Settings.Interfaces.ContainerInterface.
def UM.Settings.DefinitionContainer.DefinitionContainer.getMetaDataEntry | ( | self, | |
entry, | |||
default = None |
|||
) |
Reimplemented from ContainerInterface
str UM.Settings.DefinitionContainer.DefinitionContainer.getName | ( | self | ) |
Reimplemented from ContainerInterface
Reimplemented from UM.Settings.Interfaces.ContainerInterface.
def UM.Settings.DefinitionContainer.DefinitionContainer.getPath | ( | self | ) |
Reimplemented from ContainerInterface
Reimplemented from UM.Settings.Interfaces.ContainerInterface.
def UM.Settings.DefinitionContainer.DefinitionContainer.getProperty | ( | self, | |
key, | |||
property_name, | |||
context = None |
|||
) |
Reimplemented from ContainerInterface.
Optional[int] UM.Settings.DefinitionContainer.DefinitionContainer.getVersionFromSerialized | ( | cls, | |
str | serialized | ||
) |
Gets the version of the given serialized data.
(used by __updateSerialized())
Reimplemented from UM.Settings.Interfaces.ContainerInterface.
def UM.Settings.DefinitionContainer.DefinitionContainer.hasProperty | ( | self, | |
key, | |||
property_name, | |||
bool | ignore_inherited = False |
||
) |
Reimplemented from ContainerInterface
bool UM.Settings.DefinitionContainer.DefinitionContainer.isReadOnly | ( | self | ) |
Reimplemented from ContainerInterface
def UM.Settings.DefinitionContainer.DefinitionContainer.serialize | ( | self, | |
Optional[set] | ignored_metadata_keys = None |
||
) |
TODO: This implementation flattens the definition container, since the data about inheritance and overrides was lost when deserialising.
Reimplemented from ContainerInterface
Reimplemented from UM.Settings.Interfaces.ContainerInterface.
def UM.Settings.DefinitionContainer.DefinitionContainer.setPath | ( | self, | |
path | |||
) |
Reimplemented from ContainerInterface