\inmodule QtCore More...

#include <qabstractitemmodel.h>

Collaboration diagram for QPersistentModelIndex:

Public Member Functions
	QPersistentModelIndex ()

	QPersistentModelIndex (const QModelIndex &index)
	Creates a new QPersistentModelIndex that is a copy of the model index.

	QPersistentModelIndex (const QPersistentModelIndex &other)
	Creates a new QPersistentModelIndex that is a copy of the other persistent model index.

	~QPersistentModelIndex ()

QPersistentModelIndex &	operator= (const QPersistentModelIndex &other)
	Sets the persistent model index to refer to the same item in a model as the other persistent model index.

	QPersistentModelIndex (QPersistentModelIndex &&other) noexcept
	Move-constructs a QPersistentModelIndex instance, making it point at the same object that other was pointing to.

void	swap (QPersistentModelIndex &other) noexcept

QPersistentModelIndex &	operator= (const QModelIndex &other)
	Sets the persistent model index to refer to the same item in a model as the other model index.

	operator QModelIndex () const
	Cast operator that returns a QModelIndex.

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

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

void *	internalPointer () const

const void *	constInternalPointer () const

quintptr	internalId () const

QModelIndex	parent () const
	Returns the parent QModelIndex for this persistent index, or an invalid QModelIndex if it has no parent.

QModelIndex	sibling (int row, int column) const
	Returns the sibling at row and column or an invalid QModelIndex if there is no sibling at this position.

QVariant	data (int role=Qt::DisplayRole) const
	Returns the data for the given role for the item referred to by the index.

void	multiData (QModelRoleDataSpan roleDataSpan) const
	Populates the given roleDataSpan for the item referred to by the index.

Qt::ItemFlags	flags () const

const QAbstractItemModel *	model () const
	Returns the model that the index belongs to.

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

Friends
size_t	qHash (const QPersistentModelIndex &, size_t seed) noexcept

bool	qHashEquals (const QPersistentModelIndex &a, const QPersistentModelIndex &b) noexcept

Q_CORE_EXPORT bool	comparesEqual (const QPersistentModelIndex &lhs, const QPersistentModelIndex &rhs) noexcept

Q_CORE_EXPORT bool	comparesEqual (const QPersistentModelIndex &lhs, const QModelIndex &rhs) noexcept

Q_CORE_EXPORT Qt::strong_ordering	compareThreeWay (const QPersistentModelIndex &lhs, const QPersistentModelIndex &rhs) noexcept

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

Q_CORE_EXPORT QDebug	operator<< (QDebug, const QPersistentModelIndex &)

Related Symbols
(Note that these are not member symbols.)
size_t	qHash (const QPersistentModelIndex &index, size_t seed=0)

Detailed Description

\inmodule QtCore

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

\compares strong \compareswith strong QModelIndex \endcompareswith

A QPersistentModelIndex is a model index that can be stored by an application, and later used to access information in a model. Unlike the QModelIndex class, it is safe to store a QPersistentModelIndex since the model will ensure that references to items will continue to be valid as long as they can be accessed by the model.

It is good practice to check that persistent model indexes are valid before using them.

Note: You cannot store a QStandardItemModel's QPersistentModelIndex in one of the model's items.

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

Definition at line 174 of file qabstractitemmodel.h.

Constructor & Destructor Documentation

◆ QPersistentModelIndex() [1/4]

QPersistentModelIndex::QPersistentModelIndex ( )

Definition at line 335 of file qabstractitemmodel.cpp.

◆ QPersistentModelIndex() [2/4]

QPersistentModelIndex::QPersistentModelIndex ( const QModelIndex & index )

Creates a new QPersistentModelIndex that is a copy of the model index.

Definition at line 357 of file qabstractitemmodel.cpp.

References QPersistentModelIndexData::create(), QPersistentModelIndexData::ref, and QBasicAtomicInteger< T >::ref().

Here is the call graph for this function:

◆ QPersistentModelIndex() [3/4]

QPersistentModelIndex::QPersistentModelIndex ( const QPersistentModelIndex & other )

Creates a new QPersistentModelIndex that is a copy of the other persistent model index.

Definition at line 347 of file qabstractitemmodel.cpp.

References QPersistentModelIndexData::ref, and QBasicAtomicInteger< T >::ref().

Here is the call graph for this function:

◆ ~QPersistentModelIndex()

QPersistentModelIndex::~QPersistentModelIndex ( )

Definition at line 372 of file qabstractitemmodel.cpp.

References QBasicAtomicInteger< T >::deref(), QPersistentModelIndexData::destroy(), and QPersistentModelIndexData::ref.

Here is the call graph for this function:

◆ QPersistentModelIndex() [4/4]

QPersistentModelIndex::QPersistentModelIndex ( QPersistentModelIndex && other )

inlinenoexcept

Move-constructs a QPersistentModelIndex instance, making it point at the same object that other was pointing to.

Since: 5.2

Definition at line 188 of file qabstractitemmodel.h.

Member Function Documentation

◆ column()

int QPersistentModelIndex::column ( ) const

Returns the column this persistent model index refers to.

Definition at line 525 of file qabstractitemmodel.cpp.

References QModelIndex::column(), and QPersistentModelIndexData::index.

Referenced by QItemSelectionModelPrivate::columnsAboutToBeRemoved(), QDataWidgetMapperPrivate::currentIdx(), mergeIndexes(), mergeRowLengths(), QItemSelectionModelPrivate::rowsAboutToBeRemoved(), QTableViewPrivate::selectColumn(), and QItemSelectionModel::setCurrentIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ constInternalPointer()

const void * QPersistentModelIndex::constInternalPointer ( ) const

Since: 6.0

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

Definition at line 557 of file qabstractitemmodel.cpp.

References QModelIndex::constInternalPointer(), and QPersistentModelIndexData::index.

Here is the call graph for this function:

◆ data()

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

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

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

Definition at line 613 of file qabstractitemmodel.cpp.

References QModelIndex::data(), and QPersistentModelIndexData::index.

Here is the call graph for this function:

◆ flags()

Qt::ItemFlags QPersistentModelIndex::flags ( ) const

Since: 4.2

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

Definition at line 639 of file qabstractitemmodel.cpp.

References QModelIndex::flags(), and QPersistentModelIndexData::index.

Here is the call graph for this function:

◆ internalId()

quintptr QPersistentModelIndex::internalId ( ) const

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

Definition at line 573 of file qabstractitemmodel.cpp.

References QPersistentModelIndexData::index, and QModelIndex::internalId().

Here is the call graph for this function:

◆ internalPointer()

void * QPersistentModelIndex::internalPointer ( ) const

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

Definition at line 541 of file qabstractitemmodel.cpp.

References QPersistentModelIndexData::index, and QModelIndex::internalPointer().

Here is the call graph for this function:

◆ isValid()

bool QPersistentModelIndex::isValid ( ) const

Returns {true} if this persistent 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 668 of file qabstractitemmodel.cpp.

References QPersistentModelIndexData::index, and QModelIndex::isValid().

Referenced by QItemSelectionModelPrivate::columnsAboutToBeRemoved(), QQuickTableViewPrivate::columnsRemovedCallback(), QQuickTableViewPrivate::editFromKeyEvent(), QAbstractItemView::keyPressEvent(), mergeIndexes(), mergeRowLengths(), QTreeView::mouseDoubleClickEvent(), QQuickTableViewPrivate::processLoadRequest(), QQuickTableViewPrivate::processRebuildTable(), QComboBoxPrivate::returnPressed(), QItemSelectionModelPrivate::rowsAboutToBeRemoved(), QComboBoxPrivate::rowsInserted(), QComboBoxPrivate::rowsRemoved(), QQuickTableViewPrivate::rowsRemovedCallback(), and QQmlTreeModelToTableModel::setModel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ model()

const QAbstractItemModel * QPersistentModelIndex::model ( ) const

Returns the model that the index belongs to.

Definition at line 649 of file qabstractitemmodel.cpp.

References QPersistentModelIndexData::index, and QModelIndex::model().

Referenced by QQmlTreeModelToTableModel::setModel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ multiData()

void QPersistentModelIndex::multiData ( QModelRoleDataSpan roleDataSpan ) const

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

Since: 6.0

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

Definition at line 628 of file qabstractitemmodel.cpp.

References QPersistentModelIndexData::index, and QModelIndex::multiData().

Here is the call graph for this function:

◆ operator QModelIndex()

QPersistentModelIndex::operator QModelIndex ( ) const

Cast operator that returns a QModelIndex.

Definition at line 476 of file qabstractitemmodel.cpp.

References d.

◆ operator=() [1/2]

QPersistentModelIndex & QPersistentModelIndex::operator= ( const QModelIndex & other )

Sets the persistent model index to refer to the same item in a model as the other model index.

Definition at line 457 of file qabstractitemmodel.cpp.

References QPersistentModelIndexData::create(), QBasicAtomicInteger< T >::deref(), QPersistentModelIndexData::destroy(), other(), QPersistentModelIndexData::ref, and QBasicAtomicInteger< T >::ref().

Here is the call graph for this function:

◆ operator=() [2/2]

QPersistentModelIndex & QPersistentModelIndex::operator= ( const QPersistentModelIndex & other )

Sets the persistent model index to refer to the same item in a model as the other persistent model index.

Definition at line 434 of file qabstractitemmodel.cpp.

References QBasicAtomicInteger< T >::deref(), QPersistentModelIndexData::destroy(), other(), QPersistentModelIndexData::ref, and QBasicAtomicInteger< T >::ref().

Here is the call graph for this function:

◆ parent()

QModelIndex QPersistentModelIndex::parent ( ) const

Returns the parent QModelIndex for this persistent index, or an invalid QModelIndex if it has no parent.

See also: sibling(), model()

Definition at line 586 of file qabstractitemmodel.cpp.

References QPersistentModelIndexData::index, and QModelIndex::parent().

Referenced by QItemSelectionModelPrivate::columnsAboutToBeRemoved(), mergeIndexes(), mergeRowLengths(), QItemSelectionModelPrivate::rowsAboutToBeRemoved(), and QItemSelectionModel::setCurrentIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ row()

int QPersistentModelIndex::row ( ) const

Returns the row this persistent model index refers to.

Definition at line 512 of file qabstractitemmodel.cpp.

References QPersistentModelIndexData::index, and QModelIndex::row().

Referenced by QItemSelectionModelPrivate::columnsAboutToBeRemoved(), QDataWidgetMapperPrivate::currentIdx(), QComboBoxPrivate::dataChanged(), QComboBoxPrivate::itemSelected(), mergeIndexes(), mergeRowLengths(), QItemSelectionModelPrivate::rowsAboutToBeRemoved(), QComboBoxPrivate::rowsInserted(), QComboBoxPrivate::rowsRemoved(), QTableViewPrivate::selectRow(), QItemSelectionModel::setCurrentIndex(), and QComboBoxPrivate::updateIndexBeforeChange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sibling()

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

Returns the sibling at row and column or an invalid QModelIndex if there is no sibling at this position.

See also: parent()

Definition at line 600 of file qabstractitemmodel.cpp.

References QPersistentModelIndexData::index, and QModelIndex::sibling().

Referenced by mergeRowLengths().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ swap()

void QPersistentModelIndex::swap ( QPersistentModelIndex & other )

inlinenoexcept

Since: 5.0

Swaps this persistent modelindex with other. This function is very fast and never fails.

Definition at line 191 of file qabstractitemmodel.h.

References d, other(), and qt_ptr_swap().

Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ comparesEqual [1/2]

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

friend

Definition at line 499 of file qabstractitemmodel.cpp.

◆ comparesEqual [2/2]

Q_CORE_EXPORT bool comparesEqual	(	const QPersistentModelIndex &	lhs,
		const QPersistentModelIndex &	rhs )

friend

Definition at line 396 of file qabstractitemmodel.cpp.

◆ compareThreeWay [1/2]

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

friend

Definition at line 423 of file qabstractitemmodel.cpp.

◆ compareThreeWay [2/2]

Q_CORE_EXPORT Qt::strong_ordering compareThreeWay	(	const QPersistentModelIndex &	lhs,
		const QPersistentModelIndex &	rhs )

friend

Definition at line 413 of file qabstractitemmodel.cpp.

◆ operator<<

Q_CORE_EXPORT QDebug operator<<	(	QDebug	,
		const QPersistentModelIndex &	)

friend

Definition at line 682 of file qabstractitemmodel.cpp.

◆ qHash [1/2]

size_t qHash	(	const QPersistentModelIndex &	index,
		size_t	seed = 0 )

friend

Since: 5.0

Returns a hash of the QPersistentModelIndex index, using seed to seed the calculation.

Definition at line 233 of file qabstractitemmodel.h.

◆ qHash() [2/2]

size_t qHash	(	const QPersistentModelIndex &	index,
		size_t	seed = 0 )

Since: 5.0

Returns a hash of the QPersistentModelIndex index, using seed to seed the calculation.

Definition at line 233 of file qabstractitemmodel.h.

◆ qHashEquals

bool qHashEquals	(	const QPersistentModelIndex &	a,
		const QPersistentModelIndex &	b )

friend

Definition at line 213 of file qabstractitemmodel.h.

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

qtbase/src/corelib/itemmodels/qabstractitemmodel.h (cbda9583521633fa6e8a9274d2e47aa14c8bd175)
qtbase/src/corelib/itemmodels/qabstractitemmodel.cpp (cbda9583521633fa6e8a9274d2e47aa14c8bd175)

Public Member Functions

Friends

Related Symbols

Detailed Description

Constructor & Destructor Documentation

◆ QPersistentModelIndex() [1/4]

◆ QPersistentModelIndex() [2/4]

◆ QPersistentModelIndex() [3/4]

◆ ~QPersistentModelIndex()

◆ QPersistentModelIndex() [4/4]

Member Function Documentation

◆ column()

◆ constInternalPointer()

◆ data()

◆ flags()

◆ internalId()

◆ internalPointer()

◆ isValid()

◆ model()

◆ multiData()

◆ operator QModelIndex()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ parent()

◆ row()

◆ sibling()

◆ swap()

Friends And Related Symbol Documentation

◆ comparesEqual [1/2]

◆ comparesEqual [2/2]

◆ compareThreeWay [1/2]

◆ compareThreeWay [2/2]

◆ operator<<

◆ qHash [1/2]

◆ qHash() [2/2]

◆ qHashEquals