dpluginaction.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2018-07-30
 * Description : action container for external plugin
 *
 * Copyright (C) 2018-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_DPLUGIN_ACTION_H
#define DIGIKAM_DPLUGIN_ACTION_H
 
// Qt includes
 
#include <QString>
#include <QAction>
 
// Local includes
 
#include "digikam_export.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT DPluginAction : public QAction
{
    Q_OBJECT
 
public:
 
    enum ActionType
    {
        InvalidType   = -1,     
 
        Generic       = 0,      
        Editor                  
    };
 
    enum ActionCategory
    {
        InvalidCat    = -1,
 
        GenericExport = 0,      
        GenericImport,          
        GenericTool,            
        GenericMetadata,        
        GenericView,            
 
        EditorFile,             
        EditorColors,           
        EditorEnhance,          
        EditorTransform,        
        EditorDecorate,         
        EditorFilters           
    };
 
public:
 
    explicit DPluginAction(QObject* const parent = nullptr);
    ~DPluginAction() override;
 
    void setActionCategory(ActionCategory cat);
    ActionCategory actionCategory()  const;
    QString actionCategoryToString() const;
 
    ActionType actionType()          const;
 
    QString pluginId()               const;
 
    QString xmlSection()             const;
 
    QString toString()               const;
 
    static bool pluginActionLessThan(DPluginAction* const a, DPluginAction* const b);
};
 
} // namespace Digikam
 
#endif // DIGIKAM_DPLUGIN_ACTION_H