Public Member Functions | List of all members
qt_gui.plugin.Plugin Class Reference
Inheritance diagram for qt_gui.plugin.Plugin:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, context)
 
def restore_settings (self, plugin_settings, instance_settings)
 
def save_settings (self, plugin_settings, instance_settings)
 
def shutdown_plugin (self)
 

Detailed Description

Interface for Python plugins.

User-defined plugins may either subclass `qt_gui.plugin.Plugin` or according to duck typing
implement only the needed methods.

Definition at line 34 of file plugin.py.

Constructor & Destructor Documentation

◆ __init__()

def qt_gui.plugin.Plugin.__init__ (   self,
  context 
)
Instantiate the plugin and pass the `PluginContext`.

Definition at line 42 of file plugin.py.

Member Function Documentation

◆ restore_settings()

def qt_gui.plugin.Plugin.restore_settings (   self,
  plugin_settings,
  instance_settings 
)
Restore the intrinsic state of the plugin from the plugin or instance specific `Settings`.

@param plugin_settings: The plugin-specific settings
@type plugin_settings: qt_gui.settings.Settings
@param instance_settings: The instance-specific settings
@type instance_settings: qt_gui.settings.Settings

Definition at line 62 of file plugin.py.

◆ save_settings()

def qt_gui.plugin.Plugin.save_settings (   self,
  plugin_settings,
  instance_settings 
)
Save the intrinsic state of the plugin to the plugin or instance specific `Settings`.

@param plugin_settings: The plugin-specific settings
@type plugin_settings: qt_gui.settings.Settings
@param instance_settings: The instance-specific settings
@type instance_settings: qt_gui.settings.Settings

Definition at line 51 of file plugin.py.

◆ shutdown_plugin()

def qt_gui.plugin.Plugin.shutdown_plugin (   self)
Shutdown and clean up the plugin before unloading.

Definition at line 47 of file plugin.py.


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


qt_gui
Author(s): Dirk Thomas
autogenerated on Sun Oct 6 2019 03:43:34