Text.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2026 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_TEXT_HPP
#define TGUI_TEXT_HPP
 
#include <TGUI/Color.hpp>
#include <TGUI/Font.hpp>
#include <TGUI/RenderStates.hpp>
#include <TGUI/TextStyle.hpp>
#include <TGUI/Vector2.hpp>

 
namespace tgui
{
    class BackendText;

 
#if TGUI_COMPILED_WITH_CPP_VER >= 20
    // Inline is needed here if we want to build a C++20 module
    inline constexpr unsigned int AutoTextSize = 0xFFFFFFFF;
#else
    constexpr unsigned int AutoTextSize = 0xFFFFFFFF;
#endif

    class TGUI_API Text
    {
    public:
        struct Blueprint
        {
            unsigned int characterSize = 0;
            unsigned int style = 0;
            Color color;
            String link;
            String text;
            Vector2u gapSize;
        };

        [[nodiscard]] static float getExtraHorizontalPadding(const Font& font, unsigned int characterSize);

        [[nodiscard]] static float getExtraHorizontalOffset(const Font& font, unsigned int characterSize);

        [[nodiscard]] static float getExtraVerticalPadding(unsigned int characterSize);

        [[nodiscard]] static float getLineHeight(const Font& font, unsigned int characterSize);

        [[nodiscard]] static float getLineWidth(const String& text, const Font& font, unsigned int characterSize, TextStyles textStyle = {});

        [[nodiscard]] static unsigned int findBestTextSize(const Font& font, float height, int fit = 0);

        [[nodiscard]] static String wordWrap(float maxWidth, const String& text, const Font& font, unsigned int textSize, bool bold);

        [[nodiscard]] static std::vector<std::vector<Blueprint>> wordWrap(float maxWidth,
                                                                          const std::vector<std::vector<Blueprint>>& lines,
                                                                          const Font& font);

 
    public:
        Text();

        // Copy constructor
        Text(const Text&);

        // Move constructor
        Text(Text&&) noexcept = default;

        // Overload of copy assignment operator
        Text& operator=(const Text&);

        // Move assignment operator
        Text& operator=(Text&&) noexcept = default;

        void setPosition(Vector2f position);

        [[nodiscard]] Vector2f getPosition() const;

        [[nodiscard]] Vector2f getSize() const;

        void setString(const String& string);

        [[nodiscard]] const String& getString() const;

        void setCharacterSize(unsigned int size);

        [[nodiscard]] unsigned int getCharacterSize() const;

        void setColor(Color color);

        [[nodiscard]] Color getColor() const;

        void setOpacity(float opacity);

        [[nodiscard]] float getOpacity() const;

        void setFont(const Font& font);

        [[nodiscard]] Font getFont() const;

        void setStyle(TextStyles style);

        [[nodiscard]] TextStyles getStyle() const;

        void setOutlineColor(Color color);

        [[nodiscard]] Color getOutlineColor() const;

        void setOutlineThickness(float thickness);

        [[nodiscard]] float getOutlineThickness() const;

        [[nodiscard]] Vector2f findCharacterPos(std::size_t index) const;

        [[nodiscard]] float getExtraHorizontalPadding() const;

        [[nodiscard]] float getExtraHorizontalOffset() const;

        [[nodiscard]] float getLineHeight() const;

        [[nodiscard]] float getLineWidth() const;

        [[nodiscard]] std::shared_ptr<BackendText> getBackendText() const;

 
    private:
        std::shared_ptr<BackendText> m_backendText;
        Vector2f m_position;
        Font m_font;
        Color m_color;
        Color m_outlineColor;
        float m_opacity = 1;
    };
} // namespace tgui
 
#endif // TGUI_TEXT_HPP