Public Member Functions | Private Attributes | List of all members
rqt_robot_dashboard.menu_dash_widget.MenuDashWidget Class Reference
Inheritance diagram for rqt_robot_dashboard.menu_dash_widget.MenuDashWidget:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, name, icons=None, clicked_icons=None, icon_paths=[])
 
def add_action (self, name, callback)
 
def add_separator (self)
 
- Public Member Functions inherited from rqt_robot_dashboard.icon_tool_button.IconToolButton
def __init__ (self, name, icons, clicked_icons=None, suppress_overlays=False, icon_paths=None)
 
def state (self)
 
def update_state (self, state)
 

Private Attributes

 _menu
 

Additional Inherited Members

- Public Attributes inherited from rqt_robot_dashboard.icon_tool_button.IconToolButton
 icon_helper
 
 name
 
- Static Public Attributes inherited from rqt_robot_dashboard.icon_tool_button.IconToolButton
 state_changed = Signal(int)
 

Detailed Description

A widget which displays a pop-up menu when clicked

:param name: The name to give this widget.
:type name: str
:param icon: The icon to display in this widgets button.
:type icon: str

Definition at line 37 of file menu_dash_widget.py.

Constructor & Destructor Documentation

◆ __init__()

def rqt_robot_dashboard.menu_dash_widget.MenuDashWidget.__init__ (   self,
  name,
  icons = None,
  clicked_icons = None,
  icon_paths = [] 
)

Definition at line 46 of file menu_dash_widget.py.

Member Function Documentation

◆ add_action()

def rqt_robot_dashboard.menu_dash_widget.MenuDashWidget.add_action (   self,
  name,
  callback 
)
Add an action to the menu, and return the newly created action.

:param name: The name of the action.
:type name: str
:param callback: Function to be called when this item is pressed.
:type callback: callable

Definition at line 66 of file menu_dash_widget.py.

◆ add_separator()

def rqt_robot_dashboard.menu_dash_widget.MenuDashWidget.add_separator (   self)

Definition at line 63 of file menu_dash_widget.py.

Member Data Documentation

◆ _menu

rqt_robot_dashboard.menu_dash_widget.MenuDashWidget._menu
private

Definition at line 57 of file menu_dash_widget.py.


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


rqt_robot_dashboard
Author(s): Ze'ev Klapow
autogenerated on Wed Mar 2 2022 00:58:48