#include <kdescendantsproxymodel.h>

Inheritance diagram for KDescendantsProxyModel:

Public Member Functions
	KDescendantsProxyModel (QObject *parent=0)

virtual	~KDescendantsProxyModel ()

QString	ancestorSeparator () const

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

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

int	descendantCount (const QModelIndex &index) const

bool	displayAncestorData () const

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

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

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

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

QModelIndex	mapFromSource (const QModelIndex &sourceIndex) const

QModelIndex	mapToSource (const QModelIndex &proxyIndex) const

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

virtual QMimeData *	mimeData (const QModelIndexList &indexes) const

virtual QStringList	mimeTypes () const

virtual QModelIndex	parent (const QModelIndex &) const

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

void	setAncestorSeparator (const QString &separator)

void	setDisplayAncestorData (bool display)

void	setRootIndex (const QModelIndex &index)

virtual void	setSourceModel (QAbstractItemModel *model)

virtual Qt::DropActions	supportedDropActions () const

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

	~QAbstractProxyModel ()

virtual QModelIndex	buddy (const QModelIndex &index) const

virtual bool	canFetchMore (const QModelIndex &parent) const

virtual void	fetchMore (const QModelIndex &parent)

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

virtual QModelIndex	mapFromSource (const QModelIndex &sourceIndex) const =0

virtual QItemSelection	mapSelectionFromSource (const QItemSelection &sourceSelection) const

virtual QItemSelection	mapSelectionToSource (const QItemSelection &proxySelection) const

virtual QModelIndex	mapToSource (const QModelIndex &proxyIndex) const =0

virtual void	revert ()

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

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

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

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

QAbstractItemModel *	sourceModel () const

virtual QSize	span (const QModelIndex &index) const

virtual bool	submit ()

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

virtual	~QAbstractItemModel ()

virtual int	columnCount (const QModelIndex &parent) const =0

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

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

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

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

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

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

virtual QVariant	data (const QModelIndex &index, int role) const =0

void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight)

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

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

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

virtual QModelIndex	index (int row, int column, const QModelIndex &parent) const =0

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

void	layoutChanged ()

virtual QModelIndexList	match (const QModelIndex &start, int role, const QVariant &value, int hits, QFlags< Qt::MatchFlag > flags) const

void	modelAboutToBeReset ()

void	modelReset ()

virtual QModelIndex	parent (const QModelIndex &index) const =0

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)

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

virtual int	rowCount (const QModelIndex &parent) const =0

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 start, int end)

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

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

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

void	setSupportedDragActions (QFlags< Qt::DropAction > actions)

QModelIndex	sibling (int row, int column, const QModelIndex &index) const

Qt::DropActions	supportedDragActions () const

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

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

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

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

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

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

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

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

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

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

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)

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

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

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, void *ptr) const

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

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

void	endInsertColumns ()

void	endInsertRows ()

void	endMoveColumns ()

void	endMoveRows ()

void	endRemoveColumns ()

void	endRemoveRows ()

void	endResetModel ()

QModelIndexList	persistentIndexList () const

void	reset ()

void	resetInternalData ()

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

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QObject
	objectName

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->setDisplayAncestorSeparator(QString(" / "));
view->setModel(descProxy);

A KDescendantsProxyModel with ancestor names.

Since: 4.6

Author: Stephen Kelly steve.nosp@m.ire@.nosp@m.gmail.nosp@m..com

Definition at line 70 of file kdescendantsproxymodel.h.

Constructor & Destructor Documentation

KDescendantsProxyModel::KDescendantsProxyModel ( QObject * parent = 0 )

explicit

Creates a new descendant entities proxy model.

Parameters

parent The parent object.

Definition at line 213 of file kdescendantsproxymodel.cpp.

KDescendantsProxyModel::~KDescendantsProxyModel ( )

virtual

Destroys the descendant entities proxy model.

Definition at line 218 of file kdescendantsproxymodel.cpp.

Member Function Documentation

QString KDescendantsProxyModel::ancestorSeparator ( ) const

Separator used between data of ancestors.

Definition at line 251 of file kdescendantsproxymodel.cpp.

int KDescendantsProxyModel::columnCount ( const QModelIndex & index = QModelIndex() ) const

virtual

Definition at line 481 of file kdescendantsproxymodel.cpp.

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

virtual

Reimplemented from QAbstractProxyModel.

Definition at line 489 of file kdescendantsproxymodel.cpp.

int KDescendantsProxyModel::descendantCount ( const QModelIndex & index ) const

Returns the number of descendant entries for the given model index.

bool KDescendantsProxyModel::displayAncestorData ( ) const

Whether ancestor data will be displayed.

Definition at line 239 of file kdescendantsproxymodel.cpp.

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

virtual

Reimplemented from QAbstractProxyModel.

Definition at line 529 of file kdescendantsproxymodel.cpp.

bool KDescendantsProxyModel::hasChildren ( const QModelIndex & parent = QModelIndex() ) const

virtual

Reimplemented from QAbstractProxyModel.

Definition at line 327 of file kdescendantsproxymodel.cpp.

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

virtual

Reimplemented from QAbstractProxyModel.

Definition at line 521 of file kdescendantsproxymodel.cpp.

QModelIndex KDescendantsProxyModel::index	(	int	row,
		int	column,
		const QModelIndex &	parent = `QModelIndex()`
	)		const

virtual

Definition at line 347 of file kdescendantsproxymodel.cpp.

QModelIndex KDescendantsProxyModel::mapFromSource ( const QModelIndex & sourceIndex ) const

Definition at line 419 of file kdescendantsproxymodel.cpp.

QModelIndex KDescendantsProxyModel::mapToSource ( const QModelIndex & proxyIndex ) const

Definition at line 358 of file kdescendantsproxymodel.cpp.

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

virtual

Reimplemented to match all descendants.

Definition at line 228 of file kdescendantsproxymodel.cpp.

QMimeData * KDescendantsProxyModel::mimeData ( const QModelIndexList & indexes ) const

virtual

Reimplemented from QAbstractProxyModel.

Definition at line 981 of file kdescendantsproxymodel.cpp.

QStringList KDescendantsProxyModel::mimeTypes ( ) const

virtual

Reimplemented from QAbstractProxyModel.

Definition at line 992 of file kdescendantsproxymodel.cpp.

QModelIndex KDescendantsProxyModel::parent ( const QModelIndex & index ) const

virtual

Definition at line 321 of file kdescendantsproxymodel.cpp.

int KDescendantsProxyModel::rowCount ( const QModelIndex & parent = QModelIndex() ) const

virtual

Definition at line 333 of file kdescendantsproxymodel.cpp.

void KDescendantsProxyModel::setAncestorSeparator ( const QString & separator )

Sets the ancestor separator used between data of ancestors.

Definition at line 245 of file kdescendantsproxymodel.cpp.

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 233 of file kdescendantsproxymodel.cpp.

void KDescendantsProxyModel::setRootIndex ( const QModelIndex & index )

Deprecated:

This method does nothing.

Definition at line 223 of file kdescendantsproxymodel.cpp.

void KDescendantsProxyModel::setSourceModel ( QAbstractItemModel * model )

virtual

Sets the source model of the proxy.

Reimplemented from QAbstractProxyModel.

Definition at line 258 of file kdescendantsproxymodel.cpp.

Qt::DropActions KDescendantsProxyModel::supportedDropActions ( ) const

virtual

Reimplemented from QAbstractProxyModel.

Definition at line 1000 of file kdescendantsproxymodel.cpp.

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

KDEUI

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

KDEUI

kdelibs API Reference

Search