Uranium
Application Framework
|
Model that provides a flattened list of the tree of SettingDefinition objects in a DefinitionContainer. More...
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) |
Set the containerId property. | |
str | containerId (self) |
None | setRootKey (self, str key) |
Set the rootKey property. | |
def | rootKey (self) |
None | setShowAll (self, bool show) |
Set the showAll property. | |
bool | 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) |
None | setExpanded (self, List[str] expanded) |
Set the expanded property. | |
List[str] | expanded (self) |
int | visibleCount (self) |
int | 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. | |
None | expandRecursive (self, str key) |
Show the children of a specified SettingDefinition and all children of those settings as well. | |
None | collapse (self, str key) |
Hide the children of a specified SettingDefinition. | |
None | show (self, str key) |
Show a single SettingDefinition. | |
None | hide (self, str key) |
Hide a single SettingDefinition. | |
None | setAllExpandedVisible (self, bool visible) |
None | setAllVisible (self, bool visible) |
None | setVisible (self, str key, bool visible) |
Set a single SettingDefinition's visible state. | |
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) |
Reimplemented from QAbstractListModel. | |
def | roleNames (self) |
Reimplemented from QAbstractListModel. | |
None | forceUpdate (self) |
Force updating the model. | |
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() | |
Emitted whenever the showAncestors property changes. | |
bool | |
Whether or not the model should show all definitions regardless of visibility. | |
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. | |
str | |
The ID of the DefinitionContainer object this model exposes. More... | |
setContainerId | |
rootKeyChanged = pyqtSignal() | |
Emitted when the rootKey property changes. | |
setRootKey | |
showAllChanged = pyqtSignal() | |
Emitted when the showAll property changes. | |
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 | |
Reimplemented from QAbstractListModel. More... | |
filterChanged = pyqtSignal() | |
setFilter | |
result | |
itemsChanged = pyqtSignal() | |
Reimplemented from ListModel only because we want to use it in static context in the subclass. | |
QObject | |
This function is necessary because it is abstract in QAbstractListModel. 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.setFilter | ( | self, | |
filter_dict | |||
) |
Set the filter of this model based on a string.
filter_dict | Dictionary to do the filtering by. |
|
static |
An instance of SettingVisibilityHandler to use to determine which settings should be visible.
This property indicates which settings should never be visibile.
|
static |
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.
|
static |
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.
|
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.