RichTextLabel.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2024 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_RICH_TEXT_LABEL_HPP
#define TGUI_RICH_TEXT_LABEL_HPP
 
#include <TGUI/Widgets/Label.hpp>
 
 
TGUI_MODULE_EXPORT namespace tgui
{
    class TGUI_API RichTextLabel : public Label
    {
    public:
 
        using Ptr = std::shared_ptr<RichTextLabel>; 
        using ConstPtr = std::shared_ptr<const RichTextLabel>; 
 
        static constexpr const char StaticWidgetType[] = "RichTextLabel"; 
 
        RichTextLabel(const char* typeName = StaticWidgetType, bool initRenderer = true);
 
        TGUI_NODISCARD static RichTextLabel::Ptr create(const String& text = "");
 
        TGUI_NODISCARD static RichTextLabel::Ptr copy(const RichTextLabel::ConstPtr& label);
 
        void draw(BackendRenderTarget& target, RenderStates states) const override;
 
    protected:
 
        virtual void constructRichLineBlueprints(std::vector<std::vector<Text::Blueprint>>& textPiecesLines, std::vector<Texture>& images);
 
        void rendererChanged(const String& property) override;
 
        void rearrangeText() override;
 
        // Helper function used by rearrangeText() to calculate the height of a single line
        float calculateLineSpacing(const std::vector<Text::Blueprint>& line, float defaultLineSpacing);
 
        // Helper function used by rearrangeText() to calculate the total height of all lines
        float calculateTextHeight(const std::vector<std::vector<Text::Blueprint>>& textPiecesLines, float defaultLineSpacing);
 
        // Makes a copy of the widget
        TGUI_NODISCARD Widget::Ptr clone() const override;
 
    protected:
 
        std::vector<Sprite> m_images;
 
    };
 
}
 
 
#endif // TGUI_RICH_TEXT_LABEL_HPP