IPlugin.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: IPlugin.h
//-----------------------------------------------------------------------------
// Project: Kactus 2
// Author: Joni-Matti Maatta
// Date: 27.6.2012
//
// Description:
// Base plugin interface.
//-----------------------------------------------------------------------------
 
#ifndef IPLUGIN_H
#define IPLUGIN_H
 
#include "PluginSettingsModel.h"
 
#include <QString>
#include <QList>
#include <QtPlugin>
#include <QWidget>
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class IPlugin
{
public:

    struct ExternalProgramRequirement {
        
        QString name_;

        QString description_;

        QString filters_;
    };

    virtual ~IPlugin() {}

    virtual QString getName() const = 0;

    virtual QString getVersion() const = 0;

    virtual QString getDescription() const = 0;

    virtual QString getVendor() const = 0;

    virtual QString getLicense() const = 0;

    virtual QString getLicenseHolder() const = 0;

    virtual QWidget* getSettingsWidget() = 0;

    virtual PluginSettingsModel* getSettingsModel() = 0;

    virtual QList<ExternalProgramRequirement> getProgramRequirements() = 0;
};
 
Q_DECLARE_INTERFACE(IPlugin, "com.tut.Kactus2.IPlugin/1.0")
 
//-----------------------------------------------------------------------------
 
#endif // IPLUGIN_H