QAbstractProxyModel Class

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

Header: #include <QAbstractProxyModel>
Since: Qt 4.1
Inherits: QAbstractItemModel.
Inherited By:

QIdentityProxyModel and QSortFilterProxyModel.

Public Functions

QAbstractProxyModel(QObject * parent = 0)
~QAbstractProxyModel()
virtual QModelIndex mapFromSource(const QModelIndex & sourceIndex) const = 0
virtual QItemSelection mapSelectionFromSource(const QItemSelection & sourceSelection) const
virtual QItemSelection mapSelectionToSource(const QItemSelection & proxySelection) const
virtual QModelIndex mapToSource(const QModelIndex & proxyIndex) const = 0
virtual void setSourceModel(QAbstractItemModel * sourceModel)
QAbstractItemModel * sourceModel() const

Reimplemented Public Functions

virtual QModelIndex buddy(const QModelIndex & index) const
virtual bool canFetchMore(const QModelIndex & parent) const
virtual QVariant data(const QModelIndex & proxyIndex, int role = Qt::DisplayRole) const
virtual void fetchMore(const QModelIndex & parent)
virtual Qt::ItemFlags flags(const QModelIndex & index) const
virtual bool hasChildren(const QModelIndex & parent = QModelIndex()) const
virtual QVariant headerData(int section, Qt::Orientation orientation, int role) const
virtual QMap<int, QVariant> itemData(const QModelIndex & proxyIndex) const
virtual QMimeData * mimeData(const QModelIndexList & indexes) const
virtual QStringList mimeTypes() const
virtual void revert()
virtual bool setData(const QModelIndex & index, const QVariant & value, int role = Qt::EditRole)
virtual bool setHeaderData(int section, Qt::Orientation orientation, const QVariant & value, int role = Qt::EditRole)
virtual bool setItemData(const QModelIndex & index, const QMap<int, QVariant> & roles)
virtual void sort(int column, Qt::SortOrder order = Qt::AscendingOrder)
virtual QSize span(const QModelIndex & index) const
virtual bool submit()
virtual Qt::DropActions supportedDropActions() const

Additional Inherited Members

Detailed Description

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

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, and Model/View Programming.

Member Function Documentation

QAbstractProxyModel::QAbstractProxyModel(QObject * parent = 0)

Constructs a proxy model with the given parent.

QAbstractProxyModel::~QAbstractProxyModel()

Destroys the proxy model.

[virtual] QModelIndex QAbstractProxyModel::buddy(const QModelIndex & index) const

Reimplemented from QAbstractItemModel::buddy().

This function was introduced in Qt 4.8.

[virtual] bool QAbstractProxyModel::canFetchMore(const QModelIndex & parent) const

Reimplemented from QAbstractItemModel::canFetchMore().

This function was introduced in Qt 4.8.

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

Reimplemented from QAbstractItemModel::data().

See also setData().

[virtual] void QAbstractProxyModel::fetchMore(const QModelIndex & parent)

Reimplemented from QAbstractItemModel::fetchMore().

This function was introduced in Qt 4.8.

[virtual] Qt::ItemFlags QAbstractProxyModel::flags(const QModelIndex & index) const

Reimplemented from QAbstractItemModel::flags().

[virtual] bool QAbstractProxyModel::hasChildren(const QModelIndex & parent = QModelIndex()) const

Reimplemented from QAbstractItemModel::hasChildren().

This function was introduced in Qt 4.8.

[virtual] QVariant QAbstractProxyModel::headerData(int section, Qt::Orientation orientation, int role) const

Reimplemented from QAbstractItemModel::headerData().

See also setHeaderData().

[virtual] QMap<int, QVariant> QAbstractProxyModel::itemData(const QModelIndex & proxyIndex) const

Reimplemented from QAbstractItemModel::itemData().

See also setItemData().

[pure virtual] QModelIndex QAbstractProxyModel::mapFromSource(const QModelIndex & sourceIndex) const

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

See also mapToSource().

[virtual] QItemSelection QAbstractProxyModel::mapSelectionFromSource(const QItemSelection & sourceSelection) const

Returns a proxy selection mapped from the specified sourceSelection.

Reimplement this method to map source selections to proxy selections.

[virtual] QItemSelection QAbstractProxyModel::mapSelectionToSource(const QItemSelection & proxySelection) const

Returns a source selection mapped from the specified proxySelection.

Reimplement this method to map proxy selections to source selections.

[pure virtual] QModelIndex QAbstractProxyModel::mapToSource(const QModelIndex & proxyIndex) const

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

See also mapFromSource().

[virtual] QMimeData * QAbstractProxyModel::mimeData(const QModelIndexList & indexes) const

Reimplemented from QAbstractItemModel::mimeData().

This function was introduced in Qt 4.8.

[virtual] QStringList QAbstractProxyModel::mimeTypes() const

Reimplemented from QAbstractItemModel::mimeTypes().

This function was introduced in Qt 4.8.

[virtual] void QAbstractProxyModel::revert()

Reimplemented from QAbstractItemModel::revert().

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

Reimplemented from QAbstractItemModel::setData().

See also data().

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

Reimplemented from QAbstractItemModel::setHeaderData().

See also headerData().

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

Reimplemented from QAbstractItemModel::setItemData().

See also itemData().

[virtual] void QAbstractProxyModel::setSourceModel(QAbstractItemModel * sourceModel)

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

See also sourceModel().

[virtual] void QAbstractProxyModel::sort(int column, Qt::SortOrder order = Qt::AscendingOrder)

Reimplemented from QAbstractItemModel::sort().

This function was introduced in Qt 4.8.

QAbstractItemModel * QAbstractProxyModel::sourceModel() const

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

See also setSourceModel().

[virtual] QSize QAbstractProxyModel::span(const QModelIndex & index) const

Reimplemented from QAbstractItemModel::span().

This function was introduced in Qt 4.8.

[virtual] bool QAbstractProxyModel::submit()

Reimplemented from QAbstractItemModel::submit().

[virtual] Qt::DropActions QAbstractProxyModel::supportedDropActions() const

Reimplemented from QAbstractItemModel::supportedDropActions().

This function was introduced in Qt 4.8.

© 2015 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.