Gazebo Sim

API Reference

10.0.0~pre1
EntityContextMenuItem Class Reference

A QQUickItem that manages the render window. More...

#include <EntityContextMenuPlugin.hh>

Public Slots

void OnContextMenuRequested (QString _entity)
 Qt callback when context menu request is received.
 

Signals

void openContextMenu (QString _entity)
 Signal fired to open context menu Note that the function name needs to start with lowercase in order for the connection to work on the QML side.
 

Public Member Functions

 EntityContextMenuItem (QQuickItem *_parent=nullptr)
 Constructor.
 
void SetEntityContextMenuHandler (const EntityContextMenuHandler &_entityContextMenuHandler)
 Set the entity context menu handler.
 

Detailed Description

A QQUickItem that manages the render window.

Constructor & Destructor Documentation

◆ EntityContextMenuItem()

EntityContextMenuItem ( QQuickItem *  _parent = nullptr)
explicit

Constructor.

Parameters
[in]_parentParent item

Member Function Documentation

◆ OnContextMenuRequested

void OnContextMenuRequested ( QString  _entity)
slot

Qt callback when context menu request is received.

Parameters
[in]_entityScoped name of entity.

◆ openContextMenu

void openContextMenu ( QString  _entity)
signal

Signal fired to open context menu Note that the function name needs to start with lowercase in order for the connection to work on the QML side.

Parameters
[in]_entityScoped name of entity.

◆ SetEntityContextMenuHandler()

void SetEntityContextMenuHandler ( const EntityContextMenuHandler _entityContextMenuHandler)

Set the entity context menu handler.

Parameters
[in]_entityContextMenuHandlerEntity context menu handler

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