#include <TGUI/Widgets/MenuBar.hpp>

Inheritance diagram for tgui::MenuBar:

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

struct	Menu

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

using	ConstPtr = std::shared_ptr<const MenuBar>
	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
	MenuBar (const char *typeName=StaticWidgetType, bool initRenderer=true)

	MenuBar (const MenuBar &other)

	MenuBar (MenuBar &&other) noexcept

MenuBar &	operator= (const MenuBar &other)

MenuBar &	operator= (MenuBar &&other) noexcept

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

TGUI_NODISCARD const MenuBarRenderer *	getSharedRenderer () const override

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

template<typename Func , typename... Args>
unsigned int	connectMenuItem (const String &menu, 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
	Changes the size of the menu bar.

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

void	addMenu (const String &text)
	Adds a new menu.

bool	addMenuItem (const String &text)
	Adds a new menu item to the last added menu.

bool	addMenuItem (const String &menu, const String &text)
	Adds a new menu item to an existing menu.

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

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

void	removeAllMenus ()
	Removes all menus.

bool	removeMenu (const String &menu)
	Removes a menu.

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

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

bool	removeMenuItems (const String &menu)
	Removes all menu items from a menu.

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

bool	setMenuEnabled (const String &menu, bool enabled)
	Enable or disable an entire menu.

TGUI_NODISCARD bool	getMenuEnabled (const String &menu) const
	Check if an entire menu is enabled or disabled.

bool	setMenuItemEnabled (const String &menu, 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.

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

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

void	setMinimumSubMenuWidth (float minimumWidth)
	Changes the minimum width of the submenus.

TGUI_NODISCARD float	getMinimumSubMenuWidth () const
	Returns the distance between the text and the side of the menu item.

void	setInvertedMenuDirection (bool invertDirection)
	Changes whether the menus open above or below the menu bar.

TGUI_NODISCARD bool	getInvertedMenuDirection () const
	Returns whether the menus open above or below the menu bar.

TGUI_NODISCARD std::vector< GetMenusElement >	getMenus () const
	Returns the menus and their menu items, including submenus.

void	closeMenu ()
	Closes the open menu when one of the menus is open.

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

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

void	leftMouseReleased (Vector2f pos) override

void	mouseMoved (Vector2f pos) override

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

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

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

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

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

virtual TGUI_NODISCARD 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

TGUI_NODISCARD 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 >
TGUI_NODISCARD DataType	getUserData () const
	Returns data stored in the widget.

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

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

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

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

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

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

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

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

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

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

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

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

TGUI_NODISCARD 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 TGUI_NODISCARD bool	canGainFocus () const
	Returns whether the widget can currently gain focus.

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

TGUI_NODISCARD 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 void	rightMousePressed (Vector2f pos)

virtual void	rightMouseReleased (Vector2f pos)

virtual void	mouseReleased (Event::MouseButton button, 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 TGUI_NODISCARD Widget::Ptr	askToolTip (Vector2f mousePos)

TGUI_NODISCARD const Layout2d &	getPositionLayout () const

TGUI_NODISCARD const Layout2d &	getSizeLayout () const

void	bindPositionLayout (Layout *layout)

void	unbindPositionLayout (Layout *layout)

void	bindSizeLayout (Layout *layout)

void	unbindSizeLayout (Layout *layout)

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

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

void	rendererChangedCallback (const String &property)

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

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

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.

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

Protected Member Functions
TGUI_NODISCARD 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.

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

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

void	openMenu (std::size_t menuIndex)
	Opens a menu.

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

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

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

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

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

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

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

void	deselectBottomItem ()

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)

TGUI_NODISCARD float	calculateMenuWidth (const Menu &menu) const

TGUI_NODISCARD float	getMenuItemHeight (const Menu &menuItem) const

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

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

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

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

void	drawMenusOnBar (BackendRenderTarget &target, RenderStates states) const

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

TGUI_NODISCARD bool	isMouseOnOpenMenu (Vector2f pos) const

void	leftMouseReleasedOnMenu ()

void	mouseMovedOnMenu (Vector2f pos)

void	drawOpenMenu (BackendRenderTarget &target, RenderStates states) 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
std::vector< Menu >	m_menus

std::shared_ptr< MenuBarMenuPlaceholder >	m_menuWidgetPlaceholder

int	m_visibleMenu = -1

float	m_minimumSubMenuWidth = 125

bool	m_invertedMenuDirection = false

Sprite	m_spriteBackground

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

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	MenuBarMenuPlaceholder

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

Menu bar widget.

Member Function Documentation

◆ addMenu()

void tgui::MenuBar::addMenu ( const String & text )

Adds a new menu.

Parameters

text	The text written on the menu

◆ addMenuItem() [1/3]

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

Adds a new menu item (or sub menu item)

Parameters

hierarchy	Hierarchy of the menu items, starting with the menu and 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 does not contain at least 2 elements.

menuBar->addMenuItem({"File", "Save"});

menuBar->addMenuItem({"View", "Messages", "Tags", "Important"});

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

◆ addMenuItem() [2/3]

bool tgui::MenuBar::addMenuItem	(	const String &	menu,
		const String &	text )

Adds a new menu item to an existing menu.

Parameters

menu	The name of the menu to which the menu item will be added
text	The text written on this menu item

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

menuBar->addMenu("File");
menuBar->addMenu("Edit");
menuBar->addMenuItem("File", "Load");
menuBar->addMenuItem("File", "Save");
menuBar->addMenuItem("Edit", "Undo");

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

◆ addMenuItem() [3/3]

bool tgui::MenuBar::addMenuItem ( const String & text )

Adds a new menu item to the last added menu.

Parameters

text	The text written on this menu item

Returns: True when the item was added, false when the menu bar doesn't contain any menus yet

menuBar->addMenu("File");
menuBar->addMenuItem("Load");
menuBar->addMenuItem("Save");
menuBar->addMenu("Edit");
menuBar->addMenuItem("Undo");

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

◆ changeMenuItem()

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

Changes the text of an existing menu item.

Parameters

hierarchy	Hierarchy of the menu items, starting with the menu and ending with 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

menuBar->addMenu("File");
menuBar->addMenuItem("Load");
menuBar->changeMenuItem({"File", "Load"}, "Load file");

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

◆ clone()

TGUI_NODISCARD Widget::Ptr tgui::MenuBar::clone ( ) const

overrideprotectedvirtual

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.

◆ connectMenuItem() [1/2]

template<typename Func , typename... Args>

unsigned int tgui::MenuBar::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, starting with the menu and 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::MenuBar::connectMenuItem	(	const String &	menu,
		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

menu	Menu containing the menu item
menuItem	Menu item which should trigger the signal
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 TGUI_NODISCARD MenuBar::Ptr tgui::MenuBar::copy ( const MenuBar::ConstPtr & menuBar )

static

Makes a copy of another menu bar.

Parameters

menuBar The other menu bar

Returns: The new menu bar

◆ create()

static TGUI_NODISCARD MenuBar::Ptr tgui::MenuBar::create ( )

static

Creates a new menu bar widget.

Returns: The new menu bar

◆ draw()

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

◆ getInvertedMenuDirection()

TGUI_NODISCARD bool tgui::MenuBar::getInvertedMenuDirection ( ) const

Returns whether the menus open above or below the menu bar.

Returns: Do menus open above the bar instead of below like it does by default?

◆ getMenuEnabled()

TGUI_NODISCARD bool tgui::MenuBar::getMenuEnabled ( const String & menu ) const

Check if an entire menu is enabled or disabled.

Parameters

menu	The name of the menu to check

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

◆ getMenuItemEnabled() [1/2]

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

Check if a menu item is enabled or disabled.

Parameters

hierarchy Hierarchy of menu items, starting with the menu and 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]

TGUI_NODISCARD bool tgui::MenuBar::getMenuItemEnabled	(	const String &	menu,
		const String &	menuItem ) const

Check if a menu item is enabled or disabled.

Parameters

menu	The name of the menu in which the menu item is located
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 menu or menuItem did not exist

◆ getMenus()

TGUI_NODISCARD std::vector< GetMenusElement > tgui::MenuBar::getMenus ( ) const

Returns the menus and their menu items, including submenus.

Returns: List of menus

◆ getMinimumSubMenuWidth()

TGUI_NODISCARD float tgui::MenuBar::getMinimumSubMenuWidth ( ) const

Returns the distance between the text and the side of the menu item.

Returns: minimum width of the submenus

See also: setMinimumSubMenuWidth

◆ getRenderer()

TGUI_NODISCARD MenuBarRenderer * tgui::MenuBar::getRenderer ( )

overridevirtual

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]

TGUI_NODISCARD const MenuBarRenderer * tgui::MenuBar::getSharedRenderer ( ) const

overridevirtual

Reimplemented from tgui::Widget.

◆ getSharedRenderer() [2/2]

TGUI_NODISCARD MenuBarRenderer * tgui::MenuBar::getSharedRenderer ( )

overridevirtual

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

TGUI_NODISCARD Signal & tgui::MenuBar::getSignal ( String signalName )

overrideprotectedvirtual

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.

◆ isMouseOnWidget()

TGUI_NODISCARD bool tgui::MenuBar::isMouseOnWidget ( Vector2f pos ) const

overridevirtual

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.

◆ leftMousePressed()

bool tgui::MenuBar::leftMousePressed ( Vector2f pos )

overridevirtual

Called by the parent when the left mouse button goes down on top of the widget.

Parameters

pos	Mouse position in view coordinates relative to the parent widget

Returns: True if the clicked part of the widget is draggable, i.e. if the widget should continue to receive mouse move events until the mouse is released, even when the mouse leaves the widget. When false is returned, the mouse move events will only be sent to the widget as long as the mouse is on top of the widget.

Reimplemented from tgui::Widget.

◆ leftMouseReleased()

void tgui::MenuBar::leftMouseReleased ( Vector2f pos )

overridevirtual

Reimplemented from tgui::Widget.

◆ load()

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

overrideprotectedvirtual

Loads the widget from a tree of nodes.

Reimplemented from tgui::Widget.

◆ mouseMoved()

void tgui::MenuBar::mouseMoved ( Vector2f pos )

overridevirtual

Reimplemented from tgui::Widget.

◆ openMenu()

void tgui::MenuBar::openMenu ( std::size_t menuIndex )

protected

Opens a menu.

Parameters

menuIndex Index of the menu to open

◆ removeMenu()

bool tgui::MenuBar::removeMenu ( const String & menu )

Removes a menu.

Any menu items that belong to this menu will be removed as well.

Parameters

menu	The name of the menu to remove

Returns: True when the menu was removed, false when menu was not found

◆ removeMenuItem() [1/2]

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

Removes a menu item (or sub menu item)

Parameters

hierarchy	Hierarchy of the menu item, starting with the menu and 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

menuBar->removeMenuItem({"File", "Save"});

menuBar->removeMenuItem({"View", "Messages", "Tags", "Important"});

◆ removeMenuItem() [2/2]

bool tgui::MenuBar::removeMenuItem	(	const String &	menu,
		const String &	menuItem )

Removes a menu item.

Parameters

menu	The name of the menu in which the menu item is located
menuItem	The name of the menu item to remove

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

◆ removeMenuItems()

bool tgui::MenuBar::removeMenuItems ( const String & menu )

Removes all menu items from a menu.

Parameters

menu	The name of the menu for which all menu items should be removed

Returns: True when the menu existed and its children were removed, false when menu was not found

◆ removeSubMenuItems()

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

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

Parameters

hierarchy Hierarchy of the menu item, starting with the menu and 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

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

◆ rendererChanged()

void tgui::MenuBar::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()

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

overrideprotectedvirtual

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

Reimplemented from tgui::Widget.

◆ setEnabled()

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

◆ setInvertedMenuDirection()

void tgui::MenuBar::setInvertedMenuDirection ( bool invertDirection )

Changes whether the menus open above or below the menu bar.

Parameters

invertDirection Should the menus open above the bar instead of below like it does by default?

◆ setMenuEnabled()

bool tgui::MenuBar::setMenuEnabled	(	const String &	menu,
		bool	enabled )

Enable or disable an entire menu.

Parameters

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

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

◆ setMenuItemEnabled() [1/2]

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

Enable or disable a menu item.

Parameters

hierarchy	Hierarchy of menu items, starting with the menu and 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::MenuBar::setMenuItemEnabled	(	const String &	menu,
		const String &	menuItem,
		bool	enabled )

Enable or disable a menu item.

Parameters

menu	The name of the menu in which the menu item is located
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 menu or menuItem was not found

◆ setMinimumSubMenuWidth()

void tgui::MenuBar::setMinimumSubMenuWidth ( float minimumWidth )

Changes the minimum width of the submenus.

When a submenu is displayed, the width will be either this or the width of the longest text in the submenu. The default minimum width is 125 pixels.

Parameters

minimumWidth minimum width of the submenus

◆ setSize() [1/2]

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

overridevirtual

Changes the size of the menu bar.

Parameters

size	The new size of the menu bar

By default, the menu bar has the same width as the window and the height is 20 pixels.

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::MenuBar::updateTextSize ( )

overrideprotectedvirtual

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

Reimplemented from tgui::Widget.

Member Data Documentation

◆ onMenuItemClick

SignalItemHierarchy tgui::MenuBar::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/MenuBar.hpp

TGUI

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addMenu()

◆ addMenuItem() [1/3]

◆ addMenuItem() [2/3]

◆ addMenuItem() [3/3]

◆ changeMenuItem()

◆ clone()

◆ connectMenuItem() [1/2]

◆ connectMenuItem() [2/2]

◆ copy()

◆ create()

◆ draw()

◆ getInvertedMenuDirection()

◆ getMenuEnabled()

◆ getMenuItemEnabled() [1/2]

◆ getMenuItemEnabled() [2/2]

◆ getMenus()

◆ getMinimumSubMenuWidth()

◆ getRenderer()

◆ getSharedRenderer() [1/2]

◆ getSharedRenderer() [2/2]

◆ getSignal()

◆ isMouseOnWidget()

◆ leftMousePressed()

◆ leftMouseReleased()

◆ load()

◆ mouseMoved()

◆ openMenu()

◆ removeMenu()

◆ removeMenuItem() [1/2]

◆ removeMenuItem() [2/2]

◆ removeMenuItems()

◆ removeSubMenuItems()

◆ rendererChanged()

◆ save()

◆ setEnabled()

◆ setInvertedMenuDirection()

◆ setMenuEnabled()

◆ setMenuItemEnabled() [1/2]

◆ setMenuItemEnabled() [2/2]

◆ setMinimumSubMenuWidth()

◆ setSize() [1/2]

◆ setSize() [2/2]

◆ updateTextSize()

Member Data Documentation

◆ onMenuItemClick