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 | setDestroyed |
|
def | setShowAncestors |
|
def | showAncestors (self) |
|
def | setContainerId |
| Set the containerId property. More...
|
|
def | containerId (self) |
| The ID of the DefinitionContainer object this model exposes. More...
|
|
def | setRootKey |
| Set the rootKey property. More...
|
|
def | rootKey (self) |
| The SettingDefinition to use as root for the list. More...
|
|
def | setShowAll |
| Set the showAll property. More...
|
|
def | showAll (self) |
| Whether or not the model should show all definitions regardless of visibility. More...
|
|
def | setVisibilityHandler (self, visibility_handler) |
| Set the visibilityHandler property.
|
|
def | visibilityHandler (self) |
| An instance of SettingVisibilityHandler to use to determine which settings should be visible. More...
|
|
def | setExclude (self, exclude) |
| Set the exclude property.
|
|
def | exclude (self) |
| This property indicates which settings should never be visibile. More...
|
|
def | setExpanded |
| Set the expanded property.
|
|
def | expanded (self) |
| This property indicates which settings should never be visibile. More...
|
|
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 |
| Show the children of a specified SettingDefinition and all children of those settings as well. More...
|
|
def | collapse |
|
def | collapseRecursive |
| Hide the children of a specified SettingDefinition and all children of those settings as well. More...
|
|
def | collapseAllCategories (self) |
|
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 | count (self) |
| Reimplemented from QAbstractListModel. More...
|
|
def | rowCount |
| This function is necessary because it is abstract in QAbstractListModel. More...
|
|
def | data (self, index, role) |
| Reimplemented from QAbstractListModel.
|
|
def | roleNames (self) |
| Reimplemented from QAbstractListModel.
|
|
def | forceUpdate (self) |
| Force updating the model. More...
|
|
def | onExpandedChanged (self) |
|
|
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 expanded property changes.
|
|
tuple | visibleCountChanged = pyqtSignal() |
|
tuple | filterChanged = pyqtSignal() |
|
tuple | itemsChanged = pyqtSignal() |
| Reimplemented from ListModel only because we want to use it in static context in the subclass. 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.
def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.collapseRecursive |
( |
|
self, |
|
|
|
key |
|
) |
| |
Hide the children of a specified SettingDefinition and all children of those settings as well.
def UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.containerId |
( |
|
self, |
|
|
|
str |
|
) |
| |
The ID of the DefinitionContainer object this model exposes.
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.
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, |
|
|
|
List, |
|
|
|
str |
|
) |
| |
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, |
|
|
|
None |
|
) |
| |
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 , |
|
|
|
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.
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_dict | Dictionary 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, |
|
|
|
bool |
|
) |
| |
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.
tuple UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.containerIdChanged = pyqtSignal() |
|
static |
Emitted whenever the containerId property changes.
tuple UM.Settings.Models.SettingDefinitionsModel.SettingDefinitionsModel.itemsChanged = pyqtSignal() |
|
static |
Reimplemented from ListModel only because we want to use it in static context in the subclass.
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:
- UM/Settings/Models/SettingDefinitionsModel.py