Plasma::SortFilterModel Class Reference

#include <datamodel.h>

Inheritance diagram for Plasma::SortFilterModel:

Properties
int	count
QJSValue	filterCallback
QString	filterRegExp
QString	filterRole
QString	filterString
int	sortColumn
Qt::SortOrder	sortOrder
QString	sortRole
QAbstractItemModel	sourceModel
Properties inherited from QSortFilterProxyModel
	dynamicSortFilter
	filterCaseSensitivity
	filterKeyColumn
	filterRegExp
	filterRegularExpression
	filterRole
	isSortLocaleAware
	recursiveFilteringEnabled
	sortCaseSensitivity
	sortRole
Properties inherited from QAbstractProxyModel
	sourceModel
Properties inherited from QObject
	objectName

Signals
void	countChanged ()
void	filterRegExpChanged (const QString &)
	Q_REVISION (1) void filterCallbackChanged(const QJSValue &)
	Q_REVISION (1) void filterStringChanged(const QString &)
void	sortColumnChanged ()
void	sourceModelChanged (QObject *)

Public Member Functions
	SortFilterModel (QObject *parent=nullptr)
int	count () const
QJSValue	filterCallback () const
QString	filterRegExp () const
QString	filterRole () const
QString	filterString () const
Q_INVOKABLE QVariantMap	get (int i) const
Q_INVOKABLE int	mapRowFromSource (int i) const
Q_INVOKABLE int	mapRowToSource (int i) const
void	setFilterCallback (const QJSValue &callback)
void	setFilterRegExp (const QString &exp)
void	setFilterRole (const QString &role)
void	setFilterString (const QString &filterString)
void	setModel (QAbstractItemModel *source)
void	setSortColumn (int column)
void	setSortOrder (const Qt::SortOrder order)
void	setSortRole (const QString &role)
QString	sortRole () const
Public Member Functions inherited from QSortFilterProxyModel
	QSortFilterProxyModel (QObject *parent)
virtual QModelIndex	buddy (const QModelIndex &index) const const override
virtual bool	canFetchMore (const QModelIndex &parent) const const override
void	clear ()
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
QRegExp	filterRegExp () 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
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	setFilterRegExp (const QRegExp &regExp)
void	setFilterRegExp (const QString &pattern)
void	setFilterRegularExpression (const QRegularExpression &regularExpression)
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 void	setSourceModel (QAbstractItemModel *sourceModel) override
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)
virtual bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const const override
virtual QMap< int, QVariant >	itemData (const QModelIndex &proxyIndex) const const override
virtual void	revert () 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, QAbstractItemModel::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 &parent, int start, int end, const QModelIndex &destination, int column)
void	columnsRemoved (const QModelIndex &parent, int first, int last)
void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector< 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)
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 &parent, int start, int end, const QModelIndex &destination, int row)
void	rowsRemoved (const QModelIndex &parent, int first, int last)
void	setSupportedDragActions (Qt::DropActions actions)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
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 ()
void	dumpObjectInfo () const const
void	dumpObjectTree ()
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 QRegExp &regExp, 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
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
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_DISABLE_COPY (Class)
	Q_DISABLE_COPY_MOVE (Class)
	Q_DISABLE_MOVE (Class)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	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	qFindChild (const QObject *obj, const QString &name)
QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T >	qFindChildren (const QObject *obj, const QString &name)
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	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
QThread *	thread () const const

Protected Slots
void	syncRoleNames ()

Protected Member Functions
bool	filterAcceptsRow (int source_row, const QModelIndex &source_parent) const override
QHash< int, QByteArray >	roleNames () const override
int	roleNameToId (const QString &name) const
Protected Member Functions inherited from QSortFilterProxyModel
virtual bool	filterAcceptsColumn (int source_column, const QModelIndex &source_parent) const const
void	filterChanged ()
void	invalidateFilter ()
virtual bool	lessThan (const QModelIndex &source_left, const QModelIndex &source_right) const const
Protected Member Functions inherited from QAbstractProxyModel
void	resetInternalData ()
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, quintptr id) const const
QModelIndex	createIndex (int row, int column, void *ptr) const const
void	endInsertColumns ()
void	endInsertRows ()
void	endMoveColumns ()
void	endMoveRows ()
void	endRemoveColumns ()
void	endRemoveRows ()
void	endResetModel ()
QModelIndexList	persistentIndexList () const const
void	reset ()
void	resetInternalData ()
void	setRoleNames (const QHash< int, QByteArray > &roleNames)
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
enum	LayoutChangeHint
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)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QAbstractItemModel
typedef	CheckIndexOptions
	DoNotUseParent
	HorizontalSortHint
	IndexIsValid
	NoLayoutChangeHint
	NoOption
	ParentIsInvalid
	VerticalSortHint
Public Attributes inherited from QObject
typedef	QObjectList

Detailed Description

Filter and sort an existing QAbstractItemModel.

Definition at line 28 of file datamodel.h.

Property Documentation

count

int Plasma::SortFilterModel::count

read

How many items are in this model.

Definition at line 79 of file datamodel.h.

filterCallback

QJSValue SortFilterModel::filterCallback

readwrite

A JavaScript callable that is passed the source model row index as first argument and the value of filterRole as second argument.

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 filterCallable 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 54 of file datamodel.h.

filterRegExp

QString SortFilterModel::filterRegExp

readwrite

The regular expression for the filter, only items with their filterRole matching filterRegExp will be displayed.

Definition at line 39 of file datamodel.h.

filterRole

QString SortFilterModel::filterRole

readwrite

The role of the sourceModel on which filterRegExp must be applied.

Definition at line 59 of file datamodel.h.

filterString

QString SortFilterModel::filterString

readwrite

The string for the filter, only items with their filterRole matching filterString will be displayed.

Definition at line 44 of file datamodel.h.

sortColumn

int Plasma::SortFilterModel::sortColumn

readwrite

Specify which column should be used for sorting.

Definition at line 74 of file datamodel.h.

sortOrder

Qt::SortOrder Plasma::SortFilterModel::sortOrder

readwrite

One of Qt.Ascending or Qt.Descending.

Definition at line 69 of file datamodel.h.

sortRole

QString SortFilterModel::sortRole

readwrite

The role of the sourceModel that will be used for sorting.

if empty the order will be left unaltered

Definition at line 64 of file datamodel.h.

sourceModel

QAbstractItemModel Plasma::SortFilterModel::sourceModel

readwrite

The source model of this sorting proxy model.

It has to inherit QAbstractItemModel (ListModel is not supported)

Definition at line 34 of file datamodel.h.

Member Function Documentation

get()

QVariantMap SortFilterModel::get

(

int

i

)

const

Returns the item at index in the list model.

This allows the item data to be accessed (but not modified) from JavaScript. It returns an Object with a property for each role.

Parameters

i	the row we want

Definition at line 190 of file datamodel.cpp.

---

The documentation for this class was generated from the following files:

• datamodel.h
• datamodel.cpp