Inheritance diagram for qt_gui.plugin_handler.PluginHandler:

Public Member Functions
def	__init__
def	argv
def	emit_restore_settings_completed
def	emit_save_settings_completed
def	emit_shutdown_plugin_completed
def	instance_id
def	load
def	remove_toolbar
def	remove_widget
def	restore_settings
def	save_settings
def	shutdown_plugin
def	unload
Static Public Attributes
tuple	close_signal = Signal(str)
tuple	help_signal = Signal(str)
tuple	reload_signal = Signal(str)
Private Member Functions
def	_add_dock_widget
def	_add_dock_widget_to_main_window
def	_add_toolbar
def	_call_method_on_all_dock_widgets
def	_check_close
def	_create_dock_widget
def	_delete_toolbar
def	_delete_widget
def	_emit_close_plugin
def	_emit_help_signal
def	_emit_load_completed
def	_emit_reload_signal
def	_emit_unload_completed
def	_garbage_widgets_and_toolbars
def	_load
def	_on_widget_title_changed
def	_remove_widget_by_dock_widget
def	_restore_settings
def	_save_settings
def	_shutdown_plugin
def	_trigger_configuration
def	_unload
def	_update_title_bar
def	_update_title_bars
def	_update_widget_title
Private Attributes
	__callback
	__instance_settings
	_application_context
	_argv
	_container_manager
	_instance_id
	_main_window
	_plugin_has_configuration
	_plugin_provider
	_toolbars
	_widgets
Static Private Attributes
tuple	_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 41 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 53 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 269 of file plugin_handler.py.

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

Definition at line 280 of file plugin_handler.py.

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

Definition at line 312 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 189 of file plugin_handler.py.

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

Definition at line 339 of file plugin_handler.py.

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

Definition at line 226 of file plugin_handler.py.

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

Definition at line 139 of file plugin_handler.py.

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

Definition at line 136 of file plugin_handler.py.

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

Definition at line 344 of file plugin_handler.py.

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

Definition at line 260 of file plugin_handler.py.

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

Definition at line 96 of file plugin_handler.py.

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

Definition at line 263 of file plugin_handler.py.

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

Definition at line 157 of file plugin_handler.py.

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

Definition at line 106 of file plugin_handler.py.

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

Definition at line 93 of file plugin_handler.py.

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

Definition at line 288 of file plugin_handler.py.

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

Definition at line 256 of file plugin_handler.py.

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

Definition at line 213 of file plugin_handler.py.

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

Definition at line 177 of file plugin_handler.py.

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

Definition at line 126 of file plugin_handler.py.

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

Definition at line 266 of file plugin_handler.py.

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

Definition at line 154 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 235 of file plugin_handler.py.

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

Definition at line 250 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler._update_widget_title	(	self,
		widget,
		title
	)	`[private]`

Definition at line 292 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler.argv ( self )

Definition at line 78 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler.emit_restore_settings_completed ( self )

Definition at line 216 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler.emit_save_settings_completed ( self )

Definition at line 180 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler.emit_shutdown_plugin_completed ( self )

Definition at line 129 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler.instance_id ( self )

Definition at line 75 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 81 of file plugin_handler.py.

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

Definition at line 331 of file plugin_handler.py.

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

Definition at line 298 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 (`Plugin.restore_settings()`) and all dock widget title bars.
Completion is signaled asynchronously if a callback is passed.

Definition at line 199 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 (`Plugin.save_settings()`) and all dock widget title bars.
Completion is signaled asynchronously if a callback is passed.

Definition at line 163 of file plugin_handler.py.

def qt_gui.plugin_handler.PluginHandler.shutdown_plugin	(	self,
		callback
	)

Shutdown plugin (`Plugin.shutdown_plugin()`) and remove all added widgets.
Completion is signaled asynchronously if a callback is passed.

Definition at line 114 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 142 of file plugin_handler.py.

Member Data Documentation

qt_gui::plugin_handler.PluginHandler::__callback [private]

Definition at line 53 of file plugin_handler.py.

qt_gui::plugin_handler.PluginHandler::__instance_settings [private]

Definition at line 53 of file plugin_handler.py.

qt_gui::plugin_handler.PluginHandler::_application_context [private]

Definition at line 53 of file plugin_handler.py.

qt_gui::plugin_handler.PluginHandler::_argv [private]

Definition at line 53 of file plugin_handler.py.

qt_gui::plugin_handler.PluginHandler::_container_manager [private]

Definition at line 53 of file plugin_handler.py.

tuple qt_gui::plugin_handler.PluginHandler::_defered_check_close = Signal() [static, private]

Definition at line 51 of file plugin_handler.py.

qt_gui::plugin_handler.PluginHandler::_instance_id [private]

Definition at line 53 of file plugin_handler.py.

qt_gui::plugin_handler.PluginHandler::_main_window [private]

Definition at line 53 of file plugin_handler.py.

qt_gui::plugin_handler.PluginHandler::_plugin_has_configuration [private]

Definition at line 53 of file plugin_handler.py.

qt_gui::plugin_handler.PluginHandler::_plugin_provider [private]

Definition at line 53 of file plugin_handler.py.

qt_gui::plugin_handler.PluginHandler::_toolbars [private]

Definition at line 53 of file plugin_handler.py.

qt_gui::plugin_handler.PluginHandler::_widgets [private]

Definition at line 53 of file plugin_handler.py.

tuple qt_gui::plugin_handler.PluginHandler::close_signal = Signal(str) [static]

Definition at line 48 of file plugin_handler.py.

tuple qt_gui::plugin_handler.PluginHandler::help_signal = Signal(str) [static]

Definition at line 50 of file plugin_handler.py.

tuple qt_gui::plugin_handler.PluginHandler::reload_signal = Signal(str) [static]

Definition at line 49 of file plugin_handler.py.

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

plugin_handler.py

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation