Uranium
Application Framework
|
A stack of setting containers to handle setting value retrieval. More...
Public Member Functions | |
def | __init__ (self, stack_id, args, kwargs) |
Constructor. More... | |
def | getId (self) |
def | getName (self) |
def | setName |
Set the name of this stack. More... | |
def | isReadOnly (self) |
def | setReadOnly (self, read_only) |
def | getMetaData (self) |
def | getMetaDataEntry (self, entry, default=None) |
def | addMetaDataEntry (self, key, value) |
def | setMetaDataEntry (self, key, value) |
def | removeMetaDataEntry (self, key) |
def | isDirty (self) |
def | setDirty |
def | getProperty |
def | getRawProperty (self, key, property_name, use_next=True, skip_until_container=None) |
Retrieve a property of a setting by key and property name. More... | |
def | hasProperty |
def | serialize (self) |
def | deserialize (self, serialized) |
def | getAllKeys (self) |
Get all keys known to this container stack. More... | |
def | getContainers (self) |
Get a list of all containers in this stack. More... | |
def | getContainerIndex |
def | getContainer |
Get a container by index. More... | |
def | getTop (self) |
Get the container at the top of the stack. More... | |
def | getBottom (self) |
Get the container at the bottom of the stack. More... | |
def | getPath (self) |
def | setPath (self, path) |
def | getSettingDefinition |
Get the SettingDefinition object for a specified key. | |
def | findContainer (self, criteria=None, container_type=None, kwargs) |
Find a container matching certain criteria. More... | |
def | addContainer (self, container) |
Add a container to the top of the stack. More... | |
def | insertContainer (self, index, container) |
Insert a container into the stack. More... | |
def | replaceContainer (self, index, container, postpone_emit=False) |
Replace a container in the stack. More... | |
def | removeContainer (self, index=0) |
Remove a container from the stack. More... | |
def | getNextStack (self) |
Get the next stack. More... | |
def | setNextStack (self, stack) |
Set the next stack. More... | |
def | sendPostponedEmits (self) |
Send postponed emits These emits are collected from the option postpone_emit. More... | |
def | hasErrors (self) |
Check if the container stack has errors. | |
def | getErrorKeys (self) |
Get all the keys that are in an error state in this stack. | |
![]() | |
def | __init__ (self) |
def | getPluginId (self) |
def | setPluginId (self, plugin_id) |
Static Public Attributes | |
int | Version = 3 |
nameChanged = Signal() | |
Emitted whenever the name of this stack changes. More... | |
containersChanged = Signal() | |
metaDataChanged = Signal() | |
propertyChanged = Signal(Signal.Queued) | |
propertiesChanged = Signal(Signal.Queued) | |
A stack of setting containers to handle setting value retrieval.
def UM.Settings.ContainerStack.ContainerStack.__init__ | ( | self, | |
stack_id, | |||
args, | |||
kwargs | |||
) |
Constructor.
stack_id | string A unique, machine readable/writable ID. |
def UM.Settings.ContainerStack.ContainerStack.addContainer | ( | self, | |
container | |||
) |
Add a container to the top of the stack.
container | The container to add to the stack. |
def UM.Settings.ContainerStack.ContainerStack.deserialize | ( | self, | |
serialized | |||
) |
Reimplemented from ContainerInterface
TODO: Expand documentation here, include the fact that this should not include all containers
def UM.Settings.ContainerStack.ContainerStack.findContainer | ( | self, | |
criteria = None , |
|||
container_type = None , |
|||
kwargs, | |||
Optional, | |||
ContainerInterface | |||
) |
Find a container matching certain criteria.
filter | dict A dictionary containing key and value pairs that need to match the container. Note that the value of "*" can be used as a wild card. This will ensure that any container that has the specified key in the meta data is found. |
container_type | class An optional type of container to filter on. |
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.
def UM.Settings.ContainerStack.ContainerStack.getBottom | ( | self, | |
ContainerInterface | |||
) |
Get the container at the bottom of the stack.
This is a convenience method that will always return the bottom of the stack.
def UM.Settings.ContainerStack.ContainerStack.getContainer | ( | self, | |
index | |||
) |
Get a container by index.
index | int The index of the container to get. |
IndexError | Raised when the specified index is out of bounds. |
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.
def UM.Settings.ContainerStack.ContainerStack.getId | ( | self, | |
str | |||
) |
Reimplemented from ContainerInterface
def UM.Settings.ContainerStack.ContainerStack.getMetaData | ( | self | ) |
Reimplemented from ContainerInterface
def UM.Settings.ContainerStack.ContainerStack.getMetaDataEntry | ( | self, | |
entry, | |||
default = None |
|||
) |
Reimplemented from ContainerInterface
def UM.Settings.ContainerStack.ContainerStack.getName | ( | self, | |
str | |||
) |
Reimplemented from ContainerInterface
def UM.Settings.ContainerStack.ContainerStack.getNextStack | ( | self | ) |
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.
def UM.Settings.ContainerStack.ContainerStack.getPath | ( | self | ) |
Reimplemented from ContainerInterface
def UM.Settings.ContainerStack.ContainerStack.getProperty | ( | self, | |
key | |||
) |
Reimplemented from ContainerInterface.
getProperty will start at the top of the stack and try to get the property specified. If that container returns no value, the next container on the stack will be tried and so on until the bottom of the stack is reached. If a next stack is defined for this stack it will then try to get the value from that stack. If no next stack is defined, None will be returned.
Note that if the property value is a function, this method will return the result of evaluating that property with the current stack. If you need the actual function, use getRawProperty()
def UM.Settings.ContainerStack.ContainerStack.getRawProperty | ( | self, | |
key, | |||
property_name, | |||
use_next = True , |
|||
skip_until_container = None |
|||
) |
Retrieve a property of a setting by key and property name.
This method does the same as getProperty() except it does not perform any special handling of the result, instead the raw stored value is returned.
key | The key to get the property value of. |
property_name | The name of the property to get the value of. |
use_next | True if the value should be retrieved from the next stack if not found in this stack. False if not. |
skip_until_container | A container ID to skip to. If set, it will be as if all containers above the specified container are empty. If the container is not in the stack, it'll try to find it in the next stack. |
def UM.Settings.ContainerStack.ContainerStack.getTop | ( | self, | |
ContainerInterface | |||
) |
Get the container at the top of the stack.
This is a convenience method that will always return the top of the stack.
def UM.Settings.ContainerStack.ContainerStack.hasProperty | ( | self, | |
key | |||
) |
Reimplemented from ContainerInterface.
hasProperty will check if any of the containers in the stack has the specified property. If it does, it stops and returns True. If it gets to the end of the stack, it returns False.
def UM.Settings.ContainerStack.ContainerStack.insertContainer | ( | self, | |
index, | |||
container | |||
) |
Insert a container into the stack.
index | int The index of to insert the container at. A negative index counts from the bottom |
container | The container to add to the stack. |
def UM.Settings.ContainerStack.ContainerStack.isReadOnly | ( | self | ) |
Reimplemented from ContainerInterface
def UM.Settings.ContainerStack.ContainerStack.removeContainer | ( | self, | |
index = 0 |
|||
) |
Remove a container from the stack.
index | int The index of the container to remove. |
IndexError | Raised when the specified index is out of bounds. |
def UM.Settings.ContainerStack.ContainerStack.replaceContainer | ( | self, | |
index, | |||
container, | |||
postpone_emit = False |
|||
) |
Replace a container in the stack.
index | int The index of the container to replace. |
container | The container to replace the existing entry with. |
postpone_emit | During stack manipulation you may want to emit later. |
IndexError | Raised when the specified index is out of bounds. |
Exception | when trying to replace container ContainerStack. |
def UM.Settings.ContainerStack.ContainerStack.sendPostponedEmits | ( | self | ) |
Send postponed emits These emits are collected from the option postpone_emit.
Note: the option can be implemented for all functions modifying the stack.
def UM.Settings.ContainerStack.ContainerStack.serialize | ( | self | ) |
Reimplemented from ContainerInterface
TODO: Expand documentation here, include the fact that this should not include all containers
def UM.Settings.ContainerStack.ContainerStack.setName | ( | self, | |
name | |||
) |
Set the name of this stack.
name | string The new name of the stack. |
def UM.Settings.ContainerStack.ContainerStack.setNextStack | ( | self, | |
stack | |||
) |
Set the next stack.
stack | ContainerStack The next stack to set. Can be None. Raises Exception when trying to set itself as next stack (to prevent infinite loops) |
def UM.Settings.ContainerStack.ContainerStack.setPath | ( | self, | |
path | |||
) |
Reimplemented from ContainerInterface
|
static |
Emitted whenever the name of this stack changes.