fileactionmngr.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2009-05-05
 * Description : file action manager
 *
 * 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>
 *
 * 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_FILE_ACTION_MNGR_H
#define DIGIKAM_FILE_ACTION_MNGR_H
 
// Local includes
 
#include "iteminfo.h"
#include "metaengine_rotation.h"
#include "digikam_export.h"
 
namespace Digikam
{
 
class MetadataHub;
class MetadataHubOnTheRoad;
class DisjointMetadata;
 
class DIGIKAM_GUI_EXPORT FileActionMngr : public QObject
{
    Q_OBJECT
 
public:
 
    enum GroupAction
    {
        AddToGroup,
        RemoveFromGroup,
        SplitGroup
    };
 
public:
 
    static FileActionMngr* instance();
 
    bool requestShutDown();
    void shutDown();
    bool isActive();
 
Q_SIGNALS:
 
    void signalImageChangeFailed(const QString& message, const QStringList& fileNames);
 
public Q_SLOTS:
 
    void assignTag(const ItemInfo& info, int tagID);
    void assignTag(const QList<ItemInfo>& infos, int tagID);
    void assignTags(const ItemInfo& info, const QList<int>& tagIDs);
    void assignTags(const QList<ItemInfo>& infos, const QList<int>& tagIDs);
    void assignTags(const QList<qlonglong>& imageIds, const QList<int>& tagIDs);
 
    void removeTag(const ItemInfo& info, int tagID);
    void removeTag(const QList<ItemInfo>& infos, int tagID);
    void removeTags(const ItemInfo& info, const QList<int>& tagIDs);
    void removeTags(const QList<ItemInfo>& infos, const QList<int>& tagIDs);
 
    void assignPickLabel(const ItemInfo& infos, int pickId);
    void assignPickLabel(const QList<ItemInfo>& infos, int pickId);
 
    void assignColorLabel(const ItemInfo& infos, int colorId);
    void assignColorLabel(const QList<ItemInfo>& infos, int colorId);
 
    void assignRating(const ItemInfo& infos, int rating);
    void assignRating(const QList<ItemInfo>& infos, int rating);
 
    void addToGroup(const ItemInfo& pick, const QList<ItemInfo>& infos);
    void removeFromGroup(const ItemInfo& info);
    void removeFromGroup(const QList<ItemInfo>& infos);
    void ungroup(const ItemInfo& info);
    void ungroup(const QList<ItemInfo>& infos);
 
    void setExifOrientation(const QList<ItemInfo>& infos, int orientation);
/*
    void applyMetadata(const QList<ItemInfo>& infos, const MetadataHub& hub);
*/
    void applyMetadata(const QList<ItemInfo>& infos, const DisjointMetadata& hub);
 
    // ownership of the hub is passed, hub must be created without QObject parent
    void applyMetadata(const QList<ItemInfo>& infos, DisjointMetadata* hub);
 
    void transform(const QList<ItemInfo>& infos, MetaEngineRotation::TransformationAction action);
 
    void copyAttributes(const ItemInfo& source, const QStringList& derivedPaths);
    void copyAttributes(const ItemInfo& source, const QString& derivedPath);
 
public:
 
    // Declared public due to use by FileActionMngrWorker, FileActionMngrDatabaseWorker, and FileActionMngrFileWorker
    class Private;
 
private:
 
    // Disable
    FileActionMngr();
    explicit FileActionMngr(QObject*);
    ~FileActionMngr() override;
 
    Private* const d;
 
    friend class FileActionMngrCreator;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_FILE_ACTION_MNGR_H