dplugin.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 : abstract class to define digiKam 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_H
#define DIGIKAM_DPLUGIN_H
 
// Qt includes
 
#include <QMap>
#include <QList>
#include <QCoreApplication>
#include <QString>
#include <QStringList>
#include <QtPlugin>
#include <QObject>
#include <QIcon>
#include <QPointer>
 
// Local includes
 
#include "dpluginauthor.h"
#include "digikam_export.h"
 
#define DIGIKAM_DPLUGIN_GENERIC_IID   "org.kde.digikam.DPluginGeneric/1.1.0"
#define DIGIKAM_DPLUGIN_EDITOR_IID    "org.kde.digikam.DPluginEditor/1.1.0"
#define DIGIKAM_DPLUGIN_BQM_IID       "org.kde.digikam.DPluginBqm/1.1.0"
#define DIGIKAM_DPLUGIN_RAWIMPORT_IID "org.kde.digikam.DPluginRawImport/1.1.0"
#define DIGIKAM_DPLUGIN_DIMG_IID      "org.kde.digikam.DPluginDImg/1.1.0"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT DPlugin : public QObject
{
    Q_OBJECT
 
public:
 
    explicit DPlugin(QObject* const parent = nullptr);
 
    ~DPlugin() override;
 
public:
 
    QStringList pluginAuthors() const;
 
    QString version() const;
 
    bool shouldLoaded() const;
 
    void setShouldLoaded(bool b);
 
    QString libraryFileName() const;
 
    void setLibraryFileName(const QString&);
 
public:
 
    virtual void cleanUp() {};
 
    virtual bool hasVisibilityProperty() const;
 
    virtual void setVisible(bool b) = 0;
 
    virtual int count() const = 0;
 
    virtual QStringList categories() const = 0;
 
    virtual void setup(QObject* const parent) = 0;
 
    virtual QString name() const = 0;
 
    virtual QString iid() const = 0;
 
    virtual QString ifaceIid() const = 0;
 
    virtual QString description() const = 0;
 
    virtual QIcon icon() const;
 
    virtual QList<DPluginAuthor> authors() const = 0;
 
    virtual QString details() const = 0;
 
    virtual QMap<QString, QString> extraAboutData() const { return QMap<QString, QString>(); };
 
    virtual QString extraAboutDataTitle() const { return QString(); };
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
Q_DECLARE_TYPEINFO(Digikam::DPluginAuthor, Q_MOVABLE_TYPE);
 
#endif // DIGIKAM_DPLUGIN_H