\inmodule QtCore More...

#include <qabstractitemmodel.h>

Collaboration diagram for QModelIndex:

Public Member Functions
constexpr	QModelIndex () noexcept
	Creates a new empty model index.

constexpr int	row () const noexcept
	Returns the row this model index refers to.

constexpr int	column () const noexcept
	Returns the column this model index refers to.

constexpr quintptr	internalId () const noexcept
	Returns a {quintptr} used by the model to associate the index with the internal data structure.

void *	internalPointer () const noexcept
	Returns a {void} {*} pointer used by the model to associate the index with the internal data structure.

const void *	constInternalPointer () const noexcept
	Returns a {const void} {*} pointer used by the model to associate the index with the internal data structure.

QModelIndex	parent () const
	Returns the parent of the model index, or QModelIndex() if it has no parent.

QModelIndex	sibling (int row, int column) const
	Returns the sibling at row and column.

QModelIndex	siblingAtColumn (int column) const
	Returns the sibling at column for the current row.

QModelIndex	siblingAtRow (int row) const
	Returns the sibling at row for the current column.

QVariant	data (int role=Qt::DisplayRole) const
	Returns the data for the given role for the item referred to by the index, or a default-constructed QVariant if this model index is \l{isValid()}{invalid}.

void	multiData (QModelRoleDataSpan roleDataSpan) const

Qt::ItemFlags	flags () const

constexpr const QAbstractItemModel *	model () const noexcept
	Returns a pointer to the model containing the item that this index refers to.

constexpr bool	isValid () const noexcept
	Returns {true} if this model index is valid; otherwise returns {false}.

Friends
class	QAbstractItemModel

constexpr bool	comparesEqual (const QModelIndex &lhs, const QModelIndex &rhs) noexcept

constexpr Qt::strong_ordering	compareThreeWay (const QModelIndex &lhs, const QModelIndex &rhs) noexcept

Related Symbols
(Note that these are not member symbols.)
	QModelIndexList
	Synonym for QList<QModelIndex>.

Detailed Description

\inmodule QtCore

The QModelIndex class is used to locate data in a data model.

\compares strong

This class is used as an index into item models derived from QAbstractItemModel. The index is used by item views, delegates, and selection models to locate an item in the model.

New QModelIndex objects are created by the model using the QAbstractItemModel::createIndex() function. An invalid model index can be constructed with the QModelIndex constructor. Invalid indexes are often used as parent indexes when referring to top-level items in a model.

Model indexes refer to items in models, and contain all the information required to specify their locations in those models. Each index is located in a given row and column, and may have a parent index; use row(), column(), and parent() to obtain this information. Each top-level item in a model is represented by a model index that does not have a parent index - in this case, parent() will return an invalid model index, equivalent to an index constructed with the zero argument form of the QModelIndex() constructor.

To obtain a model index that refers to an existing item in a model, call QAbstractItemModel::index() with the required row and column values, and the model index of the parent. When referring to top-level items in a model, supply QModelIndex() as the parent index.

The model() function returns the model that the index references as a QAbstractItemModel. The child() function is used to examine items held under the index in the model. The sibling() function allows you to traverse items in the model on the same level as the index.

Note: Model indexes should be used immediately and then discarded. You should not rely on indexes to remain valid after calling model functions that change the structure of the model or delete items. If you need to keep a model index over time use a QPersistentModelIndex.

See also: {Model/View Programming}, QPersistentModelIndex, QAbstractItemModel

Definition at line 124 of file qabstractitemmodel.h.

Constructor & Destructor Documentation

◆ QModelIndex()

QModelIndex::QModelIndex ( )

inlineconstexprnoexcept

Creates a new empty model index.

This type of model index is used to indicate that the position in the model is invalid.

See also: isValid(), QAbstractItemModel

Definition at line 128 of file qabstractitemmodel.h.

Referenced by QtPrivate::QCalendarModel::setHorizontalHeaderFormat(), and QtPrivate::QCalendarModel::setWeekNumbersShown().

Here is the caller graph for this function:

Member Function Documentation

◆ column()

int QModelIndex::column ( ) const

inlineconstexprnoexcept

Returns the column this model index refers to.

Definition at line 131 of file qabstractitemmodel.h.

Referenced by testing.tools.encode_pdf_filter._Ascii85DecodePdfStream::close().

Here is the caller graph for this function:

◆ constInternalPointer()

const void * QModelIndex::constInternalPointer ( ) const

inlinenoexcept

Returns a {const void} {*} pointer used by the model to associate the index with the internal data structure.

See also: QAbstractItemModel::createIndex()

Definition at line 134 of file qabstractitemmodel.h.

◆ data()

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

inline

Returns the data for the given role for the item referred to by the index, or a default-constructed QVariant if this model index is \l{isValid()}{invalid}.

Definition at line 517 of file qabstractitemmodel.h.

◆ flags()

Qt::ItemFlags QModelIndex::flags ( ) const

inline

Since: 4.2

Returns the flags for the item referred to by the index.

Definition at line 523 of file qabstractitemmodel.h.

◆ internalId()

quintptr QModelIndex::internalId ( ) const

inlineconstexprnoexcept

Returns a {quintptr} used by the model to associate the index with the internal data structure.

See also: QAbstractItemModel::createIndex()

Definition at line 132 of file qabstractitemmodel.h.

◆ internalPointer()

void * QModelIndex::internalPointer ( ) const

inlinenoexcept

Returns a {void} {*} pointer used by the model to associate the index with the internal data structure.

See also: QAbstractItemModel::createIndex()

Definition at line 133 of file qabstractitemmodel.h.

Referenced by operator<<().

Here is the caller graph for this function:

◆ isValid()

bool QModelIndex::isValid ( ) const

inlineconstexprnoexcept

Returns {true} if this model index is valid; otherwise returns {false}.

A valid index belongs to a model, and has non-negative row and column numbers.

See also: model(), row(), column()

Definition at line 143 of file qabstractitemmodel.h.

◆ model()

const QAbstractItemModel * QModelIndex::model ( ) const

inlineconstexprnoexcept

Returns a pointer to the model containing the item that this index refers to.

A const pointer to the model is returned because calls to non-const functions of the model might invalidate the model index and possibly crash your application.

Definition at line 142 of file qabstractitemmodel.h.

◆ multiData()

void QModelIndex::multiData ( QModelRoleDataSpan roleDataSpan ) const

inline

Since: 6.0

Populates the given roleDataSpan for the item referred to by the index.

Definition at line 520 of file qabstractitemmodel.h.

◆ parent()

QModelIndex QModelIndex::parent ( ) const

inline

Returns the parent of the model index, or QModelIndex() if it has no parent.

See also: sibling(), model()

Definition at line 505 of file qabstractitemmodel.h.

◆ row()

int QModelIndex::row ( ) const

inlineconstexprnoexcept

Returns the row this model index refers to.

Definition at line 130 of file qabstractitemmodel.h.

◆ sibling()

QModelIndex QModelIndex::sibling	(	int	row,
		int	column ) const

inline

Returns the sibling at row and column.

If there is no sibling at this position, an invalid QModelIndex is returned.

See also: parent(), siblingAtColumn(), siblingAtRow()

Definition at line 508 of file qabstractitemmodel.h.

◆ siblingAtColumn()

QModelIndex QModelIndex::siblingAtColumn ( int column ) const

inline

Returns the sibling at column for the current row.

If there is no sibling at this position, an invalid QModelIndex is returned.

See also: sibling(), siblingAtRow()

Since: 5.11

Definition at line 511 of file qabstractitemmodel.h.

◆ siblingAtRow()

QModelIndex QModelIndex::siblingAtRow ( int row ) const

inline

Returns the sibling at row for the current column.

If there is no sibling at this position, an invalid QModelIndex is returned.

See also: sibling(), siblingAtColumn()

Since: 5.11

Definition at line 514 of file qabstractitemmodel.h.

Friends And Related Symbol Documentation

◆ comparesEqual

bool comparesEqual	(	const QModelIndex &	lhs,
		const QModelIndex &	rhs )

friend

Definition at line 146 of file qabstractitemmodel.h.

◆ compareThreeWay

Qt::strong_ordering compareThreeWay	(	const QModelIndex &	lhs,
		const QModelIndex &	rhs )

friend

Definition at line 150 of file qabstractitemmodel.h.

◆ QAbstractItemModel

friend class QAbstractItemModel

friend

Definition at line 126 of file qabstractitemmodel.h.

◆ QModelIndexList()

QModelIndexList

Definition at line 250 of file qabstractitemmodel.h.

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

qtbase/src/corelib/itemmodels/qabstractitemmodel.h (564f2cbbddbca3f118198f0fb4ca0a97b95b8a59)
qtbase/src/corelib/itemmodels/qabstractitemmodel.cpp (5627e113793df3df24742d7af502a075c2c9e95d)

Public Member Functions

Friends

Related Symbols

Detailed Description

Constructor & Destructor Documentation

◆ QModelIndex()

Member Function Documentation

◆ column()

◆ constInternalPointer()

◆ data()

◆ flags()

◆ internalId()

◆ internalPointer()

◆ isValid()

◆ model()

◆ multiData()

◆ parent()

◆ row()

◆ sibling()

◆ siblingAtColumn()

◆ siblingAtRow()

Friends And Related Symbol Documentation

◆ comparesEqual

◆ compareThreeWay

◆ QAbstractItemModel

◆ QModelIndexList()