QAbstractProxyModel

Inheritance diagram of QAbstractProxyModel

Inherited by: QSortFilterProxyModel

Synopsis

Functions

Virtual functions

Detailed Description

The PySide.QtGui.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 PySide.QtGui.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 PySide.QtGui.QSortFilterProxyModel .

To subclass PySide.QtGui.QAbstractProxyModel , you need to implement PySide.QtGui.QAbstractProxyModel.mapFromSource() and PySide.QtGui.QAbstractProxyModel.mapToSource() . The PySide.QtGui.QAbstractProxyModel.mapSelectionFromSource() and PySide.QtGui.QAbstractProxyModel.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.

class PySide.QtGui.QAbstractProxyModel([parent=None])
Parameters:parentPySide.QtCore.QObject

Constructs a proxy model with the given parent .

PySide.QtGui.QAbstractProxyModel.mapFromSource(sourceIndex)
Parameters:sourceIndexPySide.QtCore.QModelIndex
Return type:PySide.QtCore.QModelIndex

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

PySide.QtGui.QAbstractProxyModel.mapSelectionFromSource(selection)
Parameters:selectionPySide.QtGui.QItemSelection
Return type:PySide.QtGui.QItemSelection

Returns a proxy selection mapped from the specified sourceSelection .

Reimplement this method to map source selections to proxy selections.

PySide.QtGui.QAbstractProxyModel.mapSelectionToSource(selection)
Parameters:selectionPySide.QtGui.QItemSelection
Return type:PySide.QtGui.QItemSelection

Returns a source selection mapped from the specified proxySelection .

Reimplement this method to map proxy selections to source selections.

PySide.QtGui.QAbstractProxyModel.mapToSource(proxyIndex)
Parameters:proxyIndexPySide.QtCore.QModelIndex
Return type:PySide.QtCore.QModelIndex

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

PySide.QtGui.QAbstractProxyModel.setSourceModel(sourceModel)
Parameters:sourceModelPySide.QtCore.QAbstractItemModel

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

PySide.QtGui.QAbstractProxyModel.sourceModel()
Return type:PySide.QtCore.QAbstractItemModel

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