KSortFilterProxyModel
#include <ksortfilterproxymodel.h>
Properties | |
int | count |
QJSValue | filterColumnCallback |
QString | filterRoleName |
QJSValue | filterRowCallback |
QML_ELEMENTQString | filterString |
int | sortColumn |
Qt::SortOrder | sortOrder |
QString | sortRoleName |
Properties inherited from QSortFilterProxyModel | |
autoAcceptChildRows | |
dynamicSortFilter | |
filterCaseSensitivity | |
filterKeyColumn | |
filterRegularExpression | |
filterRole | |
isSortLocaleAware | |
recursiveFilteringEnabled | |
sortCaseSensitivity | |
sortRole | |
Properties inherited from QAbstractProxyModel | |
sourceModel | |
Properties inherited from QObject | |
objectName | |
Signals | |
void | filterColumnCallbackChanged (const QJSValue &) |
void | filterRoleNameChanged () |
void | filterRowCallbackChanged (const QJSValue &) |
void | filterStringChanged () |
void | rowCountChanged () |
void | sortColumnChanged () |
void | sortOrderChanged () |
void | sortRoleNameChanged () |
Public Slots | |
void | invalidateFilter () |
Public Member Functions | |
KSortFilterProxyModel (QObject *parent=nullptr) | |
void | classBegin () override |
void | componentComplete () override |
QJSValue | filterColumnCallback () const |
QString | filterRoleName () const |
QJSValue | filterRowCallback () const |
QString | filterString () const |
void | setFilterColumnCallback (const QJSValue &callback) |
void | setFilterRoleName (const QString &roleName) |
void | setFilterRowCallback (const QJSValue &callback) |
void | setFilterString (const QString &filterString) |
void | setSortColumn (int column) |
void | setSortOrder (const Qt::SortOrder order) |
void | setSortRoleName (const QString &roleName) |
void | setSourceModel (QAbstractItemModel *sourceModel) override |
QString | sortRoleName () const |
Public Member Functions inherited from QSortFilterProxyModel | |
QSortFilterProxyModel (QObject *parent) | |
bool | autoAcceptChildRows () const const |
void | autoAcceptChildRowsChanged (bool autoAcceptChildRows) |
QBindable< bool > | bindableAutoAcceptChildRows () |
QBindable< bool > | bindableDynamicSortFilter () |
QBindable< Qt::CaseSensitivity > | bindableFilterCaseSensitivity () |
QBindable< int > | bindableFilterKeyColumn () |
QBindable< QRegularExpression > | bindableFilterRegularExpression () |
QBindable< int > | bindableFilterRole () |
QBindable< bool > | bindableIsSortLocaleAware () |
QBindable< bool > | bindableRecursiveFilteringEnabled () |
QBindable< Qt::CaseSensitivity > | bindableSortCaseSensitivity () |
QBindable< int > | bindableSortRole () |
virtual QModelIndex | buddy (const QModelIndex &index) const const override |
virtual bool | canFetchMore (const QModelIndex &parent) const const override |
virtual int | columnCount (const QModelIndex &parent) const const override |
virtual QVariant | data (const QModelIndex &index, int role) const const override |
virtual bool | dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override |
bool | dynamicSortFilter () const const |
virtual void | fetchMore (const QModelIndex &parent) override |
Qt::CaseSensitivity | filterCaseSensitivity () const const |
void | filterCaseSensitivityChanged (Qt::CaseSensitivity filterCaseSensitivity) |
int | filterKeyColumn () const const |
QRegularExpression | filterRegularExpression () const const |
int | filterRole () const const |
void | filterRoleChanged (int filterRole) |
virtual Qt::ItemFlags | flags (const QModelIndex &index) const const override |
virtual bool | hasChildren (const QModelIndex &parent) const const override |
virtual QVariant | headerData (int section, Qt::Orientation orientation, int role) const const override |
virtual QModelIndex | index (int row, int column, const QModelIndex &parent) const const override |
virtual bool | insertColumns (int column, int count, const QModelIndex &parent) override |
virtual bool | insertRows (int row, int count, const QModelIndex &parent) override |
void | invalidate () |
bool | isRecursiveFilteringEnabled () const const |
bool | isSortLocaleAware () const const |
virtual QModelIndex | mapFromSource (const QModelIndex &sourceIndex) const const override |
virtual QItemSelection | mapSelectionFromSource (const QItemSelection &sourceSelection) const const override |
virtual QItemSelection | mapSelectionToSource (const QItemSelection &proxySelection) const const override |
virtual QModelIndex | mapToSource (const QModelIndex &proxyIndex) const const override |
virtual QModelIndexList | match (const QModelIndex &start, int role, const QVariant &value, int hits, Qt::MatchFlags flags) const const override |
virtual QMimeData * | mimeData (const QModelIndexList &indexes) const const override |
virtual QStringList | mimeTypes () const const override |
virtual QModelIndex | parent (const QModelIndex &child) const const override |
void | recursiveFilteringEnabledChanged (bool recursiveFilteringEnabled) |
virtual bool | removeColumns (int column, int count, const QModelIndex &parent) override |
virtual bool | removeRows (int row, int count, const QModelIndex &parent) override |
virtual int | rowCount (const QModelIndex &parent) const const override |
void | setAutoAcceptChildRows (bool accept) |
virtual bool | setData (const QModelIndex &index, const QVariant &value, int role) override |
void | setDynamicSortFilter (bool enable) |
void | setFilterCaseSensitivity (Qt::CaseSensitivity cs) |
void | setFilterFixedString (const QString &pattern) |
void | setFilterKeyColumn (int column) |
void | setFilterRegularExpression (const QRegularExpression ®ularExpression) |
void | setFilterRegularExpression (const QString &pattern) |
void | setFilterRole (int role) |
void | setFilterWildcard (const QString &pattern) |
virtual bool | setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role) override |
void | setRecursiveFilteringEnabled (bool recursive) |
void | setSortCaseSensitivity (Qt::CaseSensitivity cs) |
void | setSortLocaleAware (bool on) |
void | setSortRole (int role) |
virtual QModelIndex | sibling (int row, int column, const QModelIndex &idx) const const override |
virtual void | sort (int column, Qt::SortOrder order) override |
Qt::CaseSensitivity | sortCaseSensitivity () const const |
void | sortCaseSensitivityChanged (Qt::CaseSensitivity sortCaseSensitivity) |
int | sortColumn () const const |
void | sortLocaleAwareChanged (bool sortLocaleAware) |
Qt::SortOrder | sortOrder () const const |
int | sortRole () const const |
void | sortRoleChanged (int sortRole) |
virtual QSize | span (const QModelIndex &index) const const override |
virtual Qt::DropActions | supportedDropActions () const const override |
Public Member Functions inherited from QAbstractProxyModel | |
QAbstractProxyModel (QObject *parent) | |
QBindable< QAbstractItemModel * > | bindableSourceModel () |
virtual bool | canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const const override |
virtual bool | clearItemData (const QModelIndex &index) override |
virtual QMap< int, QVariant > | itemData (const QModelIndex &proxyIndex) const const override |
virtual void | revert () override |
virtual QHash< int, QByteArray > | roleNames () const const override |
virtual bool | setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles) override |
QAbstractItemModel * | sourceModel () const const |
void | sourceModelChanged () |
virtual bool | submit () override |
virtual Qt::DropActions | supportedDragActions () const const override |
Public Member Functions inherited from QAbstractItemModel | |
QAbstractItemModel (QObject *parent) | |
bool | checkIndex (const QModelIndex &index, CheckIndexOptions options) const const |
void | columnsAboutToBeInserted (const QModelIndex &parent, int first, int last) |
void | columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn) |
void | columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last) |
void | columnsInserted (const QModelIndex &parent, int first, int last) |
void | columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn) |
void | columnsRemoved (const QModelIndex &parent, int first, int last) |
void | dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles) |
bool | hasIndex (int row, int column, const QModelIndex &parent) const const |
void | headerDataChanged (Qt::Orientation orientation, int first, int last) |
bool | insertColumn (int column, const QModelIndex &parent) |
bool | insertRow (int row, const QModelIndex &parent) |
void | layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint) |
void | layoutChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint) |
void | modelAboutToBeReset () |
void | modelReset () |
bool | moveColumn (const QModelIndex &sourceParent, int sourceColumn, const QModelIndex &destinationParent, int destinationChild) |
virtual bool | moveColumns (const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destinationParent, int destinationChild) |
bool | moveRow (const QModelIndex &sourceParent, int sourceRow, const QModelIndex &destinationParent, int destinationChild) |
virtual bool | moveRows (const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild) |
virtual void | multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const const |
bool | removeColumn (int column, const QModelIndex &parent) |
bool | removeRow (int row, const QModelIndex &parent) |
void | rowsAboutToBeInserted (const QModelIndex &parent, int start, int end) |
void | rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow) |
void | rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last) |
void | rowsInserted (const QModelIndex &parent, int first, int last) |
void | rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow) |
void | rowsRemoved (const QModelIndex &parent, int first, int last) |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QBindable< QString > | bindableObjectName () |
bool | blockSignals (bool block) |
const QObjectList & | children () const const |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) const const |
bool | disconnect (const QObject *receiver, const char *method) const const |
void | dumpObjectInfo () const const |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (Qt::FindChildOptions options) const const |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isQuickItemType () const const |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_GADGET_EXPORT (EXPORT_MACRO) | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
Q_MOC_INCLUDE Q_MOC_INCLUDE | |
Q_NAMESPACE Q_NAMESPACE | |
Q_NAMESPACE_EXPORT (EXPORT_MACRO) | |
Q_OBJECT Q_OBJECT | |
Q_PROPERTY (...) | |
Q_REVISION Q_REVISION | |
Q_SET_OBJECT_NAME (Object) | |
Q_SIGNAL Q_SIGNAL | |
Q_SIGNALS Q_SIGNALS | |
Q_SLOT Q_SLOT | |
Q_SLOTS Q_SLOTS | |
T | qobject_cast (const QObject *object) |
T | qobject_cast (QObject *object) |
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
void | removeEventFilter (QObject *obj) |
void | setObjectName (const QString &name) |
void | setObjectName (QAnyStringView name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | setProperty (const char *name, QVariant &&value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType) |
QThread * | thread () const const |
Public Member Functions inherited from QQmlParserStatus |
Protected Slots | |
void | syncFilterRoleProperties () |
void | syncRoleNames () |
void | syncSortRoleProperties () |
Protected Member Functions | |
bool | filterAcceptsColumn (int source_column, const QModelIndex &source_parent) const override |
bool | filterAcceptsRow (int source_row, const QModelIndex &source_parent) const override |
int | roleNameToId (const QString &name) const |
Protected Member Functions inherited from QSortFilterProxyModel | |
void | invalidateColumnsFilter () |
void | invalidateFilter () |
void | invalidateRowsFilter () |
virtual bool | lessThan (const QModelIndex &source_left, const QModelIndex &source_right) const const |
Protected Member Functions inherited from QAbstractProxyModel | |
QModelIndex | createSourceIndex (int row, int col, void *internalPtr) const const |
Protected Member Functions inherited from QAbstractItemModel | |
void | beginInsertColumns (const QModelIndex &parent, int first, int last) |
void | beginInsertRows (const QModelIndex &parent, int first, int last) |
bool | beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild) |
bool | beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild) |
void | beginRemoveColumns (const QModelIndex &parent, int first, int last) |
void | beginRemoveRows (const QModelIndex &parent, int first, int last) |
void | beginResetModel () |
void | changePersistentIndex (const QModelIndex &from, const QModelIndex &to) |
void | changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to) |
QModelIndex | createIndex (int row, int column, const void *ptr) const const |
QModelIndex | createIndex (int row, int column, quintptr id) const const |
void | endInsertColumns () |
void | endInsertRows () |
void | endMoveColumns () |
void | endMoveRows () |
void | endRemoveColumns () |
void | endRemoveRows () |
void | endResetModel () |
QModelIndexList | persistentIndexList () const const |
virtual void | resetInternalData () |
Protected Member Functions inherited from QObject | |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
bool | isSignalConnected (const QMetaMethod &signal) const const |
int | receivers (const char *signal) const const |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Additional Inherited Members | |
Public Types inherited from QAbstractItemModel | |
enum | CheckIndexOption |
typedef | CheckIndexOptions |
enum | LayoutChangeHint |
Public Types inherited from QObject | |
typedef | QObjectList |
Static Public Member Functions inherited from QObject | |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, Functor functor) |
bool | disconnect (const QMetaObject::Connection &connection) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
Public Attributes inherited from QAbstractItemModel | |
DoNotUseParent | |
HorizontalSortHint | |
IndexIsValid | |
NoLayoutChangeHint | |
NoOption | |
ParentIsInvalid | |
VerticalSortHint | |
Detailed Description
Filter and sort an existing QAbstractItemModel.
- Since
- 5.67
Definition at line 26 of file ksortfilterproxymodel.h.
Property Documentation
◆ count
|
read |
The number of top level rows.
Definition at line 89 of file ksortfilterproxymodel.h.
◆ filterColumnCallback
|
readwrite |
A JavaScript callable that can be used to perform advanced filters on a given column.
The callback is passed the source column, and source parent for a given column as arguments.
- See also
- filterRowCallback
Definition at line 60 of file ksortfilterproxymodel.h.
◆ filterRoleName
|
readwrite |
The role of the sourceModel on which the filter will be applied.
This can either be the numerical role value or the role name as a string.
Definition at line 66 of file ksortfilterproxymodel.h.
◆ filterRowCallback
|
readwrite |
A JavaScript callable that can be used to perform advanced filters on a given row.
The callback is passed the source row, and source parent for a given row as arguments
The callable's return value is evaluated as boolean to determine whether the row is accepted (true) or filtered out (false). It overrides the default implementation that uses filterRegExp or filterString; while filterCallback is set those two properties are ignored. Attempts to write a non-callable to this property are silently ignored, but you can set it to null.
Definition at line 52 of file ksortfilterproxymodel.h.
◆ filterString
|
readwrite |
The string for the filter, only rows with their filterRole matching filterString will be displayed.
Definition at line 35 of file ksortfilterproxymodel.h.
◆ sortColumn
|
readwrite |
Specify which column should be used for sorting The default value is -1.
If sortRole is set, the default value is 0.
Definition at line 84 of file ksortfilterproxymodel.h.
◆ sortOrder
|
readwrite |
One of Qt.AscendingOrder or Qt.DescendingOrder.
Definition at line 77 of file ksortfilterproxymodel.h.
◆ sortRoleName
|
readwrite |
The role of the sourceModel that will be used for sorting.
if empty the order will be left unaltered This can either be the numerical role value or the role name as a string.
Definition at line 72 of file ksortfilterproxymodel.h.
Constructor & Destructor Documentation
◆ KSortFilterProxyModel()
|
explicit |
Definition at line 15 of file ksortfilterproxymodel.cpp.
◆ ~KSortFilterProxyModel()
|
override |
Definition at line 32 of file ksortfilterproxymodel.cpp.
Member Function Documentation
◆ classBegin()
|
overridevirtual |
Implements QQmlParserStatus.
Definition at line 299 of file ksortfilterproxymodel.cpp.
◆ componentComplete()
|
overridevirtual |
Implements QQmlParserStatus.
Definition at line 303 of file ksortfilterproxymodel.cpp.
◆ filterAcceptsColumn()
|
overrideprotectedvirtual |
Reimplemented from QSortFilterProxyModel.
Definition at line 116 of file ksortfilterproxymodel.cpp.
◆ filterAcceptsRow()
|
overrideprotectedvirtual |
Reimplemented from QSortFilterProxyModel.
Definition at line 97 of file ksortfilterproxymodel.cpp.
◆ filterColumnCallback()
QJSValue KSortFilterProxyModel::filterColumnCallback | ( | ) | const |
Definition at line 187 of file ksortfilterproxymodel.cpp.
◆ filterRoleName()
QString KSortFilterProxyModel::filterRoleName | ( | ) | const |
Definition at line 258 of file ksortfilterproxymodel.cpp.
◆ filterRowCallback()
QJSValue KSortFilterProxyModel::filterRowCallback | ( | ) | const |
Definition at line 150 of file ksortfilterproxymodel.cpp.
◆ filterString()
QString KSortFilterProxyModel::filterString | ( | ) | const |
Definition at line 145 of file ksortfilterproxymodel.cpp.
◆ invalidateFilter
|
slot |
Invalidates the current filtering.
This function should be called if you are implementing custom filtering through filterRowCallback or filterColumnCallback, and your filter parameters have changed.
- Since
- 5.70
Definition at line 309 of file ksortfilterproxymodel.cpp.
◆ roleNameToId()
|
protected |
Definition at line 62 of file ksortfilterproxymodel.cpp.
◆ setFilterColumnCallback()
void KSortFilterProxyModel::setFilterColumnCallback | ( | const QJSValue & | callback | ) |
Definition at line 171 of file ksortfilterproxymodel.cpp.
◆ setFilterRoleName()
void KSortFilterProxyModel::setFilterRoleName | ( | const QString & | roleName | ) |
Definition at line 242 of file ksortfilterproxymodel.cpp.
◆ setFilterRowCallback()
void KSortFilterProxyModel::setFilterRowCallback | ( | const QJSValue & | callback | ) |
Definition at line 155 of file ksortfilterproxymodel.cpp.
◆ setFilterString()
void KSortFilterProxyModel::setFilterString | ( | const QString & | filterString | ) |
Definition at line 135 of file ksortfilterproxymodel.cpp.
◆ setSortColumn()
void KSortFilterProxyModel::setSortColumn | ( | int | column | ) |
Definition at line 290 of file ksortfilterproxymodel.cpp.
◆ setSortOrder()
void KSortFilterProxyModel::setSortOrder | ( | const Qt::SortOrder | order | ) |
Definition at line 284 of file ksortfilterproxymodel.cpp.
◆ setSortRoleName()
void KSortFilterProxyModel::setSortRoleName | ( | const QString & | roleName | ) |
Definition at line 263 of file ksortfilterproxymodel.cpp.
◆ setSourceModel()
|
overridevirtual |
Reimplemented from QSortFilterProxyModel.
Definition at line 67 of file ksortfilterproxymodel.cpp.
◆ sortRoleName()
QString KSortFilterProxyModel::sortRoleName | ( | ) | const |
Definition at line 279 of file ksortfilterproxymodel.cpp.
◆ syncFilterRoleProperties
|
protectedslot |
Definition at line 220 of file ksortfilterproxymodel.cpp.
◆ syncRoleNames
|
protectedslot |
Definition at line 45 of file ksortfilterproxymodel.cpp.
◆ syncSortRoleProperties
|
protectedslot |
Definition at line 192 of file ksortfilterproxymodel.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Nov 22 2024 12:07:00 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.