An Abstract Base Class for widgets that can store other widgets in them. More...

#include <WidgetContainer.h>

Inheritance diagram for ime::ui::WidgetContainer:

Public Types
using	Ptr = std::unique_ptr< WidgetContainer >
	Unique IContainer pointer. More...

Public Member Functions
	WidgetContainer (std::unique_ptr< priv::IWidgetImpl > widgetImpl)

	WidgetContainer (const WidgetContainer &)
	Copy constructor. More...

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

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

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

Widget *	addWidget (Widget::Ptr widget, const std::string &name="")
	Add a widget to the container. More...

Widget *	getWidget (const std::string &name) const
	Get access to a widget in the container. More...

template<typename T >
T *	addWidget (Widget::Ptr widget, const std::string &name="")
	Add a widget to the gui. More...

template<class T >
T *	getWidget (const std::string &name) const
	Get access to a widget in the container. More...

Widget *	getWidgetAtPosition (Vector2f pos) const
	Get a widget at a given position. More...

bool	removeWidget (const std::string &name)
	Remove a widget from the container. More...

void	removeAllWidgets ()
	Remove all widgets from the container. More...

void	moveWidgetToFront (const Widget *widget)
	Place a widget before all other widgets, to the front of the z-order. More...

void	moveWidgetToBack (const Widget *widget)
	Place a widget behind all other widgets, to the back of the z-order. More...

std::size_t	moveWidgetForward (const Widget *widget)
	Place a widget one step forward in the z-order. More...

std::size_t	moveWidgetBackward (const Widget *widget)
	Place a widget one step backwards in the z-order. More...

void	moveWidgetToFront (const std::string &widget)
	Place a widget before all other widgets to the front. More...

void	moveWidgetToBack (const std::string &widget)
	Place a widget behind all other widgets. More...

size_t	moveWidgetForward (const std::string &widget)
	Place a widget one step forward in the z-order. More...

size_t	moveWidgetBackward (const std::string &widget)
	Place a widget one step backwards in the z-order. More...

Widget *	getFocusedWidget () const
	Get the currently focused widget inside the container. More...

Widget *	getFocusedLeaf () const
	Get the currently focused widget inside the container. More...

bool	focusNextWidget (bool recursive=true)
	Focus the next widget in the container. More...

bool	focusPreviousWidget (bool recursive=true)
	Focus the previous widget in the container. More...

std::size_t	getCount () const
	Get the number of widgets in the container. More...

void	forEach (const Callback< Widget * > &callback) const
	Apply a callback to each widget in the container. More...

	~WidgetContainer () 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...

IWidgetRenderer *	getRenderer ()
	Get the widgets renderer. More...

const IWidgetRenderer *	getRenderer () const

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

virtual std::string	getWidgetType () const =0
	Get the type 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...

virtual Widget::Ptr	clone () const =0
	Make a copy of the widget. More...

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

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

Detailed Description

An Abstract Base Class for widgets that can store other widgets in them.

Definition at line 38 of file WidgetContainer.h.

Member Typedef Documentation

◆ Ptr

using ime::ui::WidgetContainer::Ptr = std::unique_ptr<WidgetContainer>

Unique IContainer pointer.

Definition at line 40 of file WidgetContainer.h.

Constructor & Destructor Documentation

◆ WidgetContainer() [1/2]

ime::ui::WidgetContainer::WidgetContainer ( const WidgetContainer & )

Copy constructor.

◆ WidgetContainer() [2/2]

ime::ui::WidgetContainer::WidgetContainer ( WidgetContainer && )

noexcept

Move constructor.

◆ ~WidgetContainer()

ime::ui::WidgetContainer::~WidgetContainer ( )

override

Destructor.

Member Function Documentation

◆ addWidget() [1/2]

Widget * ime::ui::WidgetContainer::addWidget	(	Widget::Ptr	widget,
		const std::string &	name = `""`
	)

Add a widget to the container.

Parameters

widget	Widget to be added
name	Unique Name of the widget

Returns: Pointer to the widget if it was added to the container or nullptr if the container already has a widget with the same name as the specified widget name

The name parameter is kept for compatibility with v2.2.x and prior. Starting with v2.3.0, use ime::ui::Widget::setName

Warning: The name of the widget must not contain whitespaces

◆ addWidget() [2/2]

template<typename T >

T * ime::ui::WidgetContainer::addWidget	(	Widget::Ptr	widget,
		const std::string &	name = `""`
	)

inline

Add a widget to the gui.

Parameters

widget	The widget to be added
name	Unique name of the widget

Returns: Pointer to the widget if it was added to the container or a premature program exit if a widget with the same name as name already exist in the container

The name parameter is kept for compatibility with v2.2.x and prior. Starting with v2.3.0, use ime::ui::Widget::setName

This function that will return the widget pointer already casted to the desired type:

using ime::ui;
// Here the type of lblGreeting is deduced to Widget*
auto* lblGreeting = gui.addWidget(Label::create("Hi there"), "lblGreeting");
 
// Here the type of lblGreeting is deduced to Label*
auto* lblGreeting = gui.addWidget<Label>(Label::create("Hi there"), "lblGreeting");

Warning: This function will return a nullptr if the argument widget is not convertible to T. In addition name must be unique

Definition at line 125 of file WidgetContainer.h.

◆ clone()

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

pure virtualinherited

Make a copy of the widget.

Returns: A copy of the widget

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

Implemented in ime::ui::BitmapButton, ime::ui::Button, ime::ui::CheckBox, ime::ui::ChildWindow, ime::ui::EditBox, ime::ui::HorizontalLayout, ime::ui::Label, ime::ui::MenuBar, ime::ui::MessageBox, ime::ui::Panel, ime::ui::Picture, ime::ui::ProgressBar, ime::ui::RadioButton, ime::ui::ScrollablePanel, ime::ui::Separator, ime::ui::Slider, ime::ui::SpinControl, ime::ui::Tabs, ime::ui::TabsContainer, ime::ui::ToggleButton, and ime::ui::VerticalLayout.

◆ 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

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

◆ focusNextWidget()

bool ime::ui::WidgetContainer::focusNextWidget ( bool recursive = true )

Focus the next widget in the container.

Parameters

recursive Set true to focus next widget when the currently focused widget is a container or false to focus the sibling of that container

Returns: True if the next widget was focused, otherwise false

◆ focusPreviousWidget()

bool ime::ui::WidgetContainer::focusPreviousWidget ( bool recursive = true )

Focus the previous widget in the container.

Parameters

recursive Set true to focus next widget when the currently focused widget is a container or false to focus the sibling of that container

Returns: True if the next widget was focused, otherwise false

◆ forEach()

void ime::ui::WidgetContainer::forEach ( const Callback< Widget * > & callback ) const

Apply a callback to each widget in the container.

Parameters

callback The function to be applied

◆ 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

◆ getCount()

std::size_t ime::ui::WidgetContainer::getCount ( ) const

Get the number of widgets in the container.

Returns: The number of widgets in the container

Note that child widgets that are also containers are only counted as one

◆ getFocusedLeaf()

Widget * ime::ui::WidgetContainer::getFocusedLeaf ( ) const

Get the currently focused widget inside the container.

Returns: Pointer to the focused child widget or a nullptr if none of the widgets are currently focused

Note: Unlike getFocusedWidget which returns a pointer to a container when the focused widget is a child of another container within the container, this function will always return the focused widget regardless of whether its a direct child of the container or not

See also: getFocusedWidget

◆ getFocusedWidget()

Widget * ime::ui::WidgetContainer::getFocusedWidget ( ) const

Get the currently focused widget inside the container.

Returns: Pointer to the focused child widget or a nullptr if none of the widgets are currently focused

Note: If the focused widget is a container, then a pointer to the container is returned rather than a pointer to the focused widget inside that container

See also: getFocusedLeaf

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

IWidgetRenderer * ime::ui::Widget::getRenderer ( )

inherited

Get the widgets renderer.

Returns: The widgets renderer

The renderer gives access to functions that determine how the widget 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

◆ getWidget() [1/2]

Widget * ime::ui::WidgetContainer::getWidget ( const std::string & name ) const

Get access to a widget in the container.

Parameters

name	Name of the widget to get access to

Returns: Pointer to the specified widget or nullptr if the container does not have a widget with the given name

The container will first search for widgets that are direct children of it, but when none of the child widgets match the given name, a recursive search will be performed.

◆ getWidget() [2/2]

template<class T >

T * ime::ui::WidgetContainer::getWidget ( const std::string & name ) const

inline

Get access to a widget in the container.

Parameters

name	Name of the widget to get access to

Returns: Pointer to the specified widget or nullptr if the container does not have a widget with the given name

The container will first search for widgets that are direct children of it, but when none of the child widgets match the given name, a recursive search will be performed.

If the widget is found, it will be casted to the desired type

Warning: This function will return nullptr if the widget cannot be casted to the desired type

Definition at line 146 of file WidgetContainer.h.

◆ getWidgetAtPosition()

Widget * ime::ui::WidgetContainer::getWidgetAtPosition ( Vector2f pos ) const

Get a widget at a given position.

Parameters

pos	The position of the widget relative to the container view

Returns: Pointer to the widget at the specified position or a nullptr if there is no widget at that position

◆ getWidgetType()

virtual std::string ime::ui::Widget::getWidgetType ( ) const

pure virtualinherited

Get the type of the widget.

Returns: The type of the widget

Implemented in ime::ui::BitmapButton, ime::ui::Button, ime::ui::CheckBox, ime::ui::ChildWindow, ime::ui::EditBox, ime::ui::HorizontalLayout, ime::ui::Label, ime::ui::MenuBar, ime::ui::MessageBox, ime::ui::Panel, ime::ui::Picture, ime::ui::ProgressBar, ime::ui::RadioButton, ime::ui::ScrollablePanel, ime::ui::Separator, ime::ui::Slider, ime::ui::SpinControl, ime::ui::Tabs, ime::ui::TabsContainer, ime::ui::ToggleButton, and ime::ui::VerticalLayout.

◆ 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

◆ 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

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

◆ moveWidgetBackward() [1/2]

size_t ime::ui::WidgetContainer::moveWidgetBackward ( const std::string & widget )

Place a widget one step backwards in the z-order.

Parameters

widget The widget that should be moved one step backward

Returns: New index in the widgets list (one higher than the old index or the same if the widget was already in front),

◆ moveWidgetBackward() [2/2]

std::size_t ime::ui::WidgetContainer::moveWidgetBackward ( const Widget * widget )

Place a widget one step backwards in the z-order.

Parameters

widget The widget that should be moved one step backward

Returns: New index in the widgets list (one higher than the old index or the same if the widget was already in front),

◆ moveWidgetForward() [1/2]

size_t ime::ui::WidgetContainer::moveWidgetForward ( const std::string & widget )

Place a widget one step forward in the z-order.

Parameters

widget The widget that should be moved one step forward

Returns: New index in the widgets list (one higher than the old index or the same if the widget was already in front),

◆ moveWidgetForward() [2/2]

std::size_t ime::ui::WidgetContainer::moveWidgetForward ( const Widget * widget )

Place a widget one step forward in the z-order.

Parameters

widget The widget that should be moved one step forward

Returns: New index in the widgets list (one higher than the old index or the same if the widget was already in front),

◆ moveWidgetToBack() [1/2]

void ime::ui::WidgetContainer::moveWidgetToBack ( const std::string & widget )

Place a widget behind all other widgets.

Parameters

widget The widget to be moved to the back

◆ moveWidgetToBack() [2/2]

void ime::ui::WidgetContainer::moveWidgetToBack ( const Widget * widget )

Place a widget behind all other widgets, to the back of the z-order.

Parameters

widget The widget that should be moved to the front

◆ moveWidgetToFront() [1/2]

void ime::ui::WidgetContainer::moveWidgetToFront ( const std::string & widget )

Place a widget before all other widgets to the front.

Parameters

widget The widget to be moved to the front

◆ moveWidgetToFront() [2/2]

void ime::ui::WidgetContainer::moveWidgetToFront ( const Widget * widget )

Place a widget before all other widgets, to the front of the z-order.

Parameters

widget The widget that should be moved to the front

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

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

Copy assignment operator.

◆ operator=() [2/2]

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

noexcept

Move assignment operator.

◆ removeAllWidgets()

void ime::ui::WidgetContainer::removeAllWidgets ( )

Remove all widgets from the container.

◆ removeWidget()

bool ime::ui::WidgetContainer::removeWidget ( const std::string & name )

Remove a widget from the container.

Parameters

name	Name of the widget to be removed from the container

Returns: True if the widget was removed or false if the widget does not exist in the container

◆ 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

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

WidgetContainer.h

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ WidgetContainer() [1/2]

◆ WidgetContainer() [2/2]

◆ ~WidgetContainer()

Member Function Documentation

◆ addWidget() [1/2]

◆ addWidget() [2/2]

◆ clone()

◆ contains()

◆ emit()

◆ focusNextWidget()

◆ focusPreviousWidget()

◆ forEach()

◆ getAbsolutePosition()

◆ getAbsoluteSize()

◆ getCount()

◆ getFocusedLeaf()

◆ getFocusedWidget()

◆ getMouseCursor()

◆ getName()

◆ getOrigin()

◆ getPosition()

◆ getRenderer()

◆ getRotation()

◆ getScale()

◆ getSize()

◆ getTextSize()

◆ getWidget() [1/2]

◆ getWidget() [2/2]

◆ getWidgetAtPosition()

◆ getWidgetType()

◆ hideWithEffect()

◆ isAnimationPlaying()

◆ isContainer()

◆ isEnabled()

◆ isFocused()

◆ isVisible()

◆ move() [1/2]

◆ move() [2/2]

◆ moveWidgetBackward() [1/2]

◆ moveWidgetBackward() [2/2]

◆ moveWidgetForward() [1/2]

◆ moveWidgetForward() [2/2]

◆ moveWidgetToBack() [1/2]

◆ moveWidgetToBack() [2/2]

◆ moveWidgetToFront() [1/2]

◆ moveWidgetToFront() [2/2]

◆ on() [1/2]

◆ on() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ removeAllWidgets()

◆ removeWidget()

◆ rotate()

◆ scale() [1/2]

◆ scale() [2/2]

◆ setAsContainer()

◆ setEnabled()

◆ setFocused()

◆ setHeight() [1/2]

◆ setHeight() [2/2]

◆ setMouseCursor()

◆ setName()

◆ setOrigin() [1/2]

◆ setOrigin() [2/2]

◆ setPosition() [1/3]

◆ setPosition() [2/3]

◆ setPosition() [3/3]

◆ setRenderer()

◆ setRotation()

◆ setScale() [1/2]

◆ setScale() [2/2]

◆ setSize() [1/2]

◆ setSize() [2/2]