KDescendantsProxyModel
#include <KDescendantsProxyModel>
Public Types | |
enum | AdditionalRoles { LevelRole = 0x14823F9A , ExpandableRole = 0x1CA894AD , ExpandedRole = 0x1E413DA4 , HasSiblingsRole = 0x1633CE0C } |
Public Types inherited from QAbstractItemModel | |
enum | CheckIndexOption |
enum | LayoutChangeHint |
Properties | |
QString | ancestorSeparator |
bool | displayAncestorData |
bool | expandsByDefault |
QAbstractItemModel * | model |
Properties inherited from QAbstractProxyModel | |
sourceModel | |
Properties inherited from QObject | |
objectName | |
Signals | |
void | ancestorSeparatorChanged () |
void | displayAncestorDataChanged () |
void | expandsByDefaultChanged (bool expands) |
void | sourceIndexCollapsed (const QModelIndex &sourceIndex) |
void | sourceIndexExpanded (const QModelIndex &sourceIndex) |
void | sourceModelChanged () |
Detailed Description
Proxy Model for restructuring a Tree into a list.
A KDescendantsProxyModel may be used to alter how the items in the tree are presented.
Given a model which is represented as a tree:
The KDescendantsProxyModel restructures the sourceModel to represent it as a flat list.
KDescendantEntitiesProxyModel can also display the ancestors of the index in the source model as part of its display.
- Since
- 4.6
Definition at line 60 of file kdescendantsproxymodel.h.
Member Enumeration Documentation
◆ AdditionalRoles
enum KDescendantsProxyModel::AdditionalRoles |
Definition at line 86 of file kdescendantsproxymodel.h.
Property Documentation
◆ ancestorSeparator
|
readwrite |
- Since
- 5.62
Definition at line 75 of file kdescendantsproxymodel.h.
◆ displayAncestorData
|
readwrite |
- Since
- 5.62
Definition at line 71 of file kdescendantsproxymodel.h.
◆ expandsByDefault
|
readwrite |
If true, all the nodes in the whole tree will be expanded upon loading and all items of the source model will be shown in the proxy.
The default value is true.
- Since
- 5.74
Definition at line 83 of file kdescendantsproxymodel.h.
◆ model
|
readwrite |
- Since
- 5.62
Definition at line 67 of file kdescendantsproxymodel.h.
Constructor & Destructor Documentation
◆ KDescendantsProxyModel()
Creates a new descendant entities proxy model.
- Parameters
-
parent The parent object.
Definition at line 200 of file kdescendantsproxymodel.cpp.
◆ ~KDescendantsProxyModel()
|
overridedefault |
Destroys the descendant entities proxy model.
Member Function Documentation
◆ ancestorSeparator()
QString KDescendantsProxyModel::ancestorSeparator | ( | ) | const |
Separator used between data of ancestors.
Definition at line 390 of file kdescendantsproxymodel.cpp.
◆ collapseSourceIndex()
void KDescendantsProxyModel::collapseSourceIndex | ( | const QModelIndex & | sourceIndex | ) |
Maps a source index as collapsed in the proxy, all its children will be hidden.
- Parameters
-
sourceIndex an idex of the source model.
- Since
- 5.74
Definition at line 287 of file kdescendantsproxymodel.cpp.
◆ columnCount()
|
overridevirtual |
Implements QAbstractItemModel.
Definition at line 634 of file kdescendantsproxymodel.cpp.
◆ data()
|
overridevirtual |
Reimplemented from QAbstractProxyModel.
Definition at line 643 of file kdescendantsproxymodel.cpp.
◆ displayAncestorData()
bool KDescendantsProxyModel::displayAncestorData | ( | ) | const |
Whether ancestor data will be displayed.
Definition at line 370 of file kdescendantsproxymodel.cpp.
◆ expandsByDefault()
bool KDescendantsProxyModel::expandsByDefault | ( | ) | const |
- Returns
- true if all the tree nodes are expanded by default upon loading
- Since
- 5.74
Definition at line 232 of file kdescendantsproxymodel.cpp.
◆ expandSourceIndex()
void KDescendantsProxyModel::expandSourceIndex | ( | const QModelIndex & | sourceIndex | ) |
Maps a source index as expanded in the proxy, all its children will become visible.
- Parameters
-
sourceIndex an idex of the source model.
- Since
- 5.74
Definition at line 267 of file kdescendantsproxymodel.cpp.
◆ flags()
|
overridevirtual |
Reimplemented from QAbstractProxyModel.
Definition at line 705 of file kdescendantsproxymodel.cpp.
◆ hasChildren()
|
overridevirtual |
Reimplemented from QAbstractProxyModel.
Definition at line 480 of file kdescendantsproxymodel.cpp.
◆ headerData()
|
overridevirtual |
Reimplemented from QAbstractProxyModel.
Definition at line 695 of file kdescendantsproxymodel.cpp.
◆ index()
|
overridevirtual |
Implements QAbstractItemModel.
Definition at line 499 of file kdescendantsproxymodel.cpp.
◆ isSourceIndexExpanded()
bool KDescendantsProxyModel::isSourceIndexExpanded | ( | const QModelIndex & | sourceIndex | ) | const |
- Returns
- true if the source index is mapped in the proxy as expanded, therefore it will show its children
- Since
- 5.74
Definition at line 237 of file kdescendantsproxymodel.cpp.
◆ isSourceIndexVisible()
bool KDescendantsProxyModel::isSourceIndexVisible | ( | const QModelIndex & | sourceIndex | ) | const |
- Returns
- true if the source index is visible in the proxy, meaning all its parent hierarchy is expanded.
- Since
- 5.74
Definition at line 249 of file kdescendantsproxymodel.cpp.
◆ mapFromSource()
|
overridevirtual |
Implements QAbstractProxyModel.
Definition at line 572 of file kdescendantsproxymodel.cpp.
◆ mapToSource()
|
overridevirtual |
Implements QAbstractProxyModel.
Definition at line 512 of file kdescendantsproxymodel.cpp.
◆ match()
|
overridevirtual |
Reimplemented to match all descendants.
Reimplemented from QAbstractItemModel.
Definition at line 347 of file kdescendantsproxymodel.cpp.
◆ mimeData()
|
overridevirtual |
Reimplemented from QAbstractProxyModel.
Definition at line 1312 of file kdescendantsproxymodel.cpp.
◆ mimeTypes()
|
overridevirtual |
Reimplemented from QAbstractProxyModel.
Definition at line 1325 of file kdescendantsproxymodel.cpp.
◆ parent()
|
overridevirtual |
Implements QAbstractItemModel.
Definition at line 474 of file kdescendantsproxymodel.cpp.
◆ roleNames()
|
overridevirtual |
Reimplemented from QAbstractProxyModel.
Definition at line 208 of file kdescendantsproxymodel.cpp.
◆ rowCount()
|
overridevirtual |
Implements QAbstractItemModel.
Definition at line 486 of file kdescendantsproxymodel.cpp.
◆ setAncestorSeparator()
Sets the ancestor separator
used between data of ancestors.
Definition at line 376 of file kdescendantsproxymodel.cpp.
◆ setDisplayAncestorData()
void KDescendantsProxyModel::setDisplayAncestorData | ( | bool | display | ) |
Set whether to show ancestor data in the model.
If display
is true, then a source model which is displayed as
will be displayed as
If display
is false, the proxy will show
Default is false.
Definition at line 358 of file kdescendantsproxymodel.cpp.
◆ setExpandsByDefault()
void KDescendantsProxyModel::setExpandsByDefault | ( | bool | expand | ) |
If true, all the nodes in the whole tree will be expanded upon loading (default)
- Parameters
-
expand whether we want everything expanded upon load
- Since
- 5.74
Definition at line 219 of file kdescendantsproxymodel.cpp.
◆ setSourceModel()
|
overridevirtual |
Sets the source model
of the proxy.
Reimplemented from QAbstractProxyModel.
Definition at line 396 of file kdescendantsproxymodel.cpp.
◆ supportedDropActions()
|
overridevirtual |
Reimplemented from QAbstractProxyModel.
Definition at line 1334 of file kdescendantsproxymodel.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:20:34 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.