kcategorizedsortfilterproxymodel.h

Go to the documentation of this file.

/*
 * This file is part of the KDE project
 * Copyright (C) 2007 Rafael Fernández López <ereslibre@kde.org>
 * Copyright (C) 2007 John Tapsell <tapsell@kde.org>
 *
 * 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.
 */

#ifndef KCATEGORIZEDSORTFILTERPROXYMODEL_H
#define KCATEGORIZEDSORTFILTERPROXYMODEL_H

#include <QtGui/QSortFilterProxyModel>

#include <kdeui_export.h>

class QItemSelection;


class KDEUI_EXPORT KCategorizedSortFilterProxyModel
    : public QSortFilterProxyModel
{
public:
    enum AdditionalRoles {
        // Note: use printf "0x%08X\n" $(($RANDOM*$RANDOM))
        // to define additional roles.
        CategoryDisplayRole = 0x17CE990A,  

        CategorySortRole    = 0x27857E60   





    };

    KCategorizedSortFilterProxyModel(QObject *parent = 0);
    virtual ~KCategorizedSortFilterProxyModel();

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

    bool isCategorizedModel() const;

    void setCategorizedModel(bool categorizedModel);

    int sortColumn() const;

    Qt::SortOrder sortOrder() const;

    void setSortCategoriesByNaturalComparison(bool sortCategoriesByNaturalComparison);

    bool sortCategoriesByNaturalComparison() const;

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED static int naturalCompare(const QString &a, const QString &b);
#endif

protected:
    virtual bool lessThan(const QModelIndex &left, const QModelIndex &right) const;

    virtual bool subSortLessThan(const QModelIndex &left, const QModelIndex &right) const;

    virtual int compareCategories(const QModelIndex &left, const QModelIndex &right) const;

private:
    class Private;
    Private *const d;
};


#endif // KCATEGORIZEDSORTFILTERPROXYMODEL_H