The QAbstractProxyModel class provides a base class for proxy item models that can do sorting, filtering or other data processing tasks.\inmodule QtCore. More...

#include <qabstractproxymodel.h>

Inheritance diagram for QAbstractProxyModel:

Collaboration diagram for QAbstractProxyModel:

Signals
void	sourceModelChanged (QPrivateSignal)

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
	QAbstractProxyModel (QObject *parent=nullptr)
	Constructs a proxy model with the given parent.

	~QAbstractProxyModel ()
	Destroys the proxy model.

virtual void	setSourceModel (QAbstractItemModel *sourceModel)
	Sets the given sourceModel to be processed by the proxy model.

QAbstractItemModel *	sourceModel () const
	Returns the model that contains the data that is available through the proxy model.

QBindable< QAbstractItemModel * >	bindableSourceModel ()

virtual Q_INVOKABLE QModelIndex	mapToSource (const QModelIndex &proxyIndex) const =0
	Reimplement this function to return the model index in the source model that corresponds to the proxyIndex in the proxy model.

virtual Q_INVOKABLE QModelIndex	mapFromSource (const QModelIndex &sourceIndex) const =0
	Reimplement this function to return the model index in the proxy model that corresponds to the sourceIndex from the source model.

virtual Q_INVOKABLE QItemSelection	mapSelectionToSource (const QItemSelection &selection) const
	Returns a source selection mapped from the specified proxySelection.

virtual Q_INVOKABLE QItemSelection	mapSelectionFromSource (const QItemSelection &selection) const
	Returns a proxy selection mapped from the specified sourceSelection.

bool	submit () override
	\reimp

void	revert () override
	\reimp

QVariant	data (const QModelIndex &proxyIndex, int role=Qt::DisplayRole) const override
	\reimp

QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override
	\reimp

QMap< int, QVariant >	itemData (const QModelIndex &index) const override
	\reimp

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

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

bool	setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles) override
	\reimp

bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role=Qt::EditRole) override
	\reimp

bool	clearItemData (const QModelIndex &index) override
	\reimp

QModelIndex	buddy (const QModelIndex &index) const override
	\reimp

bool	canFetchMore (const QModelIndex &parent) const override
	\reimp

void	fetchMore (const QModelIndex &parent) override
	\reimp

void	sort (int column, Qt::SortOrder order=Qt::AscendingOrder) override
	\reimp

QSize	span (const QModelIndex &index) const override
	\reimp

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

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

QMimeData *	mimeData (const QModelIndexList &indexes) const override
	\reimp

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

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

QStringList	mimeTypes () const override
	\reimp

Qt::DropActions	supportedDragActions () const override
	\reimp

Qt::DropActions	supportedDropActions () const override
	\reimp

QHash< int, QByteArray >	roleNames () const override
	\reimp

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

Protected Member Functions
QModelIndex	createSourceIndex (int row, int col, void *internalPtr) const
	Equivalent to calling createIndex on the source model.

	QAbstractProxyModel (QAbstractProxyModelPrivate &, 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
QAbstractItemModel *	sourceModel
	the source model of this proxy model.

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

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

The QAbstractProxyModel class provides a base class for proxy item models that can do sorting, filtering or other data processing tasks.

\inmodule QtCore.

Since: 4.1

This class defines the standard interface that proxy models must use to be able to interoperate correctly with other model/view components. It is not supposed to be instantiated directly.

All standard proxy models are derived from the QAbstractProxyModel class. If you need to create a new proxy model class, it is usually better to subclass an existing class that provides the closest behavior to the one you want to provide.

Proxy models that filter or sort items of data from a source model should be created by using or subclassing QSortFilterProxyModel.

To subclass QAbstractProxyModel, you need to implement mapFromSource() and mapToSource(). The mapSelectionFromSource() and mapSelectionToSource() functions only need to be reimplemented if you need a behavior different from the default behavior.

Note: If the source model is deleted or no source model is specified, the proxy model operates on a empty placeholder model.

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

Definition at line 16 of file qabstractproxymodel.h.

Constructor & Destructor Documentation

◆ QAbstractProxyModel() [1/2]

QAbstractProxyModel::QAbstractProxyModel ( QObject * parent = nullptr )

explicit

Constructs a proxy model with the given parent.

Definition at line 132 of file qabstractproxymodel.cpp.

References setSourceModel(), and QAbstractItemModelPrivate::staticEmptyModel().

Here is the call graph for this function:

◆ ~QAbstractProxyModel()

QAbstractProxyModel::~QAbstractProxyModel ( )

Destroys the proxy model.

Definition at line 151 of file qabstractproxymodel.cpp.

◆ QAbstractProxyModel() [2/2]

QAbstractProxyModel::QAbstractProxyModel	(	QAbstractProxyModelPrivate &	dd,
		QObject *	parent
	)

protected

Definition at line 142 of file qabstractproxymodel.cpp.

References setSourceModel(), and QAbstractItemModelPrivate::staticEmptyModel().

Here is the call graph for this function:

Member Function Documentation

◆ bindableSourceModel()

QBindable< QAbstractItemModel * > QAbstractProxyModel::bindableSourceModel ( )

Definition at line 214 of file qabstractproxymodel.cpp.

References d.

◆ buddy()

QModelIndex QAbstractProxyModel::buddy ( const QModelIndex & index ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Reimplemented in QSortFilterProxyModel.

Definition at line 389 of file qabstractproxymodel.cpp.

References d, mapFromSource(), and mapToSource().

Here is the call graph for this function:

◆ canDropMimeData()

bool QAbstractProxyModel::canDropMimeData	(	const QMimeData *	data,
		Qt::DropAction	action,
		int	row,
		int	column,
		const QModelIndex &	parent
	)		const

overridevirtual

\reimp

Since: 5.4

Reimplemented from QAbstractItemModel.

Definition at line 485 of file qabstractproxymodel.cpp.

References d, and QAbstractItemModel::parent.

◆ canFetchMore()

bool QAbstractProxyModel::canFetchMore ( const QModelIndex & parent ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Reimplemented in QSortFilterProxyModel.

Definition at line 398 of file qabstractproxymodel.cpp.

References d, mapToSource(), and QAbstractItemModel::parent.

Here is the call graph for this function:

◆ clearItemData()

bool QAbstractProxyModel::clearItemData ( const QModelIndex & index )

overridevirtual

\reimp

Since: 6.0

Reimplemented from QAbstractItemModel.

Definition at line 380 of file qabstractproxymodel.cpp.

References d, and mapToSource().

Here is the call graph for this function:

◆ createSourceIndex()

QModelIndex QAbstractProxyModel::createSourceIndex	(	int	row,
		int	col,
		void *	internalPtr
	)		const

protected

Equivalent to calling createIndex on the source model.

This method is useful if your proxy model wants to maintain the parent-child relationship of items in the source model. When reimplementing mapToSource(), you can call this method to create an index for row row and column col of the source model.

A typical use would be to save the internal pointer coming from the source model in the proxy index when reimplementing mapFromSource() and use the same internal pointer as internalPtr to recover the original source index when reimplementing mapToSource().

Since: 6.2

Definition at line 561 of file qabstractproxymodel.cpp.

References QAbstractItemModel::createIndex(), and sourceModel.

Referenced by QIdentityProxyModel::mapToSource().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ data()

QVariant QAbstractProxyModel::data	(	const QModelIndex &	proxyIndex,
		int	role = `Qt::DisplayRole`
	)		const

overridevirtual

\reimp

Implements QAbstractItemModel.

Reimplemented in QSortFilterProxyModel, and QCompletionModel.

Definition at line 296 of file qabstractproxymodel.cpp.

References d, and mapToSource().

Here is the call graph for this function:

◆ dropMimeData()

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

overridevirtual

\reimp

Since: 5.4

Reimplemented from QAbstractItemModel.

Reimplemented in QIdentityProxyModel, and QSortFilterProxyModel.

Definition at line 500 of file qabstractproxymodel.cpp.

References d, and QAbstractItemModel::parent.

Referenced by QSortFilterProxyModel::dropMimeData().

Here is the caller graph for this function:

◆ fetchMore()

void QAbstractProxyModel::fetchMore ( const QModelIndex & parent )

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Reimplemented in QSortFilterProxyModel.

Definition at line 407 of file qabstractproxymodel.cpp.

References d, mapToSource(), and QAbstractItemModel::parent.

Here is the call graph for this function:

◆ flags()

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

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Reimplemented in QSortFilterProxyModel.

Definition at line 335 of file qabstractproxymodel.cpp.

References d, and mapToSource().

Here is the call graph for this function:

◆ hasChildren()

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

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Reimplemented in QSortFilterProxyModel, and QCompletionModel.

Definition at line 434 of file qabstractproxymodel.cpp.

References d, mapToSource(), and QAbstractItemModel::parent.

Here is the call graph for this function:

◆ headerData()

QVariant QAbstractProxyModel::headerData	(	int	section,
		Qt::Orientation	orientation,
		int	role = `Qt::DisplayRole`
	)		const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Reimplemented in QIdentityProxyModel, QSortFilterProxyModel, and QTransposeProxyModel.

Definition at line 305 of file qabstractproxymodel.cpp.

References QModelIndex::column(), QAbstractItemModel::columnCount(), d, Qt::Horizontal, mapToSource(), QModelIndex::row(), and QAbstractItemModel::rowCount().

Referenced by QSortFilterProxyModel::headerData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ itemData()

QMap< int, QVariant > QAbstractProxyModel::itemData ( const QModelIndex & index ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Reimplemented in QTransposeProxyModel.

Definition at line 326 of file qabstractproxymodel.cpp.

References d, and mapToSource().

Here is the call graph for this function:

◆ mapFromSource()

QModelIndex QAbstractProxyModel::mapFromSource ( const QModelIndex & sourceIndex ) const

pure virtual

Reimplement this function to return the model index in the proxy model that corresponds to the sourceIndex from the source model.

See also: mapToSource()

Implemented in QIdentityProxyModel, QSortFilterProxyModel, QTransposeProxyModel, and QCompletionModel.

Referenced by buddy(), and mapSelectionFromSource().

Here is the caller graph for this function:

◆ mapSelectionFromSource()

QItemSelection QAbstractProxyModel::mapSelectionFromSource ( const QItemSelection & sourceSelection ) const

virtual

Returns a proxy selection mapped from the specified sourceSelection.

Reimplement this method to map source selections to proxy selections.

Reimplemented in QIdentityProxyModel, and QSortFilterProxyModel.

Definition at line 280 of file qabstractproxymodel.cpp.

References QList< T >::at(), i, QItemSelection::indexes(), QModelIndex::isValid(), mapFromSource(), and QList< T >::size().

Referenced by QSortFilterProxyModel::mapSelectionFromSource().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mapSelectionToSource()

QItemSelection QAbstractProxyModel::mapSelectionToSource ( const QItemSelection & proxySelection ) const

virtual

Returns a source selection mapped from the specified proxySelection.

Reimplement this method to map proxy selections to source selections.

Reimplemented in QSortFilterProxyModel, and QIdentityProxyModel.

Definition at line 262 of file qabstractproxymodel.cpp.

References QList< T >::at(), i, QItemSelection::indexes(), QModelIndex::isValid(), mapToSource(), and QList< T >::size().

Referenced by QSortFilterProxyModel::mapSelectionToSource().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mapToSource()

QModelIndex QAbstractProxyModel::mapToSource ( const QModelIndex & proxyIndex ) const

pure virtual

Reimplement this function to return the model index in the source model that corresponds to the proxyIndex in the proxy model.

See also: mapFromSource()

Implemented in QIdentityProxyModel, QSortFilterProxyModel, QTransposeProxyModel, and QCompletionModel.

Referenced by buddy(), canFetchMore(), clearItemData(), data(), fetchMore(), flags(), hasChildren(), headerData(), itemData(), mapSelectionToSource(), mimeData(), setData(), setHeaderData(), setItemData(), and span().

Here is the caller graph for this function:

◆ mimeData()

QMimeData * QAbstractProxyModel::mimeData ( const QModelIndexList & indexes ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Reimplemented in QSortFilterProxyModel.

Definition at line 451 of file qabstractproxymodel.cpp.

References d, list, mapToSource(), QList< T >::reserve(), and QList< T >::size().

Here is the call graph for this function:

◆ mimeTypes()

QStringList QAbstractProxyModel::mimeTypes ( ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Reimplemented in QSortFilterProxyModel.

Definition at line 514 of file qabstractproxymodel.cpp.

References d.

◆ revert()

void QAbstractProxyModel::revert ( )

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 232 of file qabstractproxymodel.cpp.

References d.

◆ roleNames()

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

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 541 of file qabstractproxymodel.cpp.

References d.

◆ setData()

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

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Reimplemented in QSortFilterProxyModel.

Definition at line 344 of file qabstractproxymodel.cpp.

References d, and mapToSource().

Here is the call graph for this function:

◆ setHeaderData()

bool QAbstractProxyModel::setHeaderData	(	int	section,
		Qt::Orientation	orientation,
		const QVariant &	value,
		int	role = `Qt::EditRole`
	)

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Reimplemented in QSortFilterProxyModel, and QTransposeProxyModel.

Definition at line 362 of file qabstractproxymodel.cpp.

References QModelIndex::column(), d, Qt::Horizontal, mapToSource(), and QModelIndex::row().

Referenced by QSortFilterProxyModel::setHeaderData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setItemData()

bool QAbstractProxyModel::setItemData	(	const QModelIndex &	index,
		const QMap< int, QVariant > &	roles
	)

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Reimplemented in QTransposeProxyModel.

Definition at line 353 of file qabstractproxymodel.cpp.

References d, and mapToSource().

Here is the call graph for this function:

◆ setSourceModel()

void QAbstractProxyModel::setSourceModel ( QAbstractItemModel * sourceModel )

virtual

Sets the given sourceModel to be processed by the proxy model.

Subclasses should call beginResetModel() at the beginning of the method, disconnect from the old model, call this method, connect to the new model, and call endResetModel().

Reimplemented in QTransposeProxyModel, QIdentityProxyModel, QSortFilterProxyModel, and QCompletionModel.

Definition at line 163 of file qabstractproxymodel.cpp.

References QAbstractItemModel::columnsAboutToBeInserted(), QAbstractItemModel::columnsInserted(), QAbstractItemModel::columnsRemoved(), QObject::connect(), d, QObject::destroyed(), disconnect(), QAbstractItemModel::rowsAboutToBeInserted(), QAbstractItemModel::rowsInserted(), QAbstractItemModel::rowsRemoved(), SIGNAL, SLOT, sourceModel, and QAbstractItemModelPrivate::staticEmptyModel().

Referenced by QAbstractProxyModel(), QAbstractProxyModel(), QCompletionModel::modelDestroyed(), QTransposeProxyModel::setSourceModel(), QIdentityProxyModel::setSourceModel(), QSortFilterProxyModel::setSourceModel(), and QCompletionModel::setSourceModel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sibling()

QModelIndex QAbstractProxyModel::sibling	(	int	row,
		int	column,
		const QModelIndex &	idx
	)		const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Reimplemented in QIdentityProxyModel, and QSortFilterProxyModel.

Definition at line 443 of file qabstractproxymodel.cpp.

References QModelIndex::parent().

Here is the call graph for this function:

◆ sort()

void QAbstractProxyModel::sort	(	int	column,
		Qt::SortOrder	order = `Qt::AscendingOrder`
	)

override

\reimp

Definition at line 416 of file qabstractproxymodel.cpp.

References d.

◆ sourceModel()

QAbstractItemModel * QAbstractProxyModel::sourceModel ( ) const

Returns the model that contains the data that is available through the proxy model.

Definition at line 206 of file qabstractproxymodel.cpp.

References d, and QAbstractItemModelPrivate::staticEmptyModel().

Here is the call graph for this function:

◆ sourceModelChanged

void QAbstractProxyModel::sourceModelChanged ( QPrivateSignal )

signal

◆ span()

QSize QAbstractProxyModel::span ( const QModelIndex & index ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Reimplemented in QSortFilterProxyModel, and QTransposeProxyModel.

Definition at line 425 of file qabstractproxymodel.cpp.

References d, and mapToSource().

Here is the call graph for this function:

◆ submit()

bool QAbstractProxyModel::submit ( )

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 223 of file qabstractproxymodel.cpp.

References d.

◆ supportedDragActions()

Qt::DropActions QAbstractProxyModel::supportedDragActions ( ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 523 of file qabstractproxymodel.cpp.

References d.

◆ supportedDropActions()

Qt::DropActions QAbstractProxyModel::supportedDropActions ( ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Reimplemented in QSortFilterProxyModel.

Definition at line 532 of file qabstractproxymodel.cpp.

References d.

Property Documentation

◆ sourceModel

QAbstractProxyModel::sourceModel

readwrite

the source model of this proxy model.

Definition at line 86 of file qabstractproxymodel.h.

Referenced by QCompleterPrivate::_q_complete(), createSourceIndex(), DateFormatProxyModel::data(), setSourceModel(), QIdentityProxyModel::setSourceModel(), QSortFilterProxyModel::setSourceModel(), and QCompletionModel::setSourceModel().

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

qtbase/src/corelib/itemmodels/qabstractproxymodel.h
qtbase/src/corelib/itemmodels/qabstractproxymodel.cpp

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QAbstractProxyModel() [1/2]

◆ ~QAbstractProxyModel()

◆ QAbstractProxyModel() [2/2]

Member Function Documentation

◆ bindableSourceModel()

◆ buddy()

◆ canDropMimeData()

◆ canFetchMore()

◆ clearItemData()

◆ createSourceIndex()

◆ data()

◆ dropMimeData()

◆ fetchMore()

◆ flags()

◆ hasChildren()

◆ headerData()

◆ itemData()

◆ mapFromSource()

◆ mapSelectionFromSource()

◆ mapSelectionToSource()

◆ mapToSource()

◆ mimeData()

◆ mimeTypes()

◆ revert()

◆ roleNames()

◆ setData()

◆ setHeaderData()

◆ setItemData()

◆ setSourceModel()

◆ sibling()

◆ sort()

◆ sourceModel()

◆ sourceModelChanged

◆ span()

◆ submit()

◆ supportedDragActions()

◆ supportedDropActions()

Property Documentation

◆ sourceModel