dpluginloader.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 : manager to load external plugins at run-time
 *
 * 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_LOADER_H
#define DIGIKAM_DPLUGIN_LOADER_H
 
// Qt includes
 
#include <QObject>
#include <QList>
 
// Local includes
 
#include "digikam_export.h"
#include "dinfointerface.h"
#include "dplugin.h"
#include "dpluginaction.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT DPluginLoader : public QObject
{
    Q_OBJECT
 
 public:
 
    static DPluginLoader* instance();
 
    QString configGroupName() const;
 
    void registerGenericPlugins(QObject* const parent);
 
    void registerEditorPlugins(QObject* const parent);
 
    void registerRawImportPlugins(QObject* const parent);
 
    void init();
 
    void cleanUp();
 
    QList<DPlugin*> allPlugins() const;
 
    QList<DPluginAction*> pluginsActions(DPluginAction::ActionType type, QObject* const parent) const;
 
    QList<DPluginAction*> pluginsActions(DPluginAction::ActionCategory cat, QObject* const parent) const;
 
    QList<DPluginAction*> pluginActions(const QString& pluginIID, QObject* const parent) const;
 
    DPluginAction* pluginAction(const QString& actionName, QObject* const parent) const;
 
    QString pluginXmlSections(DPluginAction::ActionCategory cat, QObject* const parent) const;
 
    void appendPluginToBlackList(const QString& filename);
 
    void appendPluginToWhiteList(const QString& filename);
 
private:
 
    // Disable constructor and destructor
    DPluginLoader();
    explicit DPluginLoader(QObject*);
    ~DPluginLoader() override;
 
    Q_DISABLE_COPY(DPluginLoader)
 
    class Private;
    Private* const d;
 
    friend class DPluginLoaderCreator;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_DPLUGIN_LOADER_H