albumfiltermodel.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2009-03-24
 * Description : Qt Model for Albums - filter model
 *
 * Copyright (C) 2008-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2009      by Johannes Wienke <languitar at semipol 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_ALBUM_FILTER_MODEL_H
#define DIGIKAM_ALBUM_FILTER_MODEL_H
 
// Qt includes
 
#include <QPointer>
#include <QSortFilterProxyModel>
#include <QTreeView>
 
// Local includes
 
#include "albummodel.h"
#include "searchtextbar.h"
#include "digikam_export.h"
 
namespace Digikam
{
 
class DIGIKAM_GUI_EXPORT AlbumFilterModel : public QSortFilterProxyModel
{
    Q_OBJECT
 
public:
 
    enum MatchResult
    {
        NoMatch = 0,
        DirectMatch,
        ParentMatch,
        ChildMatch,
        SpecialMatch
    };
 
    enum FilterBehavior
    {
        SimpleFiltering,
        FullFiltering,
        StrictFiltering
    };
 
public:
 
    explicit AlbumFilterModel(QObject* const parent = nullptr);
 
    void                setSourceAlbumModel(AbstractAlbumModel* const source);
    AbstractAlbumModel* sourceAlbumModel()                                  const;
 
    void              setSourceFilterModel(AlbumFilterModel* const source);
    AlbumFilterModel* sourceFilterModel()                                   const;
 
    QModelIndex       mapToSourceAlbumModel(const QModelIndex& index)       const;
    QModelIndex       mapFromSourceAlbumModel(const QModelIndex& index)     const;
 
    Album*      albumForIndex(const QModelIndex& index)                     const;
    QModelIndex indexForAlbum(Album* album)                                 const;
    QModelIndex rootAlbumIndex()                                            const;
    QVariant    dataForCurrentSortRole(Album* album)                        const;
 
    SearchTextSettings searchTextSettings()                                 const;
 
    void setFilterBehavior(FilterBehavior behavior);
 
    MatchResult matchResult(const QModelIndex& index)                       const;
 
    virtual bool isFiltering()                                              const;
 
    void updateFilter();
 
    template <typename T>
    static inline int compareValue(const T& a, const T& b)
    {
        if (a == b)
        {
            return 0;
        }
 
        if (a < b)
        {
            return -1;
        }
        else
        {
            return 1;
        }
    }
 
    static inline int compareByOrder(int compareResult,  Qt::SortOrder sortOrder)
    {
        if (sortOrder == Qt::AscendingOrder)
        {
            return compareResult;
        }
        else
        {
            return (- compareResult);
        }
    }
 
    template <typename T>
    static inline int compareByOrder(const T& a, const T& b, Qt::SortOrder sortOrder)
    {
        return compareByOrder(compareValue(a, b), sortOrder);
    }
 
public Q_SLOTS:
 
    void setSearchTextSettings(const SearchTextSettings& settings);
 
Q_SIGNALS:
 
    void searchTextSettingsAboutToChange(bool searched, bool willSearch);
 
    void searchTextSettingsChanged(bool wasSearching, bool searched);
 
    void signalFilterChanged();
 
    void hasSearchResult(bool hasResult);
 
protected:
 
    MatchResult matchResult(Album* album)                                   const;
 
    virtual bool matches(Album* album)                                      const;
 
    void setSourceModel(QAbstractItemModel* const model)                          override;
 
    bool filterAcceptsRow(int source_row, const QModelIndex& source_parent) const override;
    bool lessThan(const QModelIndex& left, const QModelIndex& right)        const override;
 
protected Q_SLOTS:
 
    void slotAlbumRenamed(Album* album);
    void slotAlbumsHaveBeenUpdated(int type);
 
private:
 
    bool settingsFilter(const SearchTextSettings& settings)                 const;
 
protected:
 
    FilterBehavior             m_filterBehavior;
    SearchTextSettings         m_settings;
    QPointer<AlbumFilterModel> m_chainedModel;
    QObject*                   m_parent;
};
 
// -----------------------------------------------------------------------------------
 
class DIGIKAM_GUI_EXPORT CheckableAlbumFilterModel : public AlbumFilterModel
{
    Q_OBJECT
 
public:
 
    explicit CheckableAlbumFilterModel(QObject* const parent = nullptr);
 
    void setSourceAlbumModel(AbstractCheckableAlbumModel* const source);
    AbstractCheckableAlbumModel* sourceAlbumModel()                             const;
 
    void setSourceFilterModel(CheckableAlbumFilterModel* const source);
 
    void setFilterChecked(bool filter);
    void setFilterPartiallyChecked(bool filter);
 
    bool isFiltering()                                                          const override;
 
protected:
 
    bool matches(Album* album)                                                  const override;
 
protected:
 
    bool m_filterChecked;
    bool m_filterPartiallyChecked;
};
 
// -----------------------------------------------------------------------------------
 
class DIGIKAM_GUI_EXPORT SearchFilterModel : public CheckableAlbumFilterModel
{
    Q_OBJECT
 
public:
 
    explicit SearchFilterModel(QObject* const parent = nullptr);
 
    void setSourceSearchModel(SearchModel* const source);
    SearchModel* sourceSearchModel()                                            const;
 
    void setFilterSearchType(DatabaseSearch::Type);
    void listAllSearches();
    void listNormalSearches();
    void listTimelineSearches();
    void listHaarSearches();
    void listMapSearches();
    void listDuplicatesSearches();
 
    void setListTemporarySearches(bool list);
 
    bool isFiltering()                                                          const override;
 
protected:
 
    // make protected
    void setSourceAlbumModel(AbstractAlbumModel* const source);
 
    void setTypeFilter(int type);
 
    bool matches(Album* album)                                                  const override;
 
protected:
 
    int  m_searchType;
    bool m_listTemporary;
};
 
// -----------------------------------------------------------------------------------
 
class DIGIKAM_GUI_EXPORT TagPropertiesFilterModel : public CheckableAlbumFilterModel
{
    Q_OBJECT
 
public:
 
    explicit TagPropertiesFilterModel(QObject* const parent = nullptr);
 
    void      setSourceAlbumModel(TagModel* const source);
    TagModel* sourceTagModel()                                                  const;
 
    void listOnlyTagsWithProperty(const QString& property);
    void removeListOnlyProperty(const QString& property);
    void doNotListTagsWithProperty(const QString& property);
    void removeDoNotListProperty(const QString& property);
 
    bool isFiltering()                                                          const override;
 
protected Q_SLOTS:
 
    void tagPropertiesChanged(TAlbum*);
 
protected:
 
    bool matches(Album* album)                                                  const override;
 
protected:
 
    QSet<QString> m_propertiesBlackList;
    QSet<QString> m_propertiesWhiteList;
};
 
// -----------------------------------------------------------------------------------
 
class DIGIKAM_GUI_EXPORT TagsManagerFilterModel : public TagPropertiesFilterModel
{
    Q_OBJECT
 
public:
 
    explicit TagsManagerFilterModel(QObject* const data = nullptr);
 
    void setQuickListTags(const QList<int>& tags);
 
protected:
 
    bool matches(Album* album)                                                  const override;
 
protected:
 
    QSet<int> m_keywords;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_ALBUM_FILTER_MODEL_H