Model that provides a flattened list of the tree of SettingDefinition objects in a DefinitionContainer.
More...
Inherits QAbstractListModel.
|
def | __init__ (self, parent=None, args, kwargs) |
|
def | setShowAncestors (self, show_ancestors) |
|
def | showAncestors (self) |
|
def | setContainerId (self, container_id) |
| Set the containerId property. More...
|
|
def | containerId (self) |
|
def | setRootKey (self, key) |
| Set the rootKey property. More...
|
|
def | rootKey (self) |
|
def | setShowAll (self, show) |
| Set the showAll property. More...
|
|
def | showAll (self) |
|
def | setVisibilityHandler (self, visibility_handler) |
| Set the visibilityHandler property.
|
|
def | visibilityHandler (self) |
|
def | setExclude (self, exclude) |
| Set the exclude property.
|
|
def | exclude (self) |
|
def | setExpanded (self, expanded) |
| Set the expanded property.
|
|
def | expanded (self) |
|
def | visibleCount (self) |
|
def | categoryCount (self) |
|
def | setFilter (self, filter_dict) |
| Set the filter of this model based on a string. More...
|
|
def | filter (self) |
|
def | expand (self, key) |
| Show the children of a specified SettingDefinition. More...
|
|
def | expandRecursive (self, key) |
| Show the children of a specified SettingDefinition and all children of those settings as well. More...
|
|
def | collapse (self, key) |
| Hide the children of a specified SettingDefinition. More...
|
|
def | show (self, key) |
| Show a single SettingDefinition. More...
|
|
def | hide (self, key) |
| Hide a single SettingDefinition. More...
|
|
def | setAllExpandedVisible (self, visible) |
|
def | setAllVisible (self, visible) |
|
def | setVisible (self, key, visible) |
| Set a single SettingDefinition's visible state.
|
|
def | getVisible (self, key) |
|
def | getIndex (self, key) |
|
def | getRequires (self, key, role=None) |
|
def | getRequiredBy (self, key, role=None) |
|
def | rowCount (self, parent=None) |
|
def | data (self, index, role) |
| Reimplemented from QAbstractListModel.
|
|
def | roleNames (self) |
| Reimplemented from QAbstractListModel.
|
|
def | forceUpdate (self) |
| Force updating the model. More...
|
|
|
int | KeyRole = Qt.UserRole + 1 |
|
int | DepthRole = Qt.UserRole + 2 |
|
int | VisibleRole = Qt.UserRole + 3 |
|
int | ExpandedRole = Qt.UserRole + 4 |
|
| showAncestorsChanged = pyqtSignal() |
| Emitted whenever the showAncestors property changes. More...
|
|
| bool |
| Whether or not the model should show all definitions regardless of visibility. More...
|
|
| fset |
| An instance of SettingVisibilityHandler to use to determine which settings should be visible. More...
|
|
| setShowAncestors |
|
| notify |
|
| containerIdChanged = pyqtSignal() |
| Emitted whenever the containerId property changes. More...
|
|
| str |
| The ID of the DefinitionContainer object this model exposes. More...
|
|
| setContainerId |
|
| rootKeyChanged = pyqtSignal() |
| Emitted when the rootKey property changes. More...
|
|
| setRootKey |
|
| showAllChanged = pyqtSignal() |
| Emitted when the showAll property changes. More...
|
|
| setShowAll |
|
| visibilityChanged = pyqtSignal() |
|
| visibilityHandlerChanged = pyqtSignal() |
| Emitted whenever the visibilityHandler property changes.
|
|
| setVisibilityHandler |
|
| excludeChanged = pyqtSignal() |
| Emitted whenever the exclude property changes.
|
|
| setExclude |
|
| expandedChanged = pyqtSignal() |
| Emitted whenever the exclude property changes.
|
|
| setExpanded |
|
| visibleCountChanged = pyqtSignal() |
|
| int |
|
| filterChanged = pyqtSignal() |
|
| setFilter |
|
| result |
|
| QObject |
| Reimplemented from QAbstractListModel Note that rowCount() is overridden from QAbstractItemModel. More...
|
|
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.
◆ collapse()
def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.collapse |
( |
|
self, |
|
|
|
key |
|
) |
| |
Hide the children of a specified SettingDefinition.
◆ expand()
def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.expand |
( |
|
self, |
|
|
|
key |
|
) |
| |
Show the children of a specified SettingDefinition.
◆ expandRecursive()
def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.expandRecursive |
( |
|
self, |
|
|
|
key |
|
) |
| |
Show the children of a specified SettingDefinition and all children of those settings as well.
◆ forceUpdate()
def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.forceUpdate |
( |
|
self | ) |
|
Force updating the model.
◆ hide()
def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.hide |
( |
|
self, |
|
|
|
key |
|
) |
| |
Hide a single SettingDefinition.
◆ setContainerId()
def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.setContainerId |
( |
|
self, |
|
|
|
container_id |
|
) |
| |
Set the containerId property.
◆ setFilter()
def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.setFilter |
( |
|
self, |
|
|
|
filter_dict |
|
) |
| |
Set the filter of this model based on a string.
- Parameters
-
filter_dict | Dictionary to do the filtering by. |
◆ setRootKey()
def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.setRootKey |
( |
|
self, |
|
|
|
key |
|
) |
| |
Set the rootKey property.
◆ setShowAll()
def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.setShowAll |
( |
|
self, |
|
|
|
show |
|
) |
| |
Set the showAll property.
◆ show()
def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.show |
( |
|
self, |
|
|
|
key |
|
) |
| |
Show a single SettingDefinition.
◆ bool
UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.bool |
|
static |
Whether or not the model should show all definitions regardless of visibility.
◆ containerIdChanged
UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.containerIdChanged = pyqtSignal() |
|
static |
Emitted whenever the containerId property changes.
◆ fset
UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.fset |
|
static |
An instance of SettingVisibilityHandler to use to determine which settings should be visible.
This property indicates which settings should never be visibile.
◆ QObject
UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.QObject |
|
static |
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.
◆ rootKeyChanged
UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.rootKeyChanged = pyqtSignal() |
|
static |
Emitted when the rootKey property changes.
◆ showAllChanged
UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.showAllChanged = pyqtSignal() |
|
static |
Emitted when the showAll property changes.
◆ showAncestorsChanged
UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.showAncestorsChanged = pyqtSignal() |
|
static |
Emitted whenever the showAncestors property changes.
◆ str
UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.str |
|
static |
The ID of the DefinitionContainer object this model exposes.
Get a single SettingDefinition's visible state.
The SettingDefinition to use as root for the list.
The documentation for this class was generated from the following file:
- UM/Settings/Models/SettingDefinitionsModel.py