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

Public Member Functions

def __init__ (self, plugin_provider, settings, application_context, settings_prefix='')
 
def close_application (self, global_settings, perspective_settings)
 
def discover (self)
 
def find_plugins_by_name (self, lookup_name)
 
def get_plugin_descriptor (self, plugin_id)
 
def get_plugins (self)
 
def is_plugin_running (self, plugin_id, serial_number)
 
def load_plugin (self, plugin_id, serial_number=None, argv=None)
 
def reload_plugin (self, instance_id_str)
 
def restore_settings (self, global_settings, perspective_settings)
 
def restore_settings_without_plugins (self, global_settings, perspective_settings)
 
def save_settings (self, global_settings, perspective_settings)
 
def set_main_window (self, main_window, menu_bar, container_manager)
 
def set_minimized_dock_widgets_toolbar (self, toolbar)
 
def unload_plugin (self, instance_id_str)
 

Static Public Attributes

 close_application_signal = Signal()
 
int discovery_cache_max_age = 60
 
 plugin_help_signal = Signal(object)
 
 plugins_about_to_change_signal = Signal()
 
 plugins_changed_signal = Signal()
 
 save_settings_completed_signal = Signal()
 

Private Member Functions

def _add_running_plugin (self, instance_id, handler)
 
def _close_application_save_callback (self, instance_id=None)
 
def _close_application_shutdown_callback (self, instance_id=None)
 
def _close_application_shutdown_plugins (self)
 
def _close_application_signal (self)
 
def _discover (self)
 
def _emit_load_plugin_completed (self, instance_id)
 
def _emit_plugin_help_signal (self, instance_id_str)
 
def _load_plugin_completed (self, handler, exception)
 
def _load_plugin_load (self, instance_id, callback, argv=None)
 
def _load_plugin_restore (self, handler, exception)
 
def _next_serial_number (self, plugin_id)
 
def _reload_plugin_load (self, instance_id_str)
 
def _reload_plugin_restore (self, handler, exception)
 
def _reload_plugin_save (self, instance_id)
 
def _reload_plugin_schedule_load (self, instance_id)
 
def _reload_plugin_shutdown (self, instance_id)
 
def _reload_plugin_unload (self, instance_id)
 
def _remove_running_plugin (self, instance_id)
 
def _restore_plugin_settings (self, instance_id, callback)
 
def _restore_running_plugins_get_plugins (self)
 
def _restore_settings_load_missing (self)
 
def _restore_settings_load_missing_callback (self, handler=None, exception=None)
 
def _restore_settings_restore (self)
 
def _restore_settings_restore_callback (self, instance_id=None)
 
def _restore_settings_save_obsolete (self)
 
def _restore_settings_unload_obsolete (self, instance_id)
 
def _restore_settings_unload_obsolete_callback (self, instance_id=None)
 
def _save_plugin_settings (self, instance_id, callback)
 
def _save_settings (self, global_settings, perspective_settings, callback)
 
def _save_settings_callback (self, instance_id=None)
 
def _shutdown_plugin (self, instance_id, callback)
 
def _store_running_plugins (self)
 
def _unload_plugin (self, instance_id, callback=None)
 
def _unload_plugin_completed (self, instance_id)
 
def _unload_plugin_shutdown (self, instance_id)
 
def _unload_plugin_unload (self, instance_id)
 

Private Attributes

 _application_context
 
 _container_manager
 
 _dbus_service
 
 _global_settings
 
 _main_window
 
 _minimized_dock_widgets_toolbar
 
 _number_of_ongoing_calls
 
 _perspective_settings
 
 _plugin_descriptors
 
 _plugin_menu
 
 _plugin_provider
 
 _running_plugins
 
 _settings
 

Static Private Attributes

 _deferred_reload_plugin_signal = Signal(str)
 

Detailed Description

Manager of plugin life cycle.

It creates a specific `PluginHandler` for each plugin instance and maintains the perspective
specific set of running plugins.

Definition at line 46 of file plugin_manager.py.

Constructor & Destructor Documentation

def qt_gui.plugin_manager.PluginManager.__init__ (   self,
  plugin_provider,
  settings,
  application_context,
  settings_prefix = '' 
)

Definition at line 63 of file plugin_manager.py.

Member Function Documentation

def qt_gui.plugin_manager.PluginManager._add_running_plugin (   self,
  instance_id,
  handler 
)
private

Definition at line 255 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._close_application_save_callback (   self,
  instance_id = None 
)
private

Definition at line 456 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._close_application_shutdown_callback (   self,
  instance_id = None 
)
private

Definition at line 471 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._close_application_shutdown_plugins (   self)
private

Definition at line 461 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._close_application_signal (   self)
private

Definition at line 479 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._discover (   self)
private

Definition at line 133 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._emit_load_plugin_completed (   self,
  instance_id 
)
private

Definition at line 313 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._emit_plugin_help_signal (   self,
  instance_id_str 
)
private

Definition at line 296 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._load_plugin_completed (   self,
  handler,
  exception 
)
private

Definition at line 274 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._load_plugin_load (   self,
  instance_id,
  callback,
  argv = None 
)
private

Definition at line 211 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._load_plugin_restore (   self,
  handler,
  exception 
)
private

Definition at line 267 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._next_serial_number (   self,
  plugin_id 
)
private

Definition at line 196 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._reload_plugin_load (   self,
  instance_id_str 
)
private

Definition at line 403 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._reload_plugin_restore (   self,
  handler,
  exception 
)
private

Definition at line 408 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._reload_plugin_save (   self,
  instance_id 
)
private

Definition at line 386 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._reload_plugin_schedule_load (   self,
  instance_id 
)
private

Definition at line 398 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._reload_plugin_shutdown (   self,
  instance_id 
)
private

Definition at line 390 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._reload_plugin_unload (   self,
  instance_id 
)
private

Definition at line 394 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._remove_running_plugin (   self,
  instance_id 
)
private

Definition at line 370 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._restore_plugin_settings (   self,
  instance_id,
  callback 
)
private

Definition at line 301 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._restore_running_plugins_get_plugins (   self)
private

Definition at line 505 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._restore_settings_load_missing (   self)
private

Definition at line 529 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._restore_settings_load_missing_callback (   self,
  handler = None,
  exception = None 
)
private

Definition at line 545 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._restore_settings_restore (   self)
private

Definition at line 561 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._restore_settings_restore_callback (   self,
  instance_id = None 
)
private

Definition at line 571 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._restore_settings_save_obsolete (   self)
private

Definition at line 489 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._restore_settings_unload_obsolete (   self,
  instance_id 
)
private

Definition at line 515 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._restore_settings_unload_obsolete_callback (   self,
  instance_id = None 
)
private

Definition at line 519 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._save_plugin_settings (   self,
  instance_id,
  callback 
)
private

Definition at line 333 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._save_settings (   self,
  global_settings,
  perspective_settings,
  callback 
)
private

Definition at line 418 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._save_settings_callback (   self,
  instance_id = None 
)
private

Definition at line 444 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._shutdown_plugin (   self,
  instance_id,
  callback 
)
private

Definition at line 349 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._store_running_plugins (   self)
private

Definition at line 433 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._unload_plugin (   self,
  instance_id,
  callback = None 
)
private

Definition at line 360 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._unload_plugin_completed (   self,
  instance_id 
)
private

Definition at line 366 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._unload_plugin_shutdown (   self,
  instance_id 
)
private

Definition at line 345 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager._unload_plugin_unload (   self,
  instance_id 
)
private

Definition at line 356 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager.close_application (   self,
  global_settings,
  perspective_settings 
)

Definition at line 452 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager.discover (   self)

Definition at line 113 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager.find_plugins_by_name (   self,
  lookup_name 
)

Definition at line 161 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager.get_plugin_descriptor (   self,
  plugin_id 
)

Definition at line 177 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager.get_plugins (   self)

Definition at line 169 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager.is_plugin_running (   self,
  plugin_id,
  serial_number 
)

Definition at line 180 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager.load_plugin (   self,
  plugin_id,
  serial_number = None,
  argv = None 
)

Definition at line 186 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager.reload_plugin (   self,
  instance_id_str 
)

Definition at line 379 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager.restore_settings (   self,
  global_settings,
  perspective_settings 
)

Definition at line 483 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager.restore_settings_without_plugins (   self,
  global_settings,
  perspective_settings 
)

Definition at line 555 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager.save_settings (   self,
  global_settings,
  perspective_settings 
)

Definition at line 415 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager.set_main_window (   self,
  main_window,
  menu_bar,
  container_manager 
)

Definition at line 101 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager.set_minimized_dock_widgets_toolbar (   self,
  toolbar 
)

Definition at line 110 of file plugin_manager.py.

def qt_gui.plugin_manager.PluginManager.unload_plugin (   self,
  instance_id_str 
)

Definition at line 319 of file plugin_manager.py.

Member Data Documentation

qt_gui.plugin_manager.PluginManager._application_context
private

Definition at line 70 of file plugin_manager.py.

qt_gui.plugin_manager.PluginManager._container_manager
private

Definition at line 73 of file plugin_manager.py.

qt_gui.plugin_manager.PluginManager._dbus_service
private

Definition at line 99 of file plugin_manager.py.

qt_gui.plugin_manager.PluginManager._deferred_reload_plugin_signal = Signal(str)
staticprivate

Definition at line 59 of file plugin_manager.py.

qt_gui.plugin_manager.PluginManager._global_settings
private

Definition at line 77 of file plugin_manager.py.

qt_gui.plugin_manager.PluginManager._main_window
private

Definition at line 72 of file plugin_manager.py.

qt_gui.plugin_manager.PluginManager._minimized_dock_widgets_toolbar
private

Definition at line 75 of file plugin_manager.py.

qt_gui.plugin_manager.PluginManager._number_of_ongoing_calls
private

Definition at line 82 of file plugin_manager.py.

qt_gui.plugin_manager.PluginManager._perspective_settings
private

Definition at line 78 of file plugin_manager.py.

qt_gui.plugin_manager.PluginManager._plugin_descriptors
private

Definition at line 79 of file plugin_manager.py.

qt_gui.plugin_manager.PluginManager._plugin_menu
private

Definition at line 74 of file plugin_manager.py.

qt_gui.plugin_manager.PluginManager._plugin_provider
private

Definition at line 67 of file plugin_manager.py.

qt_gui.plugin_manager.PluginManager._running_plugins
private

Definition at line 80 of file plugin_manager.py.

qt_gui.plugin_manager.PluginManager._settings
private

Definition at line 68 of file plugin_manager.py.

qt_gui.plugin_manager.PluginManager.close_application_signal = Signal()
static

Definition at line 58 of file plugin_manager.py.

int qt_gui.plugin_manager.PluginManager.discovery_cache_max_age = 60
static

Definition at line 61 of file plugin_manager.py.

qt_gui.plugin_manager.PluginManager.plugin_help_signal = Signal(object)
static

Definition at line 56 of file plugin_manager.py.

qt_gui.plugin_manager.PluginManager.plugins_about_to_change_signal = Signal()
static

Definition at line 54 of file plugin_manager.py.

qt_gui.plugin_manager.PluginManager.plugins_changed_signal = Signal()
static

Definition at line 55 of file plugin_manager.py.

qt_gui.plugin_manager.PluginManager.save_settings_completed_signal = Signal()
static

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