TGUI  0.10-beta
ChatBox.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2022 Bruno Van de Velde (vdv_b@tgui.eu)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25
26#ifndef TGUI_CHAT_BOX_HPP
27#define TGUI_CHAT_BOX_HPP
28
29
30#include <TGUI/CopiedSharedPtr.hpp>
31#include <TGUI/Widgets/Scrollbar.hpp>
32#include <TGUI/Renderers/ChatBoxRenderer.hpp>
33#include <TGUI/Text.hpp>
34#include <deque>
35
37
38namespace tgui
39{
41
42 class TGUI_API ChatBox : public Widget
43 {
44 public:
45
46 typedef std::shared_ptr<ChatBox> Ptr;
47 typedef std::shared_ptr<const ChatBox> ConstPtr;
48
50 protected:
51
52 struct Line
53 {
54 Text text;
55 String string;
56 };
57
58
60 public:
61
69 ChatBox(const char* typeName = "ChatBox", bool initRenderer = true);
70
71
79
80
90
91
97 const ChatBoxRenderer* getSharedRenderer() const;
98
105 const ChatBoxRenderer* getRenderer() const;
106
107
116 void setSize(const Layout2d& size) override;
117 using Widget::setSize;
118
119
130 void addLine(const String& text);
131
132
144 void addLine(const String& text, Color color);
145
146
157 void addLine(const String& text, Color color, TextStyles style);
158
159
170 String getLine(std::size_t lineIndex) const;
171
172
181 Color getLineColor(std::size_t lineIndex) const;
182
183
189 TextStyles getLineTextStyle(std::size_t lineIndex) const;
190
191
201 bool removeLine(std::size_t lineIndex);
202
203
209
210
217 std::size_t getLineAmount();
218
219
229 void setLineLimit(std::size_t maxLines);
230
231
241 std::size_t getLineLimit();
242
243
248 void setTextColor(Color color);
249
250
255 const Color& getTextColor() const;
256
257
263
264
270
271
283 void setLinesStartFromTop(bool startFromTop = true);
284
285
296
297
306 void setNewLinesBelowOthers(bool newLinesBelowOthers = true);
307
308
316
317
323 void setScrollbarValue(unsigned int value);
324
325
331 unsigned int getScrollbarValue() const;
332
333
340 bool isMouseOnWidget(Vector2f pos) const override;
341
345 void leftMousePressed(Vector2f pos) override;
346
350 void leftMouseReleased(Vector2f pos) override;
351
355 void mouseMoved(Vector2f pos) override;
356
360 bool mouseWheelScrolled(float delta, Vector2f pos) override;
361
365 void mouseNoLongerOnWidget() override;
366
370 void leftMouseButtonNoLongerDown() override;
371
372
374 private:
375
377 // Recalculates the text attribute of the line
379 void recalculateLineText(Line& line);
380
381
383 // Recalculates all text attributes, recalculate the full text height and update the displayed text
385 void recalculateAllLines();
386
387
389 // Recalculates the space used by all the lines
391 void recalculateFullTextHeight();
392
393
395 // Updates the position of the lines
397 void updateDisplayedText();
398
399
401 // Updates the position and size of the panel and scrollbar
403 void updateRendering();
404
405
407 protected:
408
416 void draw(BackendRenderTarget& target, RenderStates states) const override;
417
418
425 void rendererChanged(const String& property) override;
426
427
431 std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
432
433
437 void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
438
439
443 void updateTextSize() override;
444
445
447 // Returns the size without the borders
449 Vector2f getInnerSize() const;
450
451
453 // Makes a copy of the widget
455 Widget::Ptr clone() const override;
456
457
459 protected:
460
461 Color m_textColor = Color::Black;
462 TextStyles m_textStyle;
463
464 std::size_t m_maxLines = 0;
465
466 float m_fullTextHeight = 0;
467
468 bool m_linesStartFromTop = false;
469 bool m_newLinesBelowOthers = true;
470
472
473 std::deque<Line> m_lines;
474
475 Sprite m_spriteBackground;
476
477 // Cached renderer properties
478 Borders m_bordersCached;
479 Padding m_paddingCached;
480 Color m_backgroundColorCached;
481 Color m_borderColorCached;
482
484 };
485
487}
488
490
491#endif // TGUI_TEXT_BOX_HPP
Base class for render targets.
Definition: BackendRenderTarget.hpp:48
Definition: ChatBoxRenderer.hpp:37
Definition: ChatBox.hpp:43
unsigned int getScrollbarValue() const
Returns the thumb position of the scrollbar.
std::size_t getLineAmount()
Returns the amount of lines in the chat box.
void rendererChanged(const String &property) override
Function called when one of the properties of the renderer is changed.
void load(const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
Loads the widget from a tree of nodes.
static ChatBox::Ptr copy(ChatBox::ConstPtr chatBox)
Makes a copy of another chat box.
ChatBoxRenderer * getRenderer()
Returns the renderer, which gives access to functions that determine how the widget is displayed.
void removeAllLines()
Removes all lines from the chat box.
bool getLinesStartFromTop() const
Returns whether the first lines start from the top or from the bottom of the chat box.
static ChatBox::Ptr create()
Creates a new chat box widget.
std::shared_ptr< const ChatBox > ConstPtr
Shared constant widget pointer.
Definition: ChatBox.hpp:47
void setLinesStartFromTop(bool startFromTop=true)
Lets the first lines start from the top or from the bottom of the chat box.
void addLine(const String &text, Color color)
Adds a new line of text to the chat box.
std::size_t getLineLimit()
Returns the maximum amount of lines in the chat box.
void addLine(const String &text, Color color, TextStyles style)
Adds a new line of text to the chat box.
const Color & getTextColor() const
Returns the default color of the text.
std::unique_ptr< DataIO::Node > save(SavingRenderersMap &renderers) const override
Saves the widget as a tree node in order to save it to a file.
bool isMouseOnWidget(Vector2f pos) const override
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget...
void addLine(const String &text)
Adds a new line of text to the chat box.
bool getNewLinesBelowOthers() const
Returns whether new lines are added below the other lines or above them.
void updateTextSize() override
Called when the text size is changed (either by setTextSize or via the renderer)
Color getLineColor(std::size_t lineIndex) const
Returns the color of the requested line.
void setSize(const Layout2d &size) override
Changes the size of the chat box.
void setNewLinesBelowOthers(bool newLinesBelowOthers=true)
Sets whether new lines are added below the other lines or above them.
ChatBoxRenderer * getSharedRenderer()
Returns the renderer, which gives access to functions that determine how the widget is displayed.
void draw(BackendRenderTarget &target, RenderStates states) const override
Draw the widget to a render target.
TextStyles getTextStyle() const
Returns the default text style.
std::shared_ptr< ChatBox > Ptr
Shared widget pointer.
Definition: ChatBox.hpp:46
TextStyles getLineTextStyle(std::size_t lineIndex) const
Returns the text style of the requested line.
void setScrollbarValue(unsigned int value)
Changes the thumb position of the scrollbar.
void setTextColor(Color color)
Changes the default color of the text.
void setTextStyle(TextStyles style)
Changes the default text style.
String getLine(std::size_t lineIndex) const
Returns the contents of the requested line.
void setLineLimit(std::size_t maxLines)
Sets a maximum amount of lines in the chat box.
bool removeLine(std::size_t lineIndex)
Removes the requested line.
Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
Wrapper for colors.
Definition: Color.hpp:63
static const Color Black
Black predefined color.
Definition: Color.hpp:253
Definition: CopiedSharedPtr.hpp:40
Class to store the position or size of a widget.
Definition: Layout.hpp:284
Definition: Outline.hpp:39
Definition: Sprite.hpp:45
Wrapper class to store strings.
Definition: String.hpp:79
Wrapper for text styles.
Definition: TextStyle.hpp:58
Definition: Text.hpp:48
The parent class for every widget.
Definition: Widget.hpp:70
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition: Widget.hpp:73
virtual void setSize(const Layout2d &size)
Changes the size of the widget.
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:36
Definition: ChatBox.hpp:53
States used for drawing.
Definition: RenderStates.hpp:39