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

Public Member Functions

def __init__ (self, parent, main_window, instance_id, application_context, container_manager, argv)
 
def add_toolbar (self, toolbar)
 
def add_widget (self, widget)
 
def close_plugin (self)
 
def eventFilter (self, watched, event)
 
def load (self, plugin_provider, callback=None)
 
def reload_plugin (self)
 
def shutdown_plugin (self, callback)
 
- Public Member Functions inherited from qt_gui.plugin_handler.PluginHandler
def argv (self)
 
def emit_restore_settings_completed (self)
 
def emit_save_settings_completed (self)
 
def emit_shutdown_plugin_completed (self)
 
def instance_id (self)
 
def remove_toolbar (self, toolbar)
 
def remove_widget (self, widget)
 
def restore_settings (self, plugin_settings, instance_settings, callback=None)
 
def save_settings (self, plugin_settings, instance_settings, callback=None)
 
def set_minimized_dock_widgets_toolbar (self, toolbar)
 
def set_plugin_descriptor (self, plugin_descriptor)
 
def unload (self, callback=None)
 

Private Member Functions

def _delete_widget (self, widget)
 
def _emit_load_completed (self, exception=None)
 
def _load (self)
 
def _restore_settings (self, plugin_settings, instance_settings)
 
def _save_settings (self, plugin_settings, instance_settings)
 
def _shutdown_plugin (self)
 
def _unload (self)
 

Private Attributes

 _context
 
 _plugin
 
 _plugin_has_configuration
 

Additional Inherited Members

- Static Public Attributes inherited from qt_gui.plugin_handler.PluginHandler
 close_signal = Signal(str)
 
 help_signal = Signal(str)
 
 label_updated = Signal(str, str)
 
 reload_signal = Signal(str)
 

Detailed Description

Handler for directly passing invocations between the framework and one `Plugin` instance.

Definition at line 39 of file plugin_handler_direct.py.

Constructor & Destructor Documentation

◆ __init__()

def qt_gui.plugin_handler_direct.PluginHandlerDirect.__init__ (   self,
  parent,
  main_window,
  instance_id,
  application_context,
  container_manager,
  argv 
)

Reimplemented from qt_gui.plugin_handler.PluginHandler.

Definition at line 42 of file plugin_handler_direct.py.

Member Function Documentation

◆ _delete_widget()

def qt_gui.plugin_handler_direct.PluginHandlerDirect._delete_widget (   self,
  widget 
)
private

Reimplemented from qt_gui.plugin_handler.PluginHandler.

Definition at line 94 of file plugin_handler_direct.py.

◆ _emit_load_completed()

def qt_gui.plugin_handler_direct.PluginHandlerDirect._emit_load_completed (   self,
  exception = None 
)
private

◆ _load()

def qt_gui.plugin_handler_direct.PluginHandlerDirect._load (   self)
private

◆ _restore_settings()

def qt_gui.plugin_handler_direct.PluginHandlerDirect._restore_settings (   self,
  plugin_settings,
  instance_settings 
)
private

Reimplemented from qt_gui.plugin_handler.PluginHandler.

Definition at line 116 of file plugin_handler_direct.py.

◆ _save_settings()

def qt_gui.plugin_handler_direct.PluginHandlerDirect._save_settings (   self,
  plugin_settings,
  instance_settings 
)
private

Reimplemented from qt_gui.plugin_handler.PluginHandler.

Definition at line 104 of file plugin_handler_direct.py.

◆ _shutdown_plugin()

def qt_gui.plugin_handler_direct.PluginHandlerDirect._shutdown_plugin (   self)
private

Reimplemented from qt_gui.plugin_handler.PluginHandler.

Definition at line 84 of file plugin_handler_direct.py.

◆ _unload()

def qt_gui.plugin_handler_direct.PluginHandlerDirect._unload (   self)
private

Reimplemented from qt_gui.plugin_handler.PluginHandler.

Definition at line 99 of file plugin_handler_direct.py.

◆ add_toolbar()

def qt_gui.plugin_handler_direct.PluginHandlerDirect.add_toolbar (   self,
  toolbar 
)

◆ add_widget()

def qt_gui.plugin_handler_direct.PluginHandlerDirect.add_widget (   self,
  widget 
)

◆ close_plugin()

def qt_gui.plugin_handler_direct.PluginHandlerDirect.close_plugin (   self)

Definition at line 148 of file plugin_handler_direct.py.

◆ eventFilter()

def qt_gui.plugin_handler_direct.PluginHandlerDirect.eventFilter (   self,
  watched,
  event 
)

Definition at line 69 of file plugin_handler_direct.py.

◆ load()

def qt_gui.plugin_handler_direct.PluginHandlerDirect.load (   self,
  plugin_provider,
  callback = None 
)
Load plugin.

Completion is signaled asynchronously if a callback is passed.

Reimplemented from qt_gui.plugin_handler.PluginHandler.

Definition at line 50 of file plugin_handler_direct.py.

◆ reload_plugin()

def qt_gui.plugin_handler_direct.PluginHandlerDirect.reload_plugin (   self)

Definition at line 154 of file plugin_handler_direct.py.

◆ shutdown_plugin()

def qt_gui.plugin_handler_direct.PluginHandlerDirect.shutdown_plugin (   self,
  callback 
)
Shut down the plugin and remove all added widgets.

Completion is signaled asynchronously if a callback is passed.

Reimplemented from qt_gui.plugin_handler.PluginHandler.

Reimplemented in qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient.

Definition at line 77 of file plugin_handler_direct.py.

Member Data Documentation

◆ _context

qt_gui.plugin_handler_direct.PluginHandlerDirect._context
private

Definition at line 46 of file plugin_handler_direct.py.

◆ _plugin

qt_gui.plugin_handler_direct.PluginHandlerDirect._plugin
private

Definition at line 47 of file plugin_handler_direct.py.

◆ _plugin_has_configuration

qt_gui.plugin_handler_direct.PluginHandlerDirect._plugin_has_configuration
private

Definition at line 57 of file plugin_handler_direct.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