Text.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_TEXT_HPP
#define TGUI_TEXT_HPP
 
#include <TGUI/Font.hpp>
#include <TGUI/Color.hpp>
#include <TGUI/Vector2.hpp>
#include <TGUI/TextStyle.hpp>
#include <TGUI/RenderStates.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;
        };

        TGUI_NODISCARD static float getExtraHorizontalPadding(const Font& font, unsigned int characterSize);

        TGUI_NODISCARD static float getExtraHorizontalOffset(const Font& font, unsigned int characterSize);

        TGUI_NODISCARD static float getExtraVerticalPadding(unsigned int characterSize);

        TGUI_NODISCARD static float getLineHeight(const Font& font, unsigned int characterSize);

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

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

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

        TGUI_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);

        TGUI_NODISCARD Vector2f getPosition() const;

        TGUI_NODISCARD Vector2f getSize() const;

        void setString(const String& string);

        TGUI_NODISCARD const String& getString() const;

        void setCharacterSize(unsigned int size);

        TGUI_NODISCARD unsigned int getCharacterSize() const;

        void setColor(Color color);

        TGUI_NODISCARD Color getColor() const;

        void setOpacity(float opacity);

        TGUI_NODISCARD float getOpacity() const;

        void setFont(const Font& font);

        TGUI_NODISCARD Font getFont() const;

        void setStyle(TextStyles style);

        TGUI_NODISCARD TextStyles getStyle() const;

        void setOutlineColor(Color color);

        TGUI_NODISCARD Color getOutlineColor() const;

        void setOutlineThickness(float thickness);

        TGUI_NODISCARD float getOutlineThickness() const;

        TGUI_NODISCARD Vector2f findCharacterPos(std::size_t index) const;

        TGUI_NODISCARD float getExtraHorizontalPadding() const;

        TGUI_NODISCARD float getExtraHorizontalOffset() const;

        TGUI_NODISCARD float getLineHeight() const;

        TGUI_NODISCARD float getLineWidth() const;

        TGUI_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;
    };

}

 
#endif // TGUI_TEXT_HPP