itemfiltersettings.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 : Filter values for use with ItemFilterModel
 *
 * Copyright (C) 2009-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2011-2022 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_SETTINGS_H
#define DIGIKAM_ITEM_FILTER_SETTINGS_H
 
// Qt includes
 
#include <QHash>
#include <QList>
#include <QMap>
#include <QString>
#include <QSet>
#include <QUrl>
#include <QDateTime>
 
// Local includes
 
#include "searchtextbar.h"
#include "mimefilter.h"
#include "digikam_export.h"
 
namespace Digikam
{
 
class ItemInfo;
class VersionManagerSettings;
 
namespace DatabaseFields
{
    class Set;
}
 
// ---------------------------------------------------------------------------------------
 
class DIGIKAM_DATABASE_EXPORT SearchTextFilterSettings : public SearchTextSettings
{
 
public:
 
    enum TextFilterFields
    {
        None             = 0x00,
        ImageName        = 0x01,
        ImageTitle       = 0x02,
        ImageComment     = 0x04,
        TagName          = 0x08,
        AlbumName        = 0x10,
        ImageAspectRatio = 0x20,
        ImagePixelSize   = 0x40,
        All              = ImageName | ImageTitle | ImageComment | TagName | AlbumName | ImageAspectRatio | ImagePixelSize
    };
 
public:
 
    SearchTextFilterSettings()
    {
        textFields = None;
    }
 
    explicit SearchTextFilterSettings(const SearchTextSettings& settings)
    {
        caseSensitive = settings.caseSensitive;
        text          = settings.text;
        textFields    = None;
    }
 
    TextFilterFields textFields;
};
 
// ---------------------------------------------------------------------------------------
 
class DIGIKAM_DATABASE_EXPORT ItemFilterSettings
{
public:
 
    enum MatchingCondition
    {
        OrCondition,
        AndCondition
    };
 
    enum RatingCondition
    {
        GreaterEqualCondition,
        EqualCondition,
        LessEqualCondition
    };
 
    enum GeolocationCondition
    {
        GeolocationNoFilter       = 0,
        GeolocationNoCoordinates  = 1 << 1,
        GeolocationHasCoordinates = 1 << 2
    };
 
public:
 
    explicit ItemFilterSettings();
 
    bool matches(const ItemInfo& info, bool* const foundText = nullptr) const;
 
public:
 
 
    void setTagFilter(const QList<int>& includedTags,
                      const QList<int>& excludedTags,
                      MatchingCondition matchingCond,
                      bool              showUnTagged,
                      const QList<int>& clTagIds,
                      const QList<int>& plTagIds);
 
public:
 
    void setRatingFilter(int rating, RatingCondition ratingCond, bool isUnratedExcluded);
 
public:
 
    void setDayFilter(const QList<QDateTime>& days);
 
public:
 
    void setTextFilter(const SearchTextFilterSettings& settings);
    void setTagNames(const QHash<int, QString>& tagNameHash);
    void setAlbumNames(const QHash<int, QString>& albumNameHash);
 
public:
 
    void setMimeTypeFilter(int mimeTypeFilter);
 
public:
 
    void setGeolocationFilter(const GeolocationCondition& condition);
 
public:
 
    bool isFilteringByDay()                                 const;
 
    bool isFilteringByTypeMime()                            const;
 
    bool isFilteringByGeolocation()                         const;
 
    bool isFilteringByRating()                              const;
 
    bool isFilteringByPickLabels()                          const;
 
    bool isFilteringByColorLabels()                         const;
 
    bool isFilteringByTags()                                const;
 
    bool isFilteringByText()                                const;
 
    bool isFiltering()                                      const;
 
public:
 
    void setUrlWhitelist(const QList<QUrl>& urlList, const QString& id);
 
public:
 
    void setIdWhitelist(const QList<qlonglong>& idList, const QString& id);
 
public:
 
 
    DatabaseFields::Set watchFlags()                        const;
 
private:
 
    bool isFilteringInternally()                            const;
 
private:
 
    bool                              m_untaggedFilter;
    QList<int>                        m_includeTagFilter;
    QList<int>                        m_excludeTagFilter;
    MatchingCondition                 m_matchingCond;
    QList<int>                        m_colorLabelTagFilter;
    QList<int>                        m_pickLabelTagFilter;
 
    int                               m_ratingFilter;
    RatingCondition                   m_ratingCond;
    bool                              m_isUnratedExcluded;
 
    QHash<QDateTime, bool>            m_dayFilter;
 
    SearchTextFilterSettings          m_textFilterSettings;
 
    QHash<int, QString>               m_tagNameHash;
    QHash<int, QString>               m_albumNameHash;
 
    MimeFilter::TypeMimeFilter        m_mimeTypeFilter;
 
    GeolocationCondition              m_geolocationCondition;
 
    QHash<QString,QList<QUrl>>        m_urlWhitelists;
 
    QHash<QString, QList<qlonglong> > m_idWhitelists;
};
 
// ---------------------------------------------------------------------------------------
 
class DIGIKAM_DATABASE_EXPORT VersionItemFilterSettings
{
public:
 
    VersionItemFilterSettings();
    explicit VersionItemFilterSettings(const VersionManagerSettings& settings);
 
    bool operator==(const VersionItemFilterSettings& other) const;
 
    bool matches(const ItemInfo& info)                      const;
 
    bool isHiddenBySettings(const ItemInfo& info)           const;
    bool isExemptedBySettings(const ItemInfo& info)         const;
 
 
    void setVersionManagerSettings(const VersionManagerSettings& settings);
 
    void setExceptionList(const QList<qlonglong>& idlist, const QString& id);
 
    bool isFiltering()                                      const;
 
    bool isFilteringByTags()                                const;
 
 
protected:
 
    QList<int>                        m_excludeTagFilter;
    int                               m_includeTagFilter;
    int                               m_exceptionTagFilter;
    QHash<QString, QList<qlonglong> > m_exceptionLists;
};
 
// ---------------------------------------------------------------------------------------
 
class DIGIKAM_DATABASE_EXPORT GroupItemFilterSettings
{
public:
 
    explicit GroupItemFilterSettings();
 
    bool operator==(const GroupItemFilterSettings& other)   const;
 
    bool matches(const ItemInfo& info)                      const;
 
    void setOpen(qlonglong group, bool open);
    bool isOpen(qlonglong group)                            const;
 
    void setAllOpen(bool open);
    bool isAllOpen()                                        const;
 
    bool isFiltering()                                      const;
 
    DatabaseFields::Set watchFlags()                        const;
 
protected:
 
    bool            m_allOpen;
    QSet<qlonglong> m_openGroups;
};
 
} // namespace Digikam
 
Q_DECLARE_METATYPE(Digikam::ItemFilterSettings::GeolocationCondition)
 
#endif // DIGIKAM_ITEM_FILTER_SETTINGS_H