#include <TGUI/Widgets/Label.hpp>

Inheritance diagram for tgui::Label:

Public Types
enum class	HorizontalAlignment { Left , Center , Right }
	The horizontal text alignment. More...

enum class	VerticalAlignment { Top , Center , Bottom }
	The vertical text alignment. More...

typedef std::shared_ptr< Label >	Ptr
	Shared widget pointer.

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

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

typedef std::shared_ptr< const ClickableWidget >	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< LabelRenderer >	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
	Changes the area of the text that will be drawn. More...

virtual sf::Vector2f	getFullSize () const override
	Returns the full size of the label. More...

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

void	setText (const sf::String &text)
	Changes the text. More...

const sf::String &	getText () const
	Returns the text. More...

void	setTextStyle (sf::Uint32 style)
	Changes the style of the text. More...

sf::Uint32	getTextStyle () const
	Returns the style of the text. 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	setHorizontalAlignment (HorizontalAlignment alignment)
	Change the horizontal text alignment. More...

HorizontalAlignment	getHorizontalAlignment () const
	Get the current horizontal text alignment. More...

void	setVerticalAlignment (VerticalAlignment alignment)
	Change the vertical text alignment. More...

VerticalAlignment	getVerticalAlignment () const
	Get the current vertical text alignment. More...

void	setTextColor (const Color &color)
	Changes the color of the text. More...

const sf::Color &	getTextColor () const
	Returns the color of the text. More...

virtual void	setAutoSize (bool autoSize)
	Changes whether the label is auto-sized or not. More...

virtual bool	getAutoSize () const
	Returns whether the label is auto-sized or not. More...

void	setMaximumTextWidth (float maximumWidth)
	Changes the maximum width that the text will have when auto-sizing. More...

float	getMaximumTextWidth () const
	Returns the maximum width that the text will have. 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::ClickableWidget
	ClickableWidget (const Layout2d &size={100, 100})
	Default constructor. More...

	ClickableWidget (const Layout &width, const Layout &height)
	Constructor. 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	getSize () const
	Returns the size of the widget. 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 Label::Ptr	create (sf::String text="")
	Creates a new label widget. More...

static Label::Ptr	copy (Label::ConstPtr label)
	Makes a copy of another label. More...

Static Public Member Functions inherited from tgui::ClickableWidget
static ClickableWidget::Ptr	create (Layout2d size={100, 100})
	Creates a new clickable widget. More...

static ClickableWidget::Ptr	copy (ClickableWidget::ConstPtr widget)
	Makes a copy of another clickable widget. 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

Label widget.

Signals:

DoubleClicked (double left clicked on top of the label)
- Optional parameter sf::String: text of the label
- Uses Callback member 'text'
Inherited signals from ClickableWidget

Member Enumeration Documentation

◆ HorizontalAlignment

enum class tgui::Label::HorizontalAlignment

strong

The horizontal text alignment.

Enumerator
Left	Put the text on the left side (default)
Center	Center the text horizontally.
Right	Put the text on the right side (e.g. for numbers)

◆ VerticalAlignment

enum class tgui::Label::VerticalAlignment

strong

The vertical text alignment.

Enumerator
Top	Put the text at the top (default)
Center	Center the text vertically.
Bottom	Put the text at the bottom.

Member Function Documentation

◆ clone()

virtual Widget::Ptr tgui::Label::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

Reimplemented from tgui::ClickableWidget.

◆ copy()

static Label::Ptr tgui::Label::copy ( Label::ConstPtr label )

static

Makes a copy of another label.

Parameters

label The other label

Returns: The new label

◆ create()

static Label::Ptr tgui::Label::create ( sf::String text = "" )

static

Creates a new label widget.

Parameters

text	The text to display

Returns: The new label

◆ getAutoSize()

virtual bool tgui::Label::getAutoSize ( ) const

inlinevirtual

Returns whether the label is auto-sized or not.

Returns: Is the size of the label changed when the text changes?

◆ getFullSize()

virtual sf::Vector2f tgui::Label::getFullSize ( ) const

overridevirtual

Returns the full size of the label.

The size returned by this function includes the borders.

Returns: Full size of the label

Reimplemented from tgui::Transformable.

◆ getHorizontalAlignment()

HorizontalAlignment tgui::Label::getHorizontalAlignment ( ) const

Get the current horizontal text alignment.

Returns: Horizontal text alignment

◆ getMaximumTextWidth()

float tgui::Label::getMaximumTextWidth ( ) const

Returns the maximum width that the text will have.

Returns

The width of the label minus the padding when a specific size was set.
The maximum text width when auto-sizing and a maximum was set.
0 when auto-sizing but there is no maximum width.

◆ getRenderer()

std::shared_ptr< LabelRenderer > tgui::Label::getRenderer ( ) const

inline

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

Returns: Reference to the renderer

◆ getText()

const sf::String & tgui::Label::getText ( ) const

inline

Returns the text.

Returns: Text that is currently used

◆ getTextColor()

const sf::Color & tgui::Label::getTextColor ( ) const

Returns the color of the text.

Returns: text color

◆ getTextSize()

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

Returns the character size of the text.

Returns: The current text size.

◆ getTextStyle()

sf::Uint32 tgui::Label::getTextStyle ( ) const

Returns the style of the text.

Returns: The current text style

◆ getVerticalAlignment()

VerticalAlignment tgui::Label::getVerticalAlignment ( ) const

Get the current vertical text alignment.

Returns: Vertical text alignment

◆ getWidgetOffset()

virtual sf::Vector2f tgui::Label::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.

◆ reload()

virtual void tgui::Label::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.

◆ setAutoSize()

virtual void tgui::Label::setAutoSize ( bool autoSize )

virtual

Changes whether the label is auto-sized or not.

Parameters

autoSize Should the size of the label be changed when the text changes?

When the label is in auto-size mode, the width and height of the label will be changed to fit the text. Otherwise, only the part defined by the size will be visible.

The label is auto-sized by default.

◆ setFont()

virtual void tgui::Label::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.

◆ setHorizontalAlignment()

void tgui::Label::setHorizontalAlignment ( HorizontalAlignment alignment )

Change the horizontal text alignment.

Parameters

alignment The new horizontal text alignment

By default the text is aligned to the left.

◆ setMaximumTextWidth()

void tgui::Label::setMaximumTextWidth ( float maximumWidth )

Changes the maximum width that the text will have when auto-sizing.

Parameters

maximumWidth The new maximum text width

This property is ignored when an exact size has been given. Pass 0 to this function to disable the maximum.

When the text is auto-sizing then the text will be split over several lines when its width would exceed th

◆ setOpacity()

virtual void tgui::Label::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::Label::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::Label::setSize ( const Layout2d & size )

overridevirtual

Changes the area of the text that will be drawn.

Parameters

size	Size of the part to draw

Only the part of the text that lies within the size will be drawn.

When a background color is set, the drawn background will have this size. So setting a size that is bigger than the text will result in a bigger area being filled.

When this function is called, the label will no longer be auto-sizing.

See also: setAutoSize

Reimplemented from tgui::Widget.

◆ setText()

void tgui::Label::setText ( const sf::String & text )

Changes the text.

Parameters

text	The new text

When the text is auto-sized (default), then the size of the label will be changed to fit the whole text.

See also: setAutoSize

◆ setTextColor()

void tgui::Label::setTextColor ( const Color & color )

Changes the color of the text.

Parameters

color New text color

◆ setTextSize()

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

Changes the character size of the text.

Parameters

size	The new text size

◆ setTextStyle()

void tgui::Label::setTextStyle ( sf::Uint32 style )

Changes the style of the text.

The possible styles can be found in the sf::Text::Style enum. You can pass a combination of one or more styles, for example sf::Text::Bold | sf::Text::Italic. The default style is sf::Text::Regular.

Parameters

style New text style

◆ setVerticalAlignment()

void tgui::Label::setVerticalAlignment ( VerticalAlignment alignment )

Change the vertical text alignment.

Parameters

alignment The new vertical text alignment

By default the text is aligned to the top.

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

include/TGUI/Widgets/Label.hpp

TGUI

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ HorizontalAlignment

◆ VerticalAlignment

Member Function Documentation

◆ clone()

◆ copy()

◆ create()

◆ getAutoSize()

◆ getFullSize()

◆ getHorizontalAlignment()

◆ getMaximumTextWidth()

◆ getRenderer()

◆ getText()

◆ getTextColor()

◆ getTextSize()

◆ getTextStyle()

◆ getVerticalAlignment()

◆ getWidgetOffset()

◆ reload()

◆ setAutoSize()

◆ setFont()

◆ setHorizontalAlignment()

◆ setMaximumTextWidth()

◆ setOpacity()

◆ setPosition() [1/3]

◆ setPosition() [2/3]

◆ setPosition() [3/3]

◆ setSize() [1/3]

◆ setSize() [2/3]

◆ setSize() [3/3]

◆ setText()

◆ setTextColor()

◆ setTextSize()

◆ setTextStyle()

◆ setVerticalAlignment()