Public Member Functions | Private Attributes
rqt_py_common.plugin_container_widget.PluginContainerWidget Class Reference
Inheritance diagram for rqt_py_common.plugin_container_widget.PluginContainerWidget:
Inheritance graph

List of all members.

Public Member Functions

def __init__
def restore_settings
def save_settings
def set_sysmsg
def set_sysprogress
def shutdown

Private Attributes


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

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

Definition at line 45 of file

Constructor & Destructor Documentation

def rqt_py_common.plugin_container_widget.PluginContainerWidget.__init__ (   self,
  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 64 of file

Member Function Documentation

def rqt_py_common.plugin_container_widget.PluginContainerWidget.restore_settings (   self,

Definition at line 124 of file

def rqt_py_common.plugin_container_widget.PluginContainerWidget.save_settings (   self,

Definition at line 116 of file

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

Definition at line 101 of file

Definition at line 97 of file

Definition at line 110 of file

Member Data Documentation

Definition at line 72 of file

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

Author(s): Dorian Scholz, Isaac Saito
autogenerated on Sat Jun 8 2019 20:23:34