Interface for clickable widgets. More...

#include <ClickableWidget.h>

Inheritance diagram for ime::ui::ClickableWidget:

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

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

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

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

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

ClickableWidget &	operator= (ClickableWidget &&) noexcept
	Move assignment operator. 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 widget if its currently enabled and vice versa. More...

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

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

	~ClickableWidget () override
	Destructor. More...

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

ui::IWidgetRenderer::Ptr	getRenderer ()
	Get the widgets renderer. More...

const ui::IWidgetRenderer::Ptr	getRenderer () const

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

void	setPosition (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 (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 (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 (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 (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	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 (ShowAnimationType type, Time duration)
	Show the widget with an animation. More...

void	hideWithEffect (ShowAnimationType 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...

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
template<typename... Args>
void	emit (const std::string &event, Args &&...args)
	Emit a widget event. More...

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

Detailed Description

Interface for clickable widgets.

Definition at line 38 of file ClickableWidget.h.

Member Typedef Documentation

◆ Ptr

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

Shared widget pointer.

Definition at line 40 of file ClickableWidget.h.

Constructor & Destructor Documentation

◆ ClickableWidget() [1/2]

ime::ui::ClickableWidget::ClickableWidget ( const ClickableWidget & )

Copy constructor.

◆ ClickableWidget() [2/2]

ime::ui::ClickableWidget::ClickableWidget ( ClickableWidget && )

noexcept

Move constructor.

◆ ~ClickableWidget()

ime::ui::ClickableWidget::~ClickableWidget ( )

override

Destructor.

Member Function Documentation

◆ 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::VerticalLayout, ime::ui::ToggleButton, ime::ui::TabsContainer, ime::ui::Tabs, ime::ui::SpinControl, ime::ui::Slider, ime::ui::Separator, ime::ui::ScrollablePanel, ime::ui::RadioButton, ime::ui::ProgressBar, ime::ui::Picture, ime::ui::Panel, ime::ui::MessageBox, ime::ui::MenuBar, ime::ui::Label, ime::ui::HorizontalLayout, ime::ui::EditBox, ime::ui::ChildWindow, ime::ui::CheckBox, ime::ui::Button, and ime::ui::BitmapButton.

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

inlineprotectedinherited

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

Definition at line 636 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

◆ 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

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

ui::IWidgetRenderer::Ptr 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

◆ 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::VerticalLayout, ime::ui::ToggleButton, ime::ui::TabsContainer, ime::ui::Tabs, ime::ui::SpinControl, ime::ui::Slider, ime::ui::Separator, ime::ui::ScrollablePanel, ime::ui::RadioButton, ime::ui::ProgressBar, ime::ui::Picture, ime::ui::Panel, ime::ui::MessageBox, ime::ui::MenuBar, ime::ui::Label, ime::ui::HorizontalLayout, ime::ui::EditBox, ime::ui::ChildWindow, ime::ui::CheckBox, ime::ui::Button, and ime::ui::BitmapButton.

◆ hideWithEffect()

void ime::ui::Widget::hideWithEffect	(	ShowAnimationType	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::ClickableWidget::isEnabled ( ) const

Check if widget is enabled or disabled.

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

◆ isFocused()

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

Check if widget is focused or not.

Returns: True if widget is focused. Otherwise, false

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

◆ move() [2/2]

void ime::ui::Widget::move ( 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.

◆ on()

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 id must if the event listener is to be removed later

See also: unsubscribe

Definition at line 582 of file Widget.h.

◆ operator=() [1/2]

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

noexcept

Move assignment operator.

◆ operator=() [2/2]

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

Copy assignment operator.

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

◆ scale() [2/2]

void ime::ui::Widget::scale ( 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.

◆ 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::ClickableWidget::setEnabled ( bool isEnable )

Enable or disable the widget.

Parameters

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

The widget is enabled by default

Note: Disabling the widget cancels all the interaction events

◆ setFocused()

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

Focus or unfocus widget.

Parameters

isFocused True to focus or false to unfocus widget

◆ 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

◆ setOrigin() [1/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.

◆ setOrigin() [2/2]

void ime::ui::Widget::setOrigin ( 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.

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

◆ setPosition() [3/3]

void ime::ui::Widget::setPosition ( 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.

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

◆ setScale() [2/2]

void ime::ui::Widget::setScale ( 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.

◆ 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	(	ShowAnimationType	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::ClickableWidget::toggleEnabled ( )

Disable widget if its currently enabled and vice versa.

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

ClickableWidget.h

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ ClickableWidget() [1/2]

◆ ClickableWidget() [2/2]

◆ ~ClickableWidget()

Member Function Documentation

◆ clone()

◆ contains()

◆ emit()

◆ getAbsolutePosition()

◆ getAbsoluteSize()

◆ getMouseCursor()

◆ getOrigin()

◆ getPosition()

◆ getRenderer()

◆ getRotation()

◆ getScale()

◆ getSize()

◆ getTextSize()

◆ getWidgetType()

◆ hideWithEffect()

◆ isAnimationPlaying()

◆ isContainer()

◆ isEnabled()

◆ isFocused()

◆ isVisible()

◆ move() [1/2]

◆ move() [2/2]

◆ on()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ rotate()

◆ scale() [1/2]

◆ scale() [2/2]

◆ setAsContainer()

◆ setEnabled()

◆ setFocused()

◆ setHeight() [1/2]

◆ setHeight() [2/2]

◆ setMouseCursor()

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

◆ setTextSize()

◆ setVisible()

◆ setWidth() [1/2]

◆ setWidth() [2/2]

◆ showWithEffect()

◆ toggleEnabled()

◆ toggleVisibility()

◆ unsubscribe()