Class Plugin

Inheritance Relationships

Base Type

  • public QObject

Class Documentation

class Plugin : public QObject

The base class for C++ plugins.

Public Functions

inline Plugin()

Construct the plugin. All initialization should be performed in initPlugin().

inline virtual void initPlugin(PluginContext&)

Instantiate the plugin.

Parameters:

the – plugin context

inline virtual void shutdownPlugin()

Shutdown and clean up the plugin before unloading.

inline virtual void saveSettings(Settings&, Settings&) const

Save the intrinsic state of the plugin to the plugin-specific or instance-specific settings.

Parameters:

  • the – plugin-specific settings

  • the – instance-specific settings

inline virtual void restoreSettings(const Settings&, const Settings&)

Restore the intrinsic state of the plugin from the plugin-specific or instance-specific settings.

Parameters:

  • the – plugin-specific settings

  • the – instance-specific settings

inline virtual bool hasConfiguration() const

Indicate if the plugin has configuration dialog which could be triggered by an icon in the title bar of the dock widgets.

Returns:

true if the plugin implements triggerConfiguration()

inline virtual void triggerConfiguration()

Trigger a configuration dialog. If this method is reimplemented hasConfiguration() should also be reimplemented and return true.