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

Public Member Functions

def __init__ (self)
 
def discover (self, discovery_data)
 
def load (self, plugin_id, plugin_context)
 
def shutdown (self)
 
def unload (self, plugin_instance)
 

Detailed Description

Interface for discovering, loading and unloading of plugins.

Definition at line 34 of file plugin_provider.py.

Constructor & Destructor Documentation

def qt_gui.plugin_provider.PluginProvider.__init__ (   self)

Definition at line 37 of file plugin_provider.py.

Member Function Documentation

def qt_gui.plugin_provider.PluginProvider.discover (   self,
  discovery_data 
)
Discover the plugins.

@param discovery_data:
    The settings containing any discovery data which is cached between invocations
@return: Dictionary of plugin ids to `PluginDescriptor`s

Definition at line 41 of file plugin_provider.py.

def qt_gui.plugin_provider.PluginProvider.load (   self,
  plugin_id,
  plugin_context 
)
Load a plugin and pass the `PluginContext`.

@return: The created plugin instance
@raise PluginLoadError

Definition at line 51 of file plugin_provider.py.

def qt_gui.plugin_provider.PluginProvider.shutdown (   self)
Notify of shutdown.

Definition at line 64 of file plugin_provider.py.

def qt_gui.plugin_provider.PluginProvider.unload (   self,
  plugin_instance 
)
Unload a plugin.

Definition at line 60 of file plugin_provider.py.


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


qt_gui
Author(s): Dirk Thomas
autogenerated on Sun Mar 1 2020 04:07:38