KCategorizedSortFilterProxyModel Class Reference

#include <KCategorizedSortFilterProxyModel>

Inheritance diagram for KCategorizedSortFilterProxyModel:

Public Types
enum	AdditionalRoles { CategoryDisplayRole = 0x17CE990A , CategorySortRole = 0x27857E60 }
Public Types inherited from QAbstractItemModel
enum	CheckIndexOption
typedef	CheckIndexOptions
enum	LayoutChangeHint
Public Types inherited from QObject
typedef	QObjectList

Public Member Functions
	KCategorizedSortFilterProxyModel (QObject *parent=nullptr)
bool	isCategorizedModel () const
void	setCategorizedModel (bool categorizedModel)
void	setSortCategoriesByNaturalComparison (bool sortCategoriesByNaturalComparison)
void	sort (int column, Qt::SortOrder order=Qt::AscendingOrder) override
bool	sortCategoriesByNaturalComparison () const
int	sortColumn () const
Qt::SortOrder	sortOrder () 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 &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
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

Protected Member Functions
virtual int	compareCategories (const QModelIndex &left, const QModelIndex &right) const
bool	lessThan (const QModelIndex &left, const QModelIndex &right) const override
virtual bool	subSortLessThan (const QModelIndex &left, const QModelIndex &right) const
Protected Member Functions inherited from QSortFilterProxyModel
virtual bool	filterAcceptsColumn (int source_column, const QModelIndex &source_parent) const const
virtual bool	filterAcceptsRow (int source_row, const QModelIndex &source_parent) const const
void	invalidateColumnsFilter ()
void	invalidateFilter ()
void	invalidateRowsFilter ()
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
Properties inherited from QSortFilterProxyModel
	autoAcceptChildRows
	dynamicSortFilter
	filterCaseSensitivity
	filterKeyColumn
	filterRegularExpression
	filterRole
	isSortLocaleAware
	recursiveFilteringEnabled
	sortCaseSensitivity
	sortRole
Properties inherited from QAbstractProxyModel
	sourceModel
Properties inherited from QObject
	objectName
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

This class lets you categorize a view.

It is meant to be used along with KCategorizedView class.

In general terms all you need to do is to reimplement subSortLessThan() and compareCategories() methods. In order to make categorization work, you need to also call setCategorizedModel() class to enable it, since the categorization is disabled by default.

See also

KCategorizedView

Author

Rafael Fernández López eresl.nosp@m.ibre.nosp@m.@kde..nosp@m.org

Definition at line 35 of file kcategorizedsortfilterproxymodel.h.

Member Enumeration Documentation

AdditionalRoles

enum KCategorizedSortFilterProxyModel::AdditionalRoles

Enumerator
CategoryDisplayRole	This role is used for asking the category to a given index.
CategorySortRole	This role is used for sorting categories. You can return a string or a long long value. Strings will be sorted alphabetically while long long will be sorted by their value. Please note that this value won't be shown on the view, is only for sorting purposes. What will be shown as "Category" on the view will be asked with the role CategoryDisplayRole.

Definition at line 39 of file kcategorizedsortfilterproxymodel.h.

Constructor & Destructor Documentation

KCategorizedSortFilterProxyModel()

KCategorizedSortFilterProxyModel::KCategorizedSortFilterProxyModel

(

QObject *

parent = nullptr

)

Definition at line 14 of file kcategorizedsortfilterproxymodel.cpp.

Member Function Documentation

compareCategories()

int KCategorizedSortFilterProxyModel::compareCategories ( const QModelIndex & left, const QModelIndex & right ) const

protectedvirtual

This method compares the category of the left index with the category of the right index.

Internally and if not reimplemented, this method will ask for left and right models for role CategorySortRole. In order to correctly sort categories, the data() method of the model should return a qlonglong (or numeric) value, or a QString object. QString objects will be sorted with QString::localeAwareCompare if sortCategoriesByNaturalComparison() is true.

Note

Please have present that: QString(QChar(QChar::ObjectReplacementCharacter)) > QString(QChar(QChar::ReplacementCharacter)) > [ all possible strings ] > QString();

This means that QString() will be sorted the first one, while QString(QChar(QChar::ObjectReplacementCharacter)) and QString(QChar(QChar::ReplacementCharacter)) will be sorted in last position.

Warning

Please note that data() method of the model should return always information of the same type. If you return a QString for an index, you should return always QStrings for all indexes for role CategorySortRole in order to correctly sort categories. You can't mix by returning a QString for one index, and a qlonglong for other.

Note

If you need a more complex layout, you will have to reimplement this method.

Returns

A negative value if the category of left should be placed before the category of right. 0 if left and right are on the same category, and a positive value if the category of left should be placed after the category of right.

Definition at line 93 of file kcategorizedsortfilterproxymodel.cpp.

isCategorizedModel()

bool KCategorizedSortFilterProxyModel::isCategorizedModel

(

)

const

Returns

whether the model is categorized or not. Disabled by default.

Definition at line 31 of file kcategorizedsortfilterproxymodel.cpp.

lessThan()

bool KCategorizedSortFilterProxyModel::lessThan ( const QModelIndex & left, const QModelIndex & right ) const

overrideprotectedvirtual

Overridden from QSortFilterProxyModel.

If you are subclassing KCategorizedSortFilterProxyModel, you will probably not need to reimplement this method.

It calls compareCategories() to sort by category. If the both items are in the same category (i.e. compareCategories returns 0), then subSortLessThan is called.

Returns

Returns true if the item left is less than the item right when sorting.

Warning

You usually won't need to reimplement this method when subclassing from KCategorizedSortFilterProxyModel.

Reimplemented from QSortFilterProxyModel.

Definition at line 73 of file kcategorizedsortfilterproxymodel.cpp.

setCategorizedModel()

void KCategorizedSortFilterProxyModel::setCategorizedModel

(

bool

categorizedModel

)

Enables or disables the categorization feature.

Parameters

categorizedModel

whether to enable or disable the categorization feature.

Definition at line 36 of file kcategorizedsortfilterproxymodel.cpp.

setSortCategoriesByNaturalComparison()

void KCategorizedSortFilterProxyModel::setSortCategoriesByNaturalComparison

(

bool

sortCategoriesByNaturalComparison

)

Set if the sorting using CategorySortRole will use a natural comparison in the case that strings were returned.

If enabled, QCollator will be used for sorting.

Parameters

sortCategoriesByNaturalComparison

whether to sort using a natural comparison or not.

Definition at line 57 of file kcategorizedsortfilterproxymodel.cpp.

sort()

void KCategorizedSortFilterProxyModel::sort ( int column, Qt::SortOrder order = Qt::AscendingOrder )

overridevirtual

Overridden from QSortFilterProxyModel.

Sorts the source model using column for the given order.

Reimplemented from QSortFilterProxyModel.

Definition at line 23 of file kcategorizedsortfilterproxymodel.cpp.

sortCategoriesByNaturalComparison()

bool KCategorizedSortFilterProxyModel::sortCategoriesByNaturalComparison

(

)

const

Returns

whether it is being used a natural comparison for sorting. Enabled by default.

Definition at line 68 of file kcategorizedsortfilterproxymodel.cpp.

sortColumn()

int KCategorizedSortFilterProxyModel::sortColumn

(

)

const

Returns

the column being used for sorting.

Definition at line 47 of file kcategorizedsortfilterproxymodel.cpp.

sortOrder()

Qt::SortOrder KCategorizedSortFilterProxyModel::sortOrder

(

)

const

Returns

the sort order being used for sorting.

Definition at line 52 of file kcategorizedsortfilterproxymodel.cpp.

subSortLessThan()

bool KCategorizedSortFilterProxyModel::subSortLessThan ( const QModelIndex & left, const QModelIndex & right ) const

protectedvirtual

This method has a similar purpose as lessThan() has on QSortFilterProxyModel.

It is used for sorting items that are in the same category.

Returns

Returns true if the item left is less than the item right when sorting.

Reimplemented in KDirSortFilterProxyModel.

Definition at line 88 of file kcategorizedsortfilterproxymodel.cpp.

---

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

• kcategorizedsortfilterproxymodel.h
• kcategorizedsortfilterproxymodel.cpp