ChatBox.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_CHAT_BOX_HPP
#define TGUI_CHAT_BOX_HPP
 
#include <TGUI/Widgets/Scrollbar.hpp>
#include <TGUI/Renderers/ChatBoxRenderer.hpp>
#include <TGUI/Text.hpp>
 
#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
    #include <deque>
#endif

 
TGUI_MODULE_EXPORT namespace tgui
{
 
    class TGUI_API ChatBox : public Widget, public ScrollbarChildInterface
    {
    public:
 
        using Ptr = std::shared_ptr<ChatBox>; 
        using ConstPtr = std::shared_ptr<const ChatBox>; 
 
        static constexpr const char StaticWidgetType[] = "ChatBox"; 
 
        struct Line
        {
            Text text;
            String string;
        };

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

        TGUI_NODISCARD static ChatBox::Ptr create();

        TGUI_NODISCARD static ChatBox::Ptr copy(const ChatBox::ConstPtr& chatBox);

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

        TGUI_NODISCARD ChatBoxRenderer* getRenderer() override;

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

        void addLine(const String& text);

        void addLine(const String& text, Color color);

        void addLine(const String& text, Color color, TextStyles style);

        TGUI_NODISCARD String getLine(std::size_t lineIndex) const;

        TGUI_NODISCARD Color getLineColor(std::size_t lineIndex) const;

        TGUI_NODISCARD TextStyles getLineTextStyle(std::size_t lineIndex) const;

        bool removeLine(std::size_t lineIndex);

        void removeAllLines();

        TGUI_NODISCARD std::size_t getLineAmount() const;

        void setLineLimit(std::size_t maxLines);

        TGUI_NODISCARD std::size_t getLineLimit() const;

        void setTextColor(Color color);

        TGUI_NODISCARD const Color& getTextColor() const;

        void setTextStyle(TextStyles style);

        TGUI_NODISCARD TextStyles getTextStyle() const;

        void setLinesStartFromTop(bool startFromTop = true);

        TGUI_NODISCARD bool getLinesStartFromTop() const;

        void setNewLinesBelowOthers(bool newLinesBelowOthers = true);

        TGUI_NODISCARD bool getNewLinesBelowOthers() 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;

        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;

    private:

        // Recalculates the text attribute of the line
        void recalculateLineText(Line& line);

        // Recalculates all text attributes, recalculate the full text height and update the displayed text
        void recalculateAllLines();

        // Recalculates the space used by all the lines
        void recalculateFullTextHeight();

        // Updates the position of the lines
        void updateDisplayedText();

        // Updates the position and size of the panel and scrollbar
        void updateRendering();

    protected:

        void draw(BackendRenderTarget& target, RenderStates states) const 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;

        // Returns the size without the borders
        TGUI_NODISCARD Vector2f getInnerSize() const;

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

    protected:
 
        Color m_textColor = Color::Black;
        TextStyles m_textStyle;
 
        std::size_t m_maxLines = 0;
 
        float m_fullTextHeight = 0;
 
        bool m_linesStartFromTop = false;
        bool m_newLinesBelowOthers = true;
 
        std::deque<Line> m_lines;
 
        Sprite m_spriteBackground;
 
        // Cached renderer properties
        Borders m_bordersCached;
        Padding m_paddingCached;
        Color   m_backgroundColorCached;
        Color   m_borderColorCached;

    };

}

 
#endif // TGUI_TEXT_BOX_HPP