batchtool.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2008-11-24
 * Description : Batch Tool Container.
 *
 * Copyright (C) 2008-2022 by Gilles Caulier <caulier dot gilles 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_BQM_BATCH_TOOL_H
#define DIGIKAM_BQM_BATCH_TOOL_H
 
// Qt includes
 
#include <QObject>
#include <QIcon>
 
// Local includes
 
#include "digikam_export.h"
#include "drawdecodersettings.h"
#include "dimg.h"
#include "iteminfo.h"
#include "queuesettings.h"
#include "iofilesettings.h"
 
class QWidget;
 
namespace Digikam
{
 
class DImgBuiltinFilter;
class DImgThreadedFilter;
class DPluginBqm;
 
typedef QMap<QString, QVariant> BatchToolSettings;
 
class DIGIKAM_GUI_EXPORT BatchTool : public QObject
{
    Q_OBJECT
 
public:
 
    enum BatchToolGroup
    {
        BaseTool = 0,             
        CustomTool,               
 
        ColorTool,                
        EnhanceTool,              
        TransformTool,            
        DecorateTool,             
        FiltersTool,              
        ConvertTool,              
        MetadataTool              
    };
 
 
public:
 
    explicit BatchTool(const QString& name, BatchToolGroup group, QObject* const parent = nullptr);
    ~BatchTool() override;
 
    void setPlugin(DPluginBqm* const plugin);
    DPluginBqm* plugin()                                    const;
 
    QString errorDescription()                              const;
 
    BatchToolGroup toolGroup()                              const;
 
    QString toolGroupToString()                             const;
 
    void setToolTitle(const QString& toolTitle);
    QString toolTitle()                                     const;
 
    void setToolDescription(const QString& toolDescription);
    QString toolDescription()                               const;
 
    void setToolIconName(const QString& iconName);
    void setToolIcon(const QIcon& icon);
    QIcon toolIcon()                                        const;
 
    void setSettings(const BatchToolSettings& settings);
    BatchToolSettings settings()                            const;
 
    void setInputUrl(const QUrl& inputUrl);
    QUrl inputUrl()                                         const;
 
    void setOutputUrl(const QUrl& outputUrl);
    QUrl outputUrl()                                        const;
 
    void setWorkingUrl(const QUrl& workingUrl);
    QUrl workingUrl()                                       const;
 
    void setImageData(const DImg& img);
    DImg imageData()                                        const;
 
    void setItemInfo(const ItemInfo& info);
    ItemInfo imageInfo()                                    const;
 
    void setLastChainedTool(bool last);
    bool isLastChainedTool()                                const;
 
    void setOutputUrlFromInputUrl();
 
    bool loadToDImg()                                       const;
 
    bool savefromDImg()                                     const;
 
    void setResetExifOrientationAllowed(bool reset);
 
    bool getResetExifOrientationAllowed()                   const;
 
    void setNeedResetExifOrientation(bool reset);
 
    bool getNeedResetExifOrientation()                      const;
 
    void setRawLoadingRules(QueueSettings::RawLoadingRule rule);
 
    void setSaveAsNewVersion(bool fork = true);
 
    void setBranchHistory(bool branch = true);
    bool getBranchHistory()                                 const;
 
    void setDRawDecoderSettings(const DRawDecoderSettings& settings);
 
    DRawDecoderSettings rawDecodingSettings()               const;
 
    void setIOFileSettings(const IOFileSettings& settings);
 
    IOFileSettings ioFileSettings()                         const;
 
    bool apply();
 
    virtual int toolVersion()                               const
    {
        return 1;
    };
 
    virtual void cancel();
 
    virtual QString outputSuffix()                          const;
 
    virtual BatchToolSettings defaultSettings()                   = 0;
 
    virtual BatchTool* clone(QObject* const parent = nullptr) const = 0;
 
Q_SIGNALS:
 
    void signalSettingsChanged(const BatchToolSettings&);
    void signalVisible(bool);
 
public Q_SLOTS:
 
    void slotResetSettingsToDefault();
    void slotSettingsChanged(const BatchToolSettings& settings);
 
protected:
 
    bool isRawFile(const QUrl& url)                         const;
 
    void setErrorDescription(const QString& errmsg);
 
    DImg& image()                                           const;
 
    bool isCancelled()                                      const;
 
    void applyFilter(DImgThreadedFilter* const filter);
    void applyFilterChangedProperties(DImgThreadedFilter* const filter);
    void applyFilter(DImgBuiltinFilter* const filter);
 
    virtual bool toolOperations() = 0;
 
protected Q_SLOTS:
 
    virtual void slotSettingsChanged() = 0;
 
 
public:
 
    QWidget* settingsWidget()                               const;
 
    void deleteSettingsWidget();
 
    virtual void registerSettingsWidget();
 
Q_SIGNALS:
 
    void signalAssignSettings2Widget();
 
protected:
 
    QWidget* m_settingsWidget;
 
protected Q_SLOTS:
 
    virtual void slotAssignSettings2Widget() = 0;
 
 
public:
 
    // Declared as public due to BatchToolObserver class.
    class Private;
 
private:
 
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_BQM_BATCH_TOOL_H