Label.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2025 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef TGUI_LABEL_HPP
#define TGUI_LABEL_HPP
 
#include <TGUI/Widgets/ClickableWidget.hpp>
#include <TGUI/Renderers/LabelRenderer.hpp>
#include <TGUI/Widgets/Scrollbar.hpp>
#include <TGUI/Text.hpp>

 
TGUI_MODULE_EXPORT namespace tgui
{
    class TGUI_API Label : public ClickableWidget, public ScrollbarChildInterface
    {
    public:
 
        using Ptr = std::shared_ptr<Label>; 
        using ConstPtr = std::shared_ptr<const Label>; 
 
        static constexpr const char StaticWidgetType[] = "Label"; 

        using HorizontalAlignment TGUI_DEPRECATED("Use tgui::HorizontalAlignment instead") = tgui::HorizontalAlignment;

        using VerticalAlignment TGUI_DEPRECATED("Use tgui::VerticalAlignment instead") = tgui::VerticalAlignment;

        Label(const char* typeName = StaticWidgetType, bool initRenderer = true);

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

        TGUI_NODISCARD static Label::Ptr copy(const Label::ConstPtr& label);

        TGUI_NODISCARD LabelRenderer* getSharedRenderer() override;
        TGUI_NODISCARD const LabelRenderer* getSharedRenderer() const override;

        TGUI_NODISCARD LabelRenderer* getRenderer() override;

        void setSize(const Layout2d& size) override;
        using Widget::setSize;

        void setText(const String& text);

        TGUI_NODISCARD const String& getText() const;

        void setHorizontalAlignment(tgui::HorizontalAlignment alignment); // TGUI_NEXT: Remove "tgui::" prefix

        TGUI_NODISCARD tgui::HorizontalAlignment getHorizontalAlignment() const; // TGUI_NEXT: Remove "tgui::" prefix

        void setVerticalAlignment(tgui::VerticalAlignment alignment); // TGUI_NEXT: Remove "tgui::" prefix

        TGUI_NODISCARD tgui::VerticalAlignment getVerticalAlignment() const; // TGUI_NEXT: Remove "tgui::" prefix

        TGUI_DEPRECATED("Use getScrollbar()->setPolicy(policy) instead") void setScrollbarPolicy(Scrollbar::Policy policy);

        TGUI_DEPRECATED("Use getScrollbar()->getPolicy() instead") TGUI_NODISCARD Scrollbar::Policy getScrollbarPolicy() const;

        TGUI_DEPRECATED("Use getScrollbar()->setValue(value) instead") void setScrollbarValue(unsigned int value);

        TGUI_DEPRECATED("Use getScrollbar()->getValue() instead") TGUI_NODISCARD unsigned int getScrollbarValue() const;

        TGUI_DEPRECATED("Use getScrollbar()->getMaxValue() instead") TGUI_NODISCARD unsigned int getScrollbarMaxValue() const;

        void setAutoSize(bool autoSize);

        TGUI_NODISCARD bool getAutoSize() const;

        void setMaximumTextWidth(float maximumWidth);

        TGUI_NODISCARD float getMaximumTextWidth() const;

        TGUI_DEPRECATED("Use setIgnoreMouseEvents instead") void ignoreMouseEvents(bool ignore = true);

        TGUI_DEPRECATED("Use getIgnoreMouseEvents instead") TGUI_NODISCARD bool isIgnoringMouseEvents() const;

        void setParent(Container* parent) override;

        TGUI_NODISCARD bool canGainFocus() const override;

        TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override;

        bool leftMousePressed(Vector2f pos) override;

        void leftMouseReleased(Vector2f pos) override;

        void mouseMoved(Vector2f pos) override;

        bool scrolled(float delta, Vector2f pos, bool touch) override;

        void mouseNoLongerOnWidget() override;

        void leftMouseButtonNoLongerDown() override;

        void draw(BackendRenderTarget& target, RenderStates states) const override;

    protected:

        TGUI_NODISCARD Signal& getSignal(String signalName) override;

        void rendererChanged(const String& property) override;

        TGUI_NODISCARD std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;

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

        void updateTextSize() override;

        // This function is called every frame with the time passed since the last frame.
        bool updateTime(Duration elapsedTime) override;

        void scrollbarPolicyChanged() override;

        virtual void rearrangeText();

        // Called at the end of rearrangeText() to position the text pieces that were created during rearrangeText().
        void updateTextPiecePositions(float maxWidth);

        // Makes a copy of the widget
        TGUI_NODISCARD Widget::Ptr clone() const override;

    public:
 
        SignalString onDoubleClick = {"DoubleClicked"}; 

    protected:
 
        String m_string;
        std::vector<std::vector<Text>> m_lines;
 
        // TGUI_NEXT: Remove "tgui::" prefixes
        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; // TGUI_NEXT: Remove this property
 
        // Will be set to true after the first click, but gets reset to false when the second click does not occur soon after
        bool m_possibleDoubleClick = false;
 
        Sprite    m_spriteBackground;
 
        // Cached renderer properties
        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;

    };

}

 
#endif // TGUI_LABEL_HPP