qt_gui.plugin_manager.PluginManager Class Reference

Inheritance diagram for qt_gui.plugin_manager.PluginManager:

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 * 60 * 24
	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

__init__()

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

_add_running_plugin()

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

private

Definition at line 255 of file plugin_manager.py.

_close_application_save_callback()

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

private

Definition at line 456 of file plugin_manager.py.

_close_application_shutdown_callback()

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

private

Definition at line 471 of file plugin_manager.py.

_close_application_shutdown_plugins()

def qt_gui.plugin_manager.PluginManager._close_application_shutdown_plugins (   self )

private

Definition at line 461 of file plugin_manager.py.

_close_application_signal()

def qt_gui.plugin_manager.PluginManager._close_application_signal (   self )

private

Definition at line 479 of file plugin_manager.py.

_discover()

def qt_gui.plugin_manager.PluginManager._discover (   self )

private

Definition at line 133 of file plugin_manager.py.

_emit_load_plugin_completed()

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

private

Definition at line 313 of file plugin_manager.py.

_emit_plugin_help_signal()

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

private

Definition at line 296 of file plugin_manager.py.

_load_plugin_completed()

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

private

Definition at line 274 of file plugin_manager.py.

_load_plugin_load()

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.

_load_plugin_restore()

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

private

Definition at line 267 of file plugin_manager.py.

_next_serial_number()

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

private

Definition at line 196 of file plugin_manager.py.

_reload_plugin_load()

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

private

Definition at line 403 of file plugin_manager.py.

_reload_plugin_restore()

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

private

Definition at line 408 of file plugin_manager.py.

_reload_plugin_save()

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

private

Definition at line 386 of file plugin_manager.py.

_reload_plugin_schedule_load()

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

private

Definition at line 398 of file plugin_manager.py.

_reload_plugin_shutdown()

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

private

Definition at line 390 of file plugin_manager.py.

_reload_plugin_unload()

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

private

Definition at line 394 of file plugin_manager.py.

_remove_running_plugin()

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

private

Definition at line 370 of file plugin_manager.py.

_restore_plugin_settings()

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

private

Definition at line 301 of file plugin_manager.py.

_restore_running_plugins_get_plugins()

def qt_gui.plugin_manager.PluginManager._restore_running_plugins_get_plugins (   self )

private

Definition at line 505 of file plugin_manager.py.

_restore_settings_load_missing()

def qt_gui.plugin_manager.PluginManager._restore_settings_load_missing (   self )

private

Definition at line 529 of file plugin_manager.py.

_restore_settings_load_missing_callback()

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.

_restore_settings_restore()

def qt_gui.plugin_manager.PluginManager._restore_settings_restore (   self )

private

Definition at line 561 of file plugin_manager.py.

_restore_settings_restore_callback()

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

private

Definition at line 571 of file plugin_manager.py.

_restore_settings_save_obsolete()

def qt_gui.plugin_manager.PluginManager._restore_settings_save_obsolete (   self )

private

Definition at line 489 of file plugin_manager.py.

_restore_settings_unload_obsolete()

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

private

Definition at line 515 of file plugin_manager.py.

_restore_settings_unload_obsolete_callback()

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.

_save_plugin_settings()

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

private

Definition at line 333 of file plugin_manager.py.

_save_settings()

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

private

Definition at line 418 of file plugin_manager.py.

_save_settings_callback()

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

private

Definition at line 444 of file plugin_manager.py.

_shutdown_plugin()

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

private

Definition at line 349 of file plugin_manager.py.

_store_running_plugins()

def qt_gui.plugin_manager.PluginManager._store_running_plugins (   self )

private

Definition at line 433 of file plugin_manager.py.

_unload_plugin()

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

private

Definition at line 360 of file plugin_manager.py.

_unload_plugin_completed()

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

private

Definition at line 366 of file plugin_manager.py.

_unload_plugin_shutdown()

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

private

Definition at line 345 of file plugin_manager.py.

_unload_plugin_unload()

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

private

Definition at line 356 of file plugin_manager.py.

close_application()

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

Definition at line 452 of file plugin_manager.py.

discover()

def qt_gui.plugin_manager.PluginManager.discover

(

self

)

Definition at line 113 of file plugin_manager.py.

find_plugins_by_name()

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

Definition at line 161 of file plugin_manager.py.

get_plugin_descriptor()

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

Definition at line 177 of file plugin_manager.py.

get_plugins()

def qt_gui.plugin_manager.PluginManager.get_plugins

(

self

)

Definition at line 169 of file plugin_manager.py.

is_plugin_running()

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

Definition at line 180 of file plugin_manager.py.

load_plugin()

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.

reload_plugin()

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

Definition at line 379 of file plugin_manager.py.

restore_settings()

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

Definition at line 483 of file plugin_manager.py.

restore_settings_without_plugins()

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

Definition at line 555 of file plugin_manager.py.

save_settings()

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

Definition at line 415 of file plugin_manager.py.

set_main_window()

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.

set_minimized_dock_widgets_toolbar()

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

Definition at line 110 of file plugin_manager.py.

unload_plugin()

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

Definition at line 319 of file plugin_manager.py.

Member Data Documentation

_application_context

qt_gui.plugin_manager.PluginManager._application_context

private

Definition at line 70 of file plugin_manager.py.

_container_manager

qt_gui.plugin_manager.PluginManager._container_manager

private

Definition at line 73 of file plugin_manager.py.

_dbus_service

qt_gui.plugin_manager.PluginManager._dbus_service

private

Definition at line 99 of file plugin_manager.py.

_deferred_reload_plugin_signal

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

staticprivate

Definition at line 59 of file plugin_manager.py.

_global_settings

qt_gui.plugin_manager.PluginManager._global_settings

private

Definition at line 77 of file plugin_manager.py.

_main_window

qt_gui.plugin_manager.PluginManager._main_window

private

Definition at line 72 of file plugin_manager.py.

_minimized_dock_widgets_toolbar

qt_gui.plugin_manager.PluginManager._minimized_dock_widgets_toolbar

private

Definition at line 75 of file plugin_manager.py.

_number_of_ongoing_calls

qt_gui.plugin_manager.PluginManager._number_of_ongoing_calls

private

Definition at line 82 of file plugin_manager.py.

_perspective_settings

qt_gui.plugin_manager.PluginManager._perspective_settings

private

Definition at line 78 of file plugin_manager.py.

_plugin_descriptors

qt_gui.plugin_manager.PluginManager._plugin_descriptors

private

Definition at line 79 of file plugin_manager.py.

_plugin_menu

qt_gui.plugin_manager.PluginManager._plugin_menu

private

Definition at line 74 of file plugin_manager.py.

_plugin_provider

qt_gui.plugin_manager.PluginManager._plugin_provider

private

Definition at line 67 of file plugin_manager.py.

_running_plugins

qt_gui.plugin_manager.PluginManager._running_plugins

private

Definition at line 80 of file plugin_manager.py.

_settings

qt_gui.plugin_manager.PluginManager._settings

private

Definition at line 68 of file plugin_manager.py.

close_application_signal

qt_gui.plugin_manager.PluginManager.close_application_signal = Signal()

static

Definition at line 58 of file plugin_manager.py.

discovery_cache_max_age

int qt_gui.plugin_manager.PluginManager.discovery_cache_max_age = 60 * 60 * 24

static

Definition at line 61 of file plugin_manager.py.

plugin_help_signal

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

static

Definition at line 56 of file plugin_manager.py.

plugins_about_to_change_signal

qt_gui.plugin_manager.PluginManager.plugins_about_to_change_signal = Signal()

static

Definition at line 54 of file plugin_manager.py.

plugins_changed_signal

qt_gui.plugin_manager.PluginManager.plugins_changed_signal = Signal()

static

Definition at line 55 of file plugin_manager.py.

save_settings_completed_signal

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:

• plugin_manager.py