rqt_py_common.plugin_container_widget.PluginContainerWidget Class Reference

Inheritance diagram for rqt_py_common.plugin_container_widget.PluginContainerWidget:

Public Member Functions
def	__init__ (self, plugin_widget, on_sys_msg=True, on_sysprogress_bar=True)
def	restore_settings (self, plugin_settings, instance_settings)
def	save_settings (self, plugin_settings, instance_settings)
def	set_sysmsg (self, sysmsg)
def	set_sysprogress (self, sysprogress)
def	shutdown (self)

Private Attributes
	_plugin_widget

Detailed Description

This widget accommodates a plugin widget that needs an area to show system
message. A plugin widget is the pane that provides plugin's main
functionalities. PluginContainerWidget visually encapsulates a plugin
widget.

In order to print msg in the msg pane provided by this class, plugin widget
MUST define and emit following signals:

- sig_sysmsg
- sig_progress

Having said that this architecture is based on signals, it is recommended
that exceptions raised in classes that are used in a plugin widget be
aggregated in it, so that only plugin widget is responsible for emitting
signals.

Definition at line 45 of file plugin_container_widget.py.

Constructor & Destructor Documentation

def rqt_py_common.plugin_container_widget.PluginContainerWidget.__init__	(		self,
			plugin_widget,
			on_sys_msg = True,
			on_sysprogress_bar = True
	)

@param plugin_widget: The main widget of an rqt plugin.
@type plugin_widget: QWidget
@type on_sys_msg: bool
@param on_sys_msg: If True, a pane that accommodates str messages will
           appear in the plugin's region.
@param on_sysprogress_bar: If True, a progress bar will appear in the
                   plugin's region.

Definition at line 66 of file plugin_container_widget.py.

Member Function Documentation

def rqt_py_common.plugin_container_widget.PluginContainerWidget.restore_settings	(		self,
			plugin_settings,
			instance_settings
	)

Definition at line 125 of file plugin_container_widget.py.

def rqt_py_common.plugin_container_widget.PluginContainerWidget.save_settings	(		self,
			plugin_settings,
			instance_settings
	)

Definition at line 117 of file plugin_container_widget.py.

def rqt_py_common.plugin_container_widget.PluginContainerWidget.set_sysmsg	(		self,
			sysmsg
	)

Set system msg that's supposed to be shown in sys msg pane.
@type sysmsg: str

Definition at line 102 of file plugin_container_widget.py.

def rqt_py_common.plugin_container_widget.PluginContainerWidget.set_sysprogress	(		self,
			sysprogress
	)

Definition at line 98 of file plugin_container_widget.py.

def rqt_py_common.plugin_container_widget.PluginContainerWidget.shutdown

(

self

)

Definition at line 111 of file plugin_container_widget.py.

Member Data Documentation

rqt_py_common.plugin_container_widget.PluginContainerWidget._plugin_widget

private

Definition at line 82 of file plugin_container_widget.py.

---

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

• plugin_container_widget.py