Uranium
Application Framework
UM.Settings.Models.SettingPropertyProvider.SettingPropertyProvider Class Reference

Inherits QObject.

Public Member Functions

def __init__ (self, parent=None)
 
def setContainerStack
 
def setContainerStackId
 
def containerStackId (self)
 
def containerStack (self)
 
def setRemoveUnusedValue
 
def removeUnusedValue (self)
 
def setWatchedProperties
 
def watchedProperties (self)
 
def setKey
 
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)
 
def getPropertyValue
 
def getPropertyValueAsString
 
def removeFromContainer
 
def isValueUsed (self)
 

Static Public Attributes

 containerStackIdChanged = pyqtSignal()
 
 str
 
 fset
 
 setContainerStackId
 
 notify
 
 containerStackChanged = pyqtSignal()
 
 QObject
 
 setContainerStack
 
 removeUnusedValueChanged = pyqtSignal()
 
 bool
 
 setRemoveUnusedValue
 
 watchedPropertiesChanged = pyqtSignal()
 
 setWatchedProperties
 
 keyChanged = pyqtSignal()
 
 setKey
 
 propertiesChanged = pyqtSignal()
 
 QQmlPropertyMap
 
 storeIndexChanged = pyqtSignal()
 
 int
 
 setStoreIndex
 
 stackLevelChanged = pyqtSignal()
 
 result
 
 isValueUsedChanged = pyqtSignal()
 

Detailed Description

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.

Member Function Documentation

◆ containerStackId()

def UM.Settings.Models.SettingPropertyProvider.SettingPropertyProvider.containerStackId (   self,
  str 
)
The ID of the container stack we should query for property values.

◆ key()

def UM.Settings.Models.SettingPropertyProvider.SettingPropertyProvider.key (   self)
The key of the setting that we should provide property values for.

◆ setPropertyValue()

def UM.Settings.Models.SettingPropertyProvider.SettingPropertyProvider.setPropertyValue (   self,
  property_name,
  property_value 
)
Set the value of a property.

:param stack_index: At which level in the stack should this property be set?
:param property_name: The name of the property to set.
:param property_value: The value of the property to set.

◆ stackLevels()

def UM.Settings.Models.SettingPropertyProvider.SettingPropertyProvider.stackLevels (   self)
At what levels in the stack does the value(s) for this setting occur?

◆ watchedProperties()

def UM.Settings.Models.SettingPropertyProvider.SettingPropertyProvider.watchedProperties (   self,
  List,
  str 
)
A list of property names that should be watched for changes.

The documentation for this class was generated from the following file: