showfotofiltermodel.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 30-07-2013
 * Description : Qt filter model for showfoto items
 *
 * Copyright (C) 2013 by Mohamed_Anwer <m_dot_anwer at gmx 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 SHOW_FOTO_FILTER_MODEL_H
#define SHOW_FOTO_FILTER_MODEL_H
 
// Qt includes
 
#include <QObject>
 
// Local includes
 
#include "dcategorizedsortfilterproxymodel.h"
#include "showfotoitemmodel.h"
#include "showfotothumbnailmodel.h"
#include "showfotoitemsortsettings.h"
 
namespace ShowFoto
{
 
class ShowfotoFilterModel;
 
class ShowfotoSortFilterModel : public DCategorizedSortFilterProxyModel
{
    Q_OBJECT
 
public:
 
    explicit ShowfotoSortFilterModel(QObject* const parent = nullptr);
    ~ShowfotoSortFilterModel() override;
 
    void setSourceShowfotoModel(ShowfotoItemModel* const sourceModel);
    ShowfotoItemModel* sourceShowfotoModel()                                                  const;
 
    void setSourceFilterModel(ShowfotoSortFilterModel* const sourceModel);
    ShowfotoSortFilterModel* sourceFilterModel()                                              const;
 
    QModelIndex mapToSourceShowfotoModel(const QModelIndex& proxyIndex)                       const;
    QModelIndex mapFromSourceShowfotoModel(const QModelIndex& showfotoModelIndex)             const;
    QModelIndex mapFromDirectSourceToSourceShowfotoModel(const QModelIndex& sourceModelIndex) const;
 
    QList<QModelIndex> mapListToSource(const QList<QModelIndex>& indexes)                     const;
    QList<QModelIndex> mapListFromSource(const QList<QModelIndex>& sourceIndexes)             const;
 
    ShowfotoItemInfo        showfotoItemInfo(const QModelIndex& index)                        const;
    qlonglong          showfotoItemId(const QModelIndex& index)                               const;
    QList<ShowfotoItemInfo> showfotoItemInfos(const QList<QModelIndex>& indexes)              const;
    QList<qlonglong>   showfotoItemIds(const QList<QModelIndex>& indexes)                     const;
 
    QModelIndex indexForUrl(const QUrl& fileUrl)                                              const;
    QModelIndex indexForShowfotoItemInfo(const ShowfotoItemInfo& info)                        const;
    QModelIndex indexForShowfotoItemId(qlonglong id)                                          const;
 
    QList<ShowfotoItemInfo> showfotoItemInfosSorted()                                         const;
 
    virtual ShowfotoFilterModel* showfotoFilterModel()                                        const;
 
protected:
 
    void setSourceModel(QAbstractItemModel* sourceModel) override;
 
    virtual void setDirectSourceShowfotoModel(ShowfotoItemModel* const sourceModel);
 
protected:
 
    ShowfotoSortFilterModel* m_chainedModel;
};
 
// ------------------------------------------------------------------------------------------
 
class ShowfotoFilterModel : public ShowfotoSortFilterModel
{
    Q_OBJECT
 
public:
 
    enum ShowfotoFilterModelRoles
    {
        CategorizationModeRole         = ShowfotoItemModel::FilterModelRoles + 1,
 
        SortOrderRole                  = ShowfotoItemModel::FilterModelRoles + 2,
 
        CategoryFormatRole             = ShowfotoItemModel::FilterModelRoles + 3,
 
        ShowfotoFilterModelPointerRole = ShowfotoItemModel::FilterModelRoles + 50
    };
 
public:
 
    explicit ShowfotoFilterModel(QObject* const parent = nullptr);
    ~ShowfotoFilterModel() override;
 
    ShowfotoItemSortSettings showfotoItemSortSettings()                                 const;
 
    void setShowfotoItemSortSettings(const ShowfotoItemSortSettings& sorter);
 
    void setSendShowfotoItemInfoSignals(bool sendSignals);
/*
    TODO: Implement grouping in Showfoto tool.
    bool isGroupOpen(qlonglong group) const;
    bool isAllGroupsOpen() const;
*/
    QVariant data(const QModelIndex& index, int role = Qt::DisplayRole)                 const override;
    ShowfotoFilterModel* showfotoFilterModel()                                          const override;
 
public Q_SLOTS:
 
    void setCategorizationMode(ShowfotoItemSortSettings::CategorizationMode mode);
    void setSortRole(ShowfotoItemSortSettings::SortRole role);
    void setSortOrder(ShowfotoItemSortSettings::SortOrder order);
/*
    TODO: Implement grouping in Showfoto tool.
    void setGroupOpen(qlonglong group, bool open);
    void toggleGroupOpen(qlonglong group);
    void setAllGroupsOpen(bool open);
 
    TODO: Implement filtering in Showfoto tool.
    virtual void setItemFilterSettings(const ItemFilterSettings& settings);
 
    TODO: virtual void setItemSortSettings(const ItemSortSettings& settings);
*/
 
Q_SIGNALS:
 
    void showfotoItemInfosAdded(const QList<ShowfotoItemInfo>& infos);
    void showfotoItemInfosAboutToBeRemoved(const QList<ShowfotoItemInfo>& infos);
 
protected Q_SLOTS:
 
    void slotRowsInserted(const QModelIndex& parent, int start, int end);
    void slotRowsAboutToBeRemoved(const QModelIndex& parent, int start, int end);
 
public:
 
    class ShowfotoFilterModelPrivate;
 
protected:
 
    ShowfotoFilterModelPrivate* const d_ptr;
 
protected:
 
    void setDirectSourceShowfotoModel(ShowfotoItemModel* const sourceModel)                   override;
/*
    TODO
    virtual bool filterAcceptsRow(int source_row, const QModelIndex& source_parent) const;
*/
    int compareCategories(const QModelIndex& left, const QModelIndex& right)            const override;
    bool subSortLessThan(const QModelIndex& left, const QModelIndex& right)             const override;
 
    virtual int compareInfosCategories(const ShowfotoItemInfo& left,
                                       const ShowfotoItemInfo& right)                   const;
 
    virtual bool infosLessThan(const ShowfotoItemInfo& left,
                               const ShowfotoItemInfo& right)                           const;
 
    virtual QString categoryIdentifier(const ShowfotoItemInfo& info)                    const;
 
private:
 
    Q_DECLARE_PRIVATE(ShowfotoFilterModel)
};
 
// -----------------------------------------------------------------------------------------------------
 
class NoDuplicatesShowfotoFilterModel : public ShowfotoSortFilterModel
{
    Q_OBJECT
 
public:
 
    explicit NoDuplicatesShowfotoFilterModel(QObject* const parent = nullptr);
 
protected:
 
    bool filterAcceptsRow(int source_row, const QModelIndex& source_parent)             const override;
};
 
} // namespace ShowFoto
 
Q_DECLARE_METATYPE(ShowFoto::ShowfotoFilterModel*)
 
#endif // SHOW_FOTO_FILTER_MODEL_H