dcategorizedsortfilterproxymodel.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2010-01-16
 * Description : categorize item view based on DCategorizedView
 *
 * Copyright (C) 2007      by Rafael Fernández López <ereslibre at kde dot org>
 * Copyright (C) 2007      by John Tapsell <tapsell at kde dot org>
 * Copyright (C) 2009-2012 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2011-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 *
 * This program 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 General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_DCATEGORIZED_SORT_FILTER_PROXY_MODEL_H
#define DIGIKAM_DCATEGORIZED_SORT_FILTER_PROXY_MODEL_H
 
// Qt includes
 
#include <QSortFilterProxyModel>
 
// Local includes
 
#include "digikam_export.h"
 
class QItemSelection;
 
namespace Digikam
{
 
class DIGIKAM_EXPORT DCategorizedSortFilterProxyModel : public QSortFilterProxyModel
{
    Q_OBJECT
 
public:
 
    enum AdditionalRoles
    {
        CategoryDisplayRole = 0x17CE990A,
 
        CategorySortRole    = 0x27857E60
    };
 
    explicit DCategorizedSortFilterProxyModel(QObject* const parent = nullptr);
    ~DCategorizedSortFilterProxyModel() override;
 
    void sort(int column, Qt::SortOrder order = Qt::AscendingOrder) override;
 
    bool isCategorizedModel() const;
 
    void setCategorizedModel(bool categorizedModel);
 
    int sortColumn() const;
 
    Qt::SortOrder sortOrder() const;
 
    void setSortCategoriesByNaturalComparison(bool sortCategoriesByNaturalComparison);
 
    bool sortCategoriesByNaturalComparison() const;
 
protected:
    bool lessThan(const QModelIndex& left, const QModelIndex& right) const override;
 
    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;
};
 
// -----------------------------------------------------------------------------------------------------------------------
 
class DIGIKAM_EXPORT ActionSortFilterProxyModel : public DCategorizedSortFilterProxyModel
{
    Q_OBJECT
 
public:
 
    explicit ActionSortFilterProxyModel(QObject* const parent = nullptr);
 
protected:
 
    bool filterAcceptsRow(int source_row, const QModelIndex& source_parent) const override;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_DCATEGORIZED_SORT_FILTER_PROXY_MODEL_H