Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QQmlTreeModel Class Reference

#include <qqmltreemodel_p.h>

Inheritance diagram for QQmlTreeModel:
Collaboration diagram for QQmlTreeModel:

Public Member Functions

 QQmlTreeModel (QObject *parent=nullptr)
 Encapsulates a simple tree model.
 ~QQmlTreeModel () override
QVariant rows () const
 \qmlproperty object TreeModel::rows
void setRows (const QVariant &rows)
Q_INVOKABLE void appendRow (QModelIndex parent, const QVariant &row)
 \qmlmethod TreeModel::appendRow(QModelIndex parent, object treeRow)
Q_INVOKABLE void appendRow (const QVariant &row)
 \qmlmethod TreeModel::appendRow(object treeRow)
Q_INVOKABLE void clear ()
 \qmlmethod TreeModel::clear()
Q_INVOKABLE QVariant getRow (const QModelIndex &index) const
 \qmlmethod object TreeModel::getRow(const QModelIndex &rowIndex)
Q_INVOKABLE void removeRow (QModelIndex index)
 \qmlmethod TreeModel::removeRow(QModelIndex rowIndex)
Q_INVOKABLE void setRow (QModelIndex index, const QVariant &rowData)
 \qmlmethod TreeModel::setRow(QModelIndex rowIndex, object treeRow)
Q_INVOKABLE QModelIndex index (const std::vector< int > &rowIndex, int column)
 \qmlmethod QModelIndex TreeModel::index(list<int> treeIndex, int column)
QModelIndex index (int row, int column, const QModelIndex &parent={}) const override
 \qmlmethod QModelIndex TreeModel::index(int row, int column, object parent)
int rowCount (const QModelIndex &parent={}) const override
 Returns the number of rows under the given parent.
int columnCount (const QModelIndex &parent={}) const override
 \qmlproperty int TreeModel::columnCount \readonly
QModelIndex parent (const QModelIndex &index) const override
Public Member Functions inherited from QQmlAbstractColumnModel
 QQmlAbstractColumnModel (QObject *parent=nullptr)
 ~QQmlAbstractColumnModel () override=default
QQmlListProperty< QQmlTableModelColumn > columns ()
Q_INVOKABLE QVariant data (const QModelIndex &index, const QString &role) const
Q_INVOKABLE QVariant data (const QModelIndex &index, int role=Qt::DisplayRole) const override
 Returns the data stored under the given role for the item referred to by the index.
Q_INVOKABLE bool setData (const QModelIndex &index, const QVariant &value, const QString &role)
Q_INVOKABLE bool setData (const QModelIndex &index, const QVariant &value, int role=Qt::DisplayRole) override
 Sets the role data for the item at index to value.
QHash< int, QByteArray > roleNames () const override
Qt::ItemFlags flags (const QModelIndex &index) const override
 Returns the item flags for the given index.
Public Member Functions inherited from QAbstractItemModel
 QAbstractItemModel (QObject *parent=nullptr)
 Constructs an abstract item model with the given parent.
virtual ~QAbstractItemModel ()
 Destroys the abstract item model.
Q_INVOKABLE bool hasIndex (int row, int column, const QModelIndex &parent=QModelIndex()) const
 Returns {true} if the model returns a valid QModelIndex for row and column with parent, otherwise returns {false}.
virtual Q_INVOKABLE QModelIndex sibling (int row, int column, const QModelIndex &idx) const
 Returns the sibling at row and column for the item at index, or an invalid QModelIndex if there is no sibling at that location.
virtual Q_INVOKABLE bool hasChildren (const QModelIndex &parent=QModelIndex()) const
 Returns {true} if parent has any children; otherwise returns {false}.
virtual Q_INVOKABLE QVariant headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
 Returns the data for the given role and section in the header with the specified orientation.
virtual bool setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role=Qt::EditRole)
 Sets the data for the given role and section in the header with the specified orientation to the value supplied.
virtual QMap< int, QVariant > itemData (const QModelIndex &index) const
 Returns a map with values for all predefined roles in the model for the item at the given index.
virtual bool setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)
 Sets the role data for the item at index to the associated value in roles, for every Qt::ItemDataRole.
virtual bool clearItemData (const QModelIndex &index)
virtual QStringList mimeTypes () const
 Returns the list of allowed MIME types.
virtual QMimeData * mimeData (const QModelIndexList &indexes) const
 Returns an object that contains serialized items of data corresponding to the list of indexes specified.
virtual bool canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const
 Returns {true} if a model can accept a drop of the data.
virtual bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
 Handles the data supplied by a drag and drop operation that ended with the given action.
virtual Qt::DropActions supportedDropActions () const
virtual Qt::DropActions supportedDragActions () const
 Returns the actions supported by the data in this model.
Q_INVOKABLE Q_REVISION (6, 4) virtual bool insertRows(int row
Q_INVOKABLE Q_REVISION (6, 4) virtual bool insertColumns(int column
Q_INVOKABLE Q_REVISION (6, 4) virtual bool removeRows(int row
Q_INVOKABLE Q_REVISION (6, 4) virtual bool removeColumns(int column
Q_INVOKABLE Q_REVISION (6, 4) virtual bool moveRows(const QModelIndex &sourceParent
Q_INVOKABLE Q_REVISION (6, 4) virtual bool moveColumns(const QModelIndex &sourceParent
Q_INVOKABLE Q_REVISION (6, 4) inline bool insertRow(int row
Q_INVOKABLE Q_REVISION (6, 4) inline bool insertColumn(int column
Q_INVOKABLE Q_REVISION (6, 4) inline bool removeRow(int row
Q_INVOKABLE Q_REVISION (6, 4) inline bool removeColumn(int column
Q_INVOKABLE Q_REVISION (6, 4) inline bool moveRow(const QModelIndex &sourceParent
Q_INVOKABLE Q_REVISION (6, 4) inline bool moveColumn(const QModelIndex &sourceParent
virtual Q_INVOKABLE void fetchMore (const QModelIndex &parent)
 Fetches any available data for the items with the parent specified by the parent index.
virtual Q_INVOKABLE bool canFetchMore (const QModelIndex &parent) const
 Returns {true} if there is more data available for parent; otherwise returns {false}.
Q_INVOKABLE Q_REVISION (6, 4) virtual void sort(int column
virtual QModelIndex buddy (const QModelIndex &index) const
 Returns a model index for the buddy of the item represented by index.
virtual Q_INVOKABLE QModelIndexList match (const QModelIndex &start, int role, const QVariant &value, int hits=1, Qt::MatchFlags flags=Qt::MatchFlags(Qt::MatchStartsWith|Qt::MatchWrap)) const
 Returns a list of indexes for the items in the column of the start index where data stored under the given role matches the specified value.
virtual QSize span (const QModelIndex &index) const
 Returns the row and column span of the item represented by index.
bool checkIndex (const QModelIndex &index, CheckIndexOptions options=CheckIndexOption::NoOption) const
virtual void multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const
QObject * parent () const
 Returns a pointer to the parent object.
Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
QString objectName () const
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString > bindableObjectName ()
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
bool isQmlObjectType () const
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread * thread () const
 Returns the thread in which the object lives.
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void killTimer (int id)
 Kills the timer with timer identifier, id.
void killTimer (Qt::TimerId id)
template<typename T>
T findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
T findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList & children () const
 Returns a list of child objects.
void setParent (QObject *parent)
 Makes the object a child of parent.
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
bool disconnect (const QObject *receiver, const char *member=nullptr) const
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
bool setProperty (const char *name, QVariant &&value)
QVariant property (const char *name) const
 Returns the value of the object's name property.
QList< QByteArray > dynamicPropertyNames () const
QBindingStorage * bindingStorage ()
const QBindingStorage * bindingStorage () const
QObject * parent () const
 Returns a pointer to the parent object.
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
virtual ~QQmlParserStatus ()

Protected Member Functions

QVariant firstRow () const override
void setInitialRows () override
Protected Member Functions inherited from QQmlAbstractColumnModel
void classBegin () override
 Invoked after class creation, but before any properties have been set.
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
ColumnRoleMetadata fetchColumnRoleData (const QString &roleNameKey, QQmlTableModelColumn *tableModelColumn, int columnIndex) const
void fetchColumnMetadata ()
bool validateRowType (QLatin1StringView functionName, const QVariant &row) const
Protected Member Functions inherited from QAbstractItemModel
 QAbstractItemModel (QAbstractItemModelPrivate &dd, QObject *parent=nullptr)
QModelIndex createIndex (int row, int column, const void *data=nullptr) const
 Creates a model index for the given row and column with the internal pointer ptr.
QModelIndex createIndex (int row, int column, quintptr id) const
 Creates a model index for the given row and column with the internal identifier, id.
void encodeData (const QModelIndexList &indexes, QDataStream &stream) const
bool decodeData (int row, int column, const QModelIndex &parent, QDataStream &stream)
void beginInsertRows (const QModelIndex &parent, int first, int last)
 Begins a row insertion operation.
void endInsertRows ()
 Ends a row insertion operation.
void beginRemoveRows (const QModelIndex &parent, int first, int last)
 Begins a row removal operation.
void endRemoveRows ()
 Ends a row removal operation.
bool beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationRow)
void endMoveRows ()
 Ends a row move operation.
void beginInsertColumns (const QModelIndex &parent, int first, int last)
 Begins a column insertion operation.
void endInsertColumns ()
 Ends a column insertion operation.
void beginRemoveColumns (const QModelIndex &parent, int first, int last)
 Begins a column removal operation.
void endRemoveColumns ()
 Ends a column removal operation.
bool beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationColumn)
 Begins a column move operation.
void endMoveColumns ()
 Ends a column move operation.
void beginResetModel ()
 Begins a model reset operation.
void endResetModel ()
 Completes a model reset operation.
void changePersistentIndex (const QModelIndex &from, const QModelIndex &to)
 Changes the QPersistentModelIndex that is equal to the given from model index to the given to model index.
void changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)
QModelIndexList persistentIndexList () const
Protected Member Functions inherited from QObject
QObject * sender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int senderSignalIndex () const
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
bool isSignalConnected (const QMetaMethod &signal) const
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
virtual void connectNotify (const QMetaMethod &signal)
virtual void disconnectNotify (const QMetaMethod &signal)
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Properties

QVariant rows
Properties inherited from QQmlAbstractColumnModel
QML_ANONYMOUSint columnCount
QQmlListProperty< QQmlTableModelColumn > columns
Properties inherited from QObject
QString objectName
 the name of this object

Private Member Functions

QVariant dataPrivate (const QModelIndex &index, const QString &roleName) const override
void setDataPrivate (const QModelIndex &index, const QString &roleName, QVariant value) override
bool validateNewRow (QLatin1StringView functionName, const QVariant &row, NewRowOperationFlag=OtherOperation) const override
 \qmlmethod variant TreeModel::data(QModelIndex index, string role)

Friends

class ::tst_QQmlTreeModel

Additional Inherited Members

Public Types inherited from QAbstractItemModel
enum  LayoutChangeHint { NoLayoutChangeHint , VerticalSortHint , HorizontalSortHint }
 This enum describes the way the model changes layout. More...
enum class  CheckIndexOption { NoOption = 0x0000 , IndexIsValid = 0x0001 , DoNotUseParent = 0x0002 , ParentIsInvalid = 0x0004 }
Public Slots inherited from QAbstractItemModel
virtual bool submit ()
 Lets the model know that it should submit cached information to permanent storage.
virtual void revert ()
 Lets the model know that it should discard cached information.
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
Signals inherited from QQmlAbstractColumnModel
void columnCountChanged ()
void rowsChanged ()
Signals inherited from QAbstractItemModel
void dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles=QList< int >())
 This signal is emitted whenever the data in an existing item changes.
void headerDataChanged (Qt::Orientation orientation, int first, int last)
 This signal is emitted whenever a header is changed.
void layoutChanged (const QList< QPersistentModelIndex > &parents=QList< QPersistentModelIndex >(), QAbstractItemModel::LayoutChangeHint hint=QAbstractItemModel::NoLayoutChangeHint)
void layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents=QList< QPersistentModelIndex >(), QAbstractItemModel::LayoutChangeHint hint=QAbstractItemModel::NoLayoutChangeHint)
void rowsAboutToBeInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted just before rows are inserted into the model.
void rowsInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted after rows have been inserted into the model.
void rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted just before rows are removed from the model.
void rowsRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted after rows have been removed from the model.
void columnsAboutToBeInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted just before columns are inserted into the model.
void columnsInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted after columns have been inserted into the model.
void columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted just before columns are removed from the model.
void columnsRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted after columns have been removed from the model.
void modelAboutToBeReset (QPrivateSignal)
void modelReset (QPrivateSignal)
void rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow, QPrivateSignal)
void rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow, QPrivateSignal)
void columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn, QPrivateSignal)
void columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn, QPrivateSignal)
Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
Static Public Member Functions inherited from QQmlAbstractColumnModel
static void columns_append (QQmlListProperty< QQmlTableModelColumn > *property, QQmlTableModelColumn *value)
static qsizetype columns_count (QQmlListProperty< QQmlTableModelColumn > *property)
static QQmlTableModelColumn * columns_at (QQmlListProperty< QQmlTableModelColumn > *property, qsizetype index)
static void columns_clear (QQmlListProperty< QQmlTableModelColumn > *property)
static void columns_replace (QQmlListProperty< QQmlTableModelColumn > *property, qsizetype index, QQmlTableModelColumn *value)
static void columns_removeLast (QQmlListProperty< QQmlTableModelColumn > *property)
Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
template<typename Func1, typename Func2>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
template<typename Func1>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
Public Attributes inherited from QAbstractItemModel
Q_INVOKABLE int count
Q_INVOKABLE int const QModelIndex & parent = QModelIndex())
 Returns the parent of the model item with the given index.
Q_INVOKABLE int sourceRow
Q_INVOKABLE int int count
Q_INVOKABLE int int const QModelIndex & destinationParent
Q_INVOKABLE int int const QModelIndex int destinationChild
Q_INVOKABLE int sourceColumn
Q_INVOKABLE const QModelIndex & parent = QModelIndex())
Q_INVOKABLE int const QModelIndex & destinationParent
Q_INVOKABLE int const QModelIndex int destinationChild
Q_INVOKABLE Qt::SortOrder order = Qt::AscendingOrder)
Protected Types inherited from QQmlAbstractColumnModel
enum class  ColumnRole : quint8 { StringRole , FunctionRole }
enum  NewRowOperationFlag { OtherOperation , SetRowsOperation , AppendOperation }
Protected Slots inherited from QAbstractItemModel
virtual void resetInternalData ()
Protected Attributes inherited from QQmlAbstractColumnModel
QList< QQmlTableModelColumn * > mColumns
bool mComponentCompleted = false
int mColumnCount = 0
QVector< ColumnMetadata > mColumnMetadata
QHash< int, QByteArray > mRoleNames
Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 \macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 34 of file qqmltreemodel_p.h.

Constructor & Destructor Documentation

◆ QQmlTreeModel()

QQmlTreeModel::QQmlTreeModel ( QObject * parent = nullptr)
explicit

Encapsulates a simple tree model. 

\qmltype TreeModel

! \nativetype QQmlTreeModel \inqmlmodule Qt.labs.qmlmodels

Since
6.10

The TreeModel type stores JavaScript/JSON objects as data for a tree model that can be used with \l TreeView. It is intended to support very simple models without requiring the creation of a custom \l QAbstractItemModel subclass in C++.

import QtQuick
import QtQuick.Controls
import Qt.labs.qmlmodels
ApplicationWindow {
visible: true
width: 500
height: 500
TreeView {
id: treeView
anchors.fill: parent
selectionModel: ItemSelectionModel {}
model: TreeModel {
id: treeModel
TableModelColumn {
display: "checked"
}
TableModelColumn {
display: "size"
}
TableModelColumn {
display: "type"
}
TableModelColumn {
display: "name"
}
TableModelColumn {
display: "lastModified"
}
rows: [{
checked: false,
size: "—",
type: "folder",
name: "Documents",
lastModified: "2025-07-01",
rows: [{
checked: true,
size: "24 KB",
type: "file",
name: "Resume.pdf",
lastModified: "2025-06-20",
}, {
checked: false,
size: "2 MB",
type: "folder",
name: "Reports",
lastModified: "2025-06-10",
rows: [{
checked: true,
size: "850 KB",
type: "file",
name: "Q2_Report.docx",
lastModified: "2025-06-15",
}, {
checked: false,
size: "1.2 MB",
type: "file",
name: "Q3_Plan.xlsx",
lastModified: "2025-06-18",
}]
}]
},
//![rows]
{
checked: false,
size: "—",
type: "folder",
name: "Pictures",
lastModified: "2025-05-30",
rows: [{
checked: true,
size: "3.5 MB",
type: "file",
name: "Vacation.jpg",
lastModified: "2025-05-15",
}, {
checked: false,
size: "2.1 MB",
type: "file",
name: "Family.png",
lastModified: "2025-05-20",
}]
}
//![rows]
]
}
delegate: TreeViewDelegate {}
}
}

The model's initial data is set with either the \l rows property or by calling \l appendRow(). Each column in the model is specified by declaring a \l TableModelColumn instance, where the order of each instance determines its column index. Once the model's \l Component::completed() signal has been emitted, the columns and roles will have been established and are then fixed for the lifetime of the model.

Definition at line 61 of file qqmltreemodel.cpp.

◆ ~QQmlTreeModel()

QQmlTreeModel::~QQmlTreeModel ( )
overridedefault

Member Function Documentation

◆ appendRow() [1/2]

void QQmlTreeModel::appendRow ( const QVariant & row)

\qmlmethod TreeModel::appendRow(object treeRow)

Appends treeRow to the root node.

See also
setRow(), removeRow()

Definition at line 239 of file qqmltreemodel.cpp.

◆ appendRow() [2/2]

void QQmlTreeModel::appendRow ( QModelIndex parent,
const QVariant & row )

\qmlmethod TreeModel::appendRow(QModelIndex parent, object treeRow)

Appends a new treeRow to parent, with the values (cells) in treeRow.

treeModel.appendRow(index, {
checked: false,
size: "-",
type: "folder",
name: "Orders",
lastModified: "2025-07-02",
rows: [
{
checked: true,
size: "38 KB",
type: "file",
name: "monitors.xlsx",
lastModified: "2025-07-02"
},
{
checked: true,
size: "54 KB",
type: "file",
name: "notebooks.xlsx",
lastModified: "2025-07-02"
}
]
});
QQmlTreeModel::index
Q_INVOKABLE QModelIndex index(const std::vector< int > &rowIndex, int column)
\qmlmethod QModelIndex TreeModel::index(list<int> treeIndex, int column)
Definition qqmltreemodel.cpp:441
size
GLenum GLuint GLintptr GLsizeiptr size
Definition qopengles2ext.h:660
type
GLenum type
Definition qopengles2ext.h:150
name
EGLImageKHR EGLint * name
Definition drmeglserverbufferintegration.h:34

If parent is invalid, treeRow gets appended to the root node.

See also
setRow(), removeRow()

Definition at line 193 of file qqmltreemodel.cpp.

◆ clear()

void QQmlTreeModel::clear ( )

\qmlmethod TreeModel::clear()

Removes all rows from the model.

See also
removeRow()

Definition at line 251 of file qqmltreemodel.cpp.

◆ columnCount()

int QQmlTreeModel::columnCount ( const QModelIndex & parent = {}) const
overridevirtual

\qmlproperty int TreeModel::columnCount \readonly

This read-only property holds the number of columns in the model.

The number of columns is fixed for the lifetime of the model after the \l rows property is set or \l appendRow() is called for the first time.

Implements QAbstractItemModel.

Definition at line 501 of file qqmltreemodel.cpp.

◆ dataPrivate()

QVariant QQmlTreeModel::dataPrivate ( const QModelIndex & index,
const QString & roleName ) const
overrideprivatevirtual

Implements QQmlAbstractColumnModel.

Definition at line 143 of file qqmltreemodel.cpp.

◆ firstRow()

QVariant QQmlTreeModel::firstRow ( ) const
overrideprotectedvirtual

Implements QQmlAbstractColumnModel.

Definition at line 277 of file qqmltreemodel.cpp.

◆ getRow()

QVariant QQmlTreeModel::getRow ( const QModelIndex & rowIndex) const

\qmlmethod object TreeModel::getRow(const QModelIndex &rowIndex)

Returns the treeRow at rowIndex in the model.

Note
the returned object cannot be used to modify the contents of the model; use setTreeRow() instead.
See also
setRow(), appendRow(), removeRow()

Definition at line 268 of file qqmltreemodel.cpp.

◆ index() [1/2]

QModelIndex QQmlTreeModel::index ( const std::vector< int > & treeIndex,
int column )

\qmlmethod QModelIndex TreeModel::index(list<int> treeIndex, int column)

Returns a \l QModelIndex object referencing the given treeIndex and column, which can be passed to the data() function to get the data from that cell, or to setData() to edit the contents of that cell.

The first parameter treeIndex represents a path of row numbers tracing from the root to the desired row and is used for navigation inside the tree. This is best explained through an example.

\table

\row

  • \inlineimage treemodel.svg
  • \list
  • The root of the tree is special, as it can be referenced by an invalid \l QModelIndex.
  • Node A is the first child of the root and the corresponding treeIndex is [0].
  • Node B is the first child of node A. Since the treeIndex of A is [0] the treeIndex of B will be [0,0].
  • Node C is the second child of A and its treeIndex is [0,1].
  • Node D is the third child of A and its treeIndex is [0,2].
  • Node E is the second child of the root and its treeIndex is [1].
  • Node F is the third child of the root and its treeIndex is [2].

\endlist

\endtable

With this overload it is possible to obtain a \l QModelIndex to a node without having a \l QModelIndex to its parent node.

If no node is found by the list specified, an invalid model index is returned. Please note that an invalid model index is referencing the root of the node.

See also
{QModelIndex and related Classes in QML}, data()

Definition at line 441 of file qqmltreemodel.cpp.

◆ index() [2/2]

QModelIndex QQmlTreeModel::index ( int row,
int column,
const QModelIndex & parent = {} ) const
overridevirtual

\qmlmethod QModelIndex TreeModel::index(int row, int column, object parent)

Returns a \l QModelIndex object referencing the given row and column of a given parent which can be passed to the data() function to get the data from that cell, or to setData() to edit the contents of that cell.

See also
{QModelIndex and related Classes in QML}, data()

Implements QAbstractItemModel.

Definition at line 381 of file qqmltreemodel.cpp.

◆ parent()

QModelIndex QQmlTreeModel::parent ( const QModelIndex & index) const
overridevirtual

Implements QAbstractItemModel.

Definition at line 453 of file qqmltreemodel.cpp.

◆ removeRow()

void QQmlTreeModel::removeRow ( QModelIndex rowIndex)

\qmlmethod TreeModel::removeRow(QModelIndex rowIndex)

Removes the TreeRow referenced by rowIndex from the model.

treeModel.removeTreeRow(rowIndex)
See also
clear()

Definition at line 298 of file qqmltreemodel.cpp.

◆ rowCount()

int QQmlTreeModel::rowCount ( const QModelIndex & parent = {}) const
overridevirtual

Returns the number of rows under the given parent.

When the parent is valid it means that rowCount is returning the number of children of parent.

Note
When implementing a table based model, rowCount() should return 0 when the parent is valid.
See also
columnCount()

Implements QAbstractItemModel.

Definition at line 482 of file qqmltreemodel.cpp.

◆ rows()

QVariant QQmlTreeModel::rows ( ) const

\qmlproperty object TreeModel::rows

This property holds the model data in the form of an array of rows.

See also
getRow(), setRow(), appendRow(), clear(), columnCount

Definition at line 75 of file qqmltreemodel.cpp.

◆ setDataPrivate()

void QQmlTreeModel::setDataPrivate ( const QModelIndex & index,
const QString & roleName,
QVariant value )
overrideprivatevirtual

Implements QQmlAbstractColumnModel.

Definition at line 151 of file qqmltreemodel.cpp.

◆ setInitialRows()

void QQmlTreeModel::setInitialRows ( )
overrideprotectedvirtual

Implements QQmlAbstractColumnModel.

Definition at line 282 of file qqmltreemodel.cpp.

◆ setRow()

void QQmlTreeModel::setRow ( QModelIndex rowIndex,
const QVariant & rowData )

\qmlmethod TreeModel::setRow(QModelIndex rowIndex, object treeRow)

Replaces the TreeRow at rowIndex in the model with treeRow. A row with child rows will be rejected.

All columns/cells must be present in treeRow, and in the correct order. The child rows of the row remain unaffected.

treeModel.setRow(rowIndex, {
checked: true,
size: "-",
type: "folder",
name: "Subtitles",
lastModified: "2025-07-07",
iconColor: "blue"
});
See also
appendRow()

Definition at line 345 of file qqmltreemodel.cpp.

◆ setRows()

void QQmlTreeModel::setRows ( const QVariant & rows)

Definition at line 84 of file qqmltreemodel.cpp.

◆ validateNewRow()

bool QQmlTreeModel::validateNewRow ( QLatin1StringView functionName,
const QVariant & row,
NewRowOperationFlag operation = OtherOperation ) const
overrideprivatevirtual

\qmlmethod variant TreeModel::data(QModelIndex index, string role)

Returns the data from the TreeModel at the given index belonging to the given role.

See also
index(), setData()

\qmlmethod bool TreeModel::setData(QModelIndex index, variant value, string role)

Inserts or updates the data field named by role in the TreeRow at the given index with value. Returns true if successful, false if not.

See also
data(), index()

Reimplemented from QQmlAbstractColumnModel.

Definition at line 526 of file qqmltreemodel.cpp.

◆ ::tst_QQmlTreeModel

friend class ::tst_QQmlTreeModel
friend

Definition at line 73 of file qqmltreemodel_p.h.

Property Documentation

◆ rows

QVariant QQmlTreeModel::rows
readwrite

Definition at line 37 of file qqmltreemodel_p.h.

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