Gazebo Gui

API Reference

7.2.2
DropdownMenuEnabled Class Reference

Event which is called to enable or disable the dropdown menu. This is primarily used by plugins which also use the right click mouse event to cancel any actions currently in progress. More...

#include <GuiEvents.hh>

Public Member Functions

 DropdownMenuEnabled (bool _menuEnabled)
 Constructor. More...
 
bool MenuEnabled () const
 Gets whether the menu is enabled or not for this event. More...
 
- Public Member Functions inherited from QEvent
 QEvent (Type type)
 
virtual ~QEvent ()
 
void accept ()
 
void ignore ()
 
bool isAccepted () const
 
void setAccepted (bool accepted)
 
bool spontaneous () const
 
Type type () const
 

Static Public Attributes

static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 7)
 Unique type for this event. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from QEvent
int registerEventType (int hint)
 
- Properties inherited from QEvent
 accepted
 

Detailed Description

Event which is called to enable or disable the dropdown menu. This is primarily used by plugins which also use the right click mouse event to cancel any actions currently in progress.

Constructor & Destructor Documentation

◆ DropdownMenuEnabled()

DropdownMenuEnabled ( bool  _menuEnabled)
explicit

Constructor.

Parameters
[in]_menuEnabledThe boolean indicating whether the dropdown menu should be enabled or disabled.

Member Function Documentation

◆ MenuEnabled()

bool MenuEnabled ( ) const

Gets whether the menu is enabled or not for this event.

Returns
True if enabling the menu, false if disabling the menu

Member Data Documentation

◆ kType

const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 7)
static

Unique type for this event.


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