TGUI  1.1
Loading...
Searching...
No Matches

Label widget. More...

#include <TGUI/Widgets/Label.hpp>

Inheritance diagram for tgui::Label:
tgui::ClickableWidget tgui::Widget tgui::RichTextLabel

Public Types

enum class  HorizontalAlignment { Left , Center , Right }
 The horizontal text alignment. More...
 
enum class  VerticalAlignment { Top , Center , Bottom }
 The vertical text alignment. More...
 
using Ptr = std::shared_ptr< Label >
 Shared widget pointer.
 
using ConstPtr = std::shared_ptr< const Label >
 Shared constant widget pointer.
 
- 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)
 
TGUI_NODISCARD LabelRenderergetSharedRenderer () override
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
TGUI_NODISCARD const LabelRenderergetSharedRenderer () const override
 
TGUI_NODISCARD LabelRenderergetRenderer () 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.
 
TGUI_NODISCARD const StringgetText () const
 Returns the text.
 
void setHorizontalAlignment (HorizontalAlignment alignment)
 Changes the horizontal text alignment.
 
TGUI_NODISCARD HorizontalAlignment getHorizontalAlignment () const
 Gets the current horizontal text alignment.
 
void setVerticalAlignment (VerticalAlignment alignment)
 Changes the vertical text alignment.
 
TGUI_NODISCARD VerticalAlignment getVerticalAlignment () const
 Gets the current vertical text alignment.
 
void setScrollbarPolicy (Scrollbar::Policy policy)
 Changes when the vertical scrollbar should be displayed.
 
TGUI_NODISCARD Scrollbar::Policy getScrollbarPolicy () const
 Returns when the vertical scrollbar should be displayed.
 
void setScrollbarValue (unsigned int value)
 Changes the thumb position of the scrollbar.
 
TGUI_NODISCARD unsigned int getScrollbarValue () const
 Returns the thumb position of the scrollbar.
 
void setAutoSize (bool autoSize)
 Changes whether the label is auto-sized or not.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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
 
TGUI_NODISCARD bool canGainFocus () const override
 Returns whether the widget can gain focus.
 
TGUI_NODISCARD 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.
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget.
 
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.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD Vector2f getSize () const
 Returns the size of the widget.
 
virtual TGUI_NODISCARD Vector2f getFullSize () const
 Returns the entire size that the widget is using.
 
virtual TGUI_NODISCARD Vector2f getAbsolutePosition (Vector2f offset={}) const
 Get the absolute position of the widget instead of the relative position to its parent.
 
virtual TGUI_NODISCARD Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed.
 
void setAutoLayout (AutoLayout layout)
 
TGUI_NODISCARD AutoLayout getAutoLayout () const
 
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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD Vector2f getScale () const
 Returns the scaling to be applied to the widget.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD float getRotation () const
 Returns the rotation to be applied to the widget.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD bool isVisible () const
 Returns true when the widget is visible.
 
virtual void setEnabled (bool enabled)
 Enables or disables the widget.
 
TGUI_NODISCARD bool isEnabled () const
 Returns true when the widget is enabled.
 
virtual void setFocused (bool focused)
 Focus or unfocus the widget.
 
TGUI_NODISCARD bool isFocused () const
 Returns true when the widget is focused and false otherwise.
 
TGUI_NODISCARD const StringgetWidgetType () const
 Returns the type of the widget.
 
TGUI_NODISCARD ContainergetParent () const
 Returns a pointer to the parent widget.
 
TGUI_NODISCARD BackendGuigetParentGui () const
 Returns a pointer to the gui to which this widget belongs.
 
TGUI_NODISCARD 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 >
TGUI_NODISCARD DataType getUserData () const
 Returns data stored in the widget.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD const FontgetInheritedFont () 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD Widget::Ptr getNavigationRight () const
 Returns which widget would become focused when navigating to the right from this widget.
 
void finishAllAnimations ()
 Makes all animations of the widget finish immediately.
 
TGUI_NODISCARD bool isContainer () const
 Returns whether the widget is a container widget or not.
 
TGUI_NODISCARD bool isDraggableWidget () const
 Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs)
 
TGUI_NODISCARD 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 TGUI_NODISCARD Widget::Ptr askToolTip (Vector2f mousePos)
 
TGUI_NODISCARD const Layout2dgetPositionLayout () const
 
TGUI_NODISCARD const Layout2dgetSizeLayout () const
 
void bindPositionLayout (Layout *layout)
 
void unbindPositionLayout (Layout *layout)
 
void bindSizeLayout (Layout *layout)
 
void unbindSizeLayout (Layout *layout)
 
template<typename WidgetType >
TGUI_NODISCARD std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
TGUI_NODISCARD std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 
void rendererChangedCallback (const String &property)
 

Static Public Member Functions

static TGUI_NODISCARD Label::Ptr create (const String &text="")
 Creates a new label widget.
 
static TGUI_NODISCARD Label::Ptr copy (const Label::ConstPtr &label)
 Makes a copy of another label.
 
- Static Public Member Functions inherited from tgui::ClickableWidget
static TGUI_NODISCARD ClickableWidget::Ptr create (const Layout2d &size={"100%", "100%"})
 Creates a new clickable widget.
 
static TGUI_NODISCARD 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

TGUI_NODISCARD SignalgetSignal (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.
 
TGUI_NODISCARD 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
 
virtual void rearrangeText ()
 Rearrange the text (recreates m_textPieces), making use of the given size of maximum text width.
 
void updateTextPiecePositions (float maxWidth)
 
TGUI_NODISCARD 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::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 Attributes

String m_string
 
std::vector< std::vector< Text > > m_lines
 
HorizontalAlignment m_horizontalAlignment = HorizontalAlignment::Left
 
VerticalAlignment m_verticalAlignment = VerticalAlignment::Top
 
bool m_autoSize = true
 
float m_maximumTextWidth = 0
 
bool m_ignoringMouseEvents = false
 
bool m_possibleDoubleClick = false
 
CopiedSharedPtr< ScrollbarChildWidgetm_scrollbar
 
Scrollbar::Policy m_scrollbarPolicy = Scrollbar::Policy::Automatic
 
Sprite m_spriteBackground
 
Borders m_bordersCached
 
Padding m_paddingCached
 
TextStyles m_textStyleCached
 
Color m_textColorCached
 
Color m_borderColorCached
 
Color m_backgroundColorCached
 
Color m_textOutlineColorCached
 
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< Vector2fm_rotationOrigin
 
Optional< Vector2fm_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.
 
Containerm_parent = nullptr
 
BackendGuim_parentGui = nullptr
 
bool m_mouseHover = false
 
bool m_mouseDown = false
 
bool m_focused = false
 
bool m_focusable = true
 
std::weak_ptr< Widgetm_navWidgetUp
 
std::weak_ptr< Widgetm_navWidgetDown
 
std::weak_ptr< Widgetm_navWidgetRight
 
std::weak_ptr< Widgetm_navWidgetLeft
 
Duration m_animationTimeElapsed
 
bool m_containerWidget = false
 
Widget::Ptr m_toolTip = nullptr
 
aurora::CopiedPtr< WidgetRendererm_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
 
Font m_fontCached = Font::getGlobalFont()
 
float m_opacityCached = 1
 
bool m_transparentTextureCached = false
 
unsigned int m_textSizeCached = 0
 

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 Enumeration Documentation

◆ HorizontalAlignment

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

◆ canGainFocus()

TGUI_NODISCARD bool tgui::Label::canGainFocus ( ) const
overridevirtual

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

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

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 TGUI_NODISCARD Label::Ptr tgui::Label::copy ( const Label::ConstPtr label)
static

Makes a copy of another label.

Parameters
labelThe other label
Returns
The new label

◆ create()

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

Creates a new label widget.

Parameters
textThe 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
targetRender target to draw to
statesCurrent render states

Reimplemented from tgui::ClickableWidget.

Reimplemented in tgui::RichTextLabel.

◆ getAutoSize()

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

Returns whether the label is auto-sized or not.

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

◆ getHorizontalAlignment()

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

Gets the current horizontal text alignment.

Returns
Horizontal text alignment

◆ getMaximumTextWidth()

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

TGUI_NODISCARD LabelRenderer * tgui::Label::getRenderer ( )
overridevirtual

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.

◆ getScrollbarPolicy()

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

Returns when the vertical scrollbar should be displayed.

Returns
The policy for displaying the vertical scrollbar

◆ getScrollbarValue()

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

Returns the thumb position of the scrollbar.

Returns
Value of the scrollbar

◆ getSharedRenderer() [1/2]

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

Reimplemented from tgui::Widget.

◆ getSharedRenderer() [2/2]

TGUI_NODISCARD LabelRenderer * tgui::Label::getSharedRenderer ( )
overridevirtual

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

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

Retrieves a signal based on its name.

Parameters
signalNameName of the signal
Returns
Signal that corresponds to the name
Exceptions
Exceptionwhen the name does not match any signal

Reimplemented from tgui::ClickableWidget.

◆ getText()

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

Returns the text.

Returns
Text that is currently used

◆ getVerticalAlignment()

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

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
ignoreShould mouse events be ignored by this widget?

By default, mouse events are NOT ignored.

◆ isIgnoringMouseEvents()

TGUI_NODISCARD bool tgui::Label::isIgnoringMouseEvents ( ) const

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

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

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
posMouse 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
propertyName of the property that was changed

Reimplemented from tgui::Widget.

Reimplemented in tgui::RichTextLabel.

◆ save()

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

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

Reimplemented from tgui::Widget.

◆ 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
deltaScroll offset (positive is up, negative is down). High-precision mice may use non-integral offsets.
posMouse position, or the initial position of the touch events
touchWas 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
autoSizeShould 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 ( HorizontalAlignment  alignment)

Changes the horizontal text alignment.

Parameters
alignmentThe 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
maximumWidthThe 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
policyThe policy for displaying the vertical scrollbar

◆ setScrollbarValue()

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

Changes the thumb position of the scrollbar.

Parameters
valueNew value of the scrollbar

◆ setSize() [1/3]

virtual void tgui::Widget::setSize ( const Layout2d size)
virtual

Changes the size of the widget.

Parameters
sizeSize of the widget

Usage examples:

// Give the widget an exact size
widget->setSize({40, 30});
// Give the widget a size relative to the size of its parent
widget->setSize({"20%", "5%"});
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize({200, tgui::bindHeight(otherWidget) + 50});

Reimplemented from tgui::Widget.

◆ setSize() [2/3]

void tgui::Label::setSize ( const Layout2d size)
overridevirtual

Changes the area of the text that will be drawn.

Parameters
sizeSize 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() [3/3]

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

Changes the size of the widget.

Parameters
widthWidth of the widget
heightHeight 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
textThe 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 ( VerticalAlignment  alignment)

Changes the vertical text alignment.

Parameters
alignmentThe 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: