Public Member Functions
qt_gui_cpp::Plugin Class Reference

#include <plugin.h>

List of all members.

Public Member Functions

virtual bool hasConfiguration () const
virtual void initPlugin (PluginContext &)
 Plugin ()
virtual void restoreSettings (const Settings &, const Settings &)
virtual void saveSettings (Settings &, Settings &) const
virtual void shutdownPlugin ()
virtual void triggerConfiguration ()

Detailed Description

The base class for C++ plugins.

Definition at line 48 of file plugin.h.


Constructor & Destructor Documentation

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

Definition at line 58 of file plugin.h.


Member Function Documentation

virtual bool qt_gui_cpp::Plugin::hasConfiguration ( ) const [inline, virtual]

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()

Definition at line 95 of file plugin.h.

virtual void qt_gui_cpp::Plugin::initPlugin ( PluginContext ) [inline, virtual]

Instantiate the plugin.

Parameters:
theplugin context

Definition at line 66 of file plugin.h.

virtual void qt_gui_cpp::Plugin::restoreSettings ( const Settings ,
const Settings  
) [inline, virtual]

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

Parameters:
theplugin-specific settings
theinstance-specific settings

Definition at line 88 of file plugin.h.

virtual void qt_gui_cpp::Plugin::saveSettings ( Settings ,
Settings  
) const [inline, virtual]

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

Parameters:
theplugin-specific settings
theinstance-specific settings

Definition at line 80 of file plugin.h.

virtual void qt_gui_cpp::Plugin::shutdownPlugin ( ) [inline, virtual]

Shutdown and clean up the plugin before unloading.

Definition at line 72 of file plugin.h.

virtual void qt_gui_cpp::Plugin::triggerConfiguration ( ) [inline, virtual]

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

Definition at line 104 of file plugin.h.


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


qt_gui_cpp
Author(s): Dirk Thomas
autogenerated on Fri Feb 3 2017 03:42:15