A widget that can be used to define different tabbed pages for the same area of a window. More...

#include <Tabs.h>

Inheritance diagram for ime::ui::Tabs:

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

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

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

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

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

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

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

TabsRenderer *	getRenderer ()
	Get the tabs renderer. More...

const TabsRenderer *	getRenderer () const

void	setAutoSize (bool autoSize)
	Set whether or not the tabs auto-size. More...

bool	getAutoSize () const
	Check whether if the tabs are auto-sized or not. More...

std::size_t	add (const std::string &text, bool select=true)
	Add a new tab. More...

void	insert (std::size_t index, const std::string &text, bool select=true)
	Insert a new tab between other tabs. More...

std::string	getText (std::size_t index) const
	Get the text of a tab. More...

bool	changeText (std::size_t index, const std::string &text)
	Change the text of a tab. More...

bool	select (const std::string &text)
	Select tab with a given text. More...

bool	select (std::size_t index)
	Select a tab with a given index. More...

void	deselect ()
	Deselect the selected tab. More...

bool	remove (const std::string &text)
	Remove a tab with a given text. More...

bool	remove (std::size_t index)
	Remove a tab with a given index. More...

void	removeAll ()
	Remove all tabs. More...

std::string	getSelected () const
	Get the text that is drawn on the currently selected tab. More...

int	getSelectedIndex () const
	Get the index of the currently selected tab. More...

void	setTabVisible (std::size_t index, bool visible)
	Hide or show a tab. More...

bool	isTabVisible (std::size_t index) const
	Check if a tab is visible or not. More...

void	setTabEnabled (std::size_t index, bool enabled)
	Enable or disable a tab. More...

bool	isTabEnabled (std::size_t index) const
	Check whether a tab is enabled or not. More...

void	setTabHeight (float height)
	Set the height of the tabs. More...

void	setMaximumTabWidth (float maximumWidth)
	Set the maximum tab width of the tabs. More...

float	getMaximumTabWidth () const
	Get the maximum tab width of the tabs. More...

void	setMinimumTabWidth (float minimumWidth)
	Set the minimum width of the tabs. More...

float	getMinimumTabWidth () const
	Get teh minimum tab width of the tabs. More...

std::size_t	getTabsCount () const
	Get the number of tabs. More...

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

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

	~Tabs () 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 Tabs::Ptr	create ()
	Create a new tabs widget. More...

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

Detailed Description

A widget that can be used to define different tabbed pages for the same area of a window.

This widget can hold multiple tabs. If you want Tabs with panels, checkout the TabsContainer class

Events generated by ime::ui::Tabs
Name	Argument Type	Description
tabSelect	std::string	A tab was selected. Parameter = The text of the selected tab

Event usage example:

tabs.on("tabSelect", ime::Callback<std::string>([](std::string tab) {
     std::cout << tab << " was selected" << "\n";
}));

Definition at line 42 of file Tabs.h.

Member Typedef Documentation

◆ ConstPtr

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

const shared widget pointer

Definition at line 45 of file Tabs.h.

◆ Ptr

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

Shared widget pointer.

Definition at line 44 of file Tabs.h.

Constructor & Destructor Documentation

◆ Tabs() [1/2]

ime::ui::Tabs::Tabs ( const Tabs & )

Copy constructor.

◆ Tabs() [2/2]

ime::ui::Tabs::Tabs ( Tabs && )

noexcept

Move constructor.

◆ ~Tabs()

ime::ui::Tabs::~Tabs ( )

override

Destructor.

Member Function Documentation

◆ add()

std::size_t ime::ui::Tabs::add	(	const std::string &	text,
		bool	select = `true`
	)

Add a new tab.

Parameters

text	The text of the tab that will be drawn on top of it
select	True to immediately select tab, otherwise false

Returns: The index of the tab in the list

Warning: The index returned by this function may be invalid when a tab is removed

◆ changeText()

bool ime::ui::Tabs::changeText	(	std::size_t	index,
		const std::string &	text
	)

Change the text of a tab.

Parameters

index	Index of the tab whose text is to be changed
text	The new tab text

Returns: True if the text was successfully changed or false if the index is invalid

◆ clone()

Widget::Ptr ime::ui::Tabs::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()

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

Create a copy of this widget.

Returns: A copy of this widget

See also: clone

◆ create()

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

static

Create a new tabs widget.

Returns: The new tabs widget

◆ deselect()

void ime::ui::Tabs::deselect ( )

Deselect the selected tab.

◆ 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

◆ getAutoSize()

bool ime::ui::Tabs::getAutoSize ( ) const

Check whether if the tabs are auto-sized or not.

Returns: True if auto-sized, otherwise false

See also: setAutoSize

◆ getMaximumTabWidth()

float ime::ui::Tabs::getMaximumTabWidth ( ) const

Get the maximum tab width of the tabs.

Returns: The maximum tab width of a single tab

This property only has effect when the tabs are auto-sizing. If the text on the tab is longer than this width then it will be cropped to fit inside the tab.

By default, the maximum width is 0 which means that there is no limitation

See also: setAutoSize

◆ getMinimumTabWidth()

float ime::ui::Tabs::getMinimumTabWidth ( ) const

Get teh minimum tab width of the tabs.

Returns: Minimum width of a single tab

This property only has effect when the tabs are auto-sizing. Every tab is at least as wide as this minimum or twice the distance to side

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

TabsRenderer * ime::ui::Tabs::getRenderer ( )

Get the tabs renderer.

Returns: The tabs renderer

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

◆ getSelected()

std::string ime::ui::Tabs::getSelected ( ) const

Get the text that is drawn on the currently selected tab.

Returns: The texts on the selected tab or an empty string if no tab is currently selected

◆ getSelectedIndex()

int ime::ui::Tabs::getSelectedIndex ( ) const

Get the index of the currently selected tab.

Returns: The index of the selected tab or -1 if not tab is currently selected

Warning: The index returned by this function may be invalid if a tab is removed

◆ 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

◆ getTabsCount()

std::size_t ime::ui::Tabs::getTabsCount ( ) const

Get the number of tabs.

Returns: The number of tabs

◆ getText()

std::string ime::ui::Tabs::getText ( std::size_t index ) const

Get the text of a tab.

Parameters

index Index of the tab to get the text of

Returns: The text of the specified tab or an empty string if the index is invalid

The first tab has an index of 0

◆ 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::Tabs::getWidgetType ( ) const

overridevirtual

Get the type of the tab.

Returns: The type of the tab

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

◆ insert()

void ime::ui::Tabs::insert	(	std::size_t	index,
		const std::string &	text,
		bool	select = `true`
	)

Insert a new tab between other tabs.

Parameters

index	The index where the tab is inserted
text	The text of the tab that will be drawn on top of it
select	True to immediately select tab, otherwise false

index of 0 means before the first tab and 1 means behind the first tab

◆ 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

◆ isTabEnabled()

bool ime::ui::Tabs::isTabEnabled ( std::size_t index ) const

Check whether a tab is enabled or not.

Parameters

index The index of the tab to be checked

Returns: True if the tab is enabled, otherwise false

◆ isTabVisible()

bool ime::ui::Tabs::isTabVisible ( std::size_t index ) const

Check if a tab is visible or not.

Parameters

index Index of the tab to be checked

Returns: True if the tab is visible or false if the tab is not visible or the index is invalid

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

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

Copy assignment operator.

◆ operator=() [2/2]

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

noexcept

Move assignment operator.

◆ remove() [1/2]

bool ime::ui::Tabs::remove ( const std::string & text )

Remove a tab with a given text.

Parameters

text	The text on the tab to remove

Returns: True if the tab was removed or false if there is no tab with the given text

See also: remove(std::size_t)

◆ remove() [2/2]

bool ime::ui::Tabs::remove ( std::size_t index )

Remove a tab with a given index.

Parameters

index The index of the tab to remove

Returns: True if the tab was removed or false if the index is invalid

◆ removeAll()

void ime::ui::Tabs::removeAll ( )

Remove all tabs.

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

◆ select() [1/2]

bool ime::ui::Tabs::select ( const std::string & text )

Select tab with a given text.

Parameters

text	The text of the tab t select

Returns: True if the tab was selected or false if the tab with text doesn't exists or the tab is hidden or disabled

If there are multiple tabs with the same text, then the first one will be selected. When false is returned, the selected tab will be deselected

See also: select(int)

◆ select() [2/2]

bool ime::ui::Tabs::select ( std::size_t index )

Select a tab with a given index.

Parameters

index Index of the tab to be selected

Returns: True if the tab was selected or false if the index is invalid or the tab is hidden or disabled

When false is returned, the selected tab will be deselected

See also: select(const std::string&)

◆ 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

◆ setAutoSize()

void ime::ui::Tabs::setAutoSize ( bool autoSize )

Set whether or not the tabs auto-size.

Parameters

autoSize True to enable auto-size, otherwise false

When the tabs are in auto-size mode, the width of the tabs will be dependent on the text which they contain. Otherwise, all tabs have an equal width to fill the size of the widget

The tabs are auto-sized 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

◆ setMaximumTabWidth()

void ime::ui::Tabs::setMaximumTabWidth ( float maximumWidth )

Set the maximum tab width of the tabs.

Parameters

maximumWidth Maximum width of a single tab

This property only has effect when the tabs are auto-sizing. If the text on the tab is longer than this width then it will be cropped to fit inside the tab.

By default, the maximum width is 0 which means that there is no limitation

See also: setAutoSize

◆ setMinimumTabWidth()

void ime::ui::Tabs::setMinimumTabWidth ( float minimumWidth )

Set the minimum width of the tabs.

Parameters

minimumWidth Minimum width of a single tab

This property only has effect when the tabs are auto-sizing. Every tab is at least as wide as this minimum or twice the distance to side

See also: setAutoSize

◆ 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

◆ setTabEnabled()

void ime::ui::Tabs::setTabEnabled	(	std::size_t	index,
		bool	enabled
	)

Enable or disable a tab.

Parameters

index	Index of the tab t enable or disable
enabled	True to enable or false to disable

◆ setTabHeight()

void ime::ui::Tabs::setTabHeight ( float height )

Set the height of the tabs.

Parameters

height New height of the tabs

When the tabs are auto-sizing, this function allows changing the width of the tabs without setting a fixed width like calling setSize would do

See also: setAutoSize

◆ setTabVisible()

void ime::ui::Tabs::setTabVisible	(	std::size_t	index,
		bool	visible
	)

Hide or show a tab.

Parameters

index	Index of the tab to hide or show
visible	True to show or false to hide

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

Tabs.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ ConstPtr

◆ Ptr

Constructor & Destructor Documentation

◆ Tabs() [1/2]

◆ Tabs() [2/2]

◆ ~Tabs()

Member Function Documentation

◆ add()

◆ changeText()

◆ clone()

◆ contains()

◆ copy()

◆ create()

◆ deselect()

◆ emit()

◆ getAbsolutePosition()

◆ getAbsoluteSize()

◆ getAutoSize()

◆ getMaximumTabWidth()

◆ getMinimumTabWidth()

◆ getMouseCursor()

◆ getName()

◆ getOrigin()

◆ getPosition()

◆ getRenderer()

◆ getRotation()

◆ getScale()

◆ getSelected()

◆ getSelectedIndex()

◆ getSize()

◆ getTabsCount()

◆ getText()

◆ getTextSize()

◆ getWidgetType()

◆ hideWithEffect()

◆ insert()

◆ isAnimationPlaying()

◆ isContainer()

◆ isEnabled()

◆ isFocused()

◆ isTabEnabled()

◆ isTabVisible()

◆ isVisible()

◆ move() [1/2]

◆ move() [2/2]

◆ on() [1/2]

◆ on() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ remove() [1/2]

◆ remove() [2/2]

◆ removeAll()

◆ rotate()

◆ scale() [1/2]

◆ scale() [2/2]

◆ select() [1/2]

◆ select() [2/2]

◆ setAsContainer()

◆ setAutoSize()

◆ setEnabled()

◆ setFocused()

◆ setHeight() [1/2]

◆ setHeight() [2/2]

◆ setMaximumTabWidth()

◆ setMinimumTabWidth()

◆ setMouseCursor()

◆ setName()

◆ setOrigin() [1/2]

◆ setOrigin() [2/2]

◆ setPosition() [1/3]

◆ setPosition() [2/3]

◆ setPosition() [3/3]

◆ setRenderer()

◆ setRotation()