#include <TGUI/Widgets/Label.hpp>

Inheritance diagram for tgui::Label:

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

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

using	HorizontalAlignment = tgui::HorizontalAlignment
	The horizontal text alignment.

using	VerticalAlignment = tgui::VerticalAlignment
	The vertical text alignment.

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

using	ConstPtr = std::shared_ptr<const ClickableWidget>
	Shared constant widget pointer.

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

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

Public Member Functions
	Label (const char *typeName=StaticWidgetType, bool initRenderer=true)

LabelRenderer *	getSharedRenderer () override
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

const LabelRenderer *	getSharedRenderer () const override

LabelRenderer *	getRenderer () override
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

void	setSize (const Layout2d &size) override
	Changes the area of the text that will be drawn.

void	setText (const String &text)
	Changes the text.

const String &	getText () const
	Returns the text.

void	setHorizontalAlignment (tgui::HorizontalAlignment alignment)
	Changes the horizontal text alignment.

tgui::HorizontalAlignment	getHorizontalAlignment () const
	Gets the current horizontal text alignment.

void	setVerticalAlignment (tgui::VerticalAlignment alignment)
	Changes the vertical text alignment.

tgui::VerticalAlignment	getVerticalAlignment () const
	Gets the current vertical text alignment.

void	setScrollbarPolicy (Scrollbar::Policy policy)
	Changes when the vertical scrollbar should be displayed.

Scrollbar::Policy	getScrollbarPolicy () const
	Returns when the vertical scrollbar should be displayed.

void	setScrollbarValue (unsigned int value)
	Changes the thumb position of the scrollbar.

unsigned int	getScrollbarValue () const
	Returns the thumb position of the scrollbar.

unsigned int	getScrollbarMaxValue () const
	Returns the maximum thumb position of the scrollbar.

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

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

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

float	getMaximumTextWidth () const
	Returns the maximum width that the text will have.

void	ignoreMouseEvents (bool ignore=true)
	Sets whether the widget should completely ignore mouse events and let them pass to the widgets behind it.

bool	isIgnoringMouseEvents () const
	Returns whether the widget is ignoring mouse events and letting them pass to the widgets behind it.

void	setParent (Container *parent) override

bool	canGainFocus () const override
	Returns whether the widget can gain focus.

bool	isMouseOnWidget (Vector2f pos) const override
	Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

bool	leftMousePressed (Vector2f pos) override
	Called by the parent when the left mouse button goes down on top of the widget.

void	leftMouseReleased (Vector2f pos) override

void	mouseMoved (Vector2f pos) override

bool	scrolled (float delta, Vector2f pos, bool touch) override
	Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen)

void	mouseNoLongerOnWidget () override

void	leftMouseButtonNoLongerDown () override

void	draw (BackendRenderTarget &target, RenderStates states) const override
	Draw the widget to a render target.

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

Public Member Functions inherited from tgui::ClickableWidget
	ClickableWidget (const char *typeName=StaticWidgetType, bool initRenderer=true)

void	rightMousePressed (Vector2f pos) override

void	rightMouseReleased (Vector2f pos) override

void	rightMouseButtonNoLongerDown () override

Public Member Functions inherited from tgui::Widget
	Widget (const char *typeName, bool initRenderer)

	Widget (const Widget &)
	Copy constructor.

	Widget (Widget &&) noexcept
	Move constructor.

virtual	~Widget ()
	Destructor.

Widget &	operator= (const Widget &)
	Overload of copy assignment operator.

Widget &	operator= (Widget &&) noexcept
	Move assignment.

void	setRenderer (std::shared_ptr< RendererData > rendererData)
	Sets a new renderer for the widget. The renderer determines how the widget looks.

virtual void	setPosition (const Layout2d &position)
	sets the position of the widget

void	setPosition (Layout x, Layout y)
	Sets the position of the widget.

Vector2f	getPosition () const
	Gets the position of the widget.

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

void	setWidth (Layout width)
	Changes the width of the widget.

void	setHeight (Layout height)
	Changes the height of the widget.

Vector2f	getSize () const
	Returns the size of the widget.

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

virtual Vector2f	getAbsolutePosition (Vector2f offset={}) const
	Get the absolute position of the widget instead of the relative position to its parent.

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

void	setAutoLayout (AutoLayout layout)
	Sets how the position is determined compared to the other widgets in the parent.

AutoLayout	getAutoLayout () const
	Returns how the position is determined compared to the other widgets in the parent.

void	setOrigin (float x, float y)
	Sets the origin point on which the position, scale and rotation is based.

void	setOrigin (Vector2f origin)
	Sets the origin point on which the position, scale and rotation is based.

Vector2f	getOrigin () const
	Returns the relative origin point on which the position, scale and rotation is based.

void	setScale (Vector2f scaleFactors)
	Sets the scaling to be applied to the widget.

void	setScale (Vector2f scaleFactors, Vector2f origin)
	Sets the scaling to be applied to the widget.

void	setScale (float scaleFactor)
	Sets the scaling to be applied to the widget.

void	setScale (float scaleFactor, Vector2f origin)
	Sets the scaling to be applied to the widget.

Vector2f	getScale () const
	Returns the scaling to be applied to the widget.

Vector2f	getScaleOrigin () const
	Returns the origin used for scaling.

void	setRotation (float angle)
	Sets the rotation to be applied to the widget.

void	setRotation (float angle, Vector2f origin)
	Sets the rotation to be applied to the widget.

float	getRotation () const
	Returns the rotation to be applied to the widget.

Vector2f	getRotationOrigin () const
	Returns the origin used for rotations.

void	showWithEffect (ShowEffectType type, Duration duration)
	Shows the widget by introducing it with an animation.

void	hideWithEffect (ShowEffectType type, Duration duration)
	Hides the widget by making it leave with an animation.

void	moveWithAnimation (Layout2d position, Duration duration)
	Moves the widget from its current position to the given position, over a given duration.

void	resizeWithAnimation (Layout2d size, Duration duration)
	Resizes the widget from its current size to the given size, over a given duration.

virtual void	setVisible (bool visible)
	Shows or hides a widget.

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

virtual void	setEnabled (bool enabled)
	Enables or disables the widget.

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

virtual void	setFocused (bool focused)
	Focus or unfocus the widget.

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

const String &	getWidgetType () const
	Returns the type of the widget.

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

BackendGui *	getParentGui () const
	Returns a pointer to the gui to which this widget belongs.

bool	isAnimationPlaying () const
	Returns whether there is an active animation (started with showWithEffect or hideWithEffect)

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

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

void	setUserData (Any userData)
	Stores some data into the widget.

template<typename DataType >
DataType	getUserData () const
	Returns data stored in the widget.

bool	hasUserData () const
	Returns whether data stored in the widget.

void	setInheritedFont (const Font &font)
	Sets the font of the widget that is used when no font is set in the renderer.

const Font &	getInheritedFont () const
	Returns the font of the widget that is used when no font is set in the renderer.

void	setInheritedOpacity (float opacity)
	Sets the opacity of the widget that will be multiplied with the opacity set in the renderer.

float	getInheritedOpacity () const
	Returns the opacity of the widget that is multiplied with the opacity set in the renderer.

void	setTextSize (unsigned int size)
	Changes the character size of text in this widget if it uses text.

unsigned int	getTextSize () const
	Returns the character size of text in this widget.

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

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

void	setWidgetName (const String &name)
	Changes the name of a widget.

String	getWidgetName () const
	Returns the name of a widget.

void	setMouseCursor (Cursor::Type cursor)
	Changes which mouse cursor is shown when hovering over the widget.

Cursor::Type	getMouseCursor () const
	Returns which mouse cursor is shown when hovering over the widget.

void	setFocusable (bool focusable)
	Changes whether a widget could be focused.

bool	isFocusable () const
	Returns whether a widget could be focused.

void	setNavigationUp (const Widget::Ptr &widgetAbove)
	Changes which widget should become focused when navigating upwards from this widget.

Widget::Ptr	getNavigationUp () const
	Returns which widget would become focused when navigating upwards from this widget.

void	setNavigationDown (const Widget::Ptr &widgetBelow)
	Changes which widget should become focused when navigating downwards from this widget.

Widget::Ptr	getNavigationDown () const
	Returns which widget would become focused when navigating downwards from this widget.

void	setNavigationLeft (const Widget::Ptr &widgetLeft)
	Changes which widget should become focused when navigating to the left from this widget.

Widget::Ptr	getNavigationLeft () const
	Returns which widget would become focused when navigating to the left from this widget.

void	setNavigationRight (const Widget::Ptr &widgetRight)
	Changes which widget should become focused when navigating to the right from this widget.

Widget::Ptr	getNavigationRight () const
	Returns which widget would become focused when navigating to the right from this widget.

void	setIgnoreMouseEvents (bool ignore)
	Sets whether the widget should completely ignore mouse events and let them pass to the widgets behind it.

bool	getIgnoreMouseEvents () const
	Returns whether the widget is ignoring mouse events and letting them pass to the widgets behind it.

void	finishAllAnimations ()
	Makes all animations of the widget finish immediately.

bool	isContainer () const
	Returns whether the widget is a container widget or not.

bool	isMouseDown () const
	Returns whether the left mouse button has been pressed on top of the widget.

void	setAutoLayoutUpdateEnabled (bool enabled)

virtual void	mouseReleased (Event::MouseButton button, Vector2f pos)

virtual void	keyPressed (const Event::KeyEvent &event)

virtual bool	canHandleKeyPress (const Event::KeyEvent &event)
	Called by the parent of the widget to check if keyPressed would process the event.

virtual void	textEntered (char32_t key)

virtual Widget::Ptr	askToolTip (Vector2f mousePos)

const Layout2d &	getPositionLayout () const

const Layout2d &	getSizeLayout () const

void	bindPositionLayout (Layout *layout)

void	unbindPositionLayout (Layout *layout)

void	bindSizeLayout (Layout *layout)

void	unbindSizeLayout (Layout *layout)

template<typename WidgetType >
std::shared_ptr< const WidgetType >	cast () const
	Downcast const widget.

template<typename WidgetType >
std::shared_ptr< WidgetType >	cast ()
	Downcast widget.

void	rendererChangedCallback (const String &property)

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

	ScrollbarChildInterface (const ScrollbarChildInterface &)
	Copy constructor.

	ScrollbarChildInterface (ScrollbarChildInterface &&) noexcept
	Move constructor.

virtual	~ScrollbarChildInterface ()=default
	Destructor.

ScrollbarChildInterface &	operator= (const ScrollbarChildInterface &)
	Overload of copy assignment operator.

ScrollbarChildInterface &	operator= (ScrollbarChildInterface &&) noexcept
	Move assignment.

ScrollbarAccessor *	getScrollbar ()
	Returns an object that provides access to the widget's scrollbar.

const ScrollbarAccessor *	getScrollbar () const
	Returns an object that provides access to the widget's scrollbar.

Static Public Member Functions
static Label::Ptr	create (const String &text="")
	Creates a new label widget.

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

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

static ClickableWidget::Ptr	copy (const ClickableWidget::ConstPtr &widget)
	Makes a copy of another clickable widget.

Public Attributes
SignalString	onDoubleClick = {"DoubleClicked"}
	The label was double clicked. Optional parameter: text of the label.

Public Attributes inherited from tgui::ClickableWidget
SignalVector2f	onMousePress = {"MousePressed"}
	The mouse went down on the widget. Optional parameter: mouse position relative to widget.

SignalVector2f	onMouseRelease = {"MouseReleased"}
	The mouse was released on top of the widget. Optional parameter: mouse position relative to widget.

SignalVector2f	onClick = {"Clicked"}
	The widget was clicked. Optional parameter: mouse position relative to widget.

SignalVector2f	onRightMousePress = {"RightMousePressed"}
	The right mouse button went down on the widget. Optional parameter: mouse position relative to widget.

SignalVector2f	onRightMouseRelease = {"RightMouseReleased"}
	The right mouse button was released on top of the widget. Optional parameter: mouse position relative to widget.

SignalVector2f	onRightClick = {"RightClicked"}
	The widget was right clicked. Optional parameter: mouse position relative to widget.

Public Attributes inherited from tgui::Widget
SignalVector2f	onPositionChange = {"PositionChanged"}
	The position of the widget changed. Optional parameter: new position.

SignalVector2f	onSizeChange = {"SizeChanged"}
	The size of the widget changed. Optional parameter: new size.

Signal	onFocus = {"Focused"}
	The widget was focused.

Signal	onUnfocus = {"Unfocused"}
	The widget was unfocused.

Signal	onMouseEnter = {"MouseEntered"}
	The mouse entered the widget.

Signal	onMouseLeave = {"MouseLeft"}
	The mouse left the widget.

SignalShowEffect	onShowEffectFinish = {"ShowEffectFinished"}
	A show or hide effect finished. Optional parameters: effect type, new widget visibility or both.

SignalAnimationType	onAnimationFinish = {"AnimationFinished"}
	An animation has finished.

Static Public Attributes
static constexpr const char	StaticWidgetType [] = "Label"
	Type name of the widget.

Static Public Attributes inherited from tgui::ClickableWidget
static constexpr const char	StaticWidgetType [] = "ClickableWidget"
	Type name of the widget.

Protected Member Functions
Signal &	getSignal (String signalName) override
	Retrieves a signal based on its name.

void	rendererChanged (const String &property) override
	Function called when one of the properties of the renderer is changed.

std::unique_ptr< DataIO::Node >	save (SavingRenderersMap &renderers) const override
	Saves the widget as a tree node in order to save it to a file.

void	load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
	Loads the widget from a tree of nodes.

void	updateTextSize () override
	Called when the text size is changed (either by setTextSize or via the renderer)

bool	updateTime (Duration elapsedTime) override

void	scrollbarPolicyChanged () override
	Called when the policy of the scrollbar has been changed via getScrollbar()->setPolicy(...)

virtual void	rearrangeText ()
	Rearrange the text (recreates m_textPieces), making use of the given size of maximum text width.

void	updateTextPiecePositions (float maxWidth)

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

Protected Member Functions inherited from tgui::ClickableWidget
Protected Member Functions inherited from tgui::Widget
virtual void	mouseEnteredWidget ()
	This function is called when the mouse enters the widget.

virtual void	mouseLeftWidget ()
	This function is called when the mouse leaves the widget.

void	recalculateBoundPositionLayouts ()
	Calls recalculateValue() on each layout in m_boundPositionLayouts.

void	recalculateBoundSizeLayouts ()
	Calls recalculateValue() on each layout in m_boundSizeLayouts.

Protected Member Functions inherited from tgui::ScrollbarChildInterface
virtual void	scrollbarValueChanged ()
	Called when the value of the scrollbar has been changed via getScrollbar()->setValue(...)

virtual void	scrollbarScrollAmountChanged ()
	Called when the scroll amount of the scrollbar has been changed via getScrollbar()->setScrollAmount(...)

void	saveScrollbarPolicy (std::unique_ptr< DataIO::Node > &node) const
	This function should be called inside the save function in order to save the configured scrollbar policy.

void	loadScrollbarPolicy (const std::unique_ptr< DataIO::Node > &node)
	This function should be called inside the load function in order to load the wanted scrollbar policy.

Protected Attributes
String	m_string

std::vector< std::vector< Text > >	m_lines

tgui::HorizontalAlignment	m_horizontalAlignment = tgui::HorizontalAlignment::Left

tgui::VerticalAlignment	m_verticalAlignment = tgui::VerticalAlignment::Top

bool	m_autoSize = true

float	m_maximumTextWidth = 0

bool	m_ignoringMouseEvents = false

bool	m_possibleDoubleClick = false

Sprite	m_spriteBackground

Borders	m_bordersCached

Padding	m_paddingCached

TextStyles	m_textStyleCached

Color	m_textColorCached

Color	m_borderColorCached

Color	m_backgroundColorCached

Color	m_textOutlineColorCached = Color::Black

float	m_textOutlineThicknessCached = 0

Protected Attributes inherited from tgui::Widget
String	m_type

String	m_name

Layout2d	m_position
	Stores the position of this widget.

Layout2d	m_size
	Stores the size of this widget.

unsigned int	m_textSize = 0

Vector2f	m_origin

Optional< Vector2f >	m_rotationOrigin

Optional< Vector2f >	m_scaleOrigin

Vector2f	m_scaleFactors = {1, 1}

float	m_rotationDeg = 0

Vector2f	m_prevPosition

Vector2f	m_prevSize

std::unordered_set< Layout * >	m_boundPositionLayouts

std::unordered_set< Layout * >	m_boundSizeLayouts

bool	m_enabled = true
	Stores the flag indicating whether this widget is enabled.

bool	m_visible = true
	Stores the flag indicating whether this widget is visible.

Container *	m_parent = nullptr

BackendGui *	m_parentGui = nullptr

bool	m_mouseHover = false

bool	m_mouseDown = false

bool	m_focused = false

bool	m_focusable = true

std::weak_ptr< Widget >	m_navWidgetUp

std::weak_ptr< Widget >	m_navWidgetDown

std::weak_ptr< Widget >	m_navWidgetRight

std::weak_ptr< Widget >	m_navWidgetLeft

Duration	m_animationTimeElapsed

bool	m_containerWidget = false

Widget::Ptr	m_toolTip = nullptr

aurora::CopiedPtr< WidgetRenderer >	m_renderer = nullptr

std::vector< std::unique_ptr< priv::Animation > >	m_showAnimations

Font	m_inheritedFont

float	m_inheritedOpacity = 1

Any	m_userData

Cursor::Type	m_mouseCursor = Cursor::Type::Arrow

AutoLayout	m_autoLayout = AutoLayout::Manual

bool	m_autoLayoutUpdateEnabled = true

bool	m_ignoreMouseEvents = false

Font	m_fontCached = Font::getGlobalFont()

float	m_opacityCached = 1

bool	m_transparentTextureCached = false

unsigned int	m_textSizeCached = 0

Protected Attributes inherited from tgui::ScrollbarChildInterface
CopiedSharedPtr< ScrollbarChildWidget >	m_scrollbar

ScrollbarAccessor	m_scrollbarAccessor

Additional Inherited Members
Protected Types inherited from tgui::Widget
using	SavingRenderersMap = std::map<const Widget*, std::pair<std::unique_ptr<DataIO::Node>, String>>

using	LoadingRenderersMap = std::map<String, std::shared_ptr<RendererData>>

Detailed Description

Label widget.

Member Function Documentation

◆ canGainFocus()

bool tgui::Label::canGainFocus ( ) const

nodiscardoverridevirtual

Returns whether the widget can gain focus.

Returns: Can the widget be focused?

This function returns false for Label widgets.

Reimplemented from tgui::Widget.

◆ clone()

Widget::Ptr tgui::Label::clone ( ) const

nodiscardoverrideprotectedvirtual

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.

Reimplemented in tgui::RichTextLabel.

◆ copy()

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

staticnodiscard

Makes a copy of another label.

Parameters

label The other label

Returns: The new label

◆ create()

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

staticnodiscard

Creates a new label widget.

Parameters

text	The text to display

Returns: The new label

◆ draw()

void tgui::Label::draw	(	BackendRenderTarget &	target,
		RenderStates	states ) const

overridevirtual

Draw the widget to a render target.

Parameters

target	Render target to draw to
states	Current render states

Reimplemented from tgui::ClickableWidget.

Reimplemented in tgui::RichTextLabel.

◆ getAutoSize()

bool tgui::Label::getAutoSize ( ) const

nodiscard

Returns whether the label is auto-sized or not.

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

◆ getHorizontalAlignment()

tgui::HorizontalAlignment tgui::Label::getHorizontalAlignment ( ) const

nodiscard

Gets the current horizontal text alignment.

Returns: Horizontal text alignment

◆ getMaximumTextWidth()

float tgui::Label::getMaximumTextWidth ( ) const

nodiscard

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

LabelRenderer * tgui::Label::getRenderer ( )

nodiscardoverridevirtual

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

Returns: Temporary pointer to the renderer

Warning: After calling this function, the widget has its own copy of the renderer and it will no longer be shared.

Reimplemented from tgui::Widget.

◆ getScrollbarMaxValue()

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

nodiscard

Returns the maximum thumb position of the scrollbar.

Returns: Maximum value of the scrollbar

Since: TGUI 1.4

◆ getScrollbarPolicy()

Scrollbar::Policy tgui::Label::getScrollbarPolicy ( ) const

nodiscard

Returns when the vertical scrollbar should be displayed.

Returns: The policy for displaying the vertical scrollbar

◆ getScrollbarValue()

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

nodiscard

Returns the thumb position of the scrollbar.

Returns: Value of the scrollbar

◆ getSharedRenderer() [1/2]

const LabelRenderer * tgui::Label::getSharedRenderer ( ) const

nodiscardoverridevirtual

Reimplemented from tgui::Widget.

◆ getSharedRenderer() [2/2]

LabelRenderer * tgui::Label::getSharedRenderer ( )

nodiscardoverridevirtual

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

Returns: Temporary pointer to the renderer that may be shared with other widgets using the same renderer

Reimplemented from tgui::Widget.

◆ getSignal()

Signal & tgui::Label::getSignal ( String signalName )

nodiscardoverrideprotectedvirtual

Retrieves a signal based on its name.

Parameters

signalName Name of the signal

Returns: Signal that corresponds to the name

Exceptions

Exception when the name does not match any signal

Reimplemented from tgui::ClickableWidget.

◆ getText()

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

nodiscard

Returns the text.

Returns: Text that is currently used

◆ getVerticalAlignment()

tgui::VerticalAlignment tgui::Label::getVerticalAlignment ( ) const

nodiscard

Gets the current vertical text alignment.

Returns: Vertical text alignment

◆ ignoreMouseEvents()

void tgui::Label::ignoreMouseEvents ( bool ignore = true )

Sets whether the widget should completely ignore mouse events and let them pass to the widgets behind it.

Parameters

ignore Should mouse events be ignored by this widget?

By default, mouse events are NOT ignored.

◆ isIgnoringMouseEvents()

bool tgui::Label::isIgnoringMouseEvents ( ) const

nodiscard

Returns whether the widget is ignoring mouse events and letting them pass to the widgets behind it.

Returns: Are mouse events ignored by this widget?

◆ isMouseOnWidget()

bool tgui::Label::isMouseOnWidget ( Vector2f pos ) const

nodiscardoverridevirtual

Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

Returns: Is the mouse on top of the widget?

Reimplemented from tgui::ClickableWidget.

◆ leftMouseButtonNoLongerDown()

void tgui::Label::leftMouseButtonNoLongerDown ( )

overridevirtual

Reimplemented from tgui::Widget.

◆ leftMousePressed()

bool tgui::Label::leftMousePressed ( Vector2f pos )

overridevirtual

Called by the parent when the left mouse button goes down on top of the widget.

Parameters

pos	Mouse position in view coordinates relative to the parent widget

Returns: True if the clicked part of the widget is draggable, i.e. if the widget should continue to receive mouse move events until the mouse is released, even when the mouse leaves the widget. When false is returned, the mouse move events will only be sent to the widget as long as the mouse is on top of the widget.

Reimplemented from tgui::ClickableWidget.

◆ leftMouseReleased()

void tgui::Label::leftMouseReleased ( Vector2f pos )

overridevirtual

Reimplemented from tgui::ClickableWidget.

◆ load()

void tgui::Label::load	(	const std::unique_ptr< DataIO::Node > &	node,
		const LoadingRenderersMap &	renderers )

overrideprotectedvirtual

Loads the widget from a tree of nodes.

Reimplemented from tgui::Widget.

◆ mouseMoved()

void tgui::Label::mouseMoved ( Vector2f pos )

overridevirtual

Reimplemented from tgui::Widget.

◆ mouseNoLongerOnWidget()

void tgui::Label::mouseNoLongerOnWidget ( )

overridevirtual

Reimplemented from tgui::Widget.

◆ rearrangeText()

virtual void tgui::Label::rearrangeText ( )

protectedvirtual

Rearrange the text (recreates m_textPieces), making use of the given size of maximum text width.

Reimplemented in tgui::RichTextLabel.

◆ rendererChanged()

void tgui::Label::rendererChanged ( const String & property )

overrideprotectedvirtual

Function called when one of the properties of the renderer is changed.

Parameters

property Name of the property that was changed

Reimplemented from tgui::Widget.

Reimplemented in tgui::RichTextLabel.

◆ save()

std::unique_ptr< DataIO::Node > tgui::Label::save ( SavingRenderersMap & renderers ) const

nodiscardoverrideprotectedvirtual

Saves the widget as a tree node in order to save it to a file.

Reimplemented from tgui::Widget.

◆ scrollbarPolicyChanged()

void tgui::Label::scrollbarPolicyChanged ( )

overrideprotectedvirtual

Called when the policy of the scrollbar has been changed via getScrollbar()->setPolicy(...)

Reimplemented from tgui::ScrollbarChildInterface.

◆ scrolled()

bool tgui::Label::scrolled	(	float	delta,
		Vector2f	pos,
		bool	touch )

overridevirtual

Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen)

Parameters

delta	Scroll offset (positive is up, negative is down). High-precision mice may use non-integral offsets.
pos	Mouse position, or the initial position of the touch events
touch	Was this a touch event or a mouse wheel scroll?

Returns: Was the scrolling was handled by the widget?

Reimplemented from tgui::Widget.

◆ setAutoSize()

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

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.

◆ setHorizontalAlignment()

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

Changes 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 the value passed to this function.

◆ setParent()

void tgui::Label::setParent ( Container * parent )

overridevirtual

Reimplemented from tgui::Widget.

◆ setScrollbarPolicy()

void tgui::Label::setScrollbarPolicy ( Scrollbar::Policy policy )

Changes when the vertical scrollbar should be displayed.

Parameters

policy The policy for displaying the vertical scrollbar

◆ setScrollbarValue()

void tgui::Label::setScrollbarValue ( unsigned int value )

Changes the thumb position of the scrollbar.

Parameters

value New value of the scrollbar

◆ setSize() [1/2]

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.

◆ setSize() [2/2]

void tgui::Widget::setSize	(	Layout	width,
		Layout	height )

inline

Changes the size of the widget.

Parameters

width	Width of the widget
height	Height of the widget

Warning: This setSize overload must never be used from internal TGUI code or by custom widget implementations

◆ setText()

void tgui::Label::setText ( const 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

◆ setVerticalAlignment()

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

Changes the vertical text alignment.

Parameters

alignment The new vertical text alignment

By default the text is aligned to the top.

◆ updateTextSize()

void tgui::Label::updateTextSize ( )

overrideprotectedvirtual

Called when the text size is changed (either by setTextSize or via the renderer)

Reimplemented from tgui::Widget.

◆ updateTime()

bool tgui::Label::updateTime ( Duration elapsedTime )

overrideprotectedvirtual

Reimplemented from tgui::Widget.

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

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ canGainFocus()

◆ clone()

◆ copy()

◆ create()

◆ draw()

◆ getAutoSize()

◆ getHorizontalAlignment()

◆ getMaximumTextWidth()

◆ getRenderer()

◆ getScrollbarMaxValue()

◆ getScrollbarPolicy()

◆ getScrollbarValue()

◆ getSharedRenderer() [1/2]

◆ getSharedRenderer() [2/2]

◆ getSignal()

◆ getText()

◆ getVerticalAlignment()

◆ ignoreMouseEvents()

◆ isIgnoringMouseEvents()

◆ isMouseOnWidget()

◆ leftMouseButtonNoLongerDown()

◆ leftMousePressed()

◆ leftMouseReleased()

◆ load()

◆ mouseMoved()

◆ mouseNoLongerOnWidget()

◆ rearrangeText()

◆ rendererChanged()

◆ save()

◆ scrollbarPolicyChanged()

◆ scrolled()

◆ setAutoSize()

◆ setHorizontalAlignment()

◆ setMaximumTextWidth()

◆ setParent()

◆ setScrollbarPolicy()

◆ setScrollbarValue()

◆ setSize() [1/2]

◆ setSize() [2/2]

◆ setText()

◆ setVerticalAlignment()

◆ updateTextSize()

◆ updateTime()