KDEUI
#include <kcategorizedsortfilterproxymodel.h>
Public Types | |
enum | AdditionalRoles { CategoryDisplayRole = 0x17CE990A, CategorySortRole = 0x27857E60 } |
Public Member Functions | |
KCategorizedSortFilterProxyModel (QObject *parent=0) | |
virtual | ~KCategorizedSortFilterProxyModel () |
bool | isCategorizedModel () const |
void | setCategorizedModel (bool categorizedModel) |
void | setSortCategoriesByNaturalComparison (bool sortCategoriesByNaturalComparison) |
virtual void | sort (int column, Qt::SortOrder order=Qt::AscendingOrder) |
bool | sortCategoriesByNaturalComparison () const |
int | sortColumn () const |
Qt::SortOrder | sortOrder () const |
Static Public Member Functions | |
static int | naturalCompare (const QString &a, const QString &b) |
Protected Member Functions | |
virtual int | compareCategories (const QModelIndex &left, const QModelIndex &right) const |
virtual bool | lessThan (const QModelIndex &left, const QModelIndex &right) const |
virtual bool | subSortLessThan (const QModelIndex &left, const QModelIndex &right) const |
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
Definition at line 45 of file kcategorizedsortfilterproxymodel.h.
Member Enumeration Documentation
Definition at line 49 of file kcategorizedsortfilterproxymodel.h.
Constructor & Destructor Documentation
KCategorizedSortFilterProxyModel::KCategorizedSortFilterProxyModel | ( | QObject * | parent = 0 | ) |
This file is part of the KDE project Copyright (C) 2007 Rafael Fernández López eresl Copyright (C) 2007 John Tapsell ibre @kde. orgtapse ll@k de.or g
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details.
You should have received a copy of the GNU Library General Public License along with this library; see the file COPYING.LIB. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Definition at line 33 of file kcategorizedsortfilterproxymodel.cpp.
|
virtual |
Definition at line 40 of file kcategorizedsortfilterproxymodel.cpp.
Member Function Documentation
|
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() metod 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 ofright
. 0 ifleft
andright
are on the same category, and a positive value if the category ofleft
should be placed after the category ofright
.
Definition at line 129 of file kcategorizedsortfilterproxymodel.cpp.
bool KCategorizedSortFilterProxyModel::isCategorizedModel | ( | ) | const |
- Returns
- whether the model is categorized or not. Disabled by default.
Definition at line 53 of file kcategorizedsortfilterproxymodel.cpp.
|
protectedvirtual |
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 itemright
when sorting.
- Warning
- You usually won't need to reimplement this method when subclassing from KCategorizedSortFilterProxyModel.
Definition at line 105 of file kcategorizedsortfilterproxymodel.cpp.
|
static |
Does a natural comparing of the strings.
A negative value is returned if a is smaller than b. A positive value is returned if a is greater than b. 0 is returned if both values are equal.
- Deprecated:
- Use KStringHandler::naturalCompare() instead.
Definition at line 98 of file kcategorizedsortfilterproxymodel.cpp.
void KCategorizedSortFilterProxyModel::setCategorizedModel | ( | bool | categorizedModel | ) |
Enables or disables the categorization feature.
- Parameters
-
categorizedModel whether to enable or disable the categorization feature.
Definition at line 58 of file kcategorizedsortfilterproxymodel.cpp.
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, QString::localeAwareCompare will be used for sorting.
- Parameters
-
sortCategoriesByNaturalComparison whether to sort using a natural comparison or not.
Definition at line 80 of file kcategorizedsortfilterproxymodel.cpp.
|
virtual |
Overridden from QSortFilterProxyModel.
Sorts the source model using column
for the given order
.
Definition at line 45 of file kcategorizedsortfilterproxymodel.cpp.
bool KCategorizedSortFilterProxyModel::sortCategoriesByNaturalComparison | ( | ) | const |
- Returns
- whether it is being used a natural comparison for sorting. Enabled by default.
Definition at line 92 of file kcategorizedsortfilterproxymodel.cpp.
int KCategorizedSortFilterProxyModel::sortColumn | ( | ) | const |
- Returns
- the column being used for sorting.
Definition at line 70 of file kcategorizedsortfilterproxymodel.cpp.
Qt::SortOrder KCategorizedSortFilterProxyModel::sortOrder | ( | ) | const |
- Returns
- the sort order being used for sorting.
Definition at line 75 of file kcategorizedsortfilterproxymodel.cpp.
|
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 itemright
when sorting.
Definition at line 124 of file kcategorizedsortfilterproxymodel.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:49:17 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.