IPlugin Class Reference

All plugin interfaces inherit from a common IPlugin interface which all plugins must implement. It is used by Kactus2 to acquire plugin information. Most of the plugins do not inherit this interface directly, but some derived interface. More...

#include <IPlugin.h>

Inheritance diagram for IPlugin:

Classes
struct	ExternalProgramRequirement
	Contains options for required external program paths for plugin. More...

Public Member Functions
virtual	~IPlugin ()
virtual QString	getDescription () const =0
virtual QString	getLicense () const =0
virtual QString	getLicenseHolder () const =0
virtual QString	getName () const =0
virtual QList< ExternalProgramRequirement >	getProgramRequirements ()=0
virtual PluginSettingsModel *	getSettingsModel ()=0
virtual QWidget *	getSettingsWidget ()=0
virtual QString	getVendor () const =0
virtual QString	getVersion () const =0

Detailed Description

All plugin interfaces inherit from a common IPlugin interface which all plugins must implement. It is used by Kactus2 to acquire plugin information. Most of the plugins do not inherit this interface directly, but some derived interface.

Definition at line 27 of file IPlugin.h.

Constructor & Destructor Documentation

~IPlugin()

virtual IPlugin::~IPlugin ( )

inlinevirtual

Destructor.

Definition at line 47 of file IPlugin.h.

Member Function Documentation

getDescription()

virtual QString IPlugin::getDescription ( ) const

pure virtual

Returns the description of the plugin.

getLicense()

virtual QString IPlugin::getLicense ( ) const

pure virtual

Returns the license of the plugin (e.g. GPL2).

getLicenseHolder()

virtual QString IPlugin::getLicenseHolder ( ) const

pure virtual

Returns the license holder i.e. who is the plugin licensed to (e.g. Public or Tampere University of Technology).

getName()

virtual QString IPlugin::getName ( ) const

pure virtual

Returns the name of the plugin.

getProgramRequirements()

virtual QList< ExternalProgramRequirement > IPlugin::getProgramRequirements ( )

pure virtual

This can be used to indicate what external programs the plugin needs in order to operate correctly. This allows Kactus2 to show settings to set paths where those external program are located.

getSettingsModel()

virtual PluginSettingsModel * IPlugin::getSettingsModel ( )

pure virtual

This is used to access the settings modified by function getSettingsWidget().

getSettingsWidget()

virtual QWidget * IPlugin::getSettingsWidget ( )

pure virtual

This can be used to show custom plugin-specific settings UI in the Kactus2 settings dialog. A QWidget should be returned even if the plugin has no custom settings.

getVendor()

virtual QString IPlugin::getVendor ( ) const

pure virtual

Returns the vendor of the plugin.

getVersion()

virtual QString IPlugin::getVersion ( ) const

pure virtual

Returns the version of the plugin.

---

The documentation for this class was generated from the following file:

• kactus2dev/KactusAPI/include/IPlugin.h