Public Member Functions
qt_gui.plugin.Plugin Class Reference
Inheritance diagram for qt_gui.plugin.Plugin:
Inheritance graph
[legend]

List of all members.

Public Member Functions

def __init__
def restore_settings
def save_settings
def shutdown_plugin

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

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

Definition at line 41 of file plugin.py.


Member Function Documentation

def qt_gui.plugin.Plugin.restore_settings (   self,
  plugin_settings,
  instance_settings 
)
Restore the intrinsic state of the plugin from the plugin-specific 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 60 of file plugin.py.

def qt_gui.plugin.Plugin.save_settings (   self,
  plugin_settings,
  instance_settings 
)
Save the intrinsic state of the plugin to the plugin-specific 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 50 of file plugin.py.

Shutdown and clean up the plugin before unloading.

Definition at line 46 of file plugin.py.


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


qt_gui
Author(s): Dirk Thomas
autogenerated on Fri Feb 3 2017 03:42:12