SortFilterProxyModel

SortFilterProxyModel is an implementation of QSortFilterProxyModel conveniently exposed for QML.

Install

With qpm :

qpm install fr.grecko.sortfilterproxymodel
add include(vendor/vendor.pri) in your .pro if it is not already done
import SortFilterProxyModel 0.1 to use this library in your QML files

Without qpm :

clone or download this repository
add include (<path/to/SortFilterProxyModel>/SortFilterProxyModel.pri) in your .pro
import SortFilterProxyModel 0.1 to use this library in your QML files

Sample Usage

You can do simple filtering and sorting with SortFilterProxyModel's own properties (filter* and sort*):

import QtQuick 2.2
import QtQuick.Controls 1.2
import SortFilterProxyModel 0.2

ApplicationWindow {
    visible: true
    width: 640
    height: 480

    ListModel {
        id: personModel
        ListElement {
            firstName: "Erwan"
            lastName: "Castex"
            favorite: true
        }
        // ...
    }

    TextField {
        id: textField
        anchors { top: parent.top; left: parent.left; right: parent.right }
        height: implicitHeight
    }

    SortFilterProxyModel {
        id: personProxyModel
        sourceModel: personModel
        filterRoleName: "lastName"
        filterPattern: textField.text
        filterCaseSensitivity: Qt.CaseInsensitive
        sortRoleName: "FirstName"
    }

    ListView {
        anchors { top: textField.bottom; bottom: parent.bottom; left: parent.left; right: parent.right }
        model: personProxyModel
        delegate: Text { text: firstName + " " + lastName}
    }
}

Here the ListView will only show elements that contains the content of the TextField in their lastName role.

But you can also achieve more complex filtering or sorting with the filters and sorters list properties :

    SortFilterProxyModel {
        id: personProxyModel
        sourceModel: personModel
        filters: [
            ValueFilter {
                enabled: onlyShowFavoritesCheckbox.checked
                roleName: "favorite"
                value: true
            },
            AnyOf {
                RegExpFilter {
                    roleName: "lastName"
                    pattern: textField.text
                    caseSensitivity: Qt.CaseInsensitive
                }
                RegExpFilter {
                    roleName: "firstName"
                    pattern: textField.text
                    caseSensitivity: Qt.CaseInsensitive
                }
            }
        ]
        sorters: [
            RoleSorter { roleName: "favorite"; ascendingOrder: false },
            RoleSorter { roleName: "firstName" },
            RoleSorter { roleName: "lastName" }
        ]
    }

This will show in the corresponding ListView only the elements where the firstName or the lastName match the text entered in the textField, and if the onlyShowFavoritesCheckbox is checked it will aditionnally filter the elements where favorite is true. The favorited elements will be shown first and all the elements are sorted by firstName and then lastName.

License

This library is licensed under the MIT License.

Documentation

This component is a subclass of QSortFilterProxyModel, to use it, you need to set the sourceModel property to a QAbstractItemModel* with correct role names. This means you can use it with custom c++ models or ListModel, but not with JavaScript models like arrays, integers or object instances.

You can then define how the source model is filtered or sorted by setting the different provided properties.
By default the source model is not sorted or filtered by the proxy model.

When filtering, filterValue is taken in account first, then filterPattern and eventually filterExpression if it's a valid expression. This means you can combine different filtering methods. Prefer using filterValue or filterPattern when possible, filterExpression is slower.
When sorting, the sort is done with sortExpression if it's a valid expression, otherwise it is done with sortRoleName in combination with sortOrder.

Properties

[__`sourceModel`__](http://doc.qt.io/qt-5/qabstractproxymodel.html#sourceModel-prop) : _`QAbstractItemModel*`_ This property holds the source model of this proxy model.

__`filterRoleName`__ : _string_ The role name of the source model's data on which `filterPattern` and `filterValue` are tested against.

__`filterValue`__ : _any_ Only contents with their `filterRoleName` data matching exactly this value (or that can be converted to this value) are available.

__`filterPattern`__ : _string_ The pattern used to filter the contents of the source model. Only the source model's value having their `filterRoleName` data matching this `filterPatern` with the specified `filterPatternSyntax` will be available.

__`filterPatternSyntax`__ : _enumeration_ This property represents the syntax of the pattern used to filter the contents of the source model. The possible values are mirrored from [`QRegExp::PatternSyntax`](http://doc.qt.io/qt-5/qregexp.html#PatternSyntax-enum) :

Value	Description
`SortFilterProxyModel.RegExp`	A rich Perl-like pattern matching syntax. This is the default
`SortFilterProxyModel.RegExp2`	Like RegExp, but with greedy quantifiers
`SortFilterProxyModel.Wildcard`	This provides a simple pattern matching syntax similar to that used by shells (command interpreters) for "file globbing"
`SortFilterProxyModel.WildcardUnix`	This is similar to Wildcard but with the behavior of a Unix shell. The wildcard characters can be escaped with the character ""
`SortFilterProxyModel.FixedString`	The pattern is a fixed string. This is equivalent to using the RegExp pattern on a string in which all metacharacters are escaped
`SortFilterProxyModel.W3CXmlSchema11`	The pattern is a regular expression as defined by the W3C XML Schema 1.1 specification

__`filterCaseSensitivity`__ : _enumeration_ This property holds the case sensitivity of the pattern used to filter the contents of the source model. Can be `Qt.CaseSensitive` or `Qt.CaseInsensitive`. This property only affects the filtering made with `filterPattern`, it does not affect `filterValue` or `filterExpression`. By default, the filter is case sensitive.

__`sortRoleName`__ : _string_ The role name of the source model's data used for the sorting.

__`ascendingSortOrder`__ : _bool_ This property holds whether the sort is done in ascending order. By default, sorting is in ascending order.

__`sortCaseSensitivity`__ : _enumeration_ This property holds the case sensitivity setting used for comparing strings when sorting. Can be `Qt.CaseSensitive` or `Qt.CaseInsensitive`. By default, sorting is case sensitive.

__`isSortLocaleAware`__ : _bool_ This property holds the local aware setting used for comparing strings when sorting. By default, sorting is not local aware.

Contributing

Don't hesitate to open an issue about a suggestion, a bug, a lack of clarity in the documentation, etc.

Pull requests are also welcome, if it's a important change you should open an issue first though.

kastravec/SortFilterProxyModel