Public Member Functions | Private Attributes | List of all members
qt_gui.composite_plugin_provider.CompositePluginProvider Class Reference
Inheritance diagram for qt_gui.composite_plugin_provider.CompositePluginProvider:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, plugin_providers=None)
 
def discover (self, discovery_data)
 
def load (self, plugin_id, plugin_context)
 
def set_plugin_providers (self, plugin_providers)
 
def shutdown (self)
 
def unload (self, plugin_instance)
 
- Public Member Functions inherited from qt_gui.plugin_provider.PluginProvider
def __init__ (self)
 

Private Attributes

 _discovered_plugins
 
 _plugin_providers
 
 _running_plugins
 

Detailed Description

Composite of multiple `PluginProvider`s.

Definition at line 38 of file composite_plugin_provider.py.

Constructor & Destructor Documentation

◆ __init__()

def qt_gui.composite_plugin_provider.CompositePluginProvider.__init__ (   self,
  plugin_providers = None 
)

Member Function Documentation

◆ discover()

def qt_gui.composite_plugin_provider.CompositePluginProvider.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

Reimplemented from qt_gui.plugin_provider.PluginProvider.

Reimplemented in qt_gui.recursive_plugin_provider.RecursivePluginProvider.

Definition at line 52 of file composite_plugin_provider.py.

◆ load()

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

@return: The created plugin instance
@raise PluginLoadError

Reimplemented from qt_gui.plugin_provider.PluginProvider.

Definition at line 67 of file composite_plugin_provider.py.

◆ set_plugin_providers()

def qt_gui.composite_plugin_provider.CompositePluginProvider.set_plugin_providers (   self,
  plugin_providers 
)

Definition at line 49 of file composite_plugin_provider.py.

◆ shutdown()

def qt_gui.composite_plugin_provider.CompositePluginProvider.shutdown (   self)
Notify of shutdown.

Reimplemented from qt_gui.plugin_provider.PluginProvider.

Definition at line 85 of file composite_plugin_provider.py.

◆ unload()

def qt_gui.composite_plugin_provider.CompositePluginProvider.unload (   self,
  plugin_instance 
)
Unload a plugin.

Reimplemented from qt_gui.plugin_provider.PluginProvider.

Definition at line 77 of file composite_plugin_provider.py.

Member Data Documentation

◆ _discovered_plugins

qt_gui.composite_plugin_provider.CompositePluginProvider._discovered_plugins
private

Definition at line 46 of file composite_plugin_provider.py.

◆ _plugin_providers

qt_gui.composite_plugin_provider.CompositePluginProvider._plugin_providers
private

Definition at line 45 of file composite_plugin_provider.py.

◆ _running_plugins

qt_gui.composite_plugin_provider.CompositePluginProvider._running_plugins
private

Definition at line 47 of file composite_plugin_provider.py.


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


qt_gui
Author(s): Dirk Thomas
autogenerated on Sat Jun 25 2022 02:15:05