A widget container that has a background colour and optional borders. More...

#include <Panel.h>

Inheritance diagram for ime::ui::Panel:

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

using	ConstPtr = std::shared_ptr< const Panel >
	const shared widget pointer More...

Public Member Functions
	Panel (const Panel &)=default
	Copy constructor. More...

Panel &	operator= (const Panel &)=default
	Copy assignment operator. More...

	Panel (Panel &&) noexcept=default
	Move constructor. More...

Panel &	operator= (Panel &&) noexcept=default
	Move assignment operator. More...

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

PanelRenderer::Ptr	getRenderer ()
	Get the panels renderer. More...

const PanelRenderer::Ptr	getRenderer () const

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

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

	~Panel () override=default
	Destructor. More...

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

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

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

Widget::Ptr	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::Ptr &widget)
	Place a widget before all other widgets, to the front of the z-order. More...

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

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

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

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

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

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

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

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

Static Public Member Functions
static Panel::Ptr	create (const std::string &width="100%", const std::string &height="100%")
	Create a new Panel widget. More...

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

A widget container that has a background colour and optional borders.

Definition at line 39 of file Panel.h.

Member Typedef Documentation

◆ ConstPtr

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

const shared widget pointer

Definition at line 42 of file Panel.h.

◆ Ptr

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

Shared widget pointer.

Definition at line 41 of file Panel.h.

Constructor & Destructor Documentation

◆ Panel() [1/2]

ime::ui::Panel::Panel ( const Panel & )

default

Copy constructor.

◆ Panel() [2/2]

ime::ui::Panel::Panel ( Panel && )

defaultnoexcept

Move constructor.

◆ ~Panel()

ime::ui::Panel::~Panel ( )

overridedefault

Destructor.

Member Function Documentation

◆ addWidget()

bool ime::ui::WidgetContainer::addWidget	(	const Widget::Ptr &	widget,
		const std::string &	name
	)

inherited

Add a widget to the container.

Parameters

widget	Widget to be added
name	Unique Name of the widget

Returns: True if the widget was added to the container or false if the container already has a widget with the same name as the specified widget name

The name of the widget must not contain whitespaces

◆ clone()

Widget::Ptr ime::ui::Panel::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.

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

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

Create a copy of this widget.

Returns: A copy of this widget

See also: clone

◆ create()

static Panel::Ptr ime::ui::Panel::create	(	const std::string &	width = `"100%"`,
		const std::string &	height = `"100%"`
	)

static

Create a new Panel widget.

Parameters

width	Width of the panel relative to the size of its parent
height	Height of the panel relative to the size of its parent

Returns: The new Panel

The relative size is specified in percentages as shown:

Panel::create({"50%", "20%"});

By default, the new panel is the same size as its parent

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

◆ focusNextWidget()

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

inherited

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 )

inherited

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

◆ 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

◆ getFocusedLeaf()

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

inherited

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::Ptr ime::ui::WidgetContainer::getFocusedWidget ( ) const

inherited

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

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

PanelRenderer::Ptr ime::ui::Panel::getRenderer ( )

Get the panels renderer.

Returns: The panels renderer

The renderer gives access to functions that determine how the panel 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::Ptr ime::ui::WidgetContainer::getWidget ( const std::string & name ) const

inherited

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 >

std::shared_ptr<T> ime::ui::WidgetContainer::getWidget ( const std::string & name ) const

inlineinherited

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 111 of file WidgetContainer.h.

◆ getWidgetAtPosition()

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

inherited

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

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

overridevirtual

Get the type of the panel.

Returns: The type of the panel

Implements ime::ui::Widget.

◆ 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

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

◆ moveWidgetBackward()

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

inherited

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

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

inherited

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

void ime::ui::WidgetContainer::moveWidgetToBack ( const Widget::Ptr & widget )

inherited

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

void ime::ui::WidgetContainer::moveWidgetToFront ( const Widget::Ptr & widget )

inherited

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

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]

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

default

Copy assignment operator.

◆ operator=() [2/2]

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

defaultnoexcept

Move assignment operator.

◆ removeAllWidgets()

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

inherited

Remove all widgets from the container.

◆ removeWidget()

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

inherited

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

◆ 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

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

Panel.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

Constructor & Destructor Documentation

◆ Panel() [1/2]

◆ Panel() [2/2]

◆ ~Panel()

Member Function Documentation

◆ addWidget()

◆ clone()

◆ contains()

◆ copy()

◆ create()

◆ emit()

◆ focusNextWidget()

◆ focusPreviousWidget()

◆ getAbsolutePosition()

◆ getAbsoluteSize()

◆ getFocusedLeaf()

◆ getFocusedWidget()

◆ getMouseCursor()

◆ getOrigin()

◆ getPosition()

◆ getRenderer()

◆ getRotation()

◆ getScale()

◆ getSize()

◆ getTextSize()

◆ getWidget() [1/2]

◆ getWidget() [2/2]

◆ getWidgetAtPosition()

◆ getWidgetType()

◆ hideWithEffect()

◆ isAnimationPlaying()

◆ isContainer()

◆ isVisible()

◆ move() [1/2]

◆ move() [2/2]

◆ moveWidgetBackward()

◆ moveWidgetForward()

◆ moveWidgetToBack()

◆ moveWidgetToFront()

◆ on()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ removeAllWidgets()

◆ removeWidget()

◆ rotate()

◆ scale() [1/2]

◆ scale() [2/2]

◆ setAsContainer()

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

◆ toggleVisibility()

◆ unsubscribe()