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

Inherits QAbstractListModel.

Public Member Functions

def __init__ (self, parent=None, args, kwargs)
 
def setDestroyed
 
def setShowAncestors
 
def showAncestors (self)
 
def setContainerId
 
def containerId (self)
 
def setRootKey
 
def rootKey (self)
 
def setShowAll
 
def showAll (self)
 
def setVisibilityHandler
 
def visibilityHandler (self)
 
def setExclude
 
def exclude (self)
 
def setExpanded
 
def expanded (self)
 
def visibleCount (self)
 
def categoryCount (self)
 
def setFilter
 
def filter (self)
 
def expand
 
def expandRecursive
 
def collapse
 
def collapseRecursive
 
def collapseAllCategories (self)
 
def show
 
def hide
 
def setAllExpandedVisible
 
def setAllVisible
 
def setVisible
 
def getVisible
 
def getIndex
 
def getRequires
 
def getRequiredBy
 
def count (self)
 
def rowCount (self, parent=None)
 
def data (self, index, role)
 
def roleNames (self)
 
def forceUpdate (self)
 

Static Public Attributes

int KeyRole = Qt.UserRole + 1
 
int DepthRole = Qt.UserRole + 2
 
int VisibleRole = Qt.UserRole + 3
 
int ExpandedRole = Qt.UserRole + 4
 
 showAncestorsChanged = pyqtSignal()
 
 bool
 
 fset
 
 setShowAncestors
 
 notify
 
 containerIdChanged = pyqtSignal()
 
 str
 
 setContainerId
 
 rootKeyChanged = pyqtSignal()
 
 setRootKey
 
 showAllChanged = pyqtSignal()
 
 setShowAll
 
 visibilityChanged = pyqtSignal()
 
 visibilityHandlerChanged = pyqtSignal()
 
 setVisibilityHandler
 
 excludeChanged = pyqtSignal()
 
 setExclude
 
 expandedChanged = pyqtSignal()
 
 setExpanded
 
 visibleCountChanged = pyqtSignal()
 
 int
 
 filterChanged = pyqtSignal()
 
 setFilter
 
 result
 
 itemsChanged = pyqtSignal()
 
 QObject
 

Detailed Description

Model that provides a flattened list of the tree of SettingDefinition objects in a DefinitionContainer

This model exposes the tree of SettingDefinition objects in a DefinitionContainer as a list of settings.
It uses two lists, one is the list of definitions which directly corresponds with the flattened contents
of the DefinitionContainer. The other is a list matching rows in the model to indexes in the list of
settings. This list can be quite a bit shorter than the list of definitions since all visibility criteria
are applied.

Member Function Documentation

◆ containerId()

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.containerId (   self,
  Optional,
  str 
)
The ID of the DefinitionContainer object this model exposes.

◆ count()

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.count (   self,
  int 
)
Reimplemented from QAbstractListModel

Note that count() is overridden from QAbstractItemModel. The signature
of the method in that class is "int count()" which makes this slot
declaration incorrect.
TODO: fix the pointer when actually using this parameter.

◆ data()

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.data (   self,
  index,
  role 
)
Reimplemented from QAbstractListModel

◆ exclude()

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.exclude (   self)
This property indicates which settings should never be visibile.

◆ expanded()

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.expanded (   self,
  List,
  str 
)
This property indicates which settings should never be visibile.

◆ forceUpdate()

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.forceUpdate (   self,
  None 
)
Force updating the model.

◆ roleNames()

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.roleNames (   self,
  Dict,
  int,
  bytes 
)
Reimplemented from QAbstractListModel

◆ rootKey()

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.rootKey (   self,
  str 
)
The SettingDefinition to use as root for the list.

◆ rowCount()

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.rowCount (   self,
  parent = None,
  int 
)
This function is necessary because it is abstract in QAbstractListModel.

Under the hood, Qt will call this function when it needs to know how many items are in the model.
This pyqtSlot will not be linked to the itemsChanged signal, so please use the normal count() function instead.

◆ showAll()

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.showAll (   self,
  bool 
)
Whether or not the model should show all definitions regardless of visibility.

◆ visibilityHandler()

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.visibilityHandler (   self)
An instance of SettingVisibilityHandler to use to determine which settings should be visible.

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