QSortFilterProxyModel#

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

Inheritance diagram of PySide6.QtCore.QSortFilterProxyModel

Synopsis#

Properties#

  • autoAcceptChildRows - If true the proxy model will not filter out children of accepted rows, even if they themselves would be filtered out otherwise

  • dynamicSortFilter - Whether the proxy model is dynamically sorted and filtered whenever the contents of the source model change

  • filterCaseSensitivity - The case sensitivity of the QRegularExpression pattern used to filter the contents of the source model

  • filterKeyColumn - The column where the key used to filter the contents of the source model is read from

  • filterRegularExpression - The QRegularExpression used to filter the contents of the source model

  • filterRole - The item role that is used to query the source model’s data when filtering items

  • isSortLocaleAware - The local aware setting used for comparing strings when sorting

  • recursiveFilteringEnabled - Whether the filter to be applied recursively on children, and for any matching child, its parents will be visible as well

  • sortCaseSensitivity - The case sensitivity setting used for comparing strings when sorting

  • sortRole - The item role that is used to query the source model’s data when sorting items

Functions#

Virtual functions#

Slots#

Signals#

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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:

treeView = QTreeView()
model = MyItemModel(self)
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:

treeView = QTreeView()
sourceModel = MyItemModel(self)
proxyModel = QSortFilterProxyModel(self)
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 QModelIndex es to sorted/filtered model indexes or vice versa, use mapToSource() , mapFromSource() , mapSelectionToSource() , and mapSelectionFromSource() .

Note

By default, the model dynamically re-sorts and re-filters 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.

../../_images/qsortfilterproxymodel-sorting.png

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() ( 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(QModelIndex left,
                                      QModelIndex right)

    leftData = sourceModel().data(left)
    rightData = sourceModel().data(right)
    if leftData.userType() == QMetaType.QDateTime:
        return leftData.toDateTime() < rightData.toDateTime()
    else:
        emailPattern = QRegularExpression("[\\w\\.]*@[\\w\\.]*")
        leftString = leftData.toString()
        if left.column() == 1:
            match = emailPattern.match(leftString)
            if match.hasMatch():
                leftString = match.captured(0)

        rightString = rightData.toString()
        if right.column() == 1:
            match = emailPattern.match(rightString)
            if match.hasMatch():
                rightString = match.captured(0)

        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 QRegularExpression object and is applied to the filterRole() ( DisplayRole by default) of each item, for a given column. The QRegularExpression object can be used to match a regular expression, a wildcard pattern, or a fixed string. For example:

proxyModel.setFilterRegularExpression(QRegularExpression("\.png", QRegularExpression.CaseInsensitiveOption))
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 regular expression, wildcard pattern, or fixed string in a QLineEdit and to connect the textChanged() signal to setFilterRegularExpression() , 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,
                                              QModelIndex sourceParent)

    index0 = sourceModel().index(sourceRow, 0, sourceParent)
    index1 = sourceModel().index(sourceRow, 1, sourceParent)
    index2 = sourceModel().index(sourceRow, 2, sourceParent)
    return (sourceModel().data(index0).toString().contains(filterRegularExpression())
            def sourceModel().data(index1).toString().contains(filterRegularExpression())):
            def 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 beginResetModel() / endResetModel() may be more efficient, depending on the implementation of your model. However, beginResetModel() / endResetModel() 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.

See also

QAbstractProxyModel QAbstractItemModel QIdentityProxyModel

class PySide6.QtCore.QSortFilterProxyModel([parent=None])#
Parameters:

parent – PySide6.QtCore.QObject

Constructs a sorting filter model with the given parent.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property PᅟySide6.QtCore.QSortFilterProxyModel.autoAcceptChildRows: bool#

This property holds if true the proxy model will not filter out children of accepted rows, even if they themselves would be filtered out otherwise..

The default value is false.

See also

recursiveFilteringEnabled filterAcceptsRow()

Access functions:
property PᅟySide6.QtCore.QSortFilterProxyModel.dynamicSortFilter: bool#

This property holds whether the proxy model is dynamically sorted and filtered whenever the contents of the source model change.

Note that you should not update the source model through the proxy model when dynamicSortFilter is true. For instance, if you set the proxy model on a QComboBox, then using functions that update the model, e.g., addItem(), will not work as expected. An alternative is to set dynamicSortFilter to false and call sort() after adding items to the QComboBox.

The default value is true.

See also

sortColumn()

Access functions:
property PᅟySide6.QtCore.QSortFilterProxyModel.filterCaseSensitivity: CaseSensitivity#

This property holds the case sensitivity of the QRegularExpression pattern used to filter the contents of the source model..

By default, the filter is case sensitive.

Note

Setting this property propagates the new case sensitivity to the filterRegularExpression property, and so breaks its binding. Likewise explicitly setting filterRegularExpression changes the current case sensitivity, thereby breaking its binding.

See also

filterRegularExpression sortCaseSensitivity

Access functions:
property PᅟySide6.QtCore.QSortFilterProxyModel.filterKeyColumn: int#

This property holds the column where the key used to filter the contents of the source model is read from..

The default value is 0. If the value is -1, the keys will be read from all columns.

Access functions:
property PᅟySide6.QtCore.QSortFilterProxyModel.filterRegularExpression: PySide6.QtCore.QRegularExpression#

This property holds the QRegularExpression used to filter the contents of the source model.

Setting this property through the QRegularExpression overload overwrites the current filterCaseSensitivity . By default, the QRegularExpression is an empty string matching all contents.

If no QRegularExpression or an empty string is set, everything in the source model will be accepted.

Note

Setting this property propagates the case sensitivity of the new regular expression to the filterCaseSensitivity property, and so breaks its binding. Likewise explicitly setting filterCaseSensitivity changes the case sensitivity of the current regular expression, thereby breaking its binding.

See also

filterCaseSensitivity setFilterWildcard() setFilterFixedString()

Access functions:
property PᅟySide6.QtCore.QSortFilterProxyModel.filterRole: int#

This property holds the item role that is used to query the source model’s data when filtering items..

The default value is DisplayRole .

Access functions:
property PᅟySide6.QtCore.QSortFilterProxyModel.isSortLocaleAware: bool#

This property holds the local aware setting used for comparing strings when sorting.

By default, sorting is not local aware.

Access functions:
property PᅟySide6.QtCore.QSortFilterProxyModel.recursiveFilteringEnabled: bool#

This property holds whether the filter to be applied recursively on children, and for any matching child, its parents will be visible as well..

The default value is false.

Access functions:
property PᅟySide6.QtCore.QSortFilterProxyModel.sortCaseSensitivity: CaseSensitivity#

This property holds the case sensitivity setting used for comparing strings when sorting.

By default, sorting is case sensitive.

Access functions:
property PᅟySide6.QtCore.QSortFilterProxyModel.sortRole: int#

This property holds the item role that is used to query the source model’s data when sorting items..

The default value is DisplayRole .

See also

lessThan()

Access functions:
PySide6.QtCore.QSortFilterProxyModel.autoAcceptChildRows()#
Return type:

bool

See also

setAutoAcceptChildRows()

Getter of property autoAcceptChildRows .

PySide6.QtCore.QSortFilterProxyModel.autoAcceptChildRowsChanged(autoAcceptChildRows)#
Parameters:

autoAcceptChildRows – bool

This signals is emitted when the value of the autoAcceptChildRows property is changed.

Notification signal of property autoAcceptChildRows .

PySide6.QtCore.QSortFilterProxyModel.dynamicSortFilter()#
Return type:

bool

See also

setDynamicSortFilter()

Getter of property dynamicSortFilter .

PySide6.QtCore.QSortFilterProxyModel.dynamicSortFilterChanged(dynamicSortFilter)#
Parameters:

dynamicSortFilter – bool

PySide6.QtCore.QSortFilterProxyModel.filterAcceptsColumn(source_column, source_parent)#
Parameters:
Return type:

bool

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.

Note

The default implementation always returns true. You must reimplement this method to get the described behavior.

See also

filterAcceptsRow() setFilterFixedString() setFilterRegularExpression() setFilterWildcard()

PySide6.QtCore.QSortFilterProxyModel.filterAcceptsRow(source_row, source_parent)#
Parameters:
Return type:

bool

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 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() setFilterRegularExpression() setFilterWildcard()

PySide6.QtCore.QSortFilterProxyModel.filterCaseSensitivity()#
Return type:

CaseSensitivity

See also

setFilterCaseSensitivity()

Getter of property filterCaseSensitivity .

PySide6.QtCore.QSortFilterProxyModel.filterCaseSensitivityChanged(filterCaseSensitivity)#
Parameters:

filterCaseSensitivity – CaseSensitivity

This signal is emitted when the case sensitivity of the filter changes to filterCaseSensitivity.

Notification signal of property filterCaseSensitivity .

PySide6.QtCore.QSortFilterProxyModel.filterKeyColumn()#
Return type:

int

See also

setFilterKeyColumn()

Getter of property filterKeyColumn .

PySide6.QtCore.QSortFilterProxyModel.filterRegularExpression()#
Return type:

PySide6.QtCore.QRegularExpression

See also

setFilterRegularExpression()

Getter of property filterRegularExpression .

PySide6.QtCore.QSortFilterProxyModel.filterRole()#
Return type:

int

See also

setFilterRole()

Getter of property filterRole .

PySide6.QtCore.QSortFilterProxyModel.filterRoleChanged(filterRole)#
Parameters:

filterRole – int

This signal is emitted when the filter role changes to filterRole.

Notification signal of property filterRole .

PySide6.QtCore.QSortFilterProxyModel.invalidate()#

Invalidates the current sorting and filtering.

PySide6.QtCore.QSortFilterProxyModel.invalidateColumnsFilter()#

Invalidates the current filtering for the columns.

This function should be called if you are implementing custom filtering (by filterAcceptsColumn() ), and your filter parameters have changed. This differs from invalidateFilter() in that it will not invoke filterAcceptsRow() , but only filterAcceptsColumn() . You can use this instead of invalidateFilter() if you want to hide or show a column where the rows don’t change.

PySide6.QtCore.QSortFilterProxyModel.invalidateFilter()#

Invalidates the current filtering.

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

PySide6.QtCore.QSortFilterProxyModel.invalidateRowsFilter()#

Invalidates the current filtering for the rows.

This function should be called if you are implementing custom filtering (by filterAcceptsRow() ), and your filter parameters have changed. This differs from invalidateFilter() in that it will not invoke filterAcceptsColumn() , but only filterAcceptsRow() . You can use this instead of invalidateFilter() if you want to hide or show a row where the columns don’t change.

PySide6.QtCore.QSortFilterProxyModel.isRecursiveFilteringEnabled()#
Return type:

bool

Getter of property recursiveFilteringEnabled .

PySide6.QtCore.QSortFilterProxyModel.isSortLocaleAware()#
Return type:

bool

Getter of property isSortLocaleAware .

PySide6.QtCore.QSortFilterProxyModel.lessThan(source_left, source_right)#
Parameters:
Return type:

bool

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

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

  • Int

  • UInt

  • LongLong

  • ULongLong

  • Float

  • Double

  • QChar

  • QDate

  • QTime

  • QDateTime

  • QString

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

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

By default, the DisplayRole associated with the QModelIndex es 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 dynamicSortFilter

PySide6.QtCore.QSortFilterProxyModel.recursiveFilteringEnabledChanged(recursiveFilteringEnabled)#
Parameters:

recursiveFilteringEnabled – bool

This signal is emitted when the recursive filter setting is changed to recursiveFilteringEnabled.

Notification signal of property recursiveFilteringEnabled .

PySide6.QtCore.QSortFilterProxyModel.setAutoAcceptChildRows(accept)#
Parameters:

accept – bool

See also

autoAcceptChildRows()

Setter of property autoAcceptChildRows .

PySide6.QtCore.QSortFilterProxyModel.setDynamicSortFilter(enable)#
Parameters:

enable – bool

See also

dynamicSortFilter()

Setter of property dynamicSortFilter .

PySide6.QtCore.QSortFilterProxyModel.setFilterCaseSensitivity(cs)#
Parameters:

cs – CaseSensitivity

See also

filterCaseSensitivity()

Setter of property filterCaseSensitivity .

PySide6.QtCore.QSortFilterProxyModel.setFilterFixedString(pattern)#
Parameters:

pattern – str

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

This method will reset the regular expression options but respect case sensitivity.

Note

Calling this method updates the regular expression, thereby breaking the binding for filterRegularExpression . However it has no effect on the filterCaseSensitivity bindings.

See also

setFilterCaseSensitivity() setFilterRegularExpression() setFilterWildcard() filterRegularExpression()

PySide6.QtCore.QSortFilterProxyModel.setFilterKeyColumn(column)#
Parameters:

column – int

See also

filterKeyColumn()

Setter of property filterKeyColumn .

PySide6.QtCore.QSortFilterProxyModel.setFilterRegularExpression(regularExpression)#
Parameters:

regularExpression – PySide6.QtCore.QRegularExpression

Setter of property filterRegularExpression .

PySide6.QtCore.QSortFilterProxyModel.setFilterRegularExpression(pattern)
Parameters:

pattern – str

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

This method should be preferred for new code as it will use QRegularExpression internally.

This method will reset the regular expression options but respect case sensitivity.

Note

Calling this method updates the regular expression, thereby breaking the binding for filterRegularExpression . However it has no effect on the filterCaseSensitivity bindings.

See also

setFilterCaseSensitivity() setFilterWildcard() setFilterFixedString() filterRegularExpression()

PySide6.QtCore.QSortFilterProxyModel.setFilterRole(role)#
Parameters:

role – int

See also

filterRole()

Setter of property filterRole .

PySide6.QtCore.QSortFilterProxyModel.setFilterWildcard(pattern)#
Parameters:

pattern – str

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

This method will reset the regular expression options but respect case sensitivity.

Note

Calling this method updates the regular expression, thereby breaking the binding for filterRegularExpression . However it has no effect on the filterCaseSensitivity bindings.

See also

setFilterCaseSensitivity() setFilterRegularExpression() setFilterFixedString() filterRegularExpression()

PySide6.QtCore.QSortFilterProxyModel.setRecursiveFilteringEnabled(recursive)#
Parameters:

recursive – bool

See also

isRecursiveFilteringEnabled()

Setter of property recursiveFilteringEnabled .

PySide6.QtCore.QSortFilterProxyModel.setSortCaseSensitivity(cs)#
Parameters:

cs – CaseSensitivity

See also

sortCaseSensitivity()

Setter of property sortCaseSensitivity .

PySide6.QtCore.QSortFilterProxyModel.setSortLocaleAware(on)#
Parameters:

on – bool

See also

isSortLocaleAware()

Setter of property isSortLocaleAware .

PySide6.QtCore.QSortFilterProxyModel.setSortRole(role)#
Parameters:

role – int

See also

sortRole()

Setter of property sortRole .

PySide6.QtCore.QSortFilterProxyModel.sortCaseSensitivity()#
Return type:

CaseSensitivity

See also

setSortCaseSensitivity()

Getter of property sortCaseSensitivity .

PySide6.QtCore.QSortFilterProxyModel.sortCaseSensitivityChanged(sortCaseSensitivity)#
Parameters:

sortCaseSensitivity – CaseSensitivity

This signal is emitted when the case sensitivity for sorting changes to sortCaseSensitivity.

Notification signal of property sortCaseSensitivity .

PySide6.QtCore.QSortFilterProxyModel.sortColumn()#
Return type:

int

Returns the column currently used for sorting

This returns the most recently used sort column. The default value is -1, which means that this proxy model does not sort.

See also

sort()

PySide6.QtCore.QSortFilterProxyModel.sortLocaleAwareChanged(sortLocaleAware)#
Parameters:

sortLocaleAware – bool

This signal is emitted when the locale aware setting changes to sortLocaleAware.

Notification signal of property isSortLocaleAware .

PySide6.QtCore.QSortFilterProxyModel.sortOrder()#
Return type:

SortOrder

Returns the order currently used for sorting

This returns the most recently used sort order. The default value is AscendingOrder .

See also

sort()

PySide6.QtCore.QSortFilterProxyModel.sortRole()#
Return type:

int

See also

setSortRole()

Getter of property sortRole .

PySide6.QtCore.QSortFilterProxyModel.sortRoleChanged(sortRole)#
Parameters:

sortRole – int

This signal is emitted when the sort role changes to sortRole.

Notification signal of property sortRole .