TGUI  1.0-alpha

Menu bar widget. More...

#include <TGUI/Widgets/MenuBar.hpp>

Inheritance diagram for tgui::MenuBar:
tgui::Widget

Classes

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

Public Types

typedef std::shared_ptr< MenuBarPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const MenuBarConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Widget
typedef std::shared_ptr< WidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const WidgetConstPtr
 Shared constant widget pointer.
 

Public Member Functions

 MenuBar (const char *typeName="MenuBar", bool initRenderer=true)
 
 MenuBar (const MenuBar &other)
 
 MenuBar (MenuBar &&other) noexcept
 
MenuBaroperator= (const MenuBar &other)
 
MenuBaroperator= (MenuBar &&other) noexcept
 
MenuBarRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
const MenuBarRenderergetSharedRenderer () const
 
MenuBarRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
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. More...
 
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. More...
 
void setSize (const Layout2d &size) override
 Changes the size of the menu bar. More...
 
void setEnabled (bool enabled) override
 Enables or disables the widget. More...
 
void addMenu (const String &text)
 Adds a new menu. More...
 
bool addMenuItem (const String &text)
 Adds a new menu item to the last added menu. More...
 
bool addMenuItem (const String &menu, const String &text)
 Adds a new menu item to an existing menu. More...
 
bool addMenuItem (const std::vector< String > &hierarchy, bool createParents=true)
 Adds a new menu item (or sub menu item) More...
 
bool changeMenuItem (const std::vector< String > &hierarchy, const String &text)
 Changes the text of an existing menu item. More...
 
void removeAllMenus ()
 Removes all menus.
 
bool removeMenu (const String &menu)
 Removes a menu. More...
 
bool removeMenuItem (const String &menu, const String &menuItem)
 Removes a menu item. More...
 
bool removeMenuItem (const std::vector< String > &hierarchy, bool removeParentsWhenEmpty=true)
 Removes a menu item (or sub menu item) More...
 
bool removeMenuItems (const String &menu)
 Removes all menu items from a menu. More...
 
bool removeSubMenuItems (const std::vector< String > &hierarchy)
 Removes a all menu items below a (sub) menu. More...
 
bool setMenuEnabled (const String &menu, bool enabled)
 Enable or disable an entire menu. More...
 
bool getMenuEnabled (const String &menu) const
 Check if an entire menu is enabled or disabled. More...
 
bool setMenuItemEnabled (const String &menu, const String &menuItem, bool enabled)
 Enable or disable a menu item. More...
 
bool setMenuItemEnabled (const std::vector< String > &hierarchy, bool enabled)
 Enable or disable a menu item. More...
 
bool getMenuItemEnabled (const String &menu, const String &menuItem) const
 Check if a menu item is enabled or disabled. More...
 
bool getMenuItemEnabled (const std::vector< String > &hierarchy) const
 Check if a menu item is enabled or disabled. More...
 
void setMinimumSubMenuWidth (float minimumWidth)
 Changes the minimum width of the submenus. More...
 
float getMinimumSubMenuWidth () const
 Returns the distance between the text and the side of the menu item. More...
 
void setInvertedMenuDirection (bool invertDirection)
 Changes whether the menus open above or below the menu bar. More...
 
bool getInvertedMenuDirection () const
 Returns whether the menus open above or below the menu bar. More...
 
std::vector< GetMenusElementgetMenus () const
 
void closeMenu ()
 Closes the open menu when one of the menus is open.
 
bool isMouseOnWidget (Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
void leftMousePressed (Vector2f pos) override
 
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. More...
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
- 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.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (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. More...
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
const WidgetRenderergetSharedRenderer () const
 
WidgetRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget More...
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget. More...
 
Vector2f getPosition () const
 Gets the position of the widget. More...
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
void setWidth (Layout width)
 Changes the width of the widget. More...
 
void setHeight (Layout height)
 Changes the height of the widget. More...
 
Vector2f getSize () const
 Returns the size of the widget. More...
 
virtual Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
virtual Vector2f getAbsolutePosition () const
 Get the absolute position of the top-left point of the widget instead of the relative position to its parent. More...
 
virtual Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
void setOrigin (float x, float y)
 Sets the origin point on which the position, scale and rotation is based. More...
 
void setOrigin (Vector2f origin)
 Sets the origin point on which the position, scale and rotation is based. More...
 
Vector2f getOrigin () const
 Returns the relative origin point on which the position, scale and rotation is based. More...
 
void setScale (Vector2f scaleFactors)
 Sets the scaling to be applied to the widget. More...
 
void setScale (Vector2f scaleFactors, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
Vector2f getScale () const
 Returns the scaling to be applied to the widget. More...
 
Vector2f getScaleOrigin () const
 Returns the origin used for scaling. More...
 
void setRotation (float angle)
 Sets the rotation to be applied to the widget. More...
 
void setRotation (float angle, Vector2f origin)
 Sets the rotation to be applied to the widget. More...
 
float getRotation () const
 Returns the rotation to be applied to the widget. More...
 
Vector2f getRotationOrigin () const
 Returns the origin used for rotations. More...
 
void showWithEffect (ShowEffectType type, Duration duration)
 Shows the widget by introducing it with an animation. More...
 
void hideWithEffect (ShowEffectType type, Duration duration)
 Hides the widget by making it leave with an animation. More...
 
void moveWithAnimation (Layout2d position, Duration duration)
 Moves the widget from its current position to the given position, over a given duration. More...
 
void resizeWithAnimation (Layout2d size, Duration duration)
 Resizes the widget from its current size to the given size, over a given duration. More...
 
virtual void setVisible (bool visible)
 Shows or hides a widget. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void setEnabled (bool enabled)
 Enables or disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
virtual void setFocused (bool focused)
 Focus or unfocus the widget. More...
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise. More...
 
const StringgetWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
BackendGuigetParentGui () const
 Returns a pointer to the gui to which this widget belongs. More...
 
bool isAnimationPlaying () const
 Returns whether there is an active animation (started with showWithEffect or hideWithEffect) More...
 
void moveToFront ()
 Places the widget before all other widgets. More...
 
void moveToBack ()
 Places the widget behind all other widgets. More...
 
void setUserData (Any userData)
 Stores some data into the widget. More...
 
template<typename T >
getUserData () const
 Returns data stored in the widget. More...
 
bool hasUserData () const
 Returns whether data stored in the widget. More...
 
void setInheritedFont (const Font &font)
 Sets the font of the widget that is used when no font is set in the renderer. More...
 
const FontgetInheritedFont () const
 Returns the font of the widget that is used when no font is set in the renderer. More...
 
void setInheritedOpacity (float opacity)
 Sets the opacity of the widget that will be multiplied with the opacity set in the renderer. More...
 
float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer. More...
 
void setTextSize (unsigned int size)
 Changes the character size of text in this widget if it uses text. More...
 
unsigned int getTextSize () const
 Returns the character size of text in this widget. More...
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip () const
 Returns the tool tip that is displayed when hovering over the widget. More...
 
void setWidgetName (const String &name)
 Changes the name of a widget. More...
 
String getWidgetName () const
 Returns the name of a widget. More...
 
void setMouseCursor (Cursor::Type cursor)
 Changes which mouse cursor is shown when hovering over the widget. More...
 
Cursor::Type getMouseCursor () const
 Returns which mouse cursor is shown when hovering over the widget. More...
 
void setFocusable (bool focusable)
 Changes whether a widget could be focused. More...
 
bool isFocusable () const
 Returns whether a widget could be focused. More...
 
void finishAllAnimations ()
 Makes all animations of the widget finish immediately.
 
virtual bool canGainFocus () const
 Returns whether the widget can currently gain focus. More...
 
bool isContainer () const
 Returns whether the widget is a container widget or not. More...
 
bool isDraggableWidget () const
 Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs) More...
 
bool isMouseDown () const
 Returns whether the left mouse button has been pressed on top of the widget. More...
 
virtual SignalgetSignal (String signalName)
 Retrieves a signal based on its name. More...
 
virtual void setParent (Container *parent)
 
virtual bool updateTime (Duration elapsedTime)
 
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. More...
 
virtual void leftMousePressed (Vector2f pos)
 
virtual void leftMouseReleased (Vector2f pos)
 
virtual void rightMousePressed (Vector2f pos)
 
virtual void rightMouseReleased (Vector2f pos)
 
virtual void mousePressed (Event::MouseButton button, Vector2f pos)
 
virtual void mouseReleased (Event::MouseButton button, Vector2f pos)
 
virtual void mouseMoved (Vector2f pos)
 
virtual void keyPressed (const Event::KeyEvent &event)
 
virtual void textEntered (char32_t key)
 
virtual bool mouseWheelScrolled (float delta, Vector2f pos)
 
virtual void mouseNoLongerOnWidget ()
 
virtual void leftMouseButtonNoLongerDown ()
 
virtual void rightMouseButtonNoLongerDown ()
 
virtual Widget::Ptr askToolTip (Vector2f mousePos)
 
const Layout2dgetPositionLayout () const
 
const Layout2dgetSizeLayout () 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. More...
 
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. More...
 
void rendererChangedCallback (const String &property)
 

Static Public Member Functions

static MenuBar::Ptr create ()
 Creates a new menu bar widget. More...
 
static MenuBar::Ptr copy (MenuBar::ConstPtr menuBar)
 Makes a copy of another menu bar. More...
 

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

Protected Member Functions

SignalgetSignal (String signalName) override
 Retrieves a signal based on its name. More...
 
void rendererChanged (const String &property) override
 Function called when one of the properties of the renderer is changed. More...
 
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. More...
 
void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
 Loads the widget from a tree of nodes. More...
 
void updateTextSize () override
 Called when the text size is changed (either by setTextSize or via the renderer) More...
 
Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type. More...
 
void openMenu (std::size_t menuIndex)
 Opens a menu. More...
 
void createMenu (std::vector< Menu > &menus, const String &text)
 
MenufindMenu (const std::vector< String > &hierarchy, unsigned int parentIndex, std::vector< Menu > &menus, bool createParents)
 
const MenufindMenu (const std::vector< String > &hierarchy, unsigned int parentIndex, const std::vector< Menu > &menus) const
 
MenufindMenuItem (const std::vector< String > &hierarchy)
 
const MenufindMenuItem (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)
 
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, int *resultSelectedMenuItem)
 
void drawMenusOnBar (BackendRenderTarget &target, RenderStates states) const
 
void drawMenu (BackendRenderTarget &target, RenderStates states, const Menu &menu, float menuWidth, float globalLeftPos, bool openSubMenuToRight) const
 
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 rendererChanged (const String &property)
 Function called when one of the properties of the renderer is changed. More...
 
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. More...
 
virtual void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers)
 Loads the widget from a tree of nodes. More...
 
virtual void updateTextSize ()
 Called when the text size is changed (either by setTextSize or via the renderer) More...
 
virtual void mouseEnteredWidget ()
 This function is called when the mouse enters the widget. More...
 
virtual void mouseLeftWidget ()
 This function is called when the mouse leaves the widget. More...
 

Protected Attributes

std::vector< Menum_menus
 
std::shared_ptr< MenuBarMenuPlaceholderm_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
 
Layout2d m_size
 
unsigned int m_textSize = 0
 
Vector2f m_origin
 
Optional< Vector2fm_rotationOrigin
 
Optional< Vector2fm_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
 
bool m_visible = true
 
Containerm_parent = nullptr
 
BackendGuim_parentGui = nullptr
 
bool m_mouseHover = false
 
bool m_mouseDown = false
 
bool m_focused = false
 
bool m_focusable = true
 
Duration m_animationTimeElapsed
 
bool m_draggableWidget = false
 
bool m_containerWidget = false
 
Widget::Ptr m_toolTip = nullptr
 
aurora::CopiedPtr< WidgetRendererm_renderer = nullptr
 
std::vector< std::shared_ptr< priv::Animation > > m_showAnimations
 
Font m_inheritedFont
 
float m_inheritedOpacity = 1
 
Font m_fontCached = Font::getGlobalFont()
 
float m_opacityCached = 1
 
bool m_transparentTextureCached = false
 
unsigned int m_textSizeCached = 0
 
Any m_userData
 
Cursor::Type m_mouseCursor = Cursor::Type::Arrow
 

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
textThe 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
hierarchyHierarchy of the menu items, starting with the menu and ending with menu item to be added
createParentsShould 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
menuThe name of the menu to which the menu item will be added
textThe 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
textThe 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
menuHierarchy of the menu items, starting with the menu and ending with menu item that is to be renamed
textThe 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()

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
hierarchyHierarchy of the menu items, starting with the menu and ending with menu item that should trigger the signal when pressed
handlerCallback function to call
argsOptional 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
menuMenu containing the menu item
menuItemMenu item which should trigger the signal
handlerCallback function to call
argsOptional 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 MenuBar::Ptr tgui::MenuBar::copy ( MenuBar::ConstPtr  menuBar)
static

Makes a copy of another menu bar.

Parameters
menuBarThe other menu bar
Returns
The new menu bar

◆ create()

static 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
targetRender target to draw to
statesCurrent render states

Implements tgui::Widget.

◆ getInvertedMenuDirection()

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

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

Check if an entire menu is enabled or disabled.

Parameters
menuThe 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]

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

Check if a menu item is enabled or disabled.

Parameters
hierarchyHierarchy 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]

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

Check if a menu item is enabled or disabled.

Parameters
menuThe name of the menu in which the menu item is located
menuItemThe 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

◆ getMinimumSubMenuWidth()

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

MenuBarRenderer * tgui::MenuBar::getRenderer ( )

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.

◆ getSharedRenderer()

MenuBarRenderer * tgui::MenuBar::getSharedRenderer ( )

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

◆ getSignal()

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

Retrieves a signal based on its name.

Parameters
signalNameName of the signal
Returns
Signal that corresponds to the name
Exceptions
Exceptionwhen the name does not match any signal

Reimplemented from tgui::Widget.

◆ isMouseOnWidget()

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

void tgui::MenuBar::leftMousePressed ( Vector2f  pos)
overridevirtual

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
menuIndexIndex 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
menuThe 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
hierarchyHierarchy of the menu item, starting with the menu and ending with menu item to be deleted
removeParentsWhenEmptyAlso 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
menuThe name of the menu in which the menu item is located
menuItemThe 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
menuThe 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
hierarchyHierarchy 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
propertyName of the property that was changed

Reimplemented from tgui::Widget.

◆ save()

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
enabledIs 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
invertDirectionShould 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
menuThe name of the menu to enable or disable
enabledShould 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
hierarchyHierarchy of menu items, starting with the menu and ending with the menu item to enable/disable
enabledShould 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
menuThe name of the menu in which the menu item is located
menuItemThe name of the menu item to enable or disable
enabledShould 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
minimumWidthminimum width of the submenus

◆ setSize() [1/3]

virtual void tgui::Widget::setSize ( const Layout2d size)
virtual

Changes the size of the widget.

Parameters
sizeSize of the widget

Usage examples:

// Give the widget an exact size
widget->setSize({40, 30});
// Give the widget a size relative to the size of its parent
widget->setSize({"20%", "5%"});
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize({200, tgui::bindHeight(otherWidget) + 50});
TGUI_API Layout bindHeight(std::shared_ptr< Widget > widget)
Bind to the height of the widget.

Reimplemented from tgui::Widget.

◆ setSize() [2/3]

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

Changes the size of the menu bar.

Parameters
sizeThe 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() [3/3]

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

Changes the size of the widget.

Parameters
widthWidth of the widget
heightHeight 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: