Class MenuHandler

• Defined in File menu_handler.hpp

Nested Relationships

Nested Types

• Struct MenuHandler::EntryContext

Class Documentation

class interactive_markers::MenuHandler

Public Types

enum CheckState

Values:

enumerator NO_CHECKBOX

enumerator CHECKED

enumerator UNCHECKED

typedef uint32_t EntryHandle

typedef visualization_msgs::msg::InteractiveMarkerFeedback::ConstSharedPtr FeedbackConstPtr

typedef std::function<void(const FeedbackConstPtr&)> FeedbackCallback

Public Functions

INTERACTIVE_MARKERS_PUBLIC MenuHandler()

INTERACTIVE_MARKERS_PUBLIC EntryHandle insert (const std::string &title, const FeedbackCallback &feedback_cb)

Insert top-level entry with feedback function.

INTERACTIVE_MARKERS_PUBLIC EntryHandle insert (const std::string &title, const uint8_t command_type=visualization_msgs::msg::MenuEntry::FEEDBACK, const std::string &command="")

Insert top-level entry with custom (client-side) command.

INTERACTIVE_MARKERS_PUBLIC EntryHandle insert (EntryHandle parent, const std::string &title, const FeedbackCallback &feedback_cb)

Insert second-level entry with feedback function.

INTERACTIVE_MARKERS_PUBLIC EntryHandle insert (EntryHandle parent, const std::string &title, const uint8_t command_type=visualization_msgs::msg::MenuEntry::FEEDBACK, const std::string &command="")

Insert second-level entry with custom (client-side) command.

INTERACTIVE_MARKERS_PUBLIC bool setVisible (EntryHandle handle, bool visible)

Specify if an entry should be visible or hidden.

INTERACTIVE_MARKERS_PUBLIC bool setCheckState (EntryHandle handle, CheckState check_state)

Specify if an entry is checked or can’t be checked at all.

INTERACTIVE_MARKERS_PUBLIC bool getCheckState (EntryHandle handle, CheckState &check_state) const

Get the current state of an entry

Returns

true if the entry exists

INTERACTIVE_MARKERS_PUBLIC bool apply (InteractiveMarkerServer &server, const std::string &marker_name)

Copy current menu state into the marker given by the specified name & divert callback for MENU_SELECT feedback to this manager

INTERACTIVE_MARKERS_PUBLIC bool reApply (InteractiveMarkerServer &server)

Re-apply to all markers that this was applied to previously.

INTERACTIVE_MARKERS_PUBLIC bool getTitle (EntryHandle handle, std::string &title) const

Get the title for the given menu entry

Returns

true if the entry exists