itemfiltermodel.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2009-03-05
 * Description : Qt item model for database entries
 *
 * Copyright (C) 2009-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C)      2011 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C)      2010 by Andi Clemens <andi dot clemens at gmail dot com>
 * Copyright (C)      2011 by Michael G. Hansen <mike at mghansen dot de>
 * Copyright (C)      2014 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 DIGIKAM_ITEM_FILTER_MODEL_H
#define DIGIKAM_ITEM_FILTER_MODEL_H
 
// Local includes
 
#include "dcategorizedsortfilterproxymodel.h"
#include "textfilter.h"
#include "itemfiltersettings.h"
#include "itemmodel.h"
#include "itemsortsettings.h"
#include "digikam_export.h"
 
namespace Digikam
{
 
class ImageChangeset;
class ItemFilterModel;
class ImageTagChangeset;
class FaceTagsIface;
 
class DIGIKAM_DATABASE_EXPORT ItemFilterModelPrepareHook
{
public:
 
    virtual ~ItemFilterModelPrepareHook() {};
    virtual void prepare(const QVector<ItemInfo>& infos) = 0;
 
private:
 
    Q_DISABLE_COPY(ItemFilterModelPrepareHook)
};
 
// -----------------------------------------------------------------------------------------------
 
class DIGIKAM_DATABASE_EXPORT ImageSortFilterModel : public DCategorizedSortFilterProxyModel
{
    Q_OBJECT
 
public:
 
    explicit ImageSortFilterModel(QObject* const parent = nullptr);
 
    void       setSourceItemModel(ItemModel* const model);
    ItemModel* sourceItemModel()                                                            const;
 
    void                  setSourceFilterModel(ImageSortFilterModel* const model);
    ImageSortFilterModel* sourceFilterModel()                                               const;
 
    QModelIndex mapToSourceItemModel(const QModelIndex& index)                              const;
    QModelIndex mapFromSourceItemModel(const QModelIndex& imagemodel_index)                 const;
    QModelIndex mapFromDirectSourceToSourceItemModel(const QModelIndex& sourceModel_index)  const;
 
    QList<QModelIndex> mapListToSource(const QList<QModelIndex>& indexes)                   const;
    QList<QModelIndex> mapListFromSource(const QList<QModelIndex>& sourceIndexes)           const;
 
    ItemInfo         imageInfo(const QModelIndex& index)                                    const;
    qlonglong        imageId(const QModelIndex& index)                                      const;
    QList<ItemInfo>  imageInfos(const QList<QModelIndex>& indexes)                          const;
    QList<qlonglong> imageIds(const QList<QModelIndex>& indexes)                            const;
 
    QModelIndex indexForPath(const QString& filePath)                                       const;
    QModelIndex indexForItemInfo(const ItemInfo& info)                                      const;
    QModelIndex indexForImageId(qlonglong id)                                               const;
 
    QList<ItemInfo> imageInfosSorted()                                                      const;
 
    virtual ItemFilterModel* imageFilterModel()                                             const;
 
protected:
 
    virtual void setDirectSourceItemModel(ItemModel* const model);
 
    void setSourceModel(QAbstractItemModel* const model)                                   override;
 
protected:
 
    ImageSortFilterModel* m_chainedModel;
};
 
// -----------------------------------------------------------------------------------------------
 
class DIGIKAM_DATABASE_EXPORT ItemFilterModel : public ImageSortFilterModel
{
    Q_OBJECT
 
public:
 
    enum ItemFilterModelRoles
    {
        CategorizationModeRole      = ItemModel::FilterModelRoles + 1,
 
        SortOrderRole               = ItemModel::FilterModelRoles + 2,
 
        //CategoryCountRole         = ItemModel::FilterModelRoles + 3,
 
        CategoryAlbumIdRole         = ItemModel::FilterModelRoles + 3,
 
        CategoryFormatRole          = ItemModel::FilterModelRoles + 4,
 
        CategoryDateRole            = ItemModel::FilterModelRoles + 5,
 
        CategoryFaceRole            = ItemModel::FilterModelRoles + 6,
 
        GroupIsOpenRole             = ItemModel::FilterModelRoles + 7,
        ItemFilterModelPointerRole  = ItemModel::FilterModelRoles + 50
    };
 
public:
 
    explicit ItemFilterModel(QObject* const parent = nullptr);
    ~ItemFilterModel() override;
 
    void addPrepareHook(ItemFilterModelPrepareHook* const hook);
    void removePrepareHook(ItemFilterModelPrepareHook* const hook);
 
    DatabaseFields::Set suggestedWatchFlags()                                               const;
 
    ItemFilterSettings        imageFilterSettings()                                         const;
    VersionItemFilterSettings versionItemFilterSettings()                                   const;
    GroupItemFilterSettings   groupItemFilterSettings()                                     const;
    ItemSortSettings          imageSortSettings()                                           const;
 
    bool isGroupOpen(qlonglong group)                                                       const;
    bool isAllGroupsOpen()                                                                  const;
 
    void setSendItemInfoSignals(bool sendSignals);
 
    QVariant data(const QModelIndex& index, int role = Qt::DisplayRole)             const override;
    ItemFilterModel* imageFilterModel()                                             const override;
 
public Q_SLOTS:
 
    void setVersionItemFilterSettings(const VersionItemFilterSettings& settings);
 
    void setGroupItemFilterSettings(const GroupItemFilterSettings& settings);
 
    void setDayFilter(const QList<QDateTime>& days);
    void setTagFilter(const QList<int>& includedTags, const QList<int>& excludedTags,
                      ItemFilterSettings::MatchingCondition matchingCond, bool showUnTagged,
                      const QList<int>& clTagIds, const QList<int>& plTagIds);
    void setRatingFilter(int rating, ItemFilterSettings::RatingCondition ratingCond, bool isUnratedExcluded);
    void setMimeTypeFilter(int mimeTypeFilter);
    void setGeolocationFilter(const ItemFilterSettings::GeolocationCondition& condition);
    void setTextFilter(const SearchTextFilterSettings& settings);
 
    void setCategorizationMode(ItemSortSettings::CategorizationMode mode);
    void setCategorizationSortOrder(ItemSortSettings::SortOrder order);
    void setSortRole(ItemSortSettings::SortRole role);
    void setSortOrder(ItemSortSettings::SortOrder order);
    void setStringTypeNatural(bool natural);
    void setUrlWhitelist(const QList<QUrl>& urlList, const QString& id);
    void setIdWhitelist(const QList<qlonglong>& idList, const QString& id);
 
    void setVersionManagerSettings(const VersionManagerSettings& settings);
    void setExceptionList(const QList<qlonglong>& idlist, const QString& id);
 
    void setGroupOpen(qlonglong group, bool open);
    void toggleGroupOpen(qlonglong group);
    void setAllGroupsOpen(bool open);
 
    virtual void setItemFilterSettings(const ItemFilterSettings& settings);
 
    virtual void setItemSortSettings(const ItemSortSettings& settings);
 
Q_SIGNALS:
 
    void filterMatches(bool matches);
 
    void filterMatchesForText(bool matchesByText);
 
    void filterSettingsChanged(const ItemFilterSettings& settings);
 
    void imageInfosAdded(const QList<ItemInfo>& infos);
    void imageInfosAboutToBeRemoved(const QList<ItemInfo>& infos);
 
public:
 
    class ItemFilterModelPrivate;
 
protected:
 
    ItemFilterModelPrivate* const d_ptr;
 
protected:
 
    ItemFilterModel(ItemFilterModelPrivate& dd, QObject* const parent);
 
    void setDirectSourceItemModel(ItemModel* const model)                                 override;
 
    bool filterAcceptsRow(int source_row, const QModelIndex& source_parent)         const override;
 
    int  compareCategories(const QModelIndex& left, const QModelIndex& right)       const override;
    bool subSortLessThan(const QModelIndex& left, const QModelIndex& right)         const override;
/*
    virtual int  categoryCount(const ItemInfo& info)                                        const;
*/
    virtual int compareInfosCategories(const ItemInfo& left, const ItemInfo& right)          const;
 
    virtual int compareInfosCategories(const ItemInfo& left, const ItemInfo& right,
                                       const FaceTagsIface& leftFace,
                                       const FaceTagsIface& rightFace)                       const;
 
    virtual bool infosLessThan(const ItemInfo& left, const ItemInfo& right)                  const;
 
    virtual QString categoryIdentifier(const ItemInfo& info, const FaceTagsIface& face)      const;
 
protected Q_SLOTS:
 
    void slotModelReset();
    void slotUpdateFilter();
 
    void slotImageTagChange(const ImageTagChangeset& changeset);
    void slotImageChange(const ImageChangeset& changeset);
 
    void slotRowsInserted(const QModelIndex& parent, int start, int end);
    void slotRowsAboutToBeRemoved(const QModelIndex& parent, int start, int end);
 
private:
 
    Q_DECLARE_PRIVATE(ItemFilterModel)
};
 
// -----------------------------------------------------------------------------------------------------
 
class DIGIKAM_DATABASE_EXPORT NoDuplicatesItemFilterModel : public ImageSortFilterModel
{
    Q_OBJECT
 
public:
 
    explicit NoDuplicatesItemFilterModel(QObject* const parent = nullptr);
 
protected:
 
    bool filterAcceptsRow(int source_row, const QModelIndex& source_parent)         const override;
};
 
} // namespace Digikam
 
Q_DECLARE_METATYPE(Digikam::ItemFilterModel*)
 
#endif // DIGIKAM_ITEM_FILTER_MODEL_H