Uranium
Application Framework
 All Classes Namespaces Files Functions Variables Pages
UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel Class Reference

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

Inherits QAbstractListModel.

Public Member Functions

def __init__
 
def setDestroyed
 
def setShowAncestors
 
def showAncestors
 
def setContainerId
 Set the containerId property. More...
 
def containerId
 The ID of the DefinitionContainer object this model exposes. More...
 
def setRootKey
 Set the rootKey property. More...
 
def rootKey
 The SettingDefinition to use as root for the list. More...
 
def setShowAll
 Set the showAll property. More...
 
def showAll
 Whether or not the model should show all definitions regardless of visibility. More...
 
def setVisibilityHandler
 Set the visibilityHandler property.
 
def visibilityHandler
 An instance of SettingVisibilityHandler to use to determine which settings should be visible. More...
 
def setExclude
 Set the exclude property.
 
def exclude
 This property indicates which settings should never be visibile. More...
 
def setExpanded
 Set the expanded property.
 
def expanded
 This property indicates which settings should never be visibile. More...
 
def visibleCount
 
def categoryCount
 
def setFilter
 Set the filter of this model based on a string. More...
 
def filter
 
def expand
 Show the children of a specified SettingDefinition. More...
 
def expandRecursive
 Show the children of a specified SettingDefinition and all children of those settings as well. More...
 
def collapse
 Hide the children of a specified SettingDefinition. More...
 
def show
 Show a single SettingDefinition. More...
 
def hide
 Hide a single SettingDefinition. More...
 
def setAllExpandedVisible
 
def setAllVisible
 
def setVisible
 Set a single SettingDefinition's visible state.
 
def getVisible
 Get a single SettingDefinition's visible state.
 
def getIndex
 
def getRequires
 
def getRequiredBy
 
def rowCount
 Reimplemented from QAbstractListModel Note that rowCount() is overridden from QAbstractItemModel. More...
 
def data
 Reimplemented from QAbstractListModel.
 
def roleNames
 Reimplemented from QAbstractListModel.
 
def forceUpdate
 Force updating the model. More...
 

Static Public Attributes

int KeyRole = Qt.UserRole+1
 
int DepthRole = Qt.UserRole+2
 
int VisibleRole = Qt.UserRole+3
 
int ExpandedRole = Qt.UserRole+4
 
tuple showAncestorsChanged = pyqtSignal()
 Emitted whenever the showAncestors property changes. More...
 
tuple containerIdChanged = pyqtSignal()
 Emitted whenever the containerId property changes. More...
 
tuple rootKeyChanged = pyqtSignal()
 Emitted when the rootKey property changes. More...
 
tuple showAllChanged = pyqtSignal()
 Emitted when the showAll property changes. More...
 
tuple visibilityChanged = pyqtSignal()
 
tuple visibilityHandlerChanged = pyqtSignal()
 Emitted whenever the visibilityHandler property changes.
 
tuple excludeChanged = pyqtSignal()
 Emitted whenever the exclude property changes.
 
tuple expandedChanged = pyqtSignal()
 Emitted whenever the exclude property changes.
 
tuple visibleCountChanged = pyqtSignal()
 
tuple filterChanged = pyqtSignal()
 

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

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.collapse (   self,
  key 
)

Hide the children of a specified SettingDefinition.

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

The ID of the DefinitionContainer object this model exposes.

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.exclude (   self)

This property indicates which settings should never be visibile.

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.expand (   self,
  key 
)

Show the children of a specified SettingDefinition.

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.expanded (   self)

This property indicates which settings should never be visibile.

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.expandRecursive (   self,
  key 
)

Show the children of a specified SettingDefinition and all children of those settings as well.

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.forceUpdate (   self)

Force updating the model.

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.hide (   self,
  key 
)

Hide a single SettingDefinition.

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.rootKey (   self)

The SettingDefinition to use as root for the list.

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.rowCount (   self,
  parent = None 
)

Reimplemented from QAbstractListModel Note that rowCount() is overridden from QAbstractItemModel.

The signature of the method in that class is "int rowCount(const QModelIndex& parent)" which makes this slot declaration incorrect. TODO: fix the pointer when actually using this parameter.

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

Set the containerId property.

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.setFilter (   self,
  filter_dict 
)

Set the filter of this model based on a string.

Parameters
filter_dictDictionary to do the filtering by.
def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.setRootKey (   self,
  key 
)

Set the rootKey property.

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.setShowAll (   self,
  show 
)

Set the showAll property.

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.show (   self,
  key 
)

Show a single SettingDefinition.

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.showAll (   self)

Whether or not the model should show all definitions regardless of visibility.

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.visibilityHandler (   self)

An instance of SettingVisibilityHandler to use to determine which settings should be visible.

Member Data Documentation

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

Emitted whenever the containerId property changes.

tuple UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.rootKeyChanged = pyqtSignal()
static

Emitted when the rootKey property changes.

tuple UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.showAllChanged = pyqtSignal()
static

Emitted when the showAll property changes.

tuple UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.showAncestorsChanged = pyqtSignal()
static

Emitted whenever the showAncestors property changes.


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