#include <qqmltablemodel_p.h>

Inheritance diagram for QQmlTableModel:

Collaboration diagram for QQmlTableModel:

Signals
void	columnCountChanged ()

void	rowCountChanged ()

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.

Public Member Functions
	QQmlTableModel (QObject *parent=nullptr)
	Encapsulates a simple table model.

	~QQmlTableModel () override

QVariant	rows () const
	\qmlproperty object TableModel::rows

void	setRows (const QVariant &rows)

Q_INVOKABLE void	appendRow (const QVariant &row)
	\qmlmethod TableModel::appendRow(object row)

Q_INVOKABLE void	clear ()
	\qmlmethod TableModel::clear()

Q_INVOKABLE QVariant	getRow (int rowIndex)
	\qmlmethod object TableModel::getRow(int rowIndex)

Q_INVOKABLE void	insertRow (int rowIndex, const QVariant &row)
	\qmlmethod TableModel::insertRow(int rowIndex, object row)

Q_INVOKABLE void	moveRow (int fromRowIndex, int toRowIndex, int rows=1)
	\qmlmethod TableModel::moveRow(int fromRowIndex, int toRowIndex, int rows)

Q_INVOKABLE void	removeRow (int rowIndex, int rows=1)
	\qmlmethod TableModel::removeRow(int rowIndex, int rows = 1)

Q_INVOKABLE void	setRow (int rowIndex, const QVariant &row)
	\qmlmethod TableModel::setRow(int rowIndex, object row)

QQmlListProperty< QQmlTableModelColumn >	columns ()

QModelIndex	index (int row, int column, const QModelIndex &parent=QModelIndex()) const override
	\qmlmethod QModelIndex TableModel::index(int row, int column)

int	rowCount (const QModelIndex &parent=QModelIndex()) const override
	\qmlproperty int TableModel::rowCount \readonly

int	columnCount (const QModelIndex &parent=QModelIndex()) const override
	\qmlproperty int TableModel::columnCount \readonly

Q_INVOKABLE QVariant	data (const QModelIndex &index, const QString &role) const
	\qmlmethod variant TableModel::data(QModelIndex index, string role)

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 QString &role, const QVariant &value)
	\qmlmethod bool TableModel::setData(QModelIndex index, string role, variant value)

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
	\reimp

Public Member Functions inherited from QAbstractTableModel
	QAbstractTableModel (QObject *parent=nullptr)
	Constructs an abstract table model for the given parent.

	~QAbstractTableModel ()
	Destroys the abstract table model.

QModelIndex	index (int row, int column, const QModelIndex &parent=QModelIndex()) const override
	Returns the index of the data in row and column with parent.

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

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

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

QObject *	parent () const
	Returns a pointer to the parent object.

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	index (int row, int column, const QModelIndex &parent=QModelIndex()) const =0
	Returns the index of the item in the model specified by the given row, column and parent index.

virtual Q_INVOKABLE QModelIndex	parent (const QModelIndex &child) const =0

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 int	rowCount (const QModelIndex &parent=QModelIndex()) const =0
	Returns the number of rows under the given parent.

virtual Q_INVOKABLE int	columnCount (const QModelIndex &parent=QModelIndex()) const =0
	Returns the number of columns for the children of the given parent.

virtual Q_INVOKABLE bool	hasChildren (const QModelIndex &parent=QModelIndex()) const
	Returns {true} if parent has any children; otherwise returns {false}.

virtual Q_INVOKABLE QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const =0
	Returns the data stored under the given role for the item referred to by the index.

virtual Q_INVOKABLE bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)
	Sets the role data for the item at index to value.

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

virtual Q_INVOKABLE Qt::ItemFlags	flags (const QModelIndex &index) const
	Returns the item flags for the given index.

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.

virtual QHash< int, QByteArray >	roleNames () const

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

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.

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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

template<typename T >
T	findChild (const QString &aName=QString(), 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 (const QString &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 >
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 ()

virtual void	classBegin ()=0
	Invoked after class creation, but before any properties have been set.

virtual void	componentComplete ()=0
	Invoked after the root component that caused this instantiation has completed construction.

Static Public Member Functions
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)

Protected Member Functions
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.

Protected Member Functions inherited from QAbstractTableModel
	QAbstractTableModel (QAbstractItemModelPrivate &dd, QObject *parent)

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
int	columnCount

int	rowCount

QVariant	rows

QQmlListProperty< QQmlTableModelColumn >	columns

Properties inherited from QObject
QString	objectName
	the name of this object

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

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 Slots inherited from QAbstractItemModel
virtual void	resetInternalData ()

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 33 of file qqmltablemodel_p.h.

Constructor & Destructor Documentation

◆ QQmlTableModel()

QT_BEGIN_NAMESPACE QQmlTableModel::QQmlTableModel ( QObject * parent = nullptr )

Encapsulates a simple table model.

\qmltype TableModel

! \instantiates QQmlTableModel \inqmlmodule Qt.labs.qmlmodels

Since: 5.14

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

import QtQuick
import QtQuick.Window
import Qt.labs.qmlmodels
 
Window {
    width: 400
    height: 400
    visible: true
 
    TableView {
        anchors.fill: parent
        columnSpacing: 1
        rowSpacing: 1
        boundsBehavior: Flickable.StopAtBounds
 
        model: TableModel {
            TableModelColumn { display: "checked" }
            TableModelColumn { display: "amount" }
            TableModelColumn { display: "fruitType" }
            TableModelColumn { display: "fruitName" }
            TableModelColumn { display: "fruitPrice" }
 
            // Each row is one type of fruit that can be ordered
//![rows]
            rows: [
                {
                    // Each property is one cell/column.
                    checked: false,
                    amount: 1,
                    fruitType: "Apple",
                    fruitName: "Granny Smith",
                    fruitPrice: 1.50
                },
                {
                    checked: true,
                    amount: 4,
                    fruitType: "Orange",
                    fruitName: "Navel",
                    fruitPrice: 2.50
                },
                {
                    checked: false,
                    amount: 1,
                    fruitType: "Banana",
                    fruitName: "Cavendish",
                    fruitPrice: 3.50
                }
            ]
//![rows]
        }
//![delegate]
        delegate:  TextInput {
            text: model.display
            padding: 12
            selectByMouse: true
 
            onAccepted: model.display = text
 
            Rectangle {
                anchors.fill: parent
                color: "#efefef"
                z: -1
            }
        }
//![delegate]
    }
}

The model's initial row 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.

To access a specific row, the \l getRow() function can be used. It's also possible to access the model's JavaScript data directly via the \l rows property, but it is not possible to modify the model data this way.

To add new rows, use \l appendRow() and \l insertRow(). To modify existing rows, use \l setRow(), \l moveRow(), \l removeRow(), and \l clear().

It is also possible to modify the model's data via the delegate, as shown in the example above:

        delegate:  TextInput {
            text: model.display
            padding: 12
            selectByMouse: true
 
            onAccepted: model.display = text
 
            Rectangle {
                anchors.fill: parent
                color: "#efefef"
                z: -1
            }
        }

If the type of the data at the modified role does not match the type of the data that is set, it will be automatically converted via \l {QVariant::canConvert()}{QVariant}.

Definition at line 134 of file qqmltablemodel.cpp.

◆ ~QQmlTableModel()

QQmlTableModel::~QQmlTableModel ( )

override

Definition at line 139 of file qqmltablemodel.cpp.

Member Function Documentation

◆ appendRow()

void QQmlTableModel::appendRow ( const QVariant & row )

\qmlmethod TableModel::appendRow(object row)

Adds a new row to the end of the model, with the values (cells) in row.

model.appendRow({
    checkable: true,
    amount: 1,
    fruitType: "Pear",
    fruitName: "Williams",
    fruitPrice: 1.50,
})

See also: insertRow(), setRow(), removeRow()

Definition at line 332 of file qqmltablemodel.cpp.

◆ classBegin()

void QQmlTableModel::classBegin ( )

overrideprotectedvirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 433 of file qqmltablemodel.cpp.

◆ clear()

void QQmlTableModel::clear ( )

\qmlmethod TableModel::clear()

Removes all rows from the model.

See also: removeRow()

Definition at line 347 of file qqmltablemodel.cpp.

References engine, QVariant::fromValue(), QJSEngine::newArray(), Q_ASSERT, qmlEngine(), and setRows().

Here is the call graph for this function:

◆ columnCount()

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

overridevirtual

\qmlproperty int TableModel::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 726 of file qqmltablemodel.cpp.

References QAbstractTableModel::parent().

Here is the call graph for this function:

◆ columnCountChanged

void QQmlTableModel::columnCountChanged ( )

signal

Referenced by componentComplete().

Here is the caller graph for this function:

◆ columns()

QQmlListProperty< QQmlTableModelColumn > QQmlTableModel::columns ( )

◆ columns_append()

void QQmlTableModel::columns_append	(	QQmlListProperty< QQmlTableModelColumn > *	property,
		QQmlTableModelColumn *	value
	)

static

Definition at line 618 of file qqmltablemodel.cpp.

References model.

◆ columns_at()

QQmlTableModelColumn * QQmlTableModel::columns_at	(	QQmlListProperty< QQmlTableModelColumn > *	property,
		qsizetype	index
	)

static

Definition at line 633 of file qqmltablemodel.cpp.

References model.

◆ columns_clear()

void QQmlTableModel::columns_clear ( QQmlListProperty< QQmlTableModelColumn > * property )

static

Definition at line 639 of file qqmltablemodel.cpp.

References QSqlQueryModel::clear(), and model.

Here is the call graph for this function:

◆ columns_count()

qsizetype QQmlTableModel::columns_count ( QQmlListProperty< QQmlTableModelColumn > * property )

static

Definition at line 627 of file qqmltablemodel.cpp.

References model.

◆ columns_removeLast()

void QQmlTableModel::columns_removeLast ( QQmlListProperty< QQmlTableModelColumn > * property )

static

Definition at line 652 of file qqmltablemodel.cpp.

References model.

◆ columns_replace()

void QQmlTableModel::columns_replace	(	QQmlListProperty< QQmlTableModelColumn > *	property,
		qsizetype	index,
		QQmlTableModelColumn *	value
	)

static

Definition at line 645 of file qqmltablemodel.cpp.

References model.

◆ componentComplete()

void QQmlTableModel::componentComplete ( )

overrideprotectedvirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 437 of file qqmltablemodel.cpp.

References columnCountChanged(), emit, and QList< T >::size().

Here is the call graph for this function:

◆ data() [1/2]

QVariant QQmlTableModel::data	(	const QModelIndex &	index,
		const QString &	role
	)		const

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

Returns the data from the table cell at the given index belonging to the given role.

See also: index()

Definition at line 742 of file qqmltablemodel.cpp.

References QHash< Key, T >::key(), and QString::toUtf8().

Here is the call graph for this function:

◆ data() [2/2]

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

overridevirtual

Returns the data stored under the given role for the item referred to by the index.

Note: If you do not have a value to return, return an invalid (default-constructed) QVariant.

See also: Qt::ItemDataRole, setData(), headerData()

Implements QAbstractItemModel.

Definition at line 750 of file qqmltablemodel.cpp.

References args, QList< T >::at(), columnCount, QString::fromUtf8(), QQmlTableModelColumn::getterAtRole(), qmlEngine(), qmlWarning(), roleData, rowCount, QVariant::toMap(), QJSEngine::toScriptValue(), QHash< Key, T >::value(), and QMap< Key, T >::value().

Here is the call graph for this function:

◆ flags()

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

overridevirtual

\reimp

Reimplemented from QAbstractTableModel.

Definition at line 1053 of file qqmltablemodel.cpp.

References Qt::ItemIsEditable, Qt::ItemIsEnabled, Qt::ItemIsSelectable, and Q_UNUSED.

◆ getRow()

QVariant QQmlTableModel::getRow ( int rowIndex )

\qmlmethod object TableModel::getRow(int rowIndex)

Returns the row at rowIndex in the model.

Note that this equivalent to accessing the row directly through the \l rows property:

Component.onCompleted: {
    // These two lines are equivalent.
    console.log(model.getRow(0).display);
    console.log(model.rows[0].fruitName);
}

Note: the returned object cannot be used to modify the contents of the model; use setRow() instead.

See also: setRow(), appendRow(), insertRow(), removeRow(), moveRow()

Definition at line 375 of file qqmltablemodel.cpp.

References QList< T >::at().

Here is the call graph for this function:

◆ index()

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

overridevirtual

\qmlmethod QModelIndex TableModel::index(int row, int column)

Returns a \l QModelIndex object referencing the given row 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.

import QtQml 2.14
import Qt.labs.qmlmodels 1.0
 
TableModel {
    id: model
 
    TableModelColumn { display: "fruitType" }
    TableModelColumn { display: "fruitPrice" }
 
    rows: [
        { fruitType: "Apple", fruitPrice: 1.50 },
        { fruitType: "Orange", fruitPrice: 2.50 }
    ]
 
    Component.onCompleted: {
        for (var r = 0; r < model.rowCount; ++r) {
            console.log("An " + model.data(model.index(r, 0)).display +
                        " costs " + model.data(model.index(r, 1)).display.toFixed(2))
        }
    }
}

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

Reimplemented from QAbstractTableModel.

Definition at line 693 of file qqmltablemodel.cpp.

References columnCount, QAbstractItemModel::createIndex(), QAbstractTableModel::parent(), and rowCount.

Here is the call graph for this function:

◆ insertRow()

void QQmlTableModel::insertRow	(	int	rowIndex,
		const QVariant &	row
	)

\qmlmethod TableModel::insertRow(int rowIndex, object row)

Adds a new row to the list model at position rowIndex, with the values (cells) in row.

model.insertRow(2, {
    checkable: true, checked: false,
    amount: 1,
    fruitType: "Pear",
    fruitName: "Williams",
    fruitPrice: 1.50,
})

The rowIndex must be to an existing item in the list, or one past the end of the list (equivalent to \l appendRow()).

See also: appendRow(), setRow(), removeRow(), rowCount

Definition at line 404 of file qqmltablemodel.cpp.

◆ moveRow()

void QQmlTableModel::moveRow	(	int	fromRowIndex,
		int	toRowIndex,
		int	rows = `1`
	)

\qmlmethod TableModel::moveRow(int fromRowIndex, int toRowIndex, int rows)

Moves rows from the index at fromRowIndex to the index at toRowIndex.

The from and to ranges must exist; for example, to move the first 3 items to the end of the list:

model.moveRow(0, model.rowCount - 3, 3)

See also: appendRow(), insertRow(), removeRow(), rowCount

Definition at line 463 of file qqmltablemodel.cpp.

References QList< T >::append(), QList< T >::at(), QAbstractItemModel::beginMoveRows(), QAbstractItemModel::endMoveRows(), i, qCDebug, qmlWarning(), QList< T >::reserve(), rows, and QList< T >::size().

Here is the call graph for this function:

◆ removeRow()

void QQmlTableModel::removeRow	(	int	rowIndex,
		int	rows = `1`
	)

\qmlmethod TableModel::removeRow(int rowIndex, int rows = 1)

Removes a number of rows at rowIndex from the model.

See also: clear(), rowCount

Definition at line 534 of file qqmltablemodel.cpp.

References QList< T >::begin(), QAbstractItemModel::beginRemoveRows(), emit, QAbstractItemModel::endRemoveRows(), QList< T >::erase(), qCDebug, qmlWarning(), rowCountChanged(), and rows.

Here is the call graph for this function:

◆ roleNames()

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

overridevirtual

Since: 4.6

Returns the model's role names.

The default role names set by Qt are:

\table \header

Qt Role
QML Role Name \row
Qt::DisplayRole
display \row
Qt::DecorationRole
decoration \row
Qt::EditRole
edit \row
Qt::ToolTipRole
toolTip \row
Qt::StatusTipRole
statusTip \row
Qt::WhatsThisRole
whatsThis \endtable

Reimplemented from QAbstractItemModel.

Definition at line 907 of file qqmltablemodel.cpp.

◆ rowCount()

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

overridevirtual

\qmlproperty int TableModel::rowCount \readonly

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

This value changes whenever rows are added or removed from the model.

Implements QAbstractItemModel.

Definition at line 708 of file qqmltablemodel.cpp.

References QAbstractTableModel::parent().

Here is the call graph for this function:

◆ rowCountChanged

void QQmlTableModel::rowCountChanged ( )

signal

Referenced by removeRow().

Here is the caller graph for this function:

◆ rows()

QVariant QQmlTableModel::rows ( ) const

\qmlproperty object TableModel::rows

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

            rows: [
                {
                    // Each property is one cell/column.
                    checked: false,
                    amount: 1,
                    fruitType: "Apple",
                    fruitName: "Granny Smith",
                    fruitPrice: 1.50
                },
                {
                    checked: true,
                    amount: 4,
                    fruitType: "Orange",
                    fruitName: "Navel",
                    fruitPrice: 2.50
                },
                {
                    checked: false,
                    amount: 1,
                    fruitType: "Banana",
                    fruitName: "Cavendish",
                    fruitPrice: 3.50
                }
            ]

See also: getRow(), setRow(), moveRow(), appendRow(), insertRow(), clear(), rowCount, columnCount

Definition at line 152 of file qqmltablemodel.cpp.

◆ rowsChanged

void QQmlTableModel::rowsChanged ( )

signal

◆ setData() [1/2]

bool QQmlTableModel::setData	(	const QModelIndex &	index,
		const QString &	role,
		const QVariant &	value
	)

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

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

See also: index()

Definition at line 795 of file qqmltablemodel.cpp.

References QHash< Key, T >::key(), setData(), and QString::toUtf8().

Referenced by setData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setData() [2/2]

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

overridevirtual

Sets the role data for the item at index to value.

Returns {true} if successful; otherwise returns {false}.

The dataChanged() signal should be emitted if the data was successfully set.

The base class implementation returns {false}. This function and data() must be reimplemented for editable models.

See also: Qt::ItemDataRole, data(), itemData()

Reimplemented from QAbstractItemModel.

Definition at line 803 of file qqmltablemodel.cpp.

References QList< T >::append(), args, QList< T >::at(), columnCount, QVariant::convert(), QAbstractItemModel::dataChanged(), emit, engine, QString::fromUtf8(), qCDebug, qmlEngine(), qmlWarning(), roleData, rowCount, QQmlTableModelColumn::setterAtRole(), QVariant::toMap(), QJSEngine::toScriptValue(), and QHash< Key, T >::value().

Here is the call graph for this function:

◆ setRow()

void QQmlTableModel::setRow	(	int	rowIndex,
		const QVariant &	row
	)

\qmlmethod TableModel::setRow(int rowIndex, object row)

Changes the row at rowIndex in the model with row.

All columns/cells must be present in row, and in the correct order.

model.setRow(0, {
    checkable: true,
    amount: 1,
    fruitType: "Pear",
    fruitName: "Williams",
    fruitPrice: 1.50,
})

If rowIndex is equal to rowCount(), then a new row is appended to the model. Otherwise, rowIndex must point to an existing row in the model.

See also: appendRow(), insertRow(), rowCount

Definition at line 588 of file qqmltablemodel.cpp.

References QAbstractItemModel::createIndex(), QAbstractItemModel::dataChanged(), and emit.

Here is the call graph for this function:

◆ setRows()

void QQmlTableModel::setRows ( const QVariant & rows )

Definition at line 157 of file qqmltablemodel.cpp.

References qmlWarning(), rows, QVariant::toList(), QJSValue::toVariant(), QVariant::typeName(), QVariant::userType(), and QVariant::value().

Referenced by clear().

Here is the call graph for this function:

Here is the caller graph for this function:

Property Documentation

◆ columnCount

int QQmlTableModel::columnCount

read

Definition at line 141 of file qqmltablemodel_p.h.

Referenced by data(), index(), and setData().

◆ columns

QQmlListProperty< QQmlTableModelColumn > QQmlTableModel::columns

read

Definition at line 141 of file qqmltablemodel_p.h.

◆ rowCount

int QQmlTableModel::rowCount

read

Definition at line 141 of file qqmltablemodel_p.h.

Referenced by data(), index(), and setData().

◆ rows

QVariant QQmlTableModel::rows

readwrite

Definition at line 141 of file qqmltablemodel_p.h.

Referenced by moveRow(), removeRow(), and setRows().

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

qtdeclarative/src/labs/models/qqmltablemodel_p.h
qtdeclarative/src/labs/models/qqmltablemodel.cpp

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQmlTableModel()

◆ ~QQmlTableModel()

Member Function Documentation

◆ appendRow()

◆ classBegin()

◆ clear()

◆ columnCount()

◆ columnCountChanged

◆ columns()

◆ columns_append()

◆ columns_at()

◆ columns_clear()

◆ columns_count()

◆ columns_removeLast()

◆ columns_replace()

◆ componentComplete()

◆ data() [1/2]

◆ data() [2/2]

◆ flags()

◆ getRow()

◆ index()

◆ insertRow()

◆ moveRow()

◆ removeRow()

◆ roleNames()

◆ rowCount()

◆ rowCountChanged

◆ rows()

◆ rowsChanged

◆ setData() [1/2]

◆ setData() [2/2]

◆ setRow()

◆ setRows()

Property Documentation

◆ columnCount

◆ columns

◆ rowCount

◆ rows