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

Inherits QAbstractListModel.

Public Member Functions

def __init__ (self, parent=None, *args, **kwargs)
 
None setDestroyed (self, bool value)
 
None setShowAncestors (self, bool show_ancestors)
 
bool showAncestors (self)
 
None setContainerId (self, str container_id)
 
str containerId (self)
 
None setRootKey (self, str key)
 
def rootKey (self)
 
None setShowAll (self, bool show)
 
bool showAll (self)
 
def setVisibilityHandler (self, visibility_handler)
 
def visibilityHandler (self)
 
def setExclude (self, exclude)
 
def exclude (self)
 
None setExpanded (self, List[str] expanded)
 
List[str] expanded (self)
 
int visibleCount (self)
 
int categoryCount (self)
 
def setFilter (self, filter_dict)
 
def filter (self)
 
def expand (self, key)
 
None expandRecursive (self, str key)
 
None collapse (self, str key)
 
None collapseRecursive (self, str key)
 Hide the children of a specified SettingDefinition and all children of those settings as well. More...
 
None collapseAllCategories (self)
 
None show (self, str key)
 
None hide (self, str key)
 
None setAllExpandedVisible (self, bool visible)
 
None setAllVisible (self, bool visible)
 
None setVisible (self, str key, bool visible)
 
bool getVisible (self, str key)
 
int getIndex (self, str key)
 
def getRequires (self, key, role=None)
 
def getRequiredBy (self, key, role=None)
 
def count (self)
 
int rowCount (self, parent=None)
 
def data (self, index, role)
 
def roleNames (self)
 
None forceUpdate (self)
 
def onExpandedChanged (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

◆ collapseRecursive()

None UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.collapseRecursive (   self,
str  key 
)

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

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

◆ containerId()

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

◆ count()

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.count (   self)
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.

◆ expand()

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.expand (   self,
  key 
)
Show the children of a specified SettingDefinition.

◆ expanded()

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

◆ expandRecursive()

None UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.expandRecursive (   self,
str  key 
)
Show the children of a specified SettingDefinition and all children of those settings as well.

◆ forceUpdate()

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

◆ getVisible()

bool UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.getVisible (   self,
str  key 
)
Get a single SettingDefinition's visible state

◆ hide()

None UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.hide (   self,
str  key 
)
Hide a single SettingDefinition.

◆ roleNames()

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.roleNames (   self)
Reimplemented from QAbstractListModel

◆ rootKey()

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

◆ rowCount()

int UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.rowCount (   self,
  parent = None 
)
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.

◆ setContainerId()

None UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.setContainerId (   self,
str  container_id 
)
Set the containerId property.

◆ setExclude()

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.setExclude (   self,
  exclude 
)
Set the exclude property

◆ setExpanded()

None UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.setExpanded (   self,
List[str]  expanded 
)
Set the expanded property

◆ setFilter()

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.setFilter (   self,
  filter_dict 
)
Set the filter of this model based on a string.

:param filter_dict: Dictionary to do the filtering by.

◆ setRootKey()

None UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.setRootKey (   self,
str  key 
)
Set the rootKey property.

◆ setShowAll()

None UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.setShowAll (   self,
bool  show 
)
Set the showAll property.

◆ setVisibilityHandler()

def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.setVisibilityHandler (   self,
  visibility_handler 
)
Set the visibilityHandler property

◆ setVisible()

None UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.setVisible (   self,
str  key,
bool  visible 
)
Set a single SettingDefinition's visible state

◆ show()

None UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.show (   self,
str  key 
)
Show a single SettingDefinition.

◆ showAll()

bool UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.showAll (   self)
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: