filteractionfilter.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 : meta-filter to apply FilterActions
 *
 * 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_FILTER_ACTION_FILTER_H
#define DIGIKAM_FILTER_ACTION_FILTER_H
 
// Local includes
 
#include "digikam_export.h"
#include "dimgthreadedfilter.h"
#include "filteraction.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT FilterActionFilter : public DImgThreadedFilter
{
    Q_OBJECT
 
public:
 
    explicit FilterActionFilter(QObject* const parent = nullptr);
    ~FilterActionFilter()                             override;
 
    void setContinueOnError(bool cont);
 
    void setFilterActions(const QList<FilterAction>& actions);
    void addFilterActions(const QList<FilterAction>& actions);
    void setFilterAction(const FilterAction& action);
    void addFilterAction(const FilterAction& action);
 
    QList<FilterAction> filterActions()         const;
 
    QList<FilterAction> appliedFilterActions()  const;
 
    bool isReproducible()                       const;
 
    bool isComplexAction()                      const;
 
    bool isSupported()                          const;
 
    bool         completelyApplied()            const;
    FilterAction failedAction()                 const;
    int          failedActionIndex()            const;
    QString      failedActionMessage()          const;
 
    FilterAction filterAction()                       override
    {
        return FilterAction();
    }
 
    void readParameters(const FilterAction&)          override
    {
    }
 
    QString filterIdentifier()                  const override
    {
        return QString();
    }
 
protected:
 
    void filterImage()                                override;
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_FILTER_ACTION_FILTER_H