ChatBox.hpp

 
//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012-2017 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/Widget.hpp>
#include <TGUI/Widgets/Panel.hpp>
#include <TGUI/Widgets/Scrollbar.hpp>
 
#include <deque>
 
 
namespace tgui
{
 class Scrollbar;
 class ChatBoxRenderer;
 
 
 class TGUI_API ChatBox : public Widget
 {
 public:
 
 typedef std::shared_ptr<ChatBox> Ptr; 
 typedef std::shared_ptr<const ChatBox> ConstPtr; 
 
 
 protected:
 
 struct Line
 {
 sf::Text text;
 sf::String string;
 unsigned int sublines = 1;
 std::shared_ptr<sf::Font> font;
 };
 
 
 public:
 
 // Default constructor
 ChatBox();
 
 
 ChatBox(const ChatBox& copy);
 
 
 ChatBox& operator= (const ChatBox& right);
 
 
 static ChatBox::Ptr create();
 
 
 static ChatBox::Ptr copy(ChatBox::ConstPtr chatBox);
 
 
 std::shared_ptr<ChatBoxRenderer> getRenderer() const
 {
 return std::static_pointer_cast<ChatBoxRenderer>(m_renderer);
 }
 
 
 void setSize(const Layout2d& size) override;
 using Transformable::setSize;
 
 
 virtual sf::Vector2f getFullSize() const override;
 
 
 void addLine(const sf::String& text);
 
 
 void addLine(const sf::String& text, unsigned int textSize);
 
 
 void addLine(const sf::String& text, const sf::Color& color);
 
 
 void addLine(const sf::String& text, const sf::Color& color, unsigned int textSize, const Font& font = nullptr);
 
 
 sf::String getLine(std::size_t lineIndex) const;
 
 
 sf::Color getLineColor(std::size_t lineIndex) const;
 
 
 unsigned int getLineTextSize(std::size_t lineIndex) const;
 
 
 std::shared_ptr<sf::Font> getLineFont(std::size_t lineIndex) const;
 
 
 bool removeLine(std::size_t lineIndex);
 
 
 void removeAllLines();
 
 
 std::size_t getLineAmount();
 
 
 void setLineLimit(std::size_t maxLines);
 
 
 std::size_t getLineLimit();
 
 
 virtual void setFont(const Font& font) override;
 
 
 void setTextSize(unsigned int size);
 
 
 unsigned int getTextSize() const
 {
 return m_textSize;
 }
 
 
 void setTextColor(const Color& color);
 
 
 const sf::Color& getTextColor() const
 {
 return m_textColor;
 }
 
 
 void setScrollbar(Scrollbar::Ptr scrollbar);
 
 
 Scrollbar::Ptr getScrollbar() const;
 
 
 void setLinesStartFromTop(bool startFromTop = true);
 
 
 bool getLinesStartFromTop() const;
 
 
 void setNewLinesBelowOthers(bool newLinesBelowOthers = true);
 
 
 bool getNewLinesBelowOthers() const;
 
 
 virtual void setOpacity(float opacity) override;
 
 
 virtual sf::Vector2f getWidgetOffset() const override;
 
 
 virtual void setParent(Container* parent) override;
 
 
 virtual bool mouseOnWidget(float x, float y) const override;
 
 virtual void leftMousePressed(float x, float y) override;
 
 virtual void leftMouseReleased(float x, float y) override;
 
 virtual void mouseMoved(float x, float y) override;
 
 virtual void mouseWheelMoved(int delta, int x, int y) override;
 
 virtual void mouseNoLongerOnWidget() override;
 
 virtual void mouseNoLongerDown() 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:
 
 virtual void reload(const std::string& primary = "", const std::string& secondary = "", bool force = false) override;
 
 
 // Makes a copy of the widget
 virtual Widget::Ptr clone() const override
 {
 return std::make_shared<ChatBox>(*this);
 }
 
 
 // Draws the widget on the render target.
 virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
 
 
 protected:
 
 unsigned int m_textSize = 18;
 sf::Color m_textColor = sf::Color::Black;
 
 std::size_t m_maxLines = 0;
 
 float m_fullTextHeight = 0;
 
 bool m_linesStartFromTop = false;
 bool m_newLinesBelowOthers = true;
 
 Scrollbar::Ptr m_scroll = std::make_shared<Scrollbar>();
 
 std::deque<Line> m_lines;
 
 friend class ChatBoxRenderer;
 
 };
 
 
 
 class TGUI_API ChatBoxRenderer : public WidgetRenderer, public WidgetBorders, public WidgetPadding
 {
 public:
 
 ChatBoxRenderer(ChatBox* chatBox) : m_chatBox{chatBox} {}
 
 
 virtual void setProperty(std::string property, const std::string& value) override;
 
 
 virtual void setProperty(std::string property, ObjectConverter&& value) override;
 
 
 virtual ObjectConverter getProperty(std::string property) const override;
 
 
 virtual std::map<std::string, ObjectConverter> getPropertyValuePairs() const override;
 
 
 void setBorderColor(const Color& borderColor);
 
 
 void setBackgroundColor(const Color& backgroundColor);
 
 
 void setBackgroundTexture(const Texture& texture);
 
 
 void setPadding(const Padding& padding) override;
 using WidgetPadding::setPadding;
 
 
 // Draws the widget on the render target.
 void draw(sf::RenderTarget& target, sf::RenderStates states) const;
 
 
 private:
 
 // Returns the padding, which is possibly scaled with the background image.
 Padding getScaledPadding() const;
 
 
 // Makes a copy of the renderer
 virtual std::shared_ptr<WidgetRenderer> clone(Widget* widget) override;
 
 
 protected:
 
 ChatBox* m_chatBox;
 
 sf::Color m_borderColor;
 sf::Color m_backgroundColor;
 
 Texture m_backgroundTexture;
 
 friend class ChatBox;
 };
 
}
 
 
#endif // TGUI_TEXT_BOX_HPP