KDescendantsProxyModel

#include <KDescendantsProxyModel>

Inheritance diagram for KDescendantsProxyModel:

[legend]

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 ()

Public Member Functions
	KDescendantsProxyModel (QObject *parent=nullptr)

	~KDescendantsProxyModel () override

QString	ancestorSeparator () const

void	collapseSourceIndex (const QModelIndex &sourceIndex)

int	columnCount (const QModelIndex &index=QModelIndex()) const override

QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override

bool	displayAncestorData () const

bool	expandsByDefault () const

void	expandSourceIndex (const QModelIndex &sourceIndex)

Qt::ItemFlags	flags (const QModelIndex &index) const override

bool	hasChildren (const QModelIndex &parent=QModelIndex()) const override

QVariant	headerData (int section, Qt::Orientation orientation, int role) const override

QModelIndex	index (int, int, const QModelIndex &parent=QModelIndex()) const override

bool	isSourceIndexExpanded (const QModelIndex &sourceIndex) const

bool	isSourceIndexVisible (const QModelIndex &sourceIndex) const

QModelIndex	mapFromSource (const QModelIndex &sourceIndex) const override

QModelIndex	mapToSource (const QModelIndex &proxyIndex) const override

virtual QModelIndexList	match (const QModelIndex &start, int role, const QVariant &value, int hits=1, Qt::MatchFlags flags=Qt::MatchFlags(Qt::MatchStartsWith\|Qt::MatchWrap)) const override

QMimeData *	mimeData (const QModelIndexList &indexes) const override

QStringList	mimeTypes () const override

QModelIndex	parent (const QModelIndex &) const override

QHash< int, QByteArray >	roleNames () const override

int	rowCount (const QModelIndex &parent=QModelIndex()) const override

void	setAncestorSeparator (const QString &separator)

void	setDisplayAncestorData (bool display)

void	setExpandsByDefault (bool expand)

void	setRootIndex (const QModelIndex &index)

void	setSourceModel (QAbstractItemModel *model) override

Qt::DropActions	supportedDropActions () const override

Public Member Functions inherited from QAbstractProxyModel
	QAbstractProxyModel (QObject *parent)

virtual QModelIndex	buddy (const QModelIndex &index) const const override

virtual bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const const override

virtual bool	canFetchMore (const QModelIndex &parent) const const override

virtual bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override

virtual void	fetchMore (const QModelIndex &parent) override

virtual QMap< int, QVariant >	itemData (const QModelIndex &proxyIndex) const const override

virtual QItemSelection	mapSelectionFromSource (const QItemSelection &sourceSelection) const const

virtual QItemSelection	mapSelectionToSource (const QItemSelection &proxySelection) const const

virtual void	revert () override

virtual bool	setData (const QModelIndex &index, const QVariant &value, int role) override

virtual bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role) override

virtual bool	setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles) override

virtual QModelIndex	sibling (int row, int column, const QModelIndex &idx) const const override

virtual void	sort (int column, Qt::SortOrder order) override

QAbstractItemModel *	sourceModel () const const

void	sourceModelChanged ()

virtual QSize	span (const QModelIndex &index) const const override

virtual bool	submit () override

virtual Qt::DropActions	supportedDragActions () const const override

Public Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QObject *parent)

bool	checkIndex (const QModelIndex &index, QAbstractItemModel::CheckIndexOptions options) const const

void	columnsAboutToBeInserted (const QModelIndex &parent, int first, int last)

void	columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)

void	columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	columnsInserted (const QModelIndex &parent, int first, int last)

void	columnsMoved (const QModelIndex &parent, int start, int end, const QModelIndex &destination, int column)

void	columnsRemoved (const QModelIndex &parent, int first, int last)

void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector< int > &roles)

bool	hasIndex (int row, int column, const QModelIndex &parent) const const

void	headerDataChanged (Qt::Orientation orientation, int first, int last)

bool	insertColumn (int column, const QModelIndex &parent)

virtual bool	insertColumns (int column, int count, const QModelIndex &parent)

bool	insertRow (int row, const QModelIndex &parent)

virtual bool	insertRows (int row, int count, const QModelIndex &parent)

void	layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)

void	layoutChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)

void	modelAboutToBeReset ()

void	modelReset ()

bool	moveColumn (const QModelIndex &sourceParent, int sourceColumn, const QModelIndex &destinationParent, int destinationChild)

virtual bool	moveColumns (const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destinationParent, int destinationChild)

bool	moveRow (const QModelIndex &sourceParent, int sourceRow, const QModelIndex &destinationParent, int destinationChild)

virtual bool	moveRows (const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild)

bool	removeColumn (int column, const QModelIndex &parent)

virtual bool	removeColumns (int column, int count, const QModelIndex &parent)

bool	removeRow (int row, const QModelIndex &parent)

virtual bool	removeRows (int row, int count, const QModelIndex &parent)

void	rowsAboutToBeInserted (const QModelIndex &parent, int start, int end)

void	rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)

void	rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	rowsInserted (const QModelIndex &parent, int first, int last)

void	rowsMoved (const QModelIndex &parent, int start, int end, const QModelIndex &destination, int row)

void	rowsRemoved (const QModelIndex &parent, int first, int last)

void	setSupportedDragActions (Qt::DropActions actions)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo ()

void	dumpObjectInfo () const const

void	dumpObjectTree ()

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

QThread *	thread () const const

Additional Inherited Members
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QAbstractItemModel
typedef	CheckIndexOptions

	DoNotUseParent

	HorizontalSortHint

	IndexIsValid

	NoLayoutChangeHint

	NoOption

	ParentIsInvalid

	VerticalSortHint

Public Attributes inherited from QObject
typedef	QObjectList

Protected Member Functions inherited from QAbstractProxyModel
void	resetInternalData ()

Protected Member Functions inherited from QAbstractItemModel
void	beginInsertColumns (const QModelIndex &parent, int first, int last)

void	beginInsertRows (const QModelIndex &parent, int first, int last)

bool	beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

bool	beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

void	beginRemoveColumns (const QModelIndex &parent, int first, int last)

void	beginRemoveRows (const QModelIndex &parent, int first, int last)

void	beginResetModel ()

void	changePersistentIndex (const QModelIndex &from, const QModelIndex &to)

void	changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)

QModelIndex	createIndex (int row, int column, quintptr id) const const

QModelIndex	createIndex (int row, int column, void *ptr) const const

void	endInsertColumns ()

void	endInsertRows ()

void	endMoveColumns ()

void	endMoveRows ()

void	endRemoveColumns ()

void	endRemoveRows ()

void	endResetModel ()

QModelIndexList	persistentIndexList () const const

void	reset ()

void	resetInternalData ()

void	setRoleNames (const QHash< int, QByteArray > &roleNames)

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

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:

A plain EntityTreeModel in a view

The KDescendantsProxyModel restructures the sourceModel to represent it as a flat list.

// ... Create an entityTreeModel
KDescendantsProxyModel *descProxy = new KDescendantsProxyModel(this);
descProxy->setSourceModel(entityTree);
view->setModel(descProxy);

A KDescendantsProxyModel.

KDescendantEntitiesProxyModel can also display the ancestors of the index in the source model as part of its display.

// ... Create an entityTreeModel
KDescendantsProxyModel *descProxy = new KDescendantsProxyModel(this);
descProxy->setSourceModel(entityTree);
 
// #### This is new
descProxy->setDisplayAncestorData(true);
descProxy->setAncestorSeparator(QString(" / "));
 
view->setModel(descProxy);

A KDescendantsProxyModel with ancestor names.

Since: 4.6

Author: Stephen Kelly steve[email protected][email protected][email protected]gmail[email protected].com

Definition at line 60 of file kdescendantsproxymodel.h.

Property Documentation

◆ ancestorSeparator

QString KDescendantsProxyModel::ancestorSeparator

readwrite

Since: 5.62

Definition at line 75 of file kdescendantsproxymodel.h.

◆ displayAncestorData

bool KDescendantsProxyModel::displayAncestorData

readwrite

Since: 5.62

Definition at line 71 of file kdescendantsproxymodel.h.

◆ expandsByDefault

bool KDescendantsProxyModel::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

QAbstractItemModel KDescendantsProxyModel::model

readwrite

Since: 5.62

Definition at line 67 of file kdescendantsproxymodel.h.

Constructor & Destructor Documentation

◆ KDescendantsProxyModel()

KDescendantsProxyModel::KDescendantsProxyModel ( QObject * parent = nullptr )

explicit

Creates a new descendant entities proxy model.

Parameters

parent The parent object.

Definition at line 200 of file kdescendantsproxymodel.cpp.

◆ ~KDescendantsProxyModel()

KDescendantsProxyModel::~KDescendantsProxyModel ( )

overridedefault

Destroys the descendant entities proxy model.

Member Function Documentation

◆ ancestorSeparator()

QString KDescendantsProxyModel::ancestorSeparator ( ) const

Separator used between data of ancestors.

◆ 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.

◆ displayAncestorData()

bool KDescendantsProxyModel::displayAncestorData ( ) const

Whether ancestor data will be displayed.

◆ expandsByDefault()

bool KDescendantsProxyModel::expandsByDefault ( ) const

Returns: true if all the tree nodes are expanded by default upon loading

Since: 5.74

◆ 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.

◆ 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.

◆ match()

QModelIndexList KDescendantsProxyModel::match	(	const QModelIndex &	start,
		int	role,
		const QVariant &	value,
		int	hits = `1`,
		Qt::MatchFlags	flags = `Qt::MatchFlags(Qt::MatchStartsWith \| Qt::MatchWrap)`
	)		const

overridevirtual

Reimplemented to match all descendants.

Reimplemented from QAbstractItemModel.

Definition at line 354 of file kdescendantsproxymodel.cpp.

◆ setAncestorSeparator()

void KDescendantsProxyModel::setAncestorSeparator ( const QString & separator )

Sets the ancestor separator used between data of ancestors.

Definition at line 383 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

-> "Item 0-0" (this is row-depth)
-> -> "Item 0-1"
-> -> "Item 1-1"
-> -> -> "Item 0-2"
-> -> -> "Item 1-2"
-> "Item 1-0"

will be displayed as

-> *Item 0-0"
-> "Item 0-0 / Item 0-1"
-> "Item 0-0 / Item 1-1"
-> "Item 0-0 / Item 1-1 / Item 0-2"
-> "Item 0-0 / Item 1-1 / Item 1-2"
-> "Item 1-0"

If display is false, the proxy will show

-> *Item 0-0"
-> "Item 0-1"
-> "Item 1-1"
-> "Item 0-2"
-> "Item 1-2"
-> "Item 1-0"

Default is false.

Definition at line 365 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.

◆ setRootIndex()

void KDescendantsProxyModel::setRootIndex ( const QModelIndex & index )

Deprecated:: Since 4.8

This method does nothing.

Definition at line 348 of file kdescendantsproxymodel.cpp.

◆ setSourceModel()

void KDescendantsProxyModel::setSourceModel ( QAbstractItemModel * model )

overridevirtual

Sets the source model of the proxy.

Reimplemented from QAbstractProxyModel.

Definition at line 403 of file kdescendantsproxymodel.cpp.

The documentation for this class was generated from the following files:

Item

KDescendantsProxyModel::setDisplayAncestorData

void setDisplayAncestorData(bool display)

Set whether to show ancestor data in the model.

Definition: kdescendantsproxymodel.cpp:365

KDescendantsProxyModel::setSourceModel

void setSourceModel(QAbstractItemModel *model) override

Sets the source model of the proxy.

Definition: kdescendantsproxymodel.cpp:403

QString

KDescendantsProxyModel

Proxy Model for restructuring a Tree into a list.

Definition: kdescendantsproxymodel.h:60

KDescendantsProxyModel::setAncestorSeparator

void setAncestorSeparator(const QString &separator)

Sets the ancestor separator used between data of ancestors.

Definition: kdescendantsproxymodel.cpp:383

KDescendantsProxyModel::KDescendantsProxyModel

KDescendantsProxyModel(QObject *parent=nullptr)

Creates a new descendant entities proxy model.

Definition: kdescendantsproxymodel.cpp:200

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KItemModels

KDescendantsProxyModel

Public Types

Properties

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Property Documentation

◆ ancestorSeparator

◆ displayAncestorData

◆ expandsByDefault

◆ model

Constructor & Destructor Documentation

◆ KDescendantsProxyModel()

◆ ~KDescendantsProxyModel()

Member Function Documentation

◆ ancestorSeparator()

◆ collapseSourceIndex()

◆ displayAncestorData()

◆ expandsByDefault()

◆ expandSourceIndex()

◆ isSourceIndexExpanded()

◆ isSourceIndexVisible()

◆ match()

◆ setAncestorSeparator()

◆ setDisplayAncestorData()

◆ setExpandsByDefault()

◆ setRootIndex()

◆ setSourceModel()