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

This class provides the value and change notifications for the properties of a single setting. More...

Inherits QObject.

Public Member Functions

def __init__
 
def setContainerId (self, container_id)
 Set the containerId property. More...
 
def containerId (self)
 The ID of the container we should query for property values. More...
 
def setWatchedProperties (self, properties)
 Set the watchedProperties property. More...
 
def watchedProperties (self)
 A list of property names that should be watched for changes. More...
 
def setKey (self, key)
 Set the key property. More...
 
def key (self)
 The key of the setting that we should provide property values for. More...
 
def properties (self)
 
def setPropertyValue (self, property_name, property_value)
 Set the value of a property. More...
 

Static Public Attributes

tuple containerIdChanged = pyqtSignal()
 Emitted when the containerId property changes. More...
 
tuple watchedPropertiesChanged = pyqtSignal()
 Emitted when the watchedProperties property changes. More...
 
tuple keyChanged = pyqtSignal()
 Emitted when the key property changes. More...
 
tuple propertiesChanged = pyqtSignal()
 

Detailed Description

This class provides the value and change notifications for the properties of a single setting.

This class provides the property values through QObject dynamic properties so that they are available from QML.

Member Function Documentation

def UM.Settings.Models.ContainerPropertyProvider.ContainerPropertyProvider.containerId (   self)

The ID of the container we should query for property values.

def UM.Settings.Models.ContainerPropertyProvider.ContainerPropertyProvider.key (   self)

The key of the setting that we should provide property values for.

def UM.Settings.Models.ContainerPropertyProvider.ContainerPropertyProvider.setContainerId (   self,
  container_id 
)

Set the containerId property.

def UM.Settings.Models.ContainerPropertyProvider.ContainerPropertyProvider.setKey (   self,
  key 
)

Set the key property.

def UM.Settings.Models.ContainerPropertyProvider.ContainerPropertyProvider.setPropertyValue (   self,
  property_name,
  property_value 
)

Set the value of a property.

Parameters
property_nameThe name of the property to set.
property_valueThe value of the property to set.
def UM.Settings.Models.ContainerPropertyProvider.ContainerPropertyProvider.setWatchedProperties (   self,
  properties 
)

Set the watchedProperties property.

def UM.Settings.Models.ContainerPropertyProvider.ContainerPropertyProvider.watchedProperties (   self)

A list of property names that should be watched for changes.

Member Data Documentation

tuple UM.Settings.Models.ContainerPropertyProvider.ContainerPropertyProvider.containerIdChanged = pyqtSignal()
static

Emitted when the containerId property changes.

tuple UM.Settings.Models.ContainerPropertyProvider.ContainerPropertyProvider.keyChanged = pyqtSignal()
static

Emitted when the key property changes.

tuple UM.Settings.Models.ContainerPropertyProvider.ContainerPropertyProvider.watchedPropertiesChanged = pyqtSignal()
static

Emitted when the watchedProperties property changes.


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