Public Member Functions | List of all members
qt_gui_cpp::Plugin Class Reference

#include <plugin.h>

Inheritance diagram for qt_gui_cpp::Plugin:
Inheritance graph
[legend]

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 49 of file plugin.h.

Constructor & Destructor Documentation

◆ Plugin()

qt_gui_cpp::Plugin::Plugin ( )
inline

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

Definition at line 61 of file plugin.h.

Member Function Documentation

◆ hasConfiguration()

virtual bool qt_gui_cpp::Plugin::hasConfiguration ( ) const
inlinevirtual

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 98 of file plugin.h.

◆ initPlugin()

virtual void qt_gui_cpp::Plugin::initPlugin ( PluginContext )
inlinevirtual

Instantiate the plugin.

Parameters
theplugin context

Definition at line 69 of file plugin.h.

◆ restoreSettings()

virtual void qt_gui_cpp::Plugin::restoreSettings ( const Settings ,
const Settings  
)
inlinevirtual

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 91 of file plugin.h.

◆ saveSettings()

virtual void qt_gui_cpp::Plugin::saveSettings ( Settings ,
Settings  
) const
inlinevirtual

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 83 of file plugin.h.

◆ shutdownPlugin()

virtual void qt_gui_cpp::Plugin::shutdownPlugin ( )
inlinevirtual

Shutdown and clean up the plugin before unloading.

Definition at line 75 of file plugin.h.

◆ triggerConfiguration()

virtual void qt_gui_cpp::Plugin::triggerConfiguration ( )
inlinevirtual

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

Definition at line 107 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 Jun 24 2022 02:42:39