SortFilterProxyModel is an implementation of QSortFilterProxyModel conveniently exposed for QML.
With qpm :
qpm install fr.grecko.sortfilterproxymodel- add
include(vendor/vendor.pri)in your .pro if it is not already done import SortFilterProxyModel 0.2to use this library in your QML files
- clone or download this repository
-
qmakeaddinclude (<path/to/SortFilterProxyModel>/SortFilterProxyModel.pri)in your.proCMakeadd $<TARGET_OBJECTS:SortFilterProxyModel> to the sources of your executable target in your cmake project
import SortFilterProxyModel 0.2to use this library in your QML files
- You can do simple filtering and sorting with SortFilterProxyModel:
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
filters: RegExpFilter {
roleName: "lastName"
pattern: textField.text
caseSensitivity: Qt.CaseInsensitive
}
sorters: StringSorter { roleName: "firstName" }
}
ListView {
anchors { top: textField.bottom; bottom: parent.bottom; left: parent.left; right: parent.right }
model: personProxyModel
delegate: Text { text: model.firstName + " " + model.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 multiple
filtersandsorters:
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"; sortOrder: Qt.DescendingOrder },
StringSorter { roleName: "firstName" },
StringSorter { roleName: "lastName" }
]
}
CheckBox {
id:onlyShowFavoritesCheckbox
}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.
You can find an application showcasing this library here: https://github.com/oKcerG/SFPMShowcase
This library is licensed under the MIT License.
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.
The complete documentation reference is available here: https://okcerg.github.io/SortFilterProxyModel/
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.