dimgbuiltinfilter.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2010-11-10
 * Description : basic filter management for DImg builtin methods
 *
 * Copyright (C) 2010-2011 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_DIMG_BUILT_IN_FILTERS_H
#define DIGIKAM_DIMG_BUILT_IN_FILTERS_H
 
// Qt includes
 
#include <QVariant>
 
// Local includes
 
#include "digikam_export.h"
 
namespace Digikam
{
 
class DImg;
class DImgThreadedFilter;
class FilterAction;
 
class DIGIKAM_EXPORT DImgBuiltinFilter
{
public:
 
    enum Type
    {
        NoOperation,
        Rotate90,
        Rotate180,
        Rotate270,
        FlipHorizontally,
        FlipVertically,
        Crop,             
        Resize,           
        ConvertTo8Bit,
        ConvertTo16Bit
    };
 
public:
 
    DImgBuiltinFilter();
 
    explicit DImgBuiltinFilter(const FilterAction& action);
 
    explicit DImgBuiltinFilter(Type type, const QVariant& arg = QVariant());
 
    void setAction(const FilterAction& action);
    void setAction(Type type, const QVariant& arg = QVariant());
 
    DImgBuiltinFilter reverseFilter()                                                               const;
    bool isReversible()                                                                             const;
 
    bool isValid()                                                                                  const;
 
    void apply(DImg& image)                                                                         const;
 
    FilterAction filterAction()                                                                     const;
 
    QString displayableName()                                                                       const;
    QString i18nDisplayableName()                                                                   const;
    QString filterIcon()                                                                            const;
 
    DImgThreadedFilter* createThreadedFilter(QObject* const parent = nullptr)                       const;
    DImgThreadedFilter* createThreadedFilter(DImg* const orgImage, QObject* const parent = nullptr) const;
 
public:
 
    static QString i18nDisplayableName(const QString& filterIdentifier);
    static QString filterIcon(const QString& filterIdentifier);
 
    static QStringList supportedFilters();
 
    static QList<int> supportedVersions(const QString& filterIdentifier);
 
    static bool isSupported(const QString& filterIdentifier);
    static bool isSupported(const QString& filterIdentifier, int version);
 
protected:
 
    Type     m_type;
    QVariant m_arg;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_DIMG_BUILT_IN_FILTERS_H