|  | Home · All Classes · Modules

# QSortFilterProxyModel Class Reference
[QtGui module]

The QSortFilterProxyModel class provides support for sorting and filtering data passed between another model and a view. More...

Inherits QAbstractProxyModel.

### Methods

- __init__ (self, QObject parent = None)
- QModelIndex buddy (self, QModelIndex index)
- bool canFetchMore (self, QModelIndex parent)
- clear (self)
- int columnCount (self, QModelIndex parent = QModelIndex())
- QVariant data (self, QModelIndex index, int role = Qt.DisplayRole)
- bool dropMimeData (self, QMimeData data, Qt.DropAction action, int row, int column, QModelIndex parent)
- bool dynamicSortFilter (self)
- fetchMore (self, QModelIndex parent)
- bool filterAcceptsColumn (self, int source_column, QModelIndex source_parent)
- bool filterAcceptsRow (self, int source_row, QModelIndex source_parent)
- Qt.CaseSensitivity filterCaseSensitivity (self)
- filterChanged (self)
- int filterKeyColumn (self)
- QRegExp filterRegExp (self)
- int filterRole (self)
- Qt.ItemFlags flags (self, QModelIndex index)
- bool hasChildren (self, QModelIndex parent = QModelIndex())
- QVariant headerData (self, int section, Qt.Orientation orientation, int role = Qt.EditRole)
- QModelIndex index (self, int row, int column, QModelIndex parent = QModelIndex())
- bool insertColumns (self, int column, int count, QModelIndex parent = QModelIndex())
- bool insertRows (self, int row, int count, QModelIndex parent = QModelIndex())
- invalidate (self)
- invalidateFilter (self)
- bool isSortLocaleAware (self)
- bool lessThan (self, QModelIndex left, QModelIndex right)
- QModelIndex mapFromSource (self, QModelIndex sourceIndex)
- QItemSelection mapSelectionFromSource (self, QItemSelection sourceSelection)
- QItemSelection mapSelectionToSource (self, QItemSelection proxySelection)
- QModelIndex mapToSource (self, QModelIndex proxyIndex)
- unknown-type match (self, QModelIndex start, int role, QVariant value, int hits = 1, Qt.MatchFlags flags = Qt.MatchStartsWith|Qt.MatchWrap)
- QMimeData mimeData (self, unknown-type indexes)
- QStringList mimeTypes (self)
- QModelIndex parent (self, QModelIndex child)
- QObject parent (self)
- bool removeColumns (self, int column, int count, QModelIndex parent = QModelIndex())
- bool removeRows (self, int row, int count, QModelIndex parent = QModelIndex())
- int rowCount (self, QModelIndex parent = QModelIndex())
- bool setData (self, QModelIndex index, QVariant value, int role = Qt.EditRole)
- setDynamicSortFilter (self, bool enable)
- setFilterCaseSensitivity (self, Qt.CaseSensitivity cs)
- setFilterFixedString (self, QString pattern)
- setFilterKeyColumn (self, int column)
- setFilterRegExp (self, QRegExp regExp)
- setFilterRegExp (self, QString pattern)
- setFilterRole (self, int role)
- setFilterWildcard (self, QString pattern)
- bool setHeaderData (self, int section, Qt.Orientation orientation, QVariant value, int role = Qt.EditRole)
- setSortCaseSensitivity (self, Qt.CaseSensitivity cs)
- setSortLocaleAware (self, bool on)
- setSortRole (self, int role)
- setSourceModel (self, QAbstractItemModel sourceModel)
- sort (self, int column, Qt.SortOrder order = Qt.AscendingOrder)
- Qt.CaseSensitivity sortCaseSensitivity (self)
- int sortColumn (self)
- Qt.SortOrder sortOrder (self)
- int sortRole (self)
- QSize span (self, QModelIndex index)
- Qt.DropActions supportedDropActions (self)

## Detailed Description

The QSortFilterProxyModel class provides support for sorting and filtering data passed between another model and a view.

QSortFilterProxyModel can be used for sorting items, filtering out items, or both. The model transforms the structure of a source model by mapping the model indexes it supplies to new indexes, corresponding to different locations, for views to use. This approach allows a given source model to be restructured as far as views are concerned without requiring any transformations on the underlying data, and without duplicating the data in memory.

Let's assume that we want to sort and filter the items provided by a custom model. The code to set up the model and the view, without sorting and filtering, would look like this:

             QTreeView *treeView = new QTreeView;
             MyItemModel *model = new MyItemModel(this);

             treeView->setModel(model);

To add sorting and filtering support to `MyItemModel`, we need to create a QSortFilterProxyModel, call setSourceModel() with the `MyItemModel` as argument, and install the QSortFilterProxyModel on the view:

             QTreeView *treeView = new QTreeView;
             MyItemModel *sourceModel = new MyItemModel(this);
             QSortFilterProxyModel *proxyModel = new QSortFilterProxyModel(this);

             proxyModel->setSourceModel(sourceModel);
             treeView->setModel(proxyModel);

At this point, neither sorting nor filtering is enabled; the original data is displayed in the view. Any changes made through the QSortFilterProxyModel are applied to the original model.

The QSortFilterProxyModel acts as a wrapper for the original model. If you need to convert source QModelIndexes to sorted/filtered model indexes or vice versa, use mapToSource(), mapFromSource(), mapSelectionToSource(), and mapSelectionFromSource().

Note: By default, the model does not dynamically re-sort and re-filter data whenever the original model changes. This behavior can be changed by setting the dynamicSortFilter property.

The Basic Sort/Filter Model and Custom Sort/Filter Model examples illustrate how to use QSortFilterProxyModel to perform basic sorting and filtering and how to subclass it to implement custom behavior.

### Sorting

QTableView and QTreeView have a sortingEnabled property that controls whether the user can sort the view by clicking the view's horizontal header. For example:

             treeView->setSortingEnabled(true);

When this feature is on (the default is off), clicking on a header section sorts the items according to that column. By clicking repeatedly, the user can alternate between ascending and descending order.

Behind the scene, the view calls the sort() virtual function on the model to reorder the data in the model. To make your data sortable, you can either implement sort() in your model, or use a QSortFilterProxyModel to wrap your model -- QSortFilterProxyModel provides a generic sort() reimplementation that operates on the sortRole() (Qt.DisplayRole by default) of the items and that understands several data types, including `int`, QString, and QDateTime. For hierarchical models, sorting is applied recursively to all child items. String comparisons are case sensitive by default; this can be changed by setting the sortCaseSensitivity property.

Custom sorting behavior is achieved by subclassing QSortFilterProxyModel and reimplementing lessThan(), which is used to compare items. For example:

     bool MySortFilterProxyModel.lessThan(const QModelIndex &left,
                                           const QModelIndex &right) const
     {
         QVariant leftData = sourceModel()->data(left);
         QVariant rightData = sourceModel()->data(right);

         if (leftData.type() == QVariant.DateTime) {
             return leftData.toDateTime() < rightData.toDateTime();
         } else {
             QRegExp *emailPattern = new QRegExp("([\\w\\.]*@[\\w\\.]*)");

             QString leftString = leftData.toString();
             if(left.column() == 1 && emailPattern->indexIn(leftString) != -1)
                 leftString = emailPattern->cap(1);

             QString rightString = rightData.toString();
             if(right.column() == 1 && emailPattern->indexIn(rightString) != -1)
                 rightString = emailPattern->cap(1);

             return QString.localeAwareCompare(leftString, rightString) < 0;
         }
     }

(This code snippet comes from the Custom Sort/Filter Model example.)

An alternative approach to sorting is to disable sorting on the view and to impose a certain order to the user. This is done by explicitly calling sort() with the desired column and order as arguments on the QSortFilterProxyModel (or on the original model if it implements sort()). For example:

             proxyModel->sort(2, Qt.AscendingOrder);

QSortFilterProxyModel can be sorted by column -1, in which case it returns to the sort order of the underlying source model.

### Filtering

In addition to sorting, QSortFilterProxyModel can be used to hide items that do not match a certain filter. The filter is specified using a QRegExp object and is applied to the filterRole() (Qt.DisplayRole by default) of each item, for a given column. The QRegExp object can be used to match a regular expression, a wildcard pattern, or a fixed string. For example:

             proxyModel->setFilterRegExp(QRegExp(".png", Qt.CaseInsensitive,
                                                 QRegExp.FixedString));
             proxyModel->setFilterKeyColumn(1);

For hierarchical models, the filter is applied recursively to all children. If a parent item doesn't match the filter, none of its children will be shown.

A common use case is to let the user specify the filter regexp, wildcard pattern, or fixed string in a QLineEdit and to connect the textChanged() signal to setFilterRegExp(), setFilterWildcard(), or setFilterFixedString() to reapply the filter.

Custom filtering behavior can be achieved by reimplementing the filterAcceptsRow() and filterAcceptsColumn() functions. For example (from the Custom Sort/Filter Model example), the following implementation ignores the filterKeyColumn property and performs filtering on columns 0, 1, and 2:

     bool MySortFilterProxyModel.filterAcceptsRow(int sourceRow,
             const QModelIndex &sourceParent) const
     {
         QModelIndex index0 = sourceModel()->index(sourceRow, 0, sourceParent);
         QModelIndex index1 = sourceModel()->index(sourceRow, 1, sourceParent);
         QModelIndex index2 = sourceModel()->index(sourceRow, 2, sourceParent);

         return (sourceModel()->data(index0).toString().contains(filterRegExp())
                 || sourceModel()->data(index1).toString().contains(filterRegExp()))
                && dateInRange(sourceModel()->data(index2).toDate());
     }

(This code snippet comes from the Custom Sort/Filter Model example.)

If you are working with large amounts of filtering and have to invoke invalidateFilter() repeatedly, using reset() may be more efficient, depending on the implementation of your model. However, reset() returns the proxy model to its original state, losing selection information, and will cause the proxy model to be repopulated.

### Subclassing

Since QAbstractProxyModel and its subclasses are derived from QAbstractItemModel, much of the same advice about subclassing normal models also applies to proxy models. In addition, it is worth noting that many of the default implementations of functions in this class are written so that they call the equivalent functions in the relevant source model. This simple proxying mechanism may need to be overridden for source models with more complex behavior; for example, if the source model provides a custom hasChildren() implementation, you should also provide one in the proxy model.

Note: Some general guidelines for subclassing models are available in the Model Subclassing Reference.

## Method Documentation

### QSortFilterProxyModel.__init__ (self, QObject parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

Constructs a sorting filter model with the given parent.

### QModelIndex QSortFilterProxyModel.buddy (self, QModelIndex index)

Reimplemented from QAbstractItemModel.buddy().

### bool QSortFilterProxyModel.canFetchMore (self, QModelIndex parent)

Reimplemented from QAbstractItemModel.canFetchMore().

### QSortFilterProxyModel.clear (self)

This method is also a Qt slot with the C++ signature `void clear()`.

### int QSortFilterProxyModel.columnCount (self, QModelIndex parent = QModelIndex())

Reimplemented from QAbstractItemModel.columnCount().

### QVariant QSortFilterProxyModel.data (self, QModelIndex index, int role = Qt.DisplayRole)

Reimplemented from QAbstractItemModel.data().

See also setData().

### bool QSortFilterProxyModel.dropMimeData (self, QMimeData data, Qt.DropAction action, int row, int column, QModelIndex parent)

Reimplemented from QAbstractItemModel.dropMimeData().

### bool QSortFilterProxyModel.dynamicSortFilter (self)

### QSortFilterProxyModel.fetchMore (self, QModelIndex parent)

Reimplemented from QAbstractItemModel.fetchMore().

### bool QSortFilterProxyModel.filterAcceptsColumn (self, int source_column, QModelIndex source_parent)

Returns true if the item in the column indicated by the given source_column and source_parent should be included in the model; otherwise returns false.

The default implementation returns true if the value held by the relevant item matches the filter string, wildcard string or regular expression.

Note: By default, the Qt.DisplayRole is used to determine if the row should be accepted or not. This can be changed by setting the filterRole property.

See also filterAcceptsRow(), setFilterFixedString(), setFilterRegExp(), and setFilterWildcard().

### bool QSortFilterProxyModel.filterAcceptsRow (self, int source_row, QModelIndex source_parent)

Returns true if the item in the row indicated by the given source_row and source_parent should be included in the model; otherwise returns false.

The default implementation returns true if the value held by the relevant item matches the filter string, wildcard string or regular expression.

Note: By default, the Qt.DisplayRole is used to determine if the row should be accepted or not. This can be changed by setting the filterRole property.

See also filterAcceptsColumn(), setFilterFixedString(), setFilterRegExp(), and setFilterWildcard().

### Qt.CaseSensitivity QSortFilterProxyModel.filterCaseSensitivity (self)

### QSortFilterProxyModel.filterChanged (self)

### int QSortFilterProxyModel.filterKeyColumn (self)

### QRegExp QSortFilterProxyModel.filterRegExp (self)

### int QSortFilterProxyModel.filterRole (self)

### Qt.ItemFlags QSortFilterProxyModel.flags (self, QModelIndex index)

Reimplemented from QAbstractItemModel.flags().

### bool QSortFilterProxyModel.hasChildren (self, QModelIndex parent = QModelIndex())

Reimplemented from QAbstractItemModel.hasChildren().

### QVariant QSortFilterProxyModel.headerData (self, int section, Qt.Orientation orientation, int role = Qt.EditRole)

Reimplemented from QAbstractItemModel.headerData().

See also setHeaderData().

### QModelIndex QSortFilterProxyModel.index (self, int row, int column, QModelIndex parent = QModelIndex())

Reimplemented from QAbstractItemModel.index().

### bool QSortFilterProxyModel.insertColumns (self, int column, int count, QModelIndex parent = QModelIndex())

Reimplemented from QAbstractItemModel.insertColumns().

### bool QSortFilterProxyModel.insertRows (self, int row, int count, QModelIndex parent = QModelIndex())

Reimplemented from QAbstractItemModel.insertRows().

### QSortFilterProxyModel.invalidate (self)

This method is also a Qt slot with the C++ signature `void invalidate()`.

Invalidates the current sorting and filtering.

This function was introduced in Qt 4.3.

See also invalidateFilter().

### QSortFilterProxyModel.invalidateFilter (self)

Invalidates the current filtering.

This function should be called if you are implementing custom filtering (e.g. filterAcceptsRow()), and your filter parameters have changed.

This function was introduced in Qt 4.3.

See also invalidate().

### bool QSortFilterProxyModel.isSortLocaleAware (self)

### bool QSortFilterProxyModel.lessThan (self, QModelIndex left, QModelIndex right)

Returns true if the value of the item referred to by the given index left is less than the value of the item referred to by the given index right, otherwise returns false.

This function is used as the < operator when sorting, and handles the following QVariant types:

- QVariant.Int
- QVariant.UInt
- QVariant.LongLong
- QVariant.ULongLong
- QVariant.Double
- QVariant.Char
- QVariant.Date
- QVariant.Time
- QVariant.DateTime
- QVariant.String

Any other type will be converted to a QString using QVariant.toString().

Comparison of QStrings is case sensitive by default; this can be changed using the sortCaseSensitivity property.

By default, the Qt.DisplayRole associated with the QModelIndexes is used for comparisons. This can be changed by setting the sortRole property.

Note: The indices passed in correspond to the source model.

See also sortRole, sortCaseSensitivity, and dynamicSortFilter.

### QModelIndex QSortFilterProxyModel.mapFromSource (self, QModelIndex sourceIndex)

Reimplemented from QAbstractProxyModel.mapFromSource().

Returns the model index in the QSortFilterProxyModel given the sourceIndex from the source model.

See also mapToSource().

### QItemSelection QSortFilterProxyModel.mapSelectionFromSource (self, QItemSelection sourceSelection)

Reimplemented from QAbstractProxyModel.mapSelectionFromSource().

### QItemSelection QSortFilterProxyModel.mapSelectionToSource (self, QItemSelection proxySelection)

Reimplemented from QAbstractProxyModel.mapSelectionToSource().

### QModelIndex QSortFilterProxyModel.mapToSource (self, QModelIndex proxyIndex)

Reimplemented from QAbstractProxyModel.mapToSource().

Returns the source model index corresponding to the given proxyIndex from the sorting filter model.

See also mapFromSource().

### unknown-type QSortFilterProxyModel.match (self, QModelIndex start, int role, QVariant value, int hits = 1, Qt.MatchFlags flags = Qt.MatchStartsWith|Qt.MatchWrap)

Reimplemented from QAbstractItemModel.match().

### QMimeData QSortFilterProxyModel.mimeData (self, unknown-type indexes)

The QMimeData result

Reimplemented from QAbstractItemModel.mimeData().

### QStringList QSortFilterProxyModel.mimeTypes (self)

Reimplemented from QAbstractItemModel.mimeTypes().

### QModelIndex QSortFilterProxyModel.parent (self, QModelIndex child)

Reimplemented from QAbstractItemModel.parent().

### QObject QSortFilterProxyModel.parent (self)

### bool QSortFilterProxyModel.removeColumns (self, int column, int count, QModelIndex parent = QModelIndex())

Reimplemented from QAbstractItemModel.removeColumns().

### bool QSortFilterProxyModel.removeRows (self, int row, int count, QModelIndex parent = QModelIndex())

Reimplemented from QAbstractItemModel.removeRows().

### int QSortFilterProxyModel.rowCount (self, QModelIndex parent = QModelIndex())

Reimplemented from QAbstractItemModel.rowCount().

### bool QSortFilterProxyModel.setData (self, QModelIndex index, QVariant value, int role = Qt.EditRole)

Reimplemented from QAbstractItemModel.setData().

See also data().

### QSortFilterProxyModel.setDynamicSortFilter (self, bool enable)

### QSortFilterProxyModel.setFilterCaseSensitivity (self, Qt.CaseSensitivity cs)

### QSortFilterProxyModel.setFilterFixedString (self, QString pattern)

This method is also a Qt slot with the C++ signature `void setFilterFixedString(const QString&)`.

Sets the fixed string used to filter the contents of the source model to the given pattern.

See also setFilterCaseSensitivity(), setFilterRegExp(), setFilterWildcard(), and filterRegExp().

### QSortFilterProxyModel.setFilterKeyColumn (self, int column)

### QSortFilterProxyModel.setFilterRegExp (self, QRegExp regExp)

### QSortFilterProxyModel.setFilterRegExp (self, QString pattern)

This method is also a Qt slot with the C++ signature `void setFilterRegExp(const QString&)`.

### QSortFilterProxyModel.setFilterRole (self, int role)

### QSortFilterProxyModel.setFilterWildcard (self, QString pattern)

This method is also a Qt slot with the C++ signature `void setFilterWildcard(const QString&)`.

Sets the wildcard expression used to filter the contents of the source model to the given pattern.

See also setFilterCaseSensitivity(), setFilterRegExp(), setFilterFixedString(), and filterRegExp().

### bool QSortFilterProxyModel.setHeaderData (self, int section, Qt.Orientation orientation, QVariant value, int role = Qt.EditRole)

Reimplemented from QAbstractItemModel.setHeaderData().

See also headerData().

### QSortFilterProxyModel.setSortCaseSensitivity (self, Qt.CaseSensitivity cs)

### QSortFilterProxyModel.setSortLocaleAware (self, bool on)

### QSortFilterProxyModel.setSortRole (self, int role)

### QSortFilterProxyModel.setSourceModel (self, QAbstractItemModel sourceModel)

Reimplemented from QAbstractProxyModel.setSourceModel().

### QSortFilterProxyModel.sort (self, int column, Qt.SortOrder order = Qt.AscendingOrder)

Reimplemented from QAbstractItemModel.sort().

### Qt.CaseSensitivity QSortFilterProxyModel.sortCaseSensitivity (self)

### int QSortFilterProxyModel.sortColumn (self)

the column currently used for sorting

This returns the most recently used sort column.

This function was introduced in Qt 4.5.

### Qt.SortOrder QSortFilterProxyModel.sortOrder (self)

the order currently used for sorting

This returns the most recently used sort order.

This function was introduced in Qt 4.5.

### int QSortFilterProxyModel.sortRole (self)

### QSize QSortFilterProxyModel.span (self, QModelIndex index)

Reimplemented from QAbstractItemModel.span().

### Qt.DropActions QSortFilterProxyModel.supportedDropActions (self)

Reimplemented from QAbstractItemModel.supportedDropActions().