Base class for MenuBar and ContextMenu. More...

#include <TGUI/Widgets/MenuWidgetBase.hpp>

Inheritance diagram for tgui::MenuWidgetBase:

Classes
struct	GetMenusElement
	Used for return value of getMenus. More...

struct	Menu

Public Member Functions
	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.

virtual void	closeMenu ()=0
	Closes the menu if it was open.

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.

virtual void	setSize (const Layout2d &size)
	Changes the size 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.

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

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	isMouseOnWidget (Vector2f pos) const =0
	Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

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)

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

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

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

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

void	rendererChangedCallback (const String &property)

virtual void	updateTextSize ()

Public Attributes
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 Member Functions
	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

virtual void	emitMenuItemClick (const std::vector< String > &hierarchy)=0

virtual float	getDefaultMenuItemHeight () const =0

virtual void	leftMouseReleasedOnMenu ()=0

virtual bool	isMouseOnOpenMenu (Vector2f pos) const =0

virtual void	mouseMovedOnMenu (Vector2f pos)=0

virtual void	deselectDeepestItem ()=0

virtual void	drawOpenMenu (BackendRenderTarget &target, RenderStates states) const =0

Protected Member Functions inherited from tgui::Widget
virtual std::unique_ptr< DataIO::Node >	save (SavingRenderersMap &renderers) const
	Saves the widget as a tree node in order to save it to a file.

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

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.

Static Protected Member Functions
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)

Protected Attributes
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

Friends
class	OpenMenuPlaceholder

Additional Inherited Members
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.

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>>

Detailed Description

Base class for MenuBar and ContextMenu.

Since: TGUI 1.8

Constructor & Destructor Documentation

◆ MenuWidgetBase()

tgui::MenuWidgetBase::MenuWidgetBase	(	const char *	typeName,
		bool	initRenderer )

protected

Constructor.

Parameters

typeName	Type of the widget
initRenderer	Should the renderer be initialized? Should be true unless a derived class initializes it.

Member Function Documentation

◆ closeMenu()

virtual void tgui::MenuWidgetBase::closeMenu ( )

pure virtual

Closes the menu if it was open.

Implemented in tgui::ContextMenu, and tgui::MenuBar.

◆ getRenderer()

MenuWidgetBaseRenderer * tgui::MenuWidgetBase::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 MenuWidgetBaseRenderer * tgui::MenuWidgetBase::getSharedRenderer ( ) const

nodiscardoverridevirtual

Reimplemented from tgui::Widget.

◆ getSharedRenderer() [2/2]

MenuWidgetBaseRenderer * tgui::MenuWidgetBase::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.

◆ getSignal()

Signal & tgui::MenuWidgetBase::getSignal ( String signalName )

nodiscardoverrideprotectedvirtual

Retrieves a signal based on its name.

Parameters

signalName Name of the signal

Returns: Signal that corresponds to the name

Exceptions

Exception when the name does not match any signal

Reimplemented from tgui::Widget.

◆ rendererChanged()

void tgui::MenuWidgetBase::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.

Member Data Documentation

◆ onMenuItemClick

SignalItemHierarchy tgui::MenuWidgetBase::onMenuItemClick = {"MenuItemClicked"}

One of the menu items was clicked. Optional parameters:

The text of the clicked menu item
List containing both the name of the menu and the menu item that was clicked

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

include/TGUI/Widgets/MenuWidgetBase.hpp

TGUI

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MenuWidgetBase()

Member Function Documentation

◆ closeMenu()

◆ getRenderer()

◆ getSharedRenderer() [1/2]

◆ getSharedRenderer() [2/2]

◆ getSignal()

◆ rendererChanged()

Member Data Documentation

◆ onMenuItemClick