filteraction.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2010-06-02
 * Description : class that holds list of applied filters to image
 *
 * Copyright (C) 2010 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2010 by Martin Klapetek <martin dot klapetek 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_FILTER_ACTION_H
#define DIGIKAM_FILTER_ACTION_H
 
// Qt includes
 
#include <QFlags>
#include <QHash>
#include <QString>
#include <QVariant>
 
// Local includes
 
#include "digikam_export.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT FilterAction
{
public:
 
    enum Category
    {
        ReproducibleFilter = 0,
 
        ComplexFilter      = 1,
 
        DocumentedHistory  = 2,
 
        CategoryFirst      = ReproducibleFilter,
        CategoryLast       = DocumentedHistory
    };
 
    enum Flag
    {
        ExplicitBranch     = 1 << 0
    };
    Q_DECLARE_FLAGS(Flags, Flag)
 
public:
 
    FilterAction();
    FilterAction(const QString& identifier, int version, Category category = ReproducibleFilter);
 
    bool isNull()                                                   const;
 
    bool operator==(const FilterAction& other)                      const;
 
    Category category()                                             const;
 
    QString  identifier()                                           const;
 
    int      version()                                              const;
 
    QString  description()                                          const;
    void     setDescription(const QString& description);
 
    QString  displayableName()                                      const;
    void     setDisplayableName(const QString& displayableName);
 
    Flags flags()                                                   const;
    void  setFlags(Flags flags);
    void  addFlag(Flags flags);
    void  removeFlag(Flags flags);
 
    bool                           hasParameters()                  const;
    const QHash<QString,QVariant>& parameters()                     const;
    QHash<QString, QVariant>&      parameters();
 
    bool                           hasParameter(const QString& key) const;
    const QVariant                 parameter(const QString& key)    const;
    QVariant&                      parameter(const QString& key);
 
    template <typename T>
    T parameter(const QString& key)                                 const
    {
        return parameter(key).value<T>();
    }
 
    template <typename T>
    T parameter(const QString& key, const T& defaultValue)          const
    {
        QVariant var = parameter(key);
        return (
                (var.isValid()) ? var.value<T>()
                                : defaultValue
               );
    }
 
    void addParameter(const QString& key, const QVariant& value);
 
    void removeParameters(const QString& key);
 
    void clearParameters();
 
    void setParameters(const QHash<QString, QVariant>& params);
 
protected:
 
    Category                 m_category;
    Flags                    m_flags;
    QString                  m_identifier;
    int                      m_version;
    QString                  m_description;
    QString                  m_displayableName;
    QHash<QString, QVariant> m_params;
};
 
} // namespace Digikam
 
Q_DECLARE_METATYPE(Digikam::FilterAction)
Q_DECLARE_OPERATORS_FOR_FLAGS(Digikam::FilterAction::Flags)
 
#endif // DIGIKAM_FILTER_ACTION_H