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

Public Member Functions

def __init__ (self, parent, main_window, instance_id, application_context, container_manager, argv, dbus_object_path)
 
def add_toolbar (self, toolbar)
 
def add_widget (self, widget)
 
def emit_restore_settings_completed (self)
 
def emit_save_settings_completed (self)
 
def emit_shutdown_plugin_completed (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 shutdown_plugin (self, callback)
 
- Public Member Functions inherited from qt_gui.plugin_handler_direct.PluginHandlerDirect
def __init__ (self, parent, main_window, instance_id, application_context, container_manager, argv)
 
def close_plugin (self)
 
def eventFilter (self, watched, event)
 
def load (self, plugin_provider, callback=None)
 
def reload_plugin (self)
 
- Public Member Functions inherited from qt_gui.plugin_handler.PluginHandler
def argv (self)
 
def instance_id (self)
 
def set_minimized_dock_widgets_toolbar (self, toolbar)
 
def set_plugin_descriptor (self, plugin_descriptor)
 
def unload (self, callback=None)
 

Private Member Functions

def _emit_close_plugin (self)
 
def _emit_load_completed (self, exception=None)
 
def _load (self)
 
def _on_embed_widget_icon_changed (self, widget)
 
def _on_embed_widget_title_changed (self, widget)
 
def _restore_settings_from_remote (self)
 
def _save_settings_from_remote (self)
 
def _toolbar_orientation_changed (self, win_id, is_horizontal)
 

Private Attributes

 _dbus_object_path
 
 _embed_widgets
 
 _remote_container
 
 _remote_instance_settings
 
 _remote_plugin_settings
 

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

Client part of the `PluginHandlerXEmbed`.

Client utilizes the `PluginHandlerDBusService` of the `PluginHandlerXEmbedContainer` through a
peer-to-peer DBus connection.

Definition at line 45 of file plugin_handler_xembed_client.py.

Constructor & Destructor Documentation

◆ __init__()

def qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient.__init__ (   self,
  parent,
  main_window,
  instance_id,
  application_context,
  container_manager,
  argv,
  dbus_object_path 
)

Definition at line 53 of file plugin_handler_xembed_client.py.

Member Function Documentation

◆ _emit_close_plugin()

def qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient._emit_close_plugin (   self)
private

Reimplemented from qt_gui.plugin_handler.PluginHandler.

Definition at line 241 of file plugin_handler_xembed_client.py.

◆ _emit_load_completed()

def qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient._emit_load_completed (   self,
  exception = None 
)
private

◆ _load()

def qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient._load (   self)
private

◆ _on_embed_widget_icon_changed()

def qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient._on_embed_widget_icon_changed (   self,
  widget 
)
private

Definition at line 171 of file plugin_handler_xembed_client.py.

◆ _on_embed_widget_title_changed()

def qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient._on_embed_widget_title_changed (   self,
  widget 
)
private

Definition at line 179 of file plugin_handler_xembed_client.py.

◆ _restore_settings_from_remote()

def qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient._restore_settings_from_remote (   self)
private

Definition at line 124 of file plugin_handler_xembed_client.py.

◆ _save_settings_from_remote()

def qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient._save_settings_from_remote (   self)
private

Definition at line 105 of file plugin_handler_xembed_client.py.

◆ _toolbar_orientation_changed()

def qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient._toolbar_orientation_changed (   self,
  win_id,
  is_horizontal 
)
private

Definition at line 224 of file plugin_handler_xembed_client.py.

◆ add_toolbar()

def qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient.add_toolbar (   self,
  toolbar 
)

◆ add_widget()

def qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient.add_widget (   self,
  widget 
)

◆ emit_restore_settings_completed()

def qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient.emit_restore_settings_completed (   self)

Reimplemented from qt_gui.plugin_handler.PluginHandler.

Definition at line 137 of file plugin_handler_xembed_client.py.

◆ emit_save_settings_completed()

def qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient.emit_save_settings_completed (   self)

Reimplemented from qt_gui.plugin_handler.PluginHandler.

Definition at line 117 of file plugin_handler_xembed_client.py.

◆ emit_shutdown_plugin_completed()

def qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient.emit_shutdown_plugin_completed (   self)

Reimplemented from qt_gui.plugin_handler.PluginHandler.

Definition at line 98 of file plugin_handler_xembed_client.py.

◆ remove_toolbar()

def qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient.remove_toolbar (   self,
  toolbar 
)

Reimplemented from qt_gui.plugin_handler.PluginHandler.

Definition at line 232 of file plugin_handler_xembed_client.py.

◆ remove_widget()

def qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient.remove_widget (   self,
  widget 
)

Reimplemented from qt_gui.plugin_handler.PluginHandler.

Definition at line 185 of file plugin_handler_xembed_client.py.

◆ restore_settings()

def qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient.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.

Reimplemented from qt_gui.plugin_handler.PluginHandler.

Definition at line 120 of file plugin_handler_xembed_client.py.

◆ save_settings()

def qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient.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.

Reimplemented from qt_gui.plugin_handler.PluginHandler.

Definition at line 101 of file plugin_handler_xembed_client.py.

◆ shutdown_plugin()

def qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient.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_direct.PluginHandlerDirect.

Definition at line 94 of file plugin_handler_xembed_client.py.

Member Data Documentation

◆ _dbus_object_path

qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient._dbus_object_path
private

Definition at line 57 of file plugin_handler_xembed_client.py.

◆ _embed_widgets

qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient._embed_widgets
private

Definition at line 62 of file plugin_handler_xembed_client.py.

◆ _remote_container

qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient._remote_container
private

Definition at line 58 of file plugin_handler_xembed_client.py.

◆ _remote_instance_settings

qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient._remote_instance_settings
private

Definition at line 60 of file plugin_handler_xembed_client.py.

◆ _remote_plugin_settings

qt_gui.plugin_handler_xembed_client.PluginHandlerXEmbedClient._remote_plugin_settings
private

Definition at line 59 of file plugin_handler_xembed_client.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