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

Public Member Functions

def __init__ (self, parent, main_window, instance_id, application_context, container_manager, argv=None)
 
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 load (self, plugin_provider, callback=None)
 
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 shutdown_plugin (self, callback)
 
def unload (self, callback=None)
 

Static Public Attributes

 close_signal = Signal(str)
 
 help_signal = Signal(str)
 
 label_updated = Signal(str, str)
 
 reload_signal = Signal(str)
 

Private Member Functions

def _add_dock_widget (self, dock_widget, widget)
 
def _add_dock_widget_to_main_window (self, dock_widget)
 
def _add_toolbar (self, toolbar)
 
def _call_method_on_all_dock_widgets (self, method_name, instance_settings)
 
def _check_close (self)
 
def _create_dock_widget (self)
 
def _delete_toolbar (self, toolbar)
 
def _delete_widget (self, widget)
 
def _emit_close_plugin (self)
 
def _emit_help_signal (self)
 
def _emit_load_completed (self, exception=None)
 
def _emit_reload_signal (self)
 
def _emit_unload_completed (self)
 
def _garbage_widgets_and_toolbars (self)
 
def _load (self)
 
def _on_dock_widget_hide (self, dock_widget)
 
def _on_dock_widget_show (self, dock_widget)
 
def _on_dock_widget_title_changed (self, dock_widget)
 
def _on_widget_icon_changed (self, widget)
 
def _on_widget_title_changed (self, widget)
 
def _remove_widget_by_dock_widget (self, dock_widget)
 
def _restore_settings (self, plugin_settings, instance_settings)
 
def _save_settings (self, plugin_settings, instance_settings)
 
def _set_window_icon (self, widget)
 
def _shutdown_plugin (self)
 
def _trigger_configuration (self)
 
def _unload (self)
 
def _update_dock_widget_features (self, dock_widget)
 
def _update_title_bar (self, dock_widget, hide_help=False, hide_reload=False)
 
def _update_title_bars (self)
 

Private Attributes

 __callback
 
 __instance_settings
 
 _application_context
 
 _argv
 
 _container_manager
 
 _instance_id
 
 _main_window
 
 _minimized_dock_widgets_toolbar
 
 _plugin_descriptor
 
 _plugin_has_configuration
 
 _plugin_provider
 
 _toolbars
 
 _widgets
 

Static Private Attributes

 _defered_check_close = Signal()
 

Detailed Description

Base class for the bidirectional exchange between the framework and one `Plugin` instance.

It utilizes a `PluginProvider` to load/unload the plugin and provides callbacks for the
`PluginContext`.

Definition at line 42 of file plugin_handler.py.

Constructor & Destructor Documentation

def qt_gui.plugin_handler.PluginHandler.__init__ (   self,
  parent,
  main_window,
  instance_id,
  application_context,
  container_manager,
  argv = None 
)

Definition at line 57 of file plugin_handler.py.

Member Function Documentation

def qt_gui.plugin_handler.PluginHandler._add_dock_widget (   self,
  dock_widget,
  widget 
)
private

Definition at line 318 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._add_dock_widget_to_main_window (   self,
  dock_widget 
)
private

Definition at line 336 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._add_toolbar (   self,
  toolbar 
)
private

Definition at line 390 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._call_method_on_all_dock_widgets (   self,
  method_name,
  instance_settings 
)
private

Definition at line 209 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._check_close (   self)
private

Definition at line 423 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._create_dock_widget (   self)
private

Definition at line 250 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._delete_toolbar (   self,
  toolbar 
)
private

Definition at line 155 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._delete_widget (   self,
  widget 
)
private

Definition at line 152 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._emit_close_plugin (   self)
private

Definition at line 428 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._emit_help_signal (   self)
private

Definition at line 309 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._emit_load_completed (   self,
  exception = None 
)
private

Definition at line 109 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._emit_reload_signal (   self)
private

Definition at line 312 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._emit_unload_completed (   self)
private

Definition at line 175 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._garbage_widgets_and_toolbars (   self)
private

Definition at line 120 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._load (   self)
private

Definition at line 106 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._on_dock_widget_hide (   self,
  dock_widget 
)
private

Definition at line 355 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._on_dock_widget_show (   self,
  dock_widget 
)
private

Definition at line 359 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._on_dock_widget_title_changed (   self,
  dock_widget 
)
private

Definition at line 363 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._on_widget_icon_changed (   self,
  widget 
)
private

Definition at line 347 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._on_widget_title_changed (   self,
  widget 
)
private

Definition at line 351 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._remove_widget_by_dock_widget (   self,
  dock_widget 
)
private

Definition at line 305 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._restore_settings (   self,
  plugin_settings,
  instance_settings 
)
private

Definition at line 237 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._save_settings (   self,
  plugin_settings,
  instance_settings 
)
private

Definition at line 197 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._set_window_icon (   self,
  widget 
)
private

Definition at line 290 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._shutdown_plugin (   self)
private

Definition at line 142 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._trigger_configuration (   self)
private

Definition at line 315 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._unload (   self)
private

Definition at line 172 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._update_dock_widget_features (   self,
  dock_widget 
)
private

Definition at line 257 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._update_title_bar (   self,
  dock_widget,
  hide_help = False,
  hide_reload = False 
)
private

Definition at line 271 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._update_title_bars (   self)
private

Definition at line 299 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler.argv (   self)

Definition at line 84 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler.emit_restore_settings_completed (   self)

Definition at line 240 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler.emit_save_settings_completed (   self)

Definition at line 200 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler.emit_shutdown_plugin_completed (   self)

Definition at line 145 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler.instance_id (   self)

Definition at line 81 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler.load (   self,
  plugin_provider,
  callback = None 
)
Load plugin.

Completion is signaled asynchronously if a callback is passed.

Definition at line 93 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler.remove_toolbar (   self,
  toolbar 
)

Definition at line 414 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler.remove_widget (   self,
  widget 
)

Definition at line 368 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler.restore_settings (   self,
  plugin_settings,
  instance_settings,
  callback = None 
)
Restore settings of the plugin and all dock widget title bars.

Completion is signaled asynchronously if a callback is passed.

Definition at line 221 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler.save_settings (   self,
  plugin_settings,
  instance_settings,
  callback = None 
)
Save settings of the plugin and all dock widget title bars.

Completion is signaled asynchronously if a callback is passed.

Definition at line 181 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler.set_minimized_dock_widgets_toolbar (   self,
  toolbar 
)

Definition at line 87 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler.set_plugin_descriptor (   self,
  plugin_descriptor 
)

Definition at line 90 of file plugin_handler.py.

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

Completion is signaled asynchronously if a callback is passed.

Definition at line 128 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler.unload (   self,
  callback = None 
)
Unload plugin.

Completion is signaled asynchronously if a callback is passed.

Definition at line 158 of file plugin_handler.py.

Member Data Documentation

qt_gui.plugin_handler.PluginHandler.__callback
private

Definition at line 71 of file plugin_handler.py.

qt_gui.plugin_handler.PluginHandler.__instance_settings
private

Definition at line 72 of file plugin_handler.py.

qt_gui.plugin_handler.PluginHandler._application_context
private

Definition at line 63 of file plugin_handler.py.

qt_gui.plugin_handler.PluginHandler._argv
private

Definition at line 65 of file plugin_handler.py.

qt_gui.plugin_handler.PluginHandler._container_manager
private

Definition at line 64 of file plugin_handler.py.

qt_gui.plugin_handler.PluginHandler._defered_check_close = Signal()
staticprivate

Definition at line 54 of file plugin_handler.py.

qt_gui.plugin_handler.PluginHandler._instance_id
private

Definition at line 62 of file plugin_handler.py.

qt_gui.plugin_handler.PluginHandler._main_window
private

Definition at line 61 of file plugin_handler.py.

qt_gui.plugin_handler.PluginHandler._minimized_dock_widgets_toolbar
private

Definition at line 66 of file plugin_handler.py.

qt_gui.plugin_handler.PluginHandler._plugin_descriptor
private

Definition at line 67 of file plugin_handler.py.

qt_gui.plugin_handler.PluginHandler._plugin_has_configuration
private

Definition at line 74 of file plugin_handler.py.

qt_gui.plugin_handler.PluginHandler._plugin_provider
private

Definition at line 70 of file plugin_handler.py.

qt_gui.plugin_handler.PluginHandler._toolbars
private

Definition at line 79 of file plugin_handler.py.

qt_gui.plugin_handler.PluginHandler._widgets
private

Definition at line 77 of file plugin_handler.py.

qt_gui.plugin_handler.PluginHandler.close_signal = Signal(str)
static

Definition at line 51 of file plugin_handler.py.

qt_gui.plugin_handler.PluginHandler.help_signal = Signal(str)
static

Definition at line 53 of file plugin_handler.py.

qt_gui.plugin_handler.PluginHandler.label_updated = Signal(str, str)
static

Definition at line 50 of file plugin_handler.py.

qt_gui.plugin_handler.PluginHandler.reload_signal = Signal(str)
static

Definition at line 52 of file plugin_handler.py.


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


qt_gui
Author(s): Dirk Thomas
autogenerated on Sun Nov 1 2020 04:03:22