Uranium
Application Framework
|
This class provides the value and change notifications for the properties of a single setting. More...
Inherits QObject.
Public Member Functions | |
None | __init__ (self, parent=None) |
None | setContainerStack (self, Optional[ContainerStack] stack) |
None | setContainerStackId (self, str stack_id) |
Set the containerStackId property. More... | |
str | containerStackId (self) |
Optional[ContainerInterface] | containerStack (self) |
None | setRemoveUnusedValue (self, bool remove_unused_value) |
bool | removeUnusedValue (self) |
None | setWatchedProperties (self, List[str] properties) |
Set the watchedProperties property. More... | |
List[str] | watchedProperties (self) |
None | setKey (self, str key) |
Set the key property. More... | |
def | key (self) |
def | properties (self) |
def | forcePropertiesChanged (self) |
def | setStoreIndex (self, index) |
def | storeIndex (self) |
def | stackLevels (self) |
def | setPropertyValue (self, property_name, property_value) |
Set the value of a property. More... | |
Any | getPropertyValue (self, str property_name, int stack_level) |
str | getPropertyValueAsString (self, str property_name) |
None | removeFromContainer (self, int index) |
bool | isValueUsed (self) |
Static Public Attributes | |
containerStackIdChanged = pyqtSignal() | |
Emitted when the containerStackId property changes. More... | |
str | |
The ID of the container stack we should query for property values. More... | |
fset | |
A list of property names that should be watched for changes. More... | |
setContainerStackId | |
notify | |
At what levels in the stack does the value(s) for this setting occur? | |
containerStackChanged = pyqtSignal() | |
QObject | |
setContainerStack | |
removeUnusedValueChanged = pyqtSignal() | |
bool | |
setRemoveUnusedValue | |
watchedPropertiesChanged = pyqtSignal() | |
Emitted when the watchedProperties property changes. More... | |
setWatchedProperties | |
keyChanged = pyqtSignal() | |
Emitted when the key property changes. More... | |
setKey | |
propertiesChanged = pyqtSignal() | |
QQmlPropertyMap | |
storeIndexChanged = pyqtSignal() | |
int | |
setStoreIndex | |
stackLevelChanged = pyqtSignal() | |
result | |
isValueUsedChanged = pyqtSignal() | |
This class provides the value and change notifications for the properties of a single setting.
Since setting values and other properties are provided by a stack, we need some way to query the stack from QML to provide us with those values. This class takes care of that.
This class provides the property values through QObject dynamic properties so that they are available from QML.
None UM.Settings.Models.SettingPropertyProvider.SettingPropertyProvider.setContainerStackId | ( | self, | |
str | stack_id | ||
) |
Set the containerStackId property.
None UM.Settings.Models.SettingPropertyProvider.SettingPropertyProvider.setKey | ( | self, | |
str | key | ||
) |
Set the key property.
def UM.Settings.Models.SettingPropertyProvider.SettingPropertyProvider.setPropertyValue | ( | self, | |
property_name, | |||
property_value | |||
) |
Set the value of a property.
stack_index | At which level in the stack should this property be set? |
property_name | The name of the property to set. |
property_value | The value of the property to set. |
None UM.Settings.Models.SettingPropertyProvider.SettingPropertyProvider.setWatchedProperties | ( | self, | |
List[str] | properties | ||
) |
Set the watchedProperties property.
|
static |
Emitted when the containerStackId property changes.
|
static |
A list of property names that should be watched for changes.
|
static |
Emitted when the key property changes.
|
static |
The ID of the container stack we should query for property values.
Manually request the value of a property.
The key of the setting that we should provide property values for.
The most notable difference with the properties is that you have more control over at what point in the stack you want the setting to be retrieved (instead of always taking the top one)
property_name | The name of the property to get the value from. |
stack_level | the index of the container to get the value from. |
|
static |
Emitted when the watchedProperties property changes.