A tree model for QObject* items, usable from both C++ and QML. More...

#include <QmlObjectTreeModel.h>

Inheritance diagram for QmlObjectTreeModel:

Collaboration diagram for QmlObjectTreeModel:

Public Member Functions
	QmlObjectTreeModel (QObject *parent=nullptr)

	~QmlObjectTreeModel () override

int	count () const override

void	setDirty (bool dirty) override

void	clear () override

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

QModelIndex	parent (const QModelIndex &child) const override

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

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

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

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

bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override

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

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

QHash< int, QByteArray >	roleNames () const override

Q_INVOKABLE QObject *	getObject (const QModelIndex &index) const
	Returns the QObject* stored at `index`, or nullptr if invalid.

Q_INVOKABLE QModelIndex	appendItem (QObject *object, const QModelIndex &parentIndex=QModelIndex())
	Appends `object` as the last child of `parentIndex` (root if invalid). Returns the new item's index.

Q_INVOKABLE QModelIndex	appendItem (QObject *object, const QModelIndex &parentIndex, const QString &nodeType)
	Same as above but also sets a nodeType tag on the created tree node.

Q_INVOKABLE QModelIndex	insertItem (int row, QObject *object, const QModelIndex &parentIndex=QModelIndex())
	Inserts `object` at `row` under `parentIndex`. Returns the new item's index.

Q_INVOKABLE QModelIndex	insertItem (int row, QObject *object, const QModelIndex &parentIndex, const QString &nodeType)
	Same as above but also sets a nodeType tag on the created tree node.

Q_INVOKABLE QObject *	removeItem (const QModelIndex &index)

Q_INVOKABLE int	childCount (const QModelIndex &parentIndex=QModelIndex()) const
	Number of direct children under `parentIndex`.

Q_INVOKABLE QModelIndex	childIndex (int row, const QModelIndex &parentIndex=QModelIndex()) const
	Returns the QModelIndex for the child at `row` under `parentIndex`.

Q_INVOKABLE QModelIndex	indexForObject (QObject *object) const
	Searches the entire tree for `object` and returns its QModelIndex (invalid if not found)

Q_INVOKABLE QModelIndex	parentIndex (const QModelIndex &index) const
	Convenience wrapper around parent()

Q_INVOKABLE int	depth (const QModelIndex &index) const
	Returns the depth of `index` (0 = root-level item, -1 = invalid index)

void	appendRootItem (QObject *object)

void	appendChild (const QModelIndex &parentIndex, QObject *object)

QObject *	removeAt (const QModelIndex &parentIndex, int row)

void	removeChildren (const QModelIndex &parentIndex)
	Removes all children of parentIndex without removing the parent itself.

void	clearAndDeleteContents ()
	Clears the tree and calls deleteLater on every QObject.

bool	contains (QObject *object) const

Public Member Functions inherited from ObjectItemModelBase
	ObjectItemModelBase (QObject *parent=nullptr)

	~ObjectItemModelBase () override

bool	dirty () const

void	beginResetModel ()
	Depth-counted beginResetModel — only the outermost call has effect.

void	endResetModel ()
	Depth-counted endResetModel — only the outermost call has effect.

virtual bool	isEmpty () const

Static Public Attributes
static constexpr int	NodeTypeRole = Qt::UserRole + 2

static constexpr int	SeparatorRole = Qt::UserRole + 3

Additional Inherited Members
Signals inherited from ObjectItemModelBase
void	countChanged (int count)

void	dirtyChanged (bool dirty)

Protected Slots inherited from ObjectItemModelBase
void	_childDirtyChanged (bool dirty)

Protected Member Functions inherited from ObjectItemModelBase
QHash< int, QByteArray >	roleNames () const override

void	_signalCountChangedIfNotNested ()

Protected Attributes inherited from ObjectItemModelBase
bool	_dirty = false

uint	_resetModelNestingCount = 0

Static Protected Attributes inherited from ObjectItemModelBase
static constexpr int	ObjectRole = Qt::UserRole

static constexpr int	TextRole = Qt::UserRole + 1

Detailed Description

A tree model for QObject* items, usable from both C++ and QML.

Works like QmlObjectListModel but supports hierarchical parent/child relationships. Compatible with Qt 6 TreeView.

Top-level items are children of an invisible root node. The root is represented by an invalid QModelIndex (the default).

Definition at line 24 of file QmlObjectTreeModel.h.

Constructor & Destructor Documentation

◆ QmlObjectTreeModel()

QmlObjectTreeModel::QmlObjectTreeModel ( QObject * parent = nullptr )

explicit

Definition at line 60 of file QmlObjectTreeModel.cc.

◆ ~QmlObjectTreeModel()

QmlObjectTreeModel::~QmlObjectTreeModel ( )

override

Definition at line 65 of file QmlObjectTreeModel.cc.

Member Function Documentation

◆ appendChild()

void QmlObjectTreeModel::appendChild	(	const QModelIndex &	parentIndex,
		QObject *	object
	)

Definition at line 377 of file QmlObjectTreeModel.cc.

References appendItem(), and parentIndex().

◆ appendItem() [1/2]

QModelIndex QmlObjectTreeModel::appendItem	(	QObject *	object,
		const QModelIndex &	parentIndex,
		const QString &	nodeType
	)

Same as above but also sets a nodeType tag on the created tree node.

Definition at line 288 of file QmlObjectTreeModel.cc.

References index(), insertItem(), and parentIndex().

◆ appendItem() [2/2]

QModelIndex QmlObjectTreeModel::appendItem	(	QObject *	object,
		const QModelIndex &	parentIndex = `QModelIndex()`
	)

Appends object as the last child of parentIndex (root if invalid). Returns the new item's index.

Definition at line 232 of file QmlObjectTreeModel.cc.

References index(), insertItem(), and parentIndex().

Referenced by appendChild(), and appendRootItem().

◆ appendRootItem()

void QmlObjectTreeModel::appendRootItem ( QObject * object )

Definition at line 372 of file QmlObjectTreeModel.cc.

References appendItem().

◆ childCount()

Q_INVOKABLE int QmlObjectTreeModel::childCount ( const QModelIndex & parentIndex = QModelIndex() ) const

inline

Number of direct children under parentIndex.

Definition at line 73 of file QmlObjectTreeModel.h.

References parentIndex(), and rowCount().

Referenced by removeChildren().

◆ childIndex()

Q_INVOKABLE QModelIndex QmlObjectTreeModel::childIndex	(	int	row,
		const QModelIndex &	parentIndex = `QModelIndex()`
	)		const

inline

Returns the QModelIndex for the child at row under parentIndex.

Definition at line 76 of file QmlObjectTreeModel.h.

References index(), and parentIndex().

◆ clear()

void QmlObjectTreeModel::clear ( )

overridevirtual

Implements ObjectItemModelBase.

Definition at line 428 of file QmlObjectTreeModel.cc.

References ObjectItemModelBase::beginResetModel(), and ObjectItemModelBase::endResetModel().

◆ clearAndDeleteContents()

void QmlObjectTreeModel::clearAndDeleteContents ( )

Clears the tree and calls deleteLater on every QObject.

Definition at line 441 of file QmlObjectTreeModel.cc.

References ObjectItemModelBase::beginResetModel(), and ObjectItemModelBase::endResetModel().

◆ columnCount()

int QmlObjectTreeModel::columnCount ( const QModelIndex & parent = QModelIndex() ) const

override

Definition at line 110 of file QmlObjectTreeModel.cc.

References index(), and parent().

◆ contains()

bool QmlObjectTreeModel::contains ( QObject * object ) const

Definition at line 454 of file QmlObjectTreeModel.cc.

◆ count()

int QmlObjectTreeModel::count ( ) const

overridevirtual

Implements ObjectItemModelBase.

Definition at line 205 of file QmlObjectTreeModel.cc.

◆ data()

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

override

Definition at line 122 of file QmlObjectTreeModel.cc.

References index(), NodeTypeRole, ObjectItemModelBase::ObjectRole, SeparatorRole, and ObjectItemModelBase::TextRole.

◆ depth()

int QmlObjectTreeModel::depth ( const QModelIndex & index ) const

Returns the depth of index (0 = root-level item, -1 = invalid index)

Definition at line 353 of file QmlObjectTreeModel.cc.

References index().

◆ getObject()

QObject * QmlObjectTreeModel::getObject ( const QModelIndex & index ) const

Returns the QObject* stored at index, or nullptr if invalid.

Definition at line 222 of file QmlObjectTreeModel.cc.

References index().

◆ hasChildren()

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

override

Definition at line 116 of file QmlObjectTreeModel.cc.

References parent().

◆ index()

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

override

Definition at line 76 of file QmlObjectTreeModel.cc.

References index(), and parent().

Referenced by appendItem(), appendItem(), childIndex(), columnCount(), data(), depth(), getObject(), index(), indexForObject(), insertItem(), insertItem(), insertRows(), parent(), parentIndex(), removeAt(), removeChildren(), removeItem(), removeRows(), roleNames(), setData(), and setDirty().

◆ indexForObject()

QModelIndex QmlObjectTreeModel::indexForObject ( QObject * object ) const

Searches the entire tree for object and returns its QModelIndex (invalid if not found)

Definition at line 343 of file QmlObjectTreeModel.cc.

References index().

◆ insertItem() [1/2]

QModelIndex QmlObjectTreeModel::insertItem	(	int	row,
		QObject *	object,
		const QModelIndex &	parentIndex,
		const QString &	nodeType
	)

Same as above but also sets a nodeType tag on the created tree node.

Definition at line 248 of file QmlObjectTreeModel.cc.

References ObjectItemModelBase::_resetModelNestingCount, ObjectItemModelBase::_signalCountChangedIfNotNested(), index(), parentIndex(), and setDirty().

◆ insertItem() [2/2]

QModelIndex QmlObjectTreeModel::insertItem	(	int	row,
		QObject *	object,
		const QModelIndex &	parentIndex = `QModelIndex()`
	)

Inserts object at row under parentIndex. Returns the new item's index.

Definition at line 243 of file QmlObjectTreeModel.cc.

References index(), insertItem(), and parentIndex().

Referenced by appendItem(), appendItem(), and insertItem().

◆ insertRows()

bool QmlObjectTreeModel::insertRows	(	int	row,
		int	count,
		const QModelIndex &	parent = `QModelIndex()`
	)

override

Definition at line 181 of file QmlObjectTreeModel.cc.

References index().

◆ parent()

QModelIndex QmlObjectTreeModel::parent ( const QModelIndex & child ) const

override

Definition at line 90 of file QmlObjectTreeModel.cc.

References index().

Referenced by columnCount(), hasChildren(), index(), parentIndex(), and rowCount().

◆ parentIndex()

Q_INVOKABLE QModelIndex QmlObjectTreeModel::parentIndex ( const QModelIndex & index ) const

inline

Convenience wrapper around parent()

Definition at line 82 of file QmlObjectTreeModel.h.

References index(), and parent().

Referenced by appendChild(), appendItem(), appendItem(), childCount(), childIndex(), insertItem(), insertItem(), removeAt(), and removeChildren().

◆ removeAt()

QObject * QmlObjectTreeModel::removeAt	(	const QModelIndex &	parentIndex,
		int	row
	)

Definition at line 382 of file QmlObjectTreeModel.cc.

References index(), parentIndex(), and removeItem().

◆ removeChildren()

void QmlObjectTreeModel::removeChildren ( const QModelIndex & parentIndex )

Removes all children of parentIndex without removing the parent itself.

Definition at line 387 of file QmlObjectTreeModel.cc.

References ObjectItemModelBase::_resetModelNestingCount, ObjectItemModelBase::_signalCountChangedIfNotNested(), childCount(), index(), and parentIndex().

◆ removeItem()

QObject * QmlObjectTreeModel::removeItem ( const QModelIndex & index )

Removes the item (and its entire subtree) at index. Returns the removed QObject* (caller takes ownership). Child QObjects are NOT deleted; only the internal tree nodes are freed.

Definition at line 298 of file QmlObjectTreeModel.cc.

References ObjectItemModelBase::_resetModelNestingCount, ObjectItemModelBase::_signalCountChangedIfNotNested(), index(), and setDirty().

Referenced by removeAt().

◆ removeRows()

bool QmlObjectTreeModel::removeRows	(	int	row,
		int	count,
		const QModelIndex &	parent = `QModelIndex()`
	)

override

Definition at line 187 of file QmlObjectTreeModel.cc.

References index().

◆ roleNames()

QHash< int, QByteArray > QmlObjectTreeModel::roleNames ( ) const

override

Definition at line 193 of file QmlObjectTreeModel.cc.

References index(), NodeTypeRole, ObjectItemModelBase::roleNames(), and SeparatorRole.

◆ rowCount()

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

override

Definition at line 104 of file QmlObjectTreeModel.cc.

References parent().

Referenced by childCount().

◆ setData()

bool QmlObjectTreeModel::setData	(	const QModelIndex &	index,
		const QVariant &	value,
		int	role = `Qt::EditRole`
	)

override

Definition at line 155 of file QmlObjectTreeModel.cc.

References index(), and ObjectItemModelBase::ObjectRole.

◆ setDirty()

void QmlObjectTreeModel::setDirty ( bool dirty )

overridevirtual

Implements ObjectItemModelBase.

Definition at line 210 of file QmlObjectTreeModel.cc.

References ObjectItemModelBase::_dirty, ObjectItemModelBase::dirty(), ObjectItemModelBase::dirtyChanged(), and index().

Referenced by insertItem(), and removeItem().

Member Data Documentation

◆ NodeTypeRole

constexpr int QmlObjectTreeModel::NodeTypeRole = Qt::UserRole + 2

staticconstexpr

Definition at line 95 of file QmlObjectTreeModel.h.

Referenced by data(), and roleNames().

◆ SeparatorRole

constexpr int QmlObjectTreeModel::SeparatorRole = Qt::UserRole + 3

staticconstexpr

Definition at line 96 of file QmlObjectTreeModel.h.

Referenced by data(), and roleNames().

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

src/QmlControls/QmlObjectTreeModel.h
src/QmlControls/QmlObjectTreeModel.cc

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QmlObjectTreeModel()

◆ ~QmlObjectTreeModel()

Member Function Documentation

◆ appendChild()

◆ appendItem() [1/2]

◆ appendItem() [2/2]

◆ appendRootItem()

◆ childCount()

◆ childIndex()

◆ clear()

◆ clearAndDeleteContents()

◆ columnCount()

◆ contains()

◆ count()

◆ data()

◆ depth()

◆ getObject()

◆ hasChildren()

◆ index()

◆ indexForObject()

◆ insertItem() [1/2]

◆ insertItem() [2/2]

◆ insertRows()

◆ parent()

◆ parentIndex()

◆ removeAt()

◆ removeChildren()

◆ removeItem()

◆ removeRows()

◆ roleNames()

◆ rowCount()

◆ setData()

◆ setDirty()

Member Data Documentation

◆ NodeTypeRole

◆ SeparatorRole