#include <TGUI/Widgets/Tab.hpp>

Inheritance diagram for tgui::Tab:

Public Types
typedef std::shared_ptr< Tab >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const Tab >	ConstPtr
	Shared constant widget pointer.

Public Types inherited from tgui::Widget
typedef std::shared_ptr< Widget >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const Widget >	ConstPtr
	Shared constant widget pointer.

Public Member Functions
std::shared_ptr< TabRenderer >	getRenderer () const
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...

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

virtual void	setSize (const Layout2d &size) override
	This function currently does nothing. More...

virtual sf::Vector2f	getSize () const override
	Returns the size of the tabs. More...

virtual void	setFont (const Font &font) override
	Changes the font of the text in the widget. More...

std::size_t	add (const sf::String &text, bool select=true)
	Adds a new tab. More...

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

sf::String	getText (std::size_t index) const
	Get the text of one of the tabs. More...

bool	changeText (std::size_t index, const sf::String &text)
	Change the text of one of the tabs. More...

void	select (const sf::String &text)
	Selects the tab with a given text. More...

void	select (std::size_t index)
	Selects the tab with a given index. More...

void	deselect ()
	Deselects the selected tab.

void	remove (const sf::String &text)
	Removes a tab with a given text. More...

void	remove (std::size_t index)
	Removes a tab with a given index. More...

void	removeAll ()
	Removes all tabs.

sf::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	setTextSize (unsigned int size)
	Changes the character size of the text. More...

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

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

float	getTabHeight () const
	Returns the height of the tabs. More...

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

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

std::size_t	getTabsCount () const
	Returns the amount of tabs. More...

virtual void	setOpacity (float opacity) override
	Changes the opacity of the widget. More...

virtual sf::Vector2f	getWidgetOffset () const override
	Returns the distance between the position where the widget is drawn and where the widget is placed. More...

virtual void	setPosition (const Layout2d &position)
	set the position of the widget More...

void	setPosition (const Layout &x, const Layout &y)
	set the position of the widget More...

virtual void	setSize (const Layout2d &size)
	Changes the size of the widget. More...

void	setSize (const Layout &width, const Layout &height)
	Changes the size of the widget. More...

Public Member Functions inherited from tgui::Widget
	Widget ()
	Default constructor.

	Widget (const Widget &copy)
	Copy constructor. More...

	~Widget ()
	Destructor.

Widget &	operator= (const Widget &right)
	Overload of assignment operator. More...

std::shared_ptr< WidgetRenderer >	getRenderer () const
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...

virtual sf::Vector2f	getAbsolutePosition () const
	Get the absolute position of the widget instead of the relative position to its parent. More...

virtual void	show ()
	Shows the widget. More...

virtual void	showWithEffect (ShowAnimationType type, sf::Time duration)
	Shows the widget by introducing it with an animation. More...

virtual void	hide ()
	Hides the widget. More...

virtual void	hideWithEffect (ShowAnimationType type, sf::Time duration)
	Hides the widget by making it leave with an animation. More...

bool	isVisible () const
	Returns true when the widget is visible. More...

virtual void	enable ()
	Enables the widget. More...

virtual void	disable (bool blockMouseEvents=true)
	Disables the widget. More...

bool	isEnabled () const
	Returns true when the widget is enabled. More...

virtual void	focus ()
	Focus the widget. More...

virtual void	unfocus ()
	Unfocus the widget. More...

bool	isFocused () const
	Returns true when the widget is focused and false otherwise. More...

const std::string &	getWidgetType () const
	Returns the type of the widget. More...

Container *	getParent () const
	Returns a pointer to the parent widget. More...

float	getOpacity () const
	Returns the opacity of the widget. More...

virtual void	moveToFront ()
	Places the widget before all other widgets.

virtual void	moveToBack ()
	Places the widget behind all other widgets.

void	setToolTip (Widget::Ptr toolTip)
	Sets the tool tip that should be displayed when hovering over the widget. More...

Widget::Ptr	getToolTip ()
	Returns the tool tip that is displayed when hovering over the widget. More...

std::shared_ptr< sf::Font >	getFont () const
	Returns the font associated with the widget (if any) More...

void	detachTheme ()
	Detach the theme from the widget. More...

std::shared_ptr< BaseTheme >	getTheme () const
	Returns the theme to which the widget is currently connected. More...

std::string	getPrimaryLoadingParameter () const
	Returns the primary parameter that was passed to the loader to load this widget. More...

std::string	getSecondaryLoadingParameter () const
	Returns the secondary parameter that was passed to the loader to load this widget. More...

void	setPosition (const Layout &x, const Layout &y)
	set the position of the widget More...

void	setSize (const Layout &width, const Layout &height)
	Changes the size of the widget. More...

Public Member Functions inherited from tgui::Transformable
virtual	~Transformable ()
	Virtual destructor.

void	setPosition (const Layout &x, const Layout &y)
	set the position of the widget More...

sf::Vector2f	getPosition () const
	get the position of the widget More...

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

void	move (const Layout &x, const Layout &y)
	Move the widget by a given offset. More...

void	setSize (const Layout &width, const Layout &height)
	Changes the size of the widget. More...

virtual sf::Vector2f	getFullSize () const
	Returns the entire size that the widget is using. More...

void	scale (const Layout2d &factors)
	Scale the widget. More...

void	scale (const Layout &x, const Layout &y)
	Scale the widget. More...

Public Member Functions inherited from tgui::SignalWidgetBase
	SignalWidgetBase ()=default
	Default constructor.

	SignalWidgetBase (const SignalWidgetBase &copy)
	Copy constructor. More...

SignalWidgetBase &	operator= (const SignalWidgetBase &right)
	Overload of assignment operator. More...

template<typename Func , typename... Args>
unsigned int	connect (const std::string &signalNames, Func func, Args... args)
	Connects a signal handler function to one or more signals. More...

template<typename Func , typename... Args>
unsigned int	connectEx (const std::string &signalName, Func func, Args... args)
	Connects a signal handler function to one or more signals. More...

void	disconnect (unsigned int id)
	Disconnects a connection. More...

void	disconnectAll (const std::string &signalName)
	Disconnect all connections from a certain signal. More...

void	disconnectAll ()
	Disconnect all connections from a all signals.

Static Public Member Functions
static Tab::Ptr	create ()
	Creates a new tabs widget. More...

static Tab::Ptr	copy (Tab::ConstPtr tab)
	Makes a copy of another tab. More...

Protected Member Functions
virtual void	reload (const std::string &primary="", const std::string &secondary="", bool force=false) override
	Reload the widget. More...

virtual Widget::Ptr	clone () const override
	Makes a copy of the widget if you don't know its exact type. More...

Protected Member Functions inherited from tgui::Widget
void	attachTheme (std::shared_ptr< BaseTheme > theme)
	Attach a theme to the widget. More...

Detailed Description

Tab widget.

Signals:

TabSelected (Another tab has been selected)
- Optional parameter sf::String: New text on the newly selected tab
- Uses Callback member 'text'
Inherited signals from Widget

Member Function Documentation

◆ add()

std::size_t tgui::Tab::add	(	const sf::String &	text,
		bool	select = `true`
	)

Adds a new tab.

Parameters

text	The text of the tab that will be drawn on top of it.
select	Do you want the new tab to be selected immediately?

Returns: The index of the tab in the list.

Warning: The index returned by this function may no longer be correct when a tab is removed.

◆ changeText()

bool tgui::Tab::changeText	(	std::size_t	index,
		const sf::String &	text
	)

Change the text of one of the tabs.

Parameters

index	The index of the tab to be changed. The first tab has index 0.
text	The new text of the tab that will be drawn on top of it.

Returns: True when text was successfully changed, false when index was too high

◆ clone()

virtual Widget::Ptr tgui::Tab::clone ( ) const

inlineoverrideprotectedvirtual

Makes a copy of the widget if you don't know its exact type.

This function should only be used when you don't know the type of the widget. If you know what kind of widget you are copying, you should use the copy function.

Returns: Copy of the widget

Implements tgui::Widget.

◆ copy()

static Tab::Ptr tgui::Tab::copy ( Tab::ConstPtr tab )

static

Makes a copy of another tab.

Parameters

tab	The other tab

Returns: The new tab

◆ create()

static Tab::Ptr tgui::Tab::create ( )

static

Creates a new tabs widget.

Returns: The new tabs

◆ getMaximumTabWidth()

float tgui::Tab::getMaximumTabWidth ( ) const

inline

Returns the maximum tab width of the tabs.

Returns: Maximum tab width

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.

◆ getRenderer()

std::shared_ptr< TabRenderer > tgui::Tab::getRenderer ( ) const

inline

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns: Reference to the renderer

◆ getSelected()

sf::String tgui::Tab::getSelected ( ) const

inline

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

Returns: The text on the tab. When no tab is selected then this function returns an empty string.

◆ getSelectedIndex()

int tgui::Tab::getSelectedIndex ( ) const

inline

Get the index of the currently selected tab.

Returns: The index of the tab. When no tab is selected then this function returns -1.

Warning: The index returned by this function may no longer be correct when a tab is removed.

◆ getSize()

virtual sf::Vector2f tgui::Tab::getSize ( ) const

inlineoverridevirtual

Returns the size of the tabs.

Returns: Size of the tabs

Reimplemented from tgui::Transformable.

◆ getTabHeight()

float tgui::Tab::getTabHeight ( ) const

inline

Returns the height of the tabs.

Returns: Tab height

◆ getTabsCount()

std::size_t tgui::Tab::getTabsCount ( ) const

inline

Returns the amount of tabs.

Returns: Number of tabs

◆ getText()

sf::String tgui::Tab::getText ( std::size_t index ) const

Get the text of one of the tabs.

Parameters

index The index of the tab. The first tab has index 0.

Returns: The text on the tab or an empty string when index was too high

◆ getTextSize()

unsigned int tgui::Tab::getTextSize ( ) const

Returns the character size of the text.

Returns: The text size.

◆ getWidgetOffset()

virtual sf::Vector2f tgui::Tab::getWidgetOffset ( ) const

overridevirtual

Returns the distance between the position where the widget is drawn and where the widget is placed.

This is basically the width and height of the optional borders drawn around widgets.

Returns: Offset of the widget

Reimplemented from tgui::Widget.

◆ insert()

void tgui::Tab::insert	(	std::size_t	index,
		const sf::String &	text,
		bool	select = `true`
	)

Insert a new tab somewhere between the other tabs.

Parameters

index	The index where the tab gets inserted. 0 means before the first tab, 1 means behind the first tab.
text	The text of the tab that will be drawn on top of it.
select	Do you want the new tab to be selected immediately?

◆ reload()

virtual void tgui::Tab::reload	(	const std::string &	primary = `""`,
		const std::string &	secondary = `""`,
		bool	force = `false`
	)

overrideprotectedvirtual

Reload the widget.

Parameters

primary	Primary parameter for the loader
secondary	Secondary parameter for the loader
force	Try to only change the looks of the widget and not alter the widget itself when false

Exceptions

Exception when the connected theme could not create the widget

When primary is an empty string the built-in white theme will be used.

Reimplemented from tgui::Widget.

◆ remove() [1/2]

void tgui::Tab::remove ( const sf::String & text )

Removes a tab with a given text.

Parameters

text	The text on the tab to remove.

When multiple tabs have the same text, only the first will be removed.

See also: remove(unsigned int)

◆ remove() [2/2]

void tgui::Tab::remove ( std::size_t index )

Removes a tab with a given index.

Parameters

index The index of the tab to remove.

When the index is too high then nothing will happen.

See also: remove(sf::String)

◆ select() [1/2]

void tgui::Tab::select ( const sf::String & text )

Selects the tab with a given text.

Parameters

text	The text of the tab to select.

When the text doen't match any tab then nothing will be changed. If there are multiple tabs with the same text then the first one will be selected.

See also: select(int)

◆ select() [2/2]

void tgui::Tab::select ( std::size_t index )

Selects the tab with a given index.

Parameters

index The index of the tab to select.

When the index is too high then nothing will happen.

See also: select(sf::String)

◆ setFont()

virtual void tgui::Tab::setFont ( const Font & font )

overridevirtual

Changes the font of the text in the widget.

Parameters

font	The new font.

When you don't call this function then the font from the parent widget will be used.

Reimplemented from tgui::Widget.

◆ setMaximumTabWidth()

void tgui::Tab::setMaximumTabWidth ( float maximumWidth )

Changes the maximum tab width of the tabs.

Parameters

maximumWidth Maximum width of a single tab

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.

◆ setOpacity()

virtual void tgui::Tab::setOpacity ( float opacity )

overridevirtual

Changes the opacity of the widget.

Parameters

opacity The opacity of the widget. 0 means completely transparent, while 1 (default) means fully opaque.

Reimplemented from tgui::Widget.

◆ setPosition() [1/3]

void tgui::Transformable::setPosition	(	const Layout &	x,
		const Layout &	y
	)

inline

set the position of the widget

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters

x	New x coordinate
y	New y coordinate

See also: move, getPosition

Usage examples:

// Place the widget on an exact position
widget->setPosition(40, 30);
 
// Place the widget 50 pixels below another widget
widget->setPosition(otherWidget->getPosition().x, otherWidget->getPosition().y + otherWidget->getSize().y + 50);
 
// Place the widget 50 pixels below another widget and automatically move it when the other widget moves
widget->setPosition(tgui::bindLeft(otherWidget), tgui::bindBottom(otherWidget) + 50);

◆ setPosition() [2/3]

virtual void tgui::Transformable::setPosition ( const Layout2d & position )

virtual

set the position of the widget

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters

position New position

See also: move, getPosition

Usage examples:

// Place the widget on an exact position
widget->setPosition({40, 30});
 
// Place the widget 50 pixels below another widget
widget->setPosition(otherWidget->getPosition() + sf::Vector2f{0, otherWidget->getSize().y + 50});
 
// Place the widget 50 pixels below another widget and automatically move it when the other widget moves
widget->setPosition({tgui::bindLeft(otherWidget), tgui::bindBottom(otherWidget) + 50});

Reimplemented from tgui::Widget.

◆ setPosition() [3/3]

virtual void tgui::Tab::setPosition ( const Layout2d & position )

overridevirtual

Set the position of the widget.

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters

position New position

See also: move, getPosition

Reimplemented from tgui::Widget.

◆ setSize() [1/3]

void tgui::Transformable::setSize	(	const Layout &	width,
		const Layout &	height
	)

inline

Changes the size of the widget.

Parameters

width	Width of the widget
height	Height of the widget

Usage examples:

// Give the widget an exact size
widget->setSize(40, 30);
 
// Make the widget 50 pixels higher than some other widget
widget->setSize(otherWidget->getSize().x, otherWidget->getSize().y + 50);
 
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize(tgui::bindWidth(otherWidget), tgui::bindHeight(otherWidget) + 50);

◆ setSize() [2/3]

virtual void tgui::Transformable::setSize ( const Layout2d & size )

virtual

Changes the size of the widget.

Parameters

size	Size of the widget

Usage examples:

// Give the widget an exact size
widget->setSize({40, 30});
 
// Make the widget 50 pixels higher than some other widget
widget->setSize(otherWidget->getSize() + sf::Vector2f{0, 50});
 
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize(tgui::bindSize(otherWidget) + sf::Vector2f{0, 50});

Reimplemented from tgui::Widget.

◆ setSize() [3/3]

virtual void tgui::Tab::setSize ( const Layout2d & size )

overridevirtual

This function currently does nothing.

Parameters

size	Currently ignored

It is not yet possible to change the size directly.

See also: setTabHeight; setDistanceToSide; setMaximumTabWidth

Reimplemented from tgui::Widget.

◆ setTabHeight()

void tgui::Tab::setTabHeight ( float height )

Changes the height of the tabs.

Parameters

height Height of the tabs

By default, it is the height of the tab image that is loaded with the load function.

◆ setTextSize()

void tgui::Tab::setTextSize ( unsigned int size )

Changes the character size of the text.

Parameters

size	The new size of the text. If the size is 0 (default) then the text will be scaled to fit in the tab.

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

include/TGUI/Widgets/Tab.hpp

TGUI

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ add()

◆ changeText()

◆ clone()

◆ copy()

◆ create()

◆ getMaximumTabWidth()

◆ getRenderer()

◆ getSelected()

◆ getSelectedIndex()

◆ getSize()

◆ getTabHeight()

◆ getTabsCount()

◆ getText()

◆ getTextSize()

◆ getWidgetOffset()

◆ insert()

◆ reload()

◆ remove() [1/2]

◆ remove() [2/2]

◆ select() [1/2]

◆ select() [2/2]

◆ setFont()

◆ setMaximumTabWidth()

◆ setOpacity()

◆ setPosition() [1/3]

◆ setPosition() [2/3]

◆ setPosition() [3/3]

◆ setSize() [1/3]

◆ setSize() [2/3]

◆ setSize() [3/3]

◆ setTabHeight()

◆ setTextSize()