QAbstractProxyModel

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

Inherited by: QIdentityProxyModel, QSortFilterProxyModel

Synopsis

Functions

• def sourceModel ()

Virtual functions

• def mapFromSource (sourceIndex)

• def mapSelectionFromSource (selection)

• def mapSelectionToSource (selection)

• def mapToSource (proxyIndex)

• def setSourceModel (sourceModel)

Detailed Description

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

class QAbstractProxyModel([parent=None])

param parent

QObject

Constructs a proxy model with the given parent .

PySide2.QtCore.QAbstractProxyModel.mapFromSource(sourceIndex)

Parameters

sourceIndex – QModelIndex

Return type

QModelIndex

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

See also

mapToSource()

PySide2.QtCore.QAbstractProxyModel.mapSelectionFromSource(selection)

Parameters

selection – QItemSelection

Return type

QItemSelection

Returns a proxy selection mapped from the specified sourceSelection .

Reimplement this method to map source selections to proxy selections.

PySide2.QtCore.QAbstractProxyModel.mapSelectionToSource(selection)

Parameters

selection – QItemSelection

Return type

QItemSelection

Returns a source selection mapped from the specified proxySelection .

Reimplement this method to map proxy selections to source selections.

PySide2.QtCore.QAbstractProxyModel.mapToSource(proxyIndex)

Parameters

proxyIndex – QModelIndex

Return type

QModelIndex

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

See also

mapFromSource()

PySide2.QtCore.QAbstractProxyModel.setSourceModel(sourceModel)

Parameters

sourceModel – QAbstractItemModel

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

See also

sourceModel()

PySide2.QtCore.QAbstractProxyModel.sourceModel()

Return type

QAbstractItemModel

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

See also

setSourceModel()