Context menu widget. More...

#include <TGUI/Widgets/ContextMenu.hpp>

Inheritance diagram for tgui::ContextMenu:

Public Types
using	Ptr = std::shared_ptr<ContextMenu>
	Shared widget pointer.

using	ConstPtr = std::shared_ptr<const ContextMenu>
	Shared constant widget pointer.

Public Types inherited from tgui::Widget
using	Ptr = std::shared_ptr<Widget>
	Shared widget pointer.

using	ConstPtr = std::shared_ptr<const Widget>
	Shared constant widget pointer.

Public Member Functions
	ContextMenu (const char *typeName=StaticWidgetType, bool initRenderer=true)

ContextMenuRenderer *	getSharedRenderer () override
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

const ContextMenuRenderer *	getSharedRenderer () const override

ContextMenuRenderer *	getRenderer () override
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

bool	isMenuOpen () const
	Returns whether the context menu is open.

void	openMenu ()
	Opens the context menu at the position of this widget.

void	openMenu (Vector2f position)
	Opens the context menu at a certain position.

void	openMenuAtMouseCursor ()
	Opens the context menu at the last mouse cursor position.

void	closeMenu () override
	Closes the context menu if it was open.

void	setItemHeight (float itemHeight)
	Changes the height of the items in the context menu.

float	getItemHeight () const
	Returns the height of the items in the context menu.

template<typename Func, typename... Args>
unsigned int	connectMenuItem (const String &menuItem, Func &&handler, const Args &... args)
	Connects a signal handler to the "MenuItemClicked" callback that will only be called when a specific menu item was clicked.

template<typename Func, typename... Args>
unsigned int	connectMenuItem (const std::vector< String > &hierarchy, Func &&handler, const Args &... args)
	Connects a signal handler to the "MenuItemClicked" callback that will only be called when a specific menu item was clicked.

void	setSize (const Layout2d &size) override
	This function is overriden to do nothing.

void	setEnabled (bool enabled) override
	Enables or disables the widget.

void	addMenuItem (const String &text)
	Adds a new menu item to the menu.

bool	addMenuItem (const std::vector< String > &hierarchy, bool createParents=true)
	Adds a new sub menu item.

bool	changeMenuItem (const std::vector< String > &hierarchy, const String &text)
	Changes the text of an existing menu item.

void	removeAllMenuItems ()
	Removes all menu items.

bool	removeMenuItem (const String &menuItem)
	Removes a menu item.

bool	removeMenuItem (const std::vector< String > &hierarchy, bool removeParentsWhenEmpty=true)
	Removes a sub menu item.

bool	removeSubMenuItems (const std::vector< String > &hierarchy)
	Removes a all menu items below a (sub) menu.

bool	setMenuItemEnabled (const String &menuItem, bool enabled)
	Enable or disable a menu item.

bool	setMenuItemEnabled (const std::vector< String > &hierarchy, bool enabled)
	Enable or disable a menu item.

bool	getMenuItemEnabled (const String &menuItem) const
	Check if a menu item is enabled or disabled.

bool	getMenuItemEnabled (const std::vector< String > &hierarchy) const
	Check if a menu item is enabled or disabled.

void	setMinimumMenuWidth (float minimumWidth)
	Changes the minimum width of the menus.

float	getMinimumMenuWidth () const
	Returns the minimum width of the menus.

std::vector< GetMenusElement >	getMenuItems () const
	Returns the menu items, including submenus.

bool	isMouseOnWidget (Vector2f pos) const override
	Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

void	draw (BackendRenderTarget &target, RenderStates states) const override
	Draw the widget to a render target.

void	setSize (Layout width, Layout height)
	Changes the size of the widget.

Public Member Functions inherited from tgui::MenuWidgetBase
	MenuWidgetBase (const MenuWidgetBase &other)

	MenuWidgetBase (MenuWidgetBase &&other) noexcept

MenuWidgetBase &	operator= (const MenuWidgetBase &other)

MenuWidgetBase &	operator= (MenuWidgetBase &&other) noexcept

MenuWidgetBaseRenderer *	getSharedRenderer () override
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

const MenuWidgetBaseRenderer *	getSharedRenderer () const override

MenuWidgetBaseRenderer *	getRenderer () override
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

Public Member Functions inherited from tgui::Widget
	Widget (const char *typeName, bool initRenderer)

	Widget (const Widget &)
	Copy constructor.

	Widget (Widget &&) noexcept
	Move constructor.

virtual	~Widget ()
	Destructor.

Widget &	operator= (const Widget &)
	Overload of copy assignment operator.

Widget &	operator= (Widget &&) noexcept
	Move assignment.

void	setRenderer (std::shared_ptr< RendererData > rendererData)
	Sets a new renderer for the widget. The renderer determines how the widget looks.

virtual void	setPosition (const Layout2d &position)
	sets the position of the widget

void	setPosition (Layout x, Layout y)
	Sets the position of the widget.

Vector2f	getPosition () const
	Gets the position of the widget.

void	setSize (Layout width, Layout height)
	Changes the size of the widget.

void	setWidth (Layout width)
	Changes the width of the widget.

void	setHeight (Layout height)
	Changes the height of the widget.

Vector2f	getSize () const
	Returns the size of the widget.

virtual Vector2f	getFullSize () const
	Returns the entire size that the widget is using.

virtual Vector2f	getAbsolutePosition (Vector2f offset={}) const
	Get the absolute position of the widget instead of the relative position to its parent.

virtual Vector2f	getWidgetOffset () const
	Returns the distance between the position where the widget is drawn and where the widget is placed.

void	setAutoLayout (AutoLayout layout)
	Sets how the position is determined compared to the other widgets in the parent.

AutoLayout	getAutoLayout () const
	Returns how the position is determined compared to the other widgets in the parent.

void	setOrigin (float x, float y)
	Sets the origin point on which the position, scale and rotation is based.

void	setOrigin (Vector2f origin)
	Sets the origin point on which the position, scale and rotation is based.

Vector2f	getOrigin () const
	Returns the relative origin point on which the position, scale and rotation is based.

void	setScale (Vector2f scaleFactors)
	Sets the scaling to be applied to the widget.

void	setScale (Vector2f scaleFactors, Vector2f origin)
	Sets the scaling to be applied to the widget.

void	setScale (float scaleFactor)
	Sets the scaling to be applied to the widget.

void	setScale (float scaleFactor, Vector2f origin)
	Sets the scaling to be applied to the widget.

Vector2f	getScale () const
	Returns the scaling to be applied to the widget.

Vector2f	getScaleOrigin () const
	Returns the origin used for scaling.

void	setRotation (float angle)
	Sets the rotation to be applied to the widget.

void	setRotation (float angle, Vector2f origin)
	Sets the rotation to be applied to the widget.

float	getRotation () const
	Returns the rotation to be applied to the widget.

Vector2f	getRotationOrigin () const
	Returns the origin used for rotations.

void	showWithEffect (ShowEffectType type, Duration duration)
	Shows the widget by introducing it with an animation.

void	hideWithEffect (ShowEffectType type, Duration duration)
	Hides the widget by making it leave with an animation.

void	moveWithAnimation (Layout2d position, Duration duration)
	Moves the widget from its current position to the given position, over a given duration.

void	resizeWithAnimation (Layout2d size, Duration duration)
	Resizes the widget from its current size to the given size, over a given duration.

virtual void	setVisible (bool visible)
	Shows or hides a widget.

bool	isVisible () const
	Returns true when the widget is visible.

bool	isEnabled () const
	Returns true when the widget is enabled.

virtual void	setFocused (bool focused)
	Focus or unfocus the widget.

bool	isFocused () const
	Returns true when the widget is focused and false otherwise.

const String &	getWidgetType () const
	Returns the type of the widget.

Container *	getParent () const
	Returns a pointer to the parent widget.

BackendGui *	getParentGui () const
	Returns a pointer to the gui to which this widget belongs.

bool	isAnimationPlaying () const
	Returns whether there is an active animation (started with showWithEffect or hideWithEffect)

void	moveToFront ()
	Places the widget before all other widgets.

void	moveToBack ()
	Places the widget behind all other widgets.

void	setUserData (Any userData)
	Stores some data into the widget.

template<typename DataType>
DataType	getUserData () const
	Returns data stored in the widget.

bool	hasUserData () const
	Returns whether data stored in the widget.

void	setInheritedFont (const Font &font)
	Sets the font of the widget that is used when no font is set in the renderer.

const Font &	getInheritedFont () const
	Returns the font of the widget that is used when no font is set in the renderer.

void	setInheritedOpacity (float opacity)
	Sets the opacity of the widget that will be multiplied with the opacity set in the renderer.

float	getInheritedOpacity () const
	Returns the opacity of the widget that is multiplied with the opacity set in the renderer.

void	setTextSize (unsigned int size)
	Changes the character size of text in this widget if it uses text.

unsigned int	getTextSize () const
	Returns the character size of text in this widget.

void	setToolTip (Widget::Ptr toolTip)
	Sets the tool tip that should be displayed when hovering over the widget.

Widget::Ptr	getToolTip () const
	Returns the tool tip that is displayed when hovering over the widget.

void	setWidgetName (const String &name)
	Changes the name of a widget.

String	getWidgetName () const
	Returns the name of a widget.

void	setMouseCursor (Cursor::Type cursor)
	Changes which mouse cursor is shown when hovering over the widget.

Cursor::Type	getMouseCursor () const
	Returns which mouse cursor is shown when hovering over the widget.

void	setFocusable (bool focusable)
	Changes whether a widget could be focused.

bool	isFocusable () const
	Returns whether a widget could be focused.

void	setNavigationUp (const Widget::Ptr &widgetAbove)
	Changes which widget should become focused when navigating upwards from this widget.

Widget::Ptr	getNavigationUp () const
	Returns which widget would become focused when navigating upwards from this widget.

void	setNavigationDown (const Widget::Ptr &widgetBelow)
	Changes which widget should become focused when navigating downwards from this widget.

Widget::Ptr	getNavigationDown () const
	Returns which widget would become focused when navigating downwards from this widget.

void	setNavigationLeft (const Widget::Ptr &widgetLeft)
	Changes which widget should become focused when navigating to the left from this widget.

Widget::Ptr	getNavigationLeft () const
	Returns which widget would become focused when navigating to the left from this widget.

void	setNavigationRight (const Widget::Ptr &widgetRight)
	Changes which widget should become focused when navigating to the right from this widget.

Widget::Ptr	getNavigationRight () const
	Returns which widget would become focused when navigating to the right from this widget.

void	setIgnoreMouseEvents (bool ignore)
	Sets whether the widget should completely ignore mouse events and let them pass to the widgets behind it.

bool	getIgnoreMouseEvents () const
	Returns whether the widget is ignoring mouse events and letting them pass to the widgets behind it.

void	finishAllAnimations ()
	Makes all animations of the widget finish immediately.

virtual bool	canGainFocus () const
	Returns whether the widget can currently gain focus.

bool	isContainer () const
	Returns whether the widget is a container widget or not.

bool	isMouseDown () const
	Returns whether the left mouse button has been pressed on top of the widget.

virtual void	setParent (Container *parent)

virtual bool	updateTime (Duration elapsedTime)

void	setAutoLayoutUpdateEnabled (bool enabled)

virtual bool	leftMousePressed (Vector2f pos)
	Called by the parent when the left mouse button goes down on top of the widget.

virtual void	leftMouseReleased (Vector2f pos)

virtual void	rightMousePressed (Vector2f pos)

virtual void	rightMouseReleased (Vector2f pos)

virtual void	mouseReleased (Event::MouseButton button, Vector2f pos)

virtual void	mouseMoved (Vector2f pos)

virtual void	keyPressed (const Event::KeyEvent &event)

virtual bool	canHandleKeyPress (const Event::KeyEvent &event)
	Called by the parent of the widget to check if keyPressed would process the event.

virtual void	textEntered (char32_t key)

virtual bool	scrolled (float delta, Vector2f pos, bool touch)
	Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen)

virtual void	mouseNoLongerOnWidget ()

virtual void	leftMouseButtonNoLongerDown ()

virtual void	rightMouseButtonNoLongerDown ()

virtual Widget::Ptr	askToolTip (Vector2f mousePos)

const Layout2d &	getPositionLayout () const

const Layout2d &	getSizeLayout () const

void	bindPositionLayout (Layout *layout)

void	unbindPositionLayout (Layout *layout)

void	bindSizeLayout (Layout *layout)

void	unbindSizeLayout (Layout *layout)

template<typename WidgetType>
std::shared_ptr< const WidgetType >	cast () const
	Downcast const widget.

template<typename WidgetType>
std::shared_ptr< WidgetType >	cast ()
	Downcast widget.

void	rendererChangedCallback (const String &property)

Static Public Member Functions
static ContextMenu::Ptr	create ()
	Creates a new menu bar widget.

static ContextMenu::Ptr	copy (const ContextMenu::ConstPtr &menuBar)
	Makes a copy of another menu bar.

Static Public Attributes
static constexpr const char	StaticWidgetType [] = "ContextMenu"
	Type name of the widget.

Protected Member Functions
void	rendererChanged (const String &property) override
	Function called when one of the properties of the renderer is changed.

std::unique_ptr< DataIO::Node >	save (SavingRenderersMap &renderers) const override
	Saves the widget as a tree node in order to save it to a file.

void	load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
	Loads the widget from a tree of nodes.

void	updateTextSize () override
	Called when the text size is changed (either by setTextSize or via the renderer)

Widget::Ptr	clone () const override
	Makes a copy of the widget if you don't know its exact type.

void	emitMenuItemClick (const std::vector< String > &hierarchy) override

float	getDefaultMenuItemHeight () const override

void	leftMouseReleasedOnMenu () override

bool	isMouseOnOpenMenu (Vector2f pos) const override

void	mouseMovedOnMenu (Vector2f pos) override

void	deselectDeepestItem () override

void	drawOpenMenu (BackendRenderTarget &target, RenderStates states) const override

Protected Member Functions inherited from tgui::MenuWidgetBase
	MenuWidgetBase (const char *typeName, bool initRenderer)
	Constructor.

Signal &	getSignal (String signalName) override
	Retrieves a signal based on its name.

void	rendererChanged (const String &property) override
	Function called when one of the properties of the renderer is changed.

void	createMenu (std::vector< Menu > &menus, const String &text)

Menu *	findMenuItemParent (const std::vector< String > &hierarchy, unsigned int parentIndex, std::vector< Menu > &menus, bool createParents)

const Menu *	findMenuItemParent (const std::vector< String > &hierarchy, unsigned int parentIndex, const std::vector< Menu > &menus) const

Menu *	findMenuItem (const std::vector< String > &hierarchy, std::vector< Menu > &menus)

const Menu *	findMenuItem (const std::vector< String > &hierarchy, const std::vector< Menu > &menus) const

void	loadMenus (const std::unique_ptr< DataIO::Node > &node, std::vector< Menu > &menus)

void	closeSubMenus (std::vector< Menu > &menus, int &selectedMenu)

void	updateMenuTextColor (Menu &menu, bool selected)

void	updateTextColors (std::vector< Menu > &menus, int selectedMenu)

void	updateTextOpacity (std::vector< Menu > &menus)

void	updateTextFont (std::vector< Menu > &menus)

float	calculateMenuWidth (const Menu &menu) const

float	getMenuItemHeight (const Menu &menuItem) const

float	calculateOpenMenuHeight (const std::vector< Menu > &menuItems) const

Vector2f	calculateSubmenuOffset (const Menu &menu, float globalLeftPos, float menuWidth, float subMenuWidth, bool &openSubMenuToRight) const

bool	isMouseOnTopOfMenu (Vector2f menuPos, Vector2f mousePos, bool openSubMenuToRight, const Menu &menu, float menuWidth) const

bool	findMenuItemBelowMouse (Vector2f menuPos, Vector2f mousePos, bool openSubMenuToRight, Menu &menu, float menuWidth, Menu *resultMenu, std::size_t resultSelectedMenuItem)

void	drawMenu (BackendRenderTarget &target, RenderStates states, const Menu &menu, float menuWidth, float globalLeftPos, bool openSubMenuToRight) const

void	leftMouseReleasedOnMenu (const Menu *menu)

bool	isMouseOnOpenMenu (Vector2f pos, const Menu &menu, Vector2f menuOffset) const

void	mouseMovedOnMenu (Vector2f pos, Menu &menu, Vector2f menuOffset)

void	deselectDeepestItem (Menu *menu)

void	drawOpenMenu (BackendRenderTarget &target, RenderStates states, const Menu &menu, Vector2f menuOffset) const

Protected Member Functions inherited from tgui::Widget
virtual void	mouseEnteredWidget ()
	This function is called when the mouse enters the widget.

virtual void	mouseLeftWidget ()
	This function is called when the mouse leaves the widget.

void	recalculateBoundPositionLayouts ()
	Calls recalculateValue() on each layout in m_boundPositionLayouts.

void	recalculateBoundSizeLayouts ()
	Calls recalculateValue() on each layout in m_boundSizeLayouts.

Protected Attributes
Menu	m_menu

bool	m_menuOpen = false

float	m_itemHeight = 0

Protected Attributes inherited from tgui::MenuWidgetBase
std::shared_ptr< OpenMenuPlaceholder >	m_openMenuPlaceholder

float	m_minimumMenuWidth = 125

Sprite	m_spriteItemBackground

Sprite	m_spriteSelectedItemBackground

Color	m_backgroundColorCached

Color	m_selectedBackgroundColorCached

Color	m_textColorCached

Color	m_selectedTextColorCached

Color	m_textColorDisabledCached

Color	m_separatorColorCached = Color::Black

float	m_separatorThicknessCached = 1

float	m_separatorVerticalPaddingCached = 0

float	m_separatorSidePaddingCached = 0

float	m_distanceToSideCached = 0

bool	m_invertedMenuDirection = false

Protected Attributes inherited from tgui::Widget
String	m_type

String	m_name

Layout2d	m_position
	Stores the position of this widget.

Layout2d	m_size
	Stores the size of this widget.

unsigned int	m_textSize = 0

Vector2f	m_origin

Optional< Vector2f >	m_rotationOrigin

Optional< Vector2f >	m_scaleOrigin

Vector2f	m_scaleFactors = {1, 1}

float	m_rotationDeg = 0

Vector2f	m_prevPosition

Vector2f	m_prevSize

std::unordered_set< Layout * >	m_boundPositionLayouts

std::unordered_set< Layout * >	m_boundSizeLayouts

bool	m_enabled = true
	Stores the flag indicating whether this widget is enabled.

bool	m_visible = true
	Stores the flag indicating whether this widget is visible.

Container *	m_parent = nullptr

BackendGui *	m_parentGui = nullptr

bool	m_mouseHover = false

bool	m_mouseDown = false

bool	m_focused = false

bool	m_focusable = true

std::weak_ptr< Widget >	m_navWidgetUp

std::weak_ptr< Widget >	m_navWidgetDown

std::weak_ptr< Widget >	m_navWidgetRight

std::weak_ptr< Widget >	m_navWidgetLeft

Duration	m_animationTimeElapsed

bool	m_containerWidget = false

Widget::Ptr	m_toolTip = nullptr

aurora::CopiedPtr< WidgetRenderer >	m_renderer = nullptr

std::vector< std::unique_ptr< priv::Animation > >	m_showAnimations

Font	m_inheritedFont

float	m_inheritedOpacity = 1

Any	m_userData

Cursor::Type	m_mouseCursor = Cursor::Type::Arrow

AutoLayout	m_autoLayout = AutoLayout::Manual

bool	m_autoLayoutUpdateEnabled = true

bool	m_ignoreMouseEvents = false

Font	m_fontCached = Font::getGlobalFont()

float	m_opacityCached = 1

bool	m_transparentTextureCached = false

unsigned int	m_textSizeCached = 0

Additional Inherited Members
Public Attributes inherited from tgui::MenuWidgetBase
SignalItemHierarchy	onMenuItemClick = {"MenuItemClicked"}

Public Attributes inherited from tgui::Widget
SignalVector2f	onPositionChange = {"PositionChanged"}
	The position of the widget changed. Optional parameter: new position.

SignalVector2f	onSizeChange = {"SizeChanged"}
	The size of the widget changed. Optional parameter: new size.

Signal	onFocus = {"Focused"}
	The widget was focused.

Signal	onUnfocus = {"Unfocused"}
	The widget was unfocused.

Signal	onMouseEnter = {"MouseEntered"}
	The mouse entered the widget.

Signal	onMouseLeave = {"MouseLeft"}
	The mouse left the widget.

SignalShowEffect	onShowEffectFinish = {"ShowEffectFinished"}
	A show or hide effect finished. Optional parameters: effect type, new widget visibility or both.

SignalAnimationType	onAnimationFinish = {"AnimationFinished"}
	An animation has finished.

Protected Types inherited from tgui::Widget
using	SavingRenderersMap = std::map<const Widget*, std::pair<std::unique_ptr<DataIO::Node>, String>>

using	LoadingRenderersMap = std::map<String, std::shared_ptr<RendererData>>

Static Protected Member Functions inherited from tgui::MenuWidgetBase
static bool	isSeparator (const Menu &menuItem)

static bool	removeMenuImpl (const std::vector< String > &hierarchy, bool removeParentsWhenEmpty, unsigned int parentIndex, std::vector< Menu > &menus)

static bool	removeSubMenusImpl (const std::vector< String > &hierarchy, unsigned int parentIndex, std::vector< Menu > &menus)

static void	setTextSizeImpl (std::vector< Menu > &menus, unsigned int textSize)

static std::vector< GetMenusElement >	getMenusImpl (const std::vector< Menu > &menus)

static void	saveMenus (const std::unique_ptr< DataIO::Node > &parentNode, const std::vector< Menu > &menus)

Detailed Description

Context menu widget.

Since: TGUI 1.8

Member Function Documentation

◆ addMenuItem() [1/2]

bool tgui::ContextMenu::addMenuItem	(	const std::vector< String > &	hierarchy,
		bool	createParents = true )

Adds a new sub menu item.

Parameters

hierarchy	Hierarchy of the menu items, ending with menu item to be added
createParents	Should the hierarchy be created if it did not exist yet?

Returns: True when the item was added, false when createParents was false and the parents hierarchy does not exist or if hierarchy is empty.

contextMenu->addMenuItem({"Edit", "Undo"});

contextMenu->addMenuItem({"Edit", "Redo"});

If the "-" string is given as menu item then a separator will appear instead of an item.

◆ addMenuItem() [2/2]

void tgui::ContextMenu::addMenuItem ( const String & text )

Adds a new menu item to the menu.

Parameters

text	The text written on this menu item

contextMenu->addMenuItem("Cut");
contextMenu->addMenuItem("Copy");
contextMenu->addMenuItem("Paste");

If the "-" string is given as menu item then a separator will appear instead of an item.

◆ changeMenuItem()

bool tgui::ContextMenu::changeMenuItem	(	const std::vector< String > &	hierarchy,
		const String &	text )

Changes the text of an existing menu item.

Parameters

hierarchy	Hierarchy of the menu items, ending with the menu item that is to be renamed
text	The new text written on this menu item

Returns: True when the menu item was renamed, false when the menu item was not found

contextMenu->addMenuItem({"Edit", "Undo"});

contextMenu->changeMenuItem({"Edit", "Undo"}, "Undo action");

This function can also be used to rename items without submenus, by passing a hierarchy with only one element.

◆ clone()

Widget::Ptr tgui::ContextMenu::clone ( ) const

nodiscardoverrideprotectedvirtual

Makes a copy of the widget if you don't know its exact type.

This function should only be used when you don't know the type of the widget. If you know what kind of widget you are copying, you should use the copy function.

Returns: Copy of the widget

Implements tgui::Widget.

◆ closeMenu()

void tgui::ContextMenu::closeMenu ( )

overridevirtual

Closes the context menu if it was open.

Implements tgui::MenuWidgetBase.

◆ connectMenuItem() [1/2]

template<typename Func, typename... Args>

unsigned int tgui::ContextMenu::connectMenuItem	(	const std::vector< String > &	hierarchy,
		Func &&	handler,
		const Args &...	args )

inline

Connects a signal handler to the "MenuItemClicked" callback that will only be called when a specific menu item was clicked.

Parameters

hierarchy	Hierarchy of the menu items, ending with menu item that should trigger the signal when pressed
handler	Callback function to call
args	Optional extra arguments to pass to the signal handler when the signal is emitted

Returns: Unique id of the connection

The hierarchy does not need to exist yet and the signal will still exist when removing and readding the menu items.

◆ connectMenuItem() [2/2]

template<typename Func, typename... Args>

unsigned int tgui::ContextMenu::connectMenuItem	(	const String &	menuItem,
		Func &&	handler,
		const Args &...	args )

inline

Connects a signal handler to the "MenuItemClicked" callback that will only be called when a specific menu item was clicked.

Parameters

menuItem	Menu item which should trigger the signal (assuming there are no submenus)
handler	Callback function to call
args	Optional extra arguments to pass to the signal handler when the signal is emitted

Returns: Unique id of the connection

The hierarchy does not need to exist yet and the signal will still exist when removing and readding the menu items.

◆ copy()

static ContextMenu::Ptr tgui::ContextMenu::copy ( const ContextMenu::ConstPtr & menuBar )

staticnodiscard

Makes a copy of another menu bar.

Parameters

menuBar The other menu bar

Returns: The new menu bar

◆ create()

static ContextMenu::Ptr tgui::ContextMenu::create ( )

staticnodiscard

Creates a new menu bar widget.

Returns: The new menu bar

◆ deselectDeepestItem()

void tgui::ContextMenu::deselectDeepestItem ( )

overrideprotectedvirtual

Implements tgui::MenuWidgetBase.

◆ draw()

void tgui::ContextMenu::draw	(	BackendRenderTarget &	target,
		RenderStates	states ) const

overridevirtual

Draw the widget to a render target.

Parameters

target	Render target to draw to
states	Current render states

Implements tgui::Widget.

◆ drawOpenMenu()

void tgui::ContextMenu::drawOpenMenu	(	BackendRenderTarget &	target,
		RenderStates	states ) const

overrideprotectedvirtual

Implements tgui::MenuWidgetBase.

◆ emitMenuItemClick()

void tgui::ContextMenu::emitMenuItemClick ( const std::vector< String > & hierarchy )

overrideprotectedvirtual

Implements tgui::MenuWidgetBase.

◆ getDefaultMenuItemHeight()

float tgui::ContextMenu::getDefaultMenuItemHeight ( ) const

nodiscardoverrideprotectedvirtual

Implements tgui::MenuWidgetBase.

◆ getItemHeight()

float tgui::ContextMenu::getItemHeight ( ) const

nodiscard

Returns the height of the items in the context menu.

Returns: The item height

◆ getMenuItemEnabled() [1/2]

bool tgui::ContextMenu::getMenuItemEnabled ( const std::vector< String > & hierarchy ) const

nodiscard

Check if a menu item is enabled or disabled.

Parameters

hierarchy Hierarchy of menu items, ending with the menu item to check

Returns: True if the menu item is enabled, false if it was disabled or when the hierarchy was incorrect

◆ getMenuItemEnabled() [2/2]

bool tgui::ContextMenu::getMenuItemEnabled ( const String & menuItem ) const

nodiscard

Check if a menu item is enabled or disabled.

Parameters

menuItem The name of the menu item to check

Returns: True if the menu item is enabled, false if it was disabled or when the menuItem did not exist

◆ getMenuItems()

std::vector< GetMenusElement > tgui::ContextMenu::getMenuItems ( ) const

nodiscard

Returns the menu items, including submenus.

Returns: List of menu items

◆ getMinimumMenuWidth()

float tgui::ContextMenu::getMinimumMenuWidth ( ) const

nodiscard

Returns the minimum width of the menus.

Returns: minimum width of the menus

See also: setMinimumMenuWidth

◆ getRenderer()

ContextMenuRenderer * tgui::ContextMenu::getRenderer ( )

nodiscardoverridevirtual

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns: Temporary pointer to the renderer

Warning: After calling this function, the widget has its own copy of the renderer and it will no longer be shared.

Reimplemented from tgui::Widget.

◆ getSharedRenderer() [1/2]

const ContextMenuRenderer * tgui::ContextMenu::getSharedRenderer ( ) const

nodiscardoverridevirtual

Reimplemented from tgui::Widget.

◆ getSharedRenderer() [2/2]

ContextMenuRenderer * tgui::ContextMenu::getSharedRenderer ( )

nodiscardoverridevirtual

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns: Temporary pointer to the renderer that may be shared with other widgets using the same renderer

Reimplemented from tgui::Widget.

◆ isMenuOpen()

bool tgui::ContextMenu::isMenuOpen ( ) const

nodiscard

Returns whether the context menu is open.

The context menu will render nothing until it is opened.

See also: openMenu

◆ isMouseOnOpenMenu()

bool tgui::ContextMenu::isMouseOnOpenMenu ( Vector2f pos ) const

nodiscardoverrideprotectedvirtual

Implements tgui::MenuWidgetBase.

◆ isMouseOnWidget()

bool tgui::ContextMenu::isMouseOnWidget ( Vector2f pos ) const

nodiscardoverridevirtual

Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

Returns: Is the mouse on top of the widget?

Implements tgui::Widget.

◆ leftMouseReleasedOnMenu()

void tgui::ContextMenu::leftMouseReleasedOnMenu ( )

overrideprotectedvirtual

Implements tgui::MenuWidgetBase.

◆ load()

void tgui::ContextMenu::load	(	const std::unique_ptr< DataIO::Node > &	node,
		const LoadingRenderersMap &	renderers )

overrideprotectedvirtual

Loads the widget from a tree of nodes.

Reimplemented from tgui::Widget.

◆ mouseMovedOnMenu()

void tgui::ContextMenu::mouseMovedOnMenu ( Vector2f pos )

overrideprotectedvirtual

Implements tgui::MenuWidgetBase.

◆ openMenu() [1/2]

void tgui::ContextMenu::openMenu ( )

Opens the context menu at the position of this widget.

The context menu will render nothing until this function is called. Once the user clicked an item in the menu, the menu will be closed and you need to call this function again in order for the menu to become visible again.

◆ openMenu() [2/2]

void tgui::ContextMenu::openMenu ( Vector2f position )

Opens the context menu at a certain position.

The context menu will render nothing until this function is called. Once the user clicked an item in the menu, the menu will be closed and you need to call this function again in order for the menu to become visible again.

See also: openMenuAtCursor

◆ openMenuAtMouseCursor()

void tgui::ContextMenu::openMenuAtMouseCursor ( )

Opens the context menu at the last mouse cursor position.

The context menu will render nothing until this function is called. Once the user clicked an item in the menu, the menu will be closed and you need to call this function again in order for the menu to become visible again.

◆ removeMenuItem() [1/2]

bool tgui::ContextMenu::removeMenuItem	(	const std::vector< String > &	hierarchy,
		bool	removeParentsWhenEmpty = true )

Removes a sub menu item.

Parameters

hierarchy	Hierarchy of the menu item, ending with menu item to be deleted
removeParentsWhenEmpty	Also delete the parent of the deleted menu item if it has no other children

Returns: True when the menu item existed and was removed, false when hierarchy was incorrect

contextMenu->removeMenuItem({"Edit", "Undo"});

◆ removeMenuItem() [2/2]

bool tgui::ContextMenu::removeMenuItem ( const String & menuItem )

Removes a menu item.

Parameters

menuItem The name of the menu item to remove

Returns: True when the item was removed, false when menuItem was not found

◆ removeSubMenuItems()

bool tgui::ContextMenu::removeSubMenuItems ( const std::vector< String > & hierarchy )

Removes a all menu items below a (sub) menu.

Parameters

hierarchy Hierarchy of the menu item, ending with the sub menu containing the items

Returns: True when the menu item existed and its children were removed, false when hierarchy was incorrect

contextMenu->removeSubMenuItems({"File", "Recent files"});

◆ rendererChanged()

void tgui::ContextMenu::rendererChanged ( const String & property )

overrideprotectedvirtual

Function called when one of the properties of the renderer is changed.

Parameters

property Name of the property that was changed

Reimplemented from tgui::Widget.

◆ save()

std::unique_ptr< DataIO::Node > tgui::ContextMenu::save ( SavingRenderersMap & renderers ) const

nodiscardoverrideprotectedvirtual

Saves the widget as a tree node in order to save it to a file.

Reimplemented from tgui::Widget.

◆ setEnabled()

void tgui::ContextMenu::setEnabled ( bool enabled )

overridevirtual

Enables or disables the widget.

Parameters

enabled Is the widget enabled?

The disabled widget will no longer receive events and thus no longer send callbacks. All widgets are enabled by default.

Reimplemented from tgui::Widget.

◆ setItemHeight()

void tgui::ContextMenu::setItemHeight ( float itemHeight )

Changes the height of the items in the context menu.

Parameters

itemHeight The size of a single item in the context menu

◆ setMenuItemEnabled() [1/2]

bool tgui::ContextMenu::setMenuItemEnabled	(	const std::vector< String > &	hierarchy,
		bool	enabled )

Enable or disable a menu item.

Parameters

hierarchy	Hierarchy of menu items, ending with the menu item to enable/disable
enabled	Should the menu item be enabled or disabled?

Returns: True when the menu item exists, false when hierarchy was incorrect

◆ setMenuItemEnabled() [2/2]

bool tgui::ContextMenu::setMenuItemEnabled	(	const String &	menuItem,
		bool	enabled )

Enable or disable a menu item.

Parameters

menuItem	The name of the menu item to enable or disable
enabled	Should the menu item be enabled or disabled?

Returns: True when the menu item exists, false when menuItem was not found

◆ setMinimumMenuWidth()

void tgui::ContextMenu::setMinimumMenuWidth ( float minimumWidth )

Changes the minimum width of the menus.

When a menu is displayed, the width will be either this or the width of the longest text in the menu.

Parameters

minimumWidth minimum width of the menus

◆ setSize() [1/2]

void tgui::ContextMenu::setSize ( const Layout2d & size )

overridevirtual

This function is overriden to do nothing.

Parameters

size	This parameter is ignored by this overriden function

Warning: The size of the ContextMenu can't be manually set! It depends on the items and the MinimumMenuWidth property.

Reimplemented from tgui::Widget.

◆ setSize() [2/2]

void tgui::Widget::setSize	(	Layout	width,
		Layout	height )

inline

Changes the size of the widget.

Parameters

width	Width of the widget
height	Height of the widget

Warning: This setSize overload must never be used from internal TGUI code or by custom widget implementations

◆ updateTextSize()

void tgui::ContextMenu::updateTextSize ( )

overrideprotectedvirtual

Called when the text size is changed (either by setTextSize or via the renderer)

Reimplemented from tgui::Widget.

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

include/TGUI/Widgets/ContextMenu.hpp

TGUI

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addMenuItem() [1/2]

◆ addMenuItem() [2/2]

◆ changeMenuItem()

◆ clone()

◆ closeMenu()

◆ connectMenuItem() [1/2]

◆ connectMenuItem() [2/2]

◆ copy()

◆ create()

◆ deselectDeepestItem()

◆ draw()

◆ drawOpenMenu()

◆ emitMenuItemClick()

◆ getDefaultMenuItemHeight()

◆ getItemHeight()

◆ getMenuItemEnabled() [1/2]

◆ getMenuItemEnabled() [2/2]

◆ getMenuItems()

◆ getMinimumMenuWidth()

◆ getRenderer()

◆ getSharedRenderer() [1/2]

◆ getSharedRenderer() [2/2]

◆ isMenuOpen()

◆ isMouseOnOpenMenu()

◆ isMouseOnWidget()

◆ leftMouseReleasedOnMenu()

◆ load()

◆ mouseMovedOnMenu()

◆ openMenu() [1/2]

◆ openMenu() [2/2]

◆ openMenuAtMouseCursor()

◆ removeMenuItem() [1/2]

◆ removeMenuItem() [2/2]

◆ removeSubMenuItems()

◆ rendererChanged()

◆ save()

◆ setEnabled()

◆ setItemHeight()

◆ setMenuItemEnabled() [1/2]

◆ setMenuItemEnabled() [2/2]

◆ setMinimumMenuWidth()

◆ setSize() [1/2]

◆ setSize() [2/2]

◆ updateTextSize()