A widget which contains navigational drop-down menus. More...

#include <MenuBar.h>

Inheritance diagram for ime::ui::MenuBar:

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

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

Public Member Functions
	MenuBar (const MenuBar &)
	Copy constructor. More...

MenuBar &	operator= (const MenuBar &)
	Copy assignment operator. More...

	MenuBar (MenuBar &&) noexcept
	Move constructor. More...

MenuBar &	operator= (MenuBar &&) noexcept
	Move assignment operator. More...

MenuBar::Ptr	copy () const
	Create a copy of this widget. More...

Widget::Ptr	clone () const override
	Make a copy of this widget. More...

MenuBarRenderer *	getRenderer ()
	Get the menu bars renderer. More...

const MenuBarRenderer *	getRenderer () const

void	addMenu (const std::string &text)
	Add a new menu. More...

void	addMenus (const std::initializer_list< std::string > &menus)
	Add new menus. More...

bool	addMenuItem (const std::string &text)
	Add a new menu item to the last added menu. More...

bool	addMenuItem (const std::string &menu, const std::string &text)
	Add a new menu item to an existing menu. More...

void	addMenuItem (const std::initializer_list< std::string > &hierarchy)
	Add a new menu or a sub menu item. More...

void	removeAllMenus ()
	Remove all menus from the menu bar. More...

bool	removeMenu (const std::string &menu)
	Remove a menu. More...

bool	removeMenuItem (const std::string &menu, const std::string &menuItem)
	Remove a menu item from a menu. More...

bool	removeMenuItem (const std::initializer_list< std::string > &hierarchy, bool removeParentsWhenEmpty=true)
	Remove a menu or a sub menu item. More...

bool	removeMenuItems (const std::string &menu)
	Remove all menu items of a menu. More...

bool	removeSubMenuItems (const std::initializer_list< std::string > &hierarchy)
	Remove menu items below a menu or sub menu. More...

void	setMenuEnable (const std::string &menu, bool enabled)
	Enable or disable a menu. More...

bool	isMenuEnabled (const std::string &menu) const
	Check if a menu is enabled or disabled. More...

void	setMenuItemEnable (const std::string &menu, const std::string &menuItem, bool enabled)
	Enable or disable a menu item. More...

void	setMenuItemEnable (const std::initializer_list< std::string > &hierarchy, bool enabled)
	Enable or disable a menu item. More...

bool	isMenuItemEnabled (const std::string &menu, const std::string &menuItem) const
	Check if a menu item is enabled or disabled. More...

bool	isMenuItemEnabled (const std::initializer_list< std::string > &hierarchy) const
	Check if a menu item is enabled or disabled. More...

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

float	getMinimumSubMenuWidth () const
	Get the distance between the text and the side of the menu item. More...

void	invertMenuDirection (bool invert)
	Set whether the menus open above or below the menu bar. More...

bool	isMenuDirectionInverted () const
	Check if the menu bar direction is inverted or not. More...

void	closeMenu ()
	Close an open menu. More...

std::string	getWidgetType () const override
	Get the type of the spin control. More...

	~MenuBar () override
	Destructor. More...

void	setName (const std::string &name)
	Set the name of the widget. More...

const std::string &	getName () const
	Get the name of the widget. More...

void	setRenderer (IWidgetRenderer::Ptr renderer)
	Set the widgets renderer. More...

void	setPosition (float x, float y) override
	Set the position of the widget. More...

void	setPosition (const Vector2f &position) override
	Set the position of the widget. More...

void	setPosition (const std::string &x, const std::string &y)
	Set the position of the widget relative to the size of its parent. More...

Vector2f	getPosition () const override
	Get the position of the widget. More...

Vector2f	getAbsolutePosition () const
	Get the absolute position of the widget. More...

void	setRotation (float angle) override
	Set the orientation of the widget. More...

void	rotate (float angle) override
	Rotate the widget. More...

float	getRotation () const override
	Get the orientation of the widget. More...

void	setScale (float factorX, float factorY) override
	Set the scale factors of the widget. More...

void	setScale (const Vector2f &scale) override
	Set the scale factor of the widget. More...

void	scale (float factorX, float factorY) override
	Scale the widget by an offset. More...

void	scale (const Vector2f &factor) override
	Scale the widget by an offset. More...

Vector2f	getScale () const override
	Get the current scale of the widget. More...

void	setOrigin (float x, float y) override
	Set the local origin of the widget. More...

void	setOrigin (const Vector2f &origin) override
	Set the local origin of the widget. More...

Vector2f	getOrigin () const override
	Get the local origin of the widget. More...

void	move (float offsetX, float offsetY) override
	Move the widget by a given offset. More...

void	move (const Vector2f &offset) override
	Move the widget by a given offset. More...

void	setTextSize (unsigned int size)
	Set the character size of the text. More...

unsigned int	getTextSize () const
	Get the character size of the text. More...

void	setSize (float width, float height)
	Set the size of the widget. More...

void	setSize (const std::string &width, const std::string &height)
	Set the size of the widget relative to the size of its parent. More...

Vector2f	getSize () const
	Get the size of the widget. More...

Vector2f	getAbsoluteSize ()
	Get the absolute size of the widget. More...

void	setWidth (float width)
	Set the width of the widget. More...

void	setWidth (const std::string &width)
	Set the width of the widget relative to its parent. More...

void	setHeight (float height)
	Set the height of the widget. More...

void	setHeight (const std::string &height)
	Set the height of the widget relative to its parent. More...

void	setFocused (bool isFocused)
	Focus or unfocus widget. More...

bool	isFocused () const
	Check if widget is focused or not. More...

void	setEnabled (bool isEnable)
	Enable or disable the widget. More...

bool	isEnabled () const
	Check if widget is enabled or disabled. More...

void	toggleEnabled ()
	Disable the widget if its currently enabled and vice versa. More...

void	setMouseCursor (CursorType cursor)
	Set the mouse cursor that is displayed when the mouse is on top of the widget. More...

CursorType	getMouseCursor () const
	Get the mouse cursor that is displayed when the mouse is on top of the widget. More...

void	showWithEffect (AnimationType type, Time duration)
	Show the widget with an animation. More...

void	hideWithEffect (AnimationType type, Time duration)
	Hide the widget with an animation. More...

bool	isAnimationPlaying () const
	Check whether or not an animation is currently playing. More...

void	setVisible (bool visible)
	Show or hide a widget. More...

bool	isVisible () const
	Check if the widget is visible or not. More...

void	toggleVisibility ()
	Toggle the visibility of the widget. More...

bool	isContainer () const
	Check if the widget is a container or not. More...

bool	contains (float x, float y) const
	Check if coordinates lie inside the widget. More...

template<typename... Args>
int	on (const std::string &event, Callback< Args... > callback)
	Add an event listener to a widget event. More...

template<typename... Args>
int	on (const std::string &event, Callback< Widget *, Args... > callback)
	Add an event listener to a widget event. More...

template<typename... Args>
void	emit (const std::string &event, Args &&...args)
	Emit a widget event. More...

bool	unsubscribe (const std::string &event, int id)
	Remove an event listener from a widget event. More...

const std::shared_ptr< void >	getInternalPtr () const

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

Protected Member Functions
void	setAsContainer (bool container)
	Set whether or not the widget is a container. More...

Detailed Description

A widget which contains navigational drop-down menus.

Events generated by ime::ui::MenuBar
Name	Argument Type	Description
menuItemClick	std::string	The menu item was clicked. Parameter = The text of the clicked menu item

Event usage example:

widget.on("menuItemClick", ime::Callback<std::string>([](std::string item) {
     std::cout << item << " was clicked << "\n";
}));

Definition at line 40 of file MenuBar.h.

Member Typedef Documentation

◆ ConstPtr

using ime::ui::MenuBar::ConstPtr = std::shared_ptr<const MenuBar>

Shared constant widget pointer.

Definition at line 43 of file MenuBar.h.

◆ Ptr

using ime::ui::MenuBar::Ptr = std::shared_ptr<MenuBar>

Shared widget pointer.

Definition at line 42 of file MenuBar.h.

Constructor & Destructor Documentation

◆ MenuBar() [1/2]

ime::ui::MenuBar::MenuBar ( const MenuBar & )

Copy constructor.

◆ MenuBar() [2/2]

ime::ui::MenuBar::MenuBar ( MenuBar && )

noexcept

Move constructor.

◆ ~MenuBar()

ime::ui::MenuBar::~MenuBar ( )

override

Destructor.

Member Function Documentation

◆ addMenu()

void ime::ui::MenuBar::addMenu ( const std::string & text )

Add a new menu.

Parameters

text	The text to be displayed on the menu

◆ addMenuItem() [1/3]

void ime::ui::MenuBar::addMenuItem ( const std::initializer_list< std::string > & hierarchy )

Add a new menu or a sub menu item.

Parameters

hierarchy Hierarchy of the menu item, starting with the parent menu and ending with menu item to be added

Note that the hierarchy must contain at least two items. The first item is the name of the parent menu and the second item is the sub-menu of the parent menu. Items three and beyond are cascades of the second item. If the parent menu does not exist it will be created

menuBar->addMenuItem({"File", "Save"});
menuBar->addMenuItem({"File", "Open recent", "SaveGame01"});
menuBar->addMenuItem({"File", "Open recent", "SaveGame02"});
menuBar->addMenuItem({"Window", "Editor tabs", "Split", "Left"});

◆ addMenuItem() [2/3]

bool ime::ui::MenuBar::addMenuItem	(	const std::string &	menu,
		const std::string &	text
	)

Add a new menu item to an existing menu.

Parameters

menu	The name of the menu to add the item to
text	The text to de displayed on the item

Returns: True if the menu item was added or false if the given menu could not be found

menuBar->addMenu("File");
menuBar->addMenu("Edit");
menuBar->addMenuItem("File", "Load");
menuBar->addMenuItem("File", "-"); // Adds a line separator between "Load" and "Save"
menuBar->addMenuItem("File", "Save");
menuBar->addMenuItem("Edit", "Undo");

You can add a separator between menu items by adding "-" as a menu item between the items you want to visually separate

◆ addMenuItem() [3/3]

bool ime::ui::MenuBar::addMenuItem ( const std::string & text )

Add a new menu item to the last added menu.

Parameters

text	The text to be displayed on the menu item

Returns: True if the menu item was added or false if the menu bar does not contain any menus yet

menuBar->addMenu("File");
menuBar->addMenuItem("Load");
menuBar->addMenuItem("-"); // Adds a line separator between "Load" and "Save"
menuBar->addMenuItem("Save");
menuBar->addMenu("Edit");
menuBar->addMenuItem("Undo");

You can add a separator between menu items by adding "-" as a menu item between the items you want to visually separate

◆ addMenus()

void ime::ui::MenuBar::addMenus ( const std::initializer_list< std::string > & menus )

Add new menus.

Parameters

menus The menus to be added

The menus are created in the given order

menuBar.addMenus({"File", "Edit", "View", "Help"});

◆ clone()

Widget::Ptr ime::ui::MenuBar::clone ( ) const

overridevirtual

Make a copy of this widget.

Returns: A copy of this widget

You should use this function if you don't care about the type of the widget, otherwise use the widgets copy function

See also: copy

Implements ime::ui::Widget.

◆ closeMenu()

void ime::ui::MenuBar::closeMenu ( )

Close an open menu.

◆ contains()

bool ime::ui::Widget::contains	(	float	x,
		float	y
	)		const

inherited

Check if coordinates lie inside the widget.

Parameters

x	X coordinate to be checked
y	Y coordinate to be checked

Returns: true if coordinates lie inside the widget, false if coordinates do not lie inside the widget

◆ copy()

MenuBar::Ptr ime::ui::MenuBar::copy ( ) const

Create a copy of this widget.

Returns: A copy of this widget

See also: clone

◆ create()

static MenuBar::Ptr ime::ui::MenuBar::create ( )

static

Create a new menu bar widget.

Returns: The new menu bar

◆ emit()

template<typename... Args>

void ime::ui::Widget::emit	(	const std::string &	event,
		Args &&...	args
	)

inlineinherited

Emit a widget event.

Parameters

event	Name of the event to be emitted
args	Arguments to pass to event listeners

This function will invoke all event listeners of the given event.

button.emit("click");

button.emit("click", ime::Vector2f{100, 200});

ime::Vector2< float >

Definition at line 739 of file Widget.h.

◆ getAbsolutePosition()

Vector2f ime::ui::Widget::getAbsolutePosition ( ) const

inherited

Get the absolute position of the widget.

Returns: The absolute position of the widget

Unlike getPosition, this function returns the absolute position of the top-left point of the widget instead of the relative position to its parent

See also: setPosition

◆ getAbsoluteSize()

Vector2f ime::ui::Widget::getAbsoluteSize ( )

inherited

Get the absolute size of the widget.

Returns: The absolute size of the widget

The absolute size includes the size of the widget, the padding, margin and outline thickness

See also: getSize

◆ getMinimumSubMenuWidth()

float ime::ui::MenuBar::getMinimumSubMenuWidth ( ) const

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

Returns: The minimum width of the submenus

See also: setMinimumSubMenuWidth

◆ getMouseCursor()

CursorType ime::ui::Widget::getMouseCursor ( ) const

inherited

Get the mouse cursor that is displayed when the mouse is on top of the widget.

Returns: The cursor shown when hovering above the widget

◆ getName()

const std::string & ime::ui::Widget::getName ( ) const

inherited

Get the name of the widget.

Returns: The name of the widget

See also: setName

◆ getOrigin()

Vector2f ime::ui::Widget::getOrigin ( ) const

overridevirtualinherited

Get the local origin of the widget.

Returns: Local origin of the widget

Implements ime::ITransformable.

◆ getPosition()

Vector2f ime::ui::Widget::getPosition ( ) const

overridevirtualinherited

Get the position of the widget.

Returns: Current position of the widget

Implements ime::ITransformable.

◆ getRenderer()

MenuBarRenderer * ime::ui::MenuBar::getRenderer ( )

Get the menu bars renderer.

Returns: The menu bars renderer

The renderer gives access to functions that determine how the menu bar is displayed. It allows you to manipulate things such as the background colour, border colour etc...

See also: setRenderer

◆ getRotation()

float ime::ui::Widget::getRotation ( ) const

overridevirtualinherited

Get the orientation of the widget.

Returns: Current rotation, in degrees

The rotation is always in the range [0, 360]

Implements ime::ITransformable.

◆ getScale()

Vector2f ime::ui::Widget::getScale ( ) const

overridevirtualinherited

Get the current scale of the widget.

Returns: Current scale of the widget

Implements ime::ITransformable.

◆ getSize()

Vector2f ime::ui::Widget::getSize ( ) const

inherited

Get the size of the widget.

Returns: Current size of the widget

This function only returns the size of the widget (It does not accommodate margin, outline thickness etc ...)

See also: getAbsoluteSize

◆ getTextSize()

unsigned int ime::ui::Widget::getTextSize ( ) const

inherited

Get the character size of the text.

Returns: The character size of the text

◆ getWidgetType()

std::string ime::ui::MenuBar::getWidgetType ( ) const

overridevirtual

Get the type of the spin control.

Returns: The type of the spin control

Implements ime::ui::Widget.

◆ hideWithEffect()

void ime::ui::Widget::hideWithEffect	(	AnimationType	type,
		Time	duration
	)

inherited

Hide the widget with an animation.

Parameters

type	Type of the animation
duration	Duration of the animation

The animation will also be played if the widget currently hidden but it will not be seen

Note: During the animation the position, size and/or opacity opacity may change. Once the animation is done the widget will be back in the state in which it was when this function was called

See also: showWithEffect; isAnimationPlaying

◆ invertMenuDirection()

void ime::ui::MenuBar::invertMenuDirection ( bool invert )

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

Parameters

invert True to open the menus above the menu bar or false to open them below the menu bar

By default the menus open below the menu bar

◆ isAnimationPlaying()

bool ime::ui::Widget::isAnimationPlaying ( ) const

inherited

Check whether or not an animation is currently playing.

Returns: True if an animation is playing, otherwise false

See also: showWithEffect; hideWithEffect

◆ isContainer()

bool ime::ui::Widget::isContainer ( ) const

inherited

Check if the widget is a container or not.

Returns: True if the widget is a container, otherwise false

A container widget is a widget that can store other widgets inside it. Such widgets inherit from IWidget class

◆ isEnabled()

bool ime::ui::Widget::isEnabled ( ) const

inherited

Check if widget is enabled or disabled.

Returns: True if widget is enabled, false if widget is disabled

See also: setEnabled

◆ isFocused()

bool ime::ui::Widget::isFocused ( ) const

inherited

Check if widget is focused or not.

Returns: True if widget is focused. Otherwise, false

See also: setFocused

◆ isMenuDirectionInverted()

bool ime::ui::MenuBar::isMenuDirectionInverted ( ) const

Check if the menu bar direction is inverted or not.

Returns: True if inverted, otherwise false

See also: invertMenuDirection

◆ isMenuEnabled()

bool ime::ui::MenuBar::isMenuEnabled ( const std::string & menu ) const

Check if a menu is enabled or disabled.

Parameters

menu	The name of the menu to be checked

Returns: True if the menu is enabled or false if the menu is disabled or it could not be found

◆ isMenuItemEnabled() [1/2]

bool ime::ui::MenuBar::isMenuItemEnabled ( const std::initializer_list< std::string > & hierarchy ) const

Check if a menu item is enabled or disabled.

Parameters

hierarchy Hierarchy of menu item, starting with the parent menu and ending with the menu item to be checked

Returns: True if the menu item is enabled or false if it is disabled or the given hierarchy is incorrect

menuBar->isMenuItemEnabled({"Edit", "Find", "Replace"});

See also: setMenuItemEnable

◆ isMenuItemEnabled() [2/2]

bool ime::ui::MenuBar::isMenuItemEnabled	(	const std::string &	menu,
		const std::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 be checked

Returns: True if the menu item is enabled or false if the menu item is disabled or it could not be found

See also: setMenuItemEnable

◆ isVisible()

bool ime::ui::Widget::isVisible ( ) const

inherited

Check if the widget is visible or not.

Returns: True if the widget is visible or false if hidden

◆ move() [1/2]

void ime::ui::Widget::move ( const Vector2f & offset )

overridevirtualinherited

Move the widget by a given offset.

Parameters

offset Offset to apply

This function adds to the current position of the widget, unlike setPosition which overwrites it

See also: setPosition

Implements ime::ITransformable.

◆ move() [2/2]

void ime::ui::Widget::move	(	float	offsetX,
		float	offsetY
	)

overridevirtualinherited

Move the widget by a given offset.

Parameters

offsetX	Horizontal offset
offsetY	Vertical offset

This function adds to the current position of the widget, unlike setPosition which overwrites it

See also: setPosition

Implements ime::ITransformable.

◆ on() [1/2]

template<typename... Args>

int ime::ui::Widget::on	(	const std::string &	event,
		Callback< Args... >	callback
	)

inlineinherited

Add an event listener to a widget event.

Parameters

event	Event to add an event listener to
callback	Function to execute when the event is fired

Returns: The event listeners identification number

The callback is passed event arguments (if any) on invocation. Here is an example demonstrating an event listener listening to an event with and arguments

// Event without arguments
widget.on("mouseEnter", ime::Callback<>([] {
     std::cout << "Mouse entered widget" << "\n";
}));
 
// Event with arguments
widget.on("positionChange", ime::Callback<ime::Vector2f>([](ime::Vector2f pos) {
     std::cout << "Widget moved to {" << pos.x << ", " << pos.y << "}" << "\n";
})):

See also: unsubscribe

Definition at line 689 of file Widget.h.

◆ on() [2/2]

template<typename... Args>

int ime::ui::Widget::on	(	const std::string &	event,
		Callback< Widget *, Args... >	callback
	)

inlineinherited

Add an event listener to a widget event.

Parameters

event	Event to add an event listener to
callback	Function to execute when the event is fired

Returns: The event listeners identification number

The callback is passed a pointer to the widget as the first argument followed by the event arguments (if any) on invocation

// Event without arguments
widget.on("mouseEnter", ime::Callback<ime::ui::Widget*>([](ime::ui::Widget* widget) {
     std::cout << "Mouse entered " << widget->getName() << "\n";
}));
 
// Event with arguments
widget.on("positionChange", ime::Callback<ime::ui::Widget*, ime::Vector2f>([](ime::ui::Widget* widget, ime::Vector2f pos) {
     std::cout << "Widget " << widget->getName() << " moved to {" << pos.x << ", " << pos.y << "}" << "\n";
})):

Note: Event listeners without the context/widget pointer are invoked first

See also: unsubscribe

Definition at line 721 of file Widget.h.

◆ operator=() [1/2]

MenuBar & ime::ui::MenuBar::operator= ( const MenuBar & )

Copy assignment operator.

◆ operator=() [2/2]

MenuBar & ime::ui::MenuBar::operator= ( MenuBar && )

noexcept

Move assignment operator.

◆ removeAllMenus()

void ime::ui::MenuBar::removeAllMenus ( )

Remove all menus from the menu bar.

◆ removeMenu()

bool ime::ui::MenuBar::removeMenu ( const std::string & menu )

Remove a menu.

Parameters

menu	The name of the menu to be removed

Returns: True if the menu was removed or false if the menu bar does not contain a menu with the given name

Note that all menu items that belonged to the menu will also be removed

◆ removeMenuItem() [1/2]

bool ime::ui::MenuBar::removeMenuItem	(	const std::initializer_list< std::string > &	hierarchy,
		bool	removeParentsWhenEmpty = `true`
	)

Remove a menu or a sub menu item.

Parameters

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

Returns: True if the menu item was found and removed or false if the given hierarchy is incorrect

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

menuBar->removeMenuItem({"File", "Open recent", "SaveGame02"});

◆ removeMenuItem() [2/2]

bool ime::ui::MenuBar::removeMenuItem	(	const std::string &	menu,
		const std::string &	menuItem
	)

Remove a menu item from a menu.

Parameters

menu	The name of the menu to remove an item from
menuItem	The name of the item to be removed

Returns: True if the item was removed or false if either the menu or menu item does not exist

◆ removeMenuItems()

bool ime::ui::MenuBar::removeMenuItems ( const std::string & menu )

Remove all menu items of a menu.

Parameters

menu	The name of the menu to remove all items from

Returns: True if the menu items were removed or false if the menu could not be found or the menu does not have any items

◆ removeSubMenuItems()

bool ime::ui::MenuBar::removeSubMenuItems ( const std::initializer_list< std::string > & hierarchy )

Remove menu items below a menu or sub menu.

Parameters

hierarchy Hierarchy of the menu item, starting with the parent menu and ending with the sub menu containing the items to be removed

Returns: True if the menu item existed and its children were removed or false if the given hierarchy is incorrect

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

◆ rotate()

void ime::ui::Widget::rotate ( float angle )

overridevirtualinherited

Rotate the widget.

Parameters

angle Angle of rotation, in degrees

This function adds to the current rotation of the widget, unlike setRotation which overwrites it

See also: setRotation

Implements ime::ITransformable.

◆ scale() [1/2]

void ime::ui::Widget::scale ( const Vector2f & factor )

overridevirtualinherited

Scale the widget by an offset.

Parameters

factor Offset to apply

This function multiplies the current scale of the widget, unlike setScale which overwrites it

See also: setScale

Implements ime::ITransformable.

◆ scale() [2/2]

void ime::ui::Widget::scale	(	float	factorX,
		float	factorY
	)

overridevirtualinherited

Scale the widget by an offset.

Parameters

factorX	Horizontal scale factor
factorY	Vertical scale factor

This function multiplies the current scale of the widget, unlike setScale which overwrites it

See also: setScale

Implements ime::ITransformable.

◆ setAsContainer()

void ime::ui::Widget::setAsContainer ( bool container )

protectedinherited

Set whether or not the widget is a container.

Parameters

container True to flag as container, otherwise false

A container widget is a widget that can store other widgets inside it. Such widgets inherit from IWidget class

All widgets are not containers by default

◆ setEnabled()

void ime::ui::Widget::setEnabled ( bool isEnable )

inherited

Enable or disable the widget.

Parameters

isEnable Set true to enable the widget or false to disable the widget

If the widget is disabled, it wont not receive events and hence does won't dispatch callbacks

By default, the widget is enabled

See also: isEnabled

◆ setFocused()

void ime::ui::Widget::setFocused ( bool isFocused )

inherited

Focus or unfocus widget.

Parameters

isFocused True to focus or false to unfocus widget

When the widget is focused, a previously focused widget will be unfocused

Note: This function only works properly if the widget has already been added to the gui (see ime::ui::GuiContainer)

By default, the widget is not focused

See also: isFocused

◆ setHeight() [1/2]

void ime::ui::Widget::setHeight ( const std::string & height )

inherited

Set the height of the widget relative to its parent.

Parameters

height New height

The relative height is given in percentages as shown:

widget->setHeight("10%");

This function sets the height of the widget while keeping the width the same

See also: setSize

◆ setHeight() [2/2]

void ime::ui::Widget::setHeight ( float height )

inherited

Set the height of the widget.

Parameters

height New height of the widget

This function sets the height while keeping the width the same

See also: setSize

◆ setMenuEnable()

void ime::ui::MenuBar::setMenuEnable	(	const std::string &	menu,
		bool	enabled
	)

Enable or disable a menu.

Parameters

menu	The name of the menu to enable or disable
enabled	True to enable the menu of false to disable it

◆ setMenuItemEnable() [1/2]

void ime::ui::MenuBar::setMenuItemEnable	(	const std::initializer_list< std::string > &	hierarchy,
		bool	enabled
	)

Enable or disable a menu item.

Parameters

hierarchy	Hierarchy of the menu item, starting with the parent menu and ending with the menu item to be enabled or disabled
enabled	True to enable or false to disable

menuBar->setMenuItemEnable({"Edit", "Find", "Replace"});

◆ setMenuItemEnable() [2/2]

void ime::ui::MenuBar::setMenuItemEnable	(	const std::string &	menu,
		const std::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	True to enable the menu item of false to disable it

◆ setMinimumSubMenuWidth()

void ime::ui::MenuBar::setMinimumSubMenuWidth ( float minimumWidth )

Set the minimum width of the submenus.

Parameters

minimumWidth The new minimum width

When a submenu is displayed, the width will either be minimumWidth or the width of the longest text in the submenu

The default minimum width is 125 pixels

◆ setMouseCursor()

void ime::ui::Widget::setMouseCursor ( CursorType cursor )

inherited

Set the mouse cursor that is displayed when the mouse is on top of the widget.

Parameters

cursor The cursor to be shown

By default, the arrow cursor is shown

◆ setName()

void ime::ui::Widget::setName ( const std::string & name )

inherited

Set the name of the widget.

Parameters

name	The name of the widget

By default the widget is assigned a unique name. The naming convention is as follows:

widgetType + instantiation number

For example:

ime::Button::Ptr myBtn = ime::Button::create("Click me");
std::cout << myBtn->getName(); // Button1
 
ime::Label::Ptr lblGreet = ime::Label::create("Hello");
std::cout << lblGreet->getName(); // Label1
 
std::cout << lblGreet->copy()->getName(); // Label2

Warning: The name must not contain white spaces

See also: getName

◆ setOrigin() [1/2]

void ime::ui::Widget::setOrigin ( const Vector2f & origin )

overridevirtualinherited

Set the local origin of the widget.

Parameters

origin New origin

The origin of the widget defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the widget, and ignore all transformations (position, scale, rotation).

The default origin of the widget is (0, 0)

Implements ime::ITransformable.

◆ setOrigin() [2/2]

void ime::ui::Widget::setOrigin	(	float	x,
		float	y
	)

overridevirtualinherited

Set the local origin of the widget.

Parameters

x	X coordinate of the new origin
y	Y coordinate of the new origin

The origin of the widget defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the widget, and ignore all transformations (position, scale, rotation).

The default origin of the widget is (0, 0)

Implements ime::ITransformable.

◆ setPosition() [1/3]

void ime::ui::Widget::setPosition	(	const std::string &	x,
		const std::string &	y
	)

inherited

Set the position of the widget relative to the size of its parent.

Parameters

x	New x coordinate of the widget
y	New y coordinate of the widget

The position is specified in percentages as shown below:

widget->setPosition("5%", "10%");

This function completely overwrites the previous position. Use the move function to apply an offset based on the previous position instead.

The default position of the widget is (0, 0)

See also: move

◆ setPosition() [2/3]

void ime::ui::Widget::setPosition ( const Vector2f & position )

overridevirtualinherited

Set the position of the widget.

Parameters

position New position

This function completely overwrites the previous position. Use the move function to apply an offset based on the previous position instead.

The default position of the widget is (0, 0)

See also: move

Implements ime::ITransformable.

◆ setPosition() [3/3]

void ime::ui::Widget::setPosition	(	float	x,
		float	y
	)

overridevirtualinherited

Set the position of the widget.

Parameters

x	X coordinate of the new position
y	Y coordinate of the new position

This function completely overwrites the previous position. use move function to apply an offset based on the previous position instead

The default position of a the widget is (0, 0)

See also: move

Implements ime::ITransformable.

◆ setRenderer()

void ime::ui::Widget::setRenderer ( IWidgetRenderer::Ptr renderer )

inherited

Set the widgets renderer.

Parameters

renderer The new renderer

The renderer determines how the widget is displayed.

See also: getRenderer

◆ setRotation()

void ime::ui::Widget::setRotation ( float angle )

overridevirtualinherited

Set the orientation of the widget.

Parameters

angle New rotation, in degrees

This function completely overwrites the previous rotation. See the rotate function to add an angle based on the previous rotation instead.

The default rotation of the widget is 0

See also: rotate

Implements ime::ITransformable.

◆ setScale() [1/2]

void ime::ui::Widget::setScale ( const Vector2f & scale )

overridevirtualinherited

Set the scale factor of the widget.

Parameters

scale New scale

This function completely overwrites the previous scale

See also: scale

Implements ime::ITransformable.

◆ setScale() [2/2]

void ime::ui::Widget::setScale	(	float	factorX,
		float	factorY
	)

overridevirtualinherited

Set the scale factors of the widget.

Parameters

factorX	New horizontal scale factor
factorY	New vertical scale factor

This function completely overwrites the previous scale

See also: scale

Implements ime::ITransformable.

◆ setSize() [1/2]

void ime::ui::Widget::setSize	(	const std::string &	width,
		const std::string &	height
	)

inherited

Set the size of the widget relative to the size of its parent.

Parameters

width	The new width of the widget
height	The new height of the widget

The size is specified in percentages as shown below:

widget->setSize("20%", "5%");

◆ setSize() [2/2]

void ime::ui::Widget::setSize	(	float	width,
		float	height
	)

inherited

Set the size of the widget.

Parameters

width	The width of the widget
height	The height of the widget

◆ setTextSize()

void ime::ui::Widget::setTextSize ( unsigned int size )

inherited

Set the character size of the text.

Parameters

size	New character size

◆ setVisible()

void ime::ui::Widget::setVisible ( bool visible )

inherited

Show or hide a widget.

Parameters

visible True to show or false to hide

If the widget is hidden, it won't receive events (and thus won't send callbacks) nor will it be drawn

The widget is visible by default.

◆ setWidth() [1/2]

void ime::ui::Widget::setWidth ( const std::string & width )

inherited

Set the width of the widget relative to its parent.

Parameters

width New width

The relative width is given in percentages as shown:

widget->setWidth("10%");

This function sets the width of the widget while keeping the height the same

See also: setSize

◆ setWidth() [2/2]

void ime::ui::Widget::setWidth ( float width )

inherited

Set the width of the widget.

Parameters

width New width of the widget

This function sets the width while keeping the height the same

See also: setSize

◆ showWithEffect()

void ime::ui::Widget::showWithEffect	(	AnimationType	type,
		Time	duration
	)

inherited

Show the widget with an animation.

Parameters

type	Type of the animation
duration	Duration of the animation

The animation will be played if the widget currently visible

Note: During the animation the position, size and/or opacity opacity may change. Once the animation is done the widget will be back in the state in which it was when this function was called

See also: hideWithEffect; isAnimationPlaying

◆ toggleEnabled()

void ime::ui::Widget::toggleEnabled ( )

inherited

Disable the widget if its currently enabled and vice versa.

If the widget is disabled, it wont not receive events and hence does won't dispatch callbacks

See also: setEnabled

◆ toggleVisibility()

void ime::ui::Widget::toggleVisibility ( )

inherited

Toggle the visibility of the widget.

This function will hide the widget if its currently visible and vice versa

See also: setVisible

◆ unsubscribe()

bool ime::ui::Widget::unsubscribe	(	const std::string &	event,
		int	id
	)

inherited

Remove an event listener from a widget event.

Parameters

event	Event to remove event listener from
id	Id number of the event listener

Returns: True if the event listener was removed or false if the given event does not exist or the event does not have an event listener with the given id

The id is the number given when the event listener was registered

See also: on

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

MenuBar.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

Constructor & Destructor Documentation

◆ MenuBar() [1/2]

◆ MenuBar() [2/2]

◆ ~MenuBar()

Member Function Documentation

◆ addMenu()

◆ addMenuItem() [1/3]

◆ addMenuItem() [2/3]

◆ addMenuItem() [3/3]

◆ addMenus()

◆ clone()

◆ closeMenu()

◆ contains()

◆ copy()

◆ create()

◆ emit()

◆ getAbsolutePosition()

◆ getAbsoluteSize()

◆ getMinimumSubMenuWidth()

◆ getMouseCursor()

◆ getName()

◆ getOrigin()

◆ getPosition()

◆ getRenderer()

◆ getRotation()

◆ getScale()

◆ getSize()

◆ getTextSize()

◆ getWidgetType()

◆ hideWithEffect()

◆ invertMenuDirection()

◆ isAnimationPlaying()

◆ isContainer()

◆ isEnabled()

◆ isFocused()

◆ isMenuDirectionInverted()

◆ isMenuEnabled()

◆ isMenuItemEnabled() [1/2]

◆ isMenuItemEnabled() [2/2]

◆ isVisible()

◆ move() [1/2]

◆ move() [2/2]

◆ on() [1/2]

◆ on() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ removeAllMenus()

◆ removeMenu()

◆ removeMenuItem() [1/2]

◆ removeMenuItem() [2/2]

◆ removeMenuItems()

◆ removeSubMenuItems()

◆ rotate()

◆ scale() [1/2]

◆ scale() [2/2]

◆ setAsContainer()

◆ setEnabled()

◆ setFocused()

◆ setHeight() [1/2]

◆ setHeight() [2/2]

◆ setMenuEnable()

◆ setMenuItemEnable() [1/2]

◆ setMenuItemEnable() [2/2]

◆ setMinimumSubMenuWidth()

◆ setMouseCursor()

◆ setName()

◆ setOrigin() [1/2]

◆ setOrigin() [2/2]

◆ setPosition() [1/3]

◆ setPosition() [2/3]

◆ setPosition() [3/3]

◆ setRenderer()