TGUI  0.9.1
Label.hpp
1 //
3 // TGUI - Texus' Graphical User Interface
4 // Copyright (C) 2012-2021 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_LABEL_HPP
27 #define TGUI_LABEL_HPP
28 
29 
30 #include <TGUI/Widgets/ClickableWidget.hpp>
31 #include <TGUI/Renderers/LabelRenderer.hpp>
32 #include <TGUI/CopiedSharedPtr.hpp>
33 #include <TGUI/Widgets/Scrollbar.hpp>
34 #include <TGUI/Text.hpp>
35 
37 
38 namespace tgui
39 {
43  class TGUI_API Label : public ClickableWidget
44  {
45  public:
46 
47  typedef std::shared_ptr<Label> Ptr;
48  typedef std::shared_ptr<const Label> ConstPtr;
49 
54  {
55  Left,
56  Center,
57  Right
58  };
59 
60 
64  enum class VerticalAlignment
65  {
66  Top ,
67  Center,
68  Bottom
69  };
70 
71 
79  Label(const char* typeName = "Label", bool initRenderer = true);
80 
81 
90  static Label::Ptr create(String text = "");
91 
92 
102 
103 
109  const LabelRenderer* getSharedRenderer() const;
110 
117  const LabelRenderer* getRenderer() const;
118 
119 
135  void setSize(const Layout2d& size) override;
136  using Widget::setSize;
137 
138 
149  void setText(const String& text);
150 
151 
158  const String& getText() const;
159 
160 
167  void setTextSize(unsigned int size) override;
168 
169 
179 
180 
188 
189 
199 
200 
208 
209 
215 
216 
222 
223 
235  void setAutoSize(bool autoSize);
236 
237 
244  bool getAutoSize() const;
245 
246 
259  void setMaximumTextWidth(float maximumWidth);
260 
261 
271  float getMaximumTextWidth() const;
272 
273 
281  void ignoreMouseEvents(bool ignore = true);
282 
283 
289  bool isIgnoringMouseEvents() const;
290 
291 
297  void setParent(Container* parent) override;
298 
299 
306  bool canGainFocus() const override;
307 
308 
313  bool isMouseOnWidget(Vector2f pos) const override;
314 
315 
317  void leftMousePressed(Vector2f pos) override;
318 
320  void leftMouseReleased(Vector2f pos) override;
321 
323  void mouseMoved(Vector2f pos) override;
324 
326  bool mouseWheelScrolled(float delta, Vector2f pos) override;
327 
329  void mouseNoLongerOnWidget() override;
330 
332  void leftMouseButtonNoLongerDown() override;
333 
334 
342  void draw(BackendRenderTargetBase& target, RenderStates states) const override;
343 
344 
346  protected:
347 
357  Signal& getSignal(String signalName) override;
358 
359 
366  void rendererChanged(const String& property) override;
367 
368 
372  std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
373 
374 
378  void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
379 
380 
382  // This function is called every frame with the time passed since the last frame.
384  bool updateTime(Duration elapsedTime) override;
385 
386 
388  // Rearrange the text, making use of the given size of maximum text width.
390  void rearrangeText();
391 
392 
394  // Makes a copy of the widget
396  Widget::Ptr clone() const override
397  {
398  return std::make_shared<Label>(*this);
399  }
400 
401 
403  public:
404 
405  SignalString onDoubleClick = {"DoubleClicked"};
406 
407 
409  protected:
410 
411  String m_string;
412  std::vector<Text> m_lines;
413 
414  HorizontalAlignment m_horizontalAlignment = HorizontalAlignment::Left;
415  VerticalAlignment m_verticalAlignment = VerticalAlignment::Top;
416 
417  bool m_autoSize = true;
418 
419  float m_maximumTextWidth = 0;
420 
421  bool m_ignoringMouseEvents = false;
422 
423  // Will be set to true after the first click, but gets reset to false when the second click does not occur soon after
424  bool m_possibleDoubleClick = false;
425 
428 
429  Sprite m_spriteBackground;
430 
431  // Cached renderer properties
432  Borders m_bordersCached;
433  Padding m_paddingCached;
434  TextStyles m_textStyleCached;
435  Color m_textColorCached;
436  Color m_borderColorCached;
437  Color m_backgroundColorCached;
438  Color m_textOutlineColorCached;
439  float m_textOutlineThicknessCached = 0;
440 
442  };
443 
445 }
446 
448 
449 #endif // TGUI_LABEL_HPP
Base class for render targets.
Definition: BackendRenderTarget.hpp:48
Clickable widget.
Definition: ClickableWidget.hpp:40
Wrapper for colors.
Definition: Color.hpp:52
Container widget.
Definition: Container.hpp:47
Definition: CopiedSharedPtr.hpp:40
Wrapper for durations.
Definition: Duration.hpp:52
Definition: LabelRenderer.hpp:37
Label widget.
Definition: Label.hpp:44
const String & getText() const
Returns the text.
void setTextSize(unsigned int size) override
Changes the character size of the text.
bool canGainFocus() const override
Returns whether the widget can gain focus.
void setAutoSize(bool autoSize)
Changes whether the label is auto-sized or not.
HorizontalAlignment getHorizontalAlignment() const
Gets the current horizontal text alignment.
void setMaximumTextWidth(float maximumWidth)
Changes the maximum width that the text will have when auto-sizing.
void setScrollbarPolicy(Scrollbar::Policy policy)
Changes when the vertical scrollbar should be displayed.
Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
Definition: Label.hpp:396
VerticalAlignment
The vertical text alignment.
Definition: Label.hpp:65
Signal & getSignal(String signalName) override
Retrieves a signal based on its name.
void ignoreMouseEvents(bool ignore=true)
Sets whether the widget should completely ignore mouse events and let them pass to the widgets behind...
void load(const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
Loads the widget from a tree of nodes.
float getMaximumTextWidth() const
Returns the maximum width that the text will have.
void draw(BackendRenderTargetBase &target, RenderStates states) const override
Draw the widget to a render target.
void setVerticalAlignment(VerticalAlignment alignment)
Changes the vertical text alignment.
bool isIgnoringMouseEvents() const
Returns whether the widget is ignoring mouse events and letting them pass to the widgets behind it.
std::shared_ptr< const Label > ConstPtr
Shared constant widget pointer.
Definition: Label.hpp:48
static Label::Ptr copy(Label::ConstPtr label)
Makes a copy of another label.
void setText(const String &text)
Changes the text.
std::shared_ptr< Label > Ptr
Shared widget pointer.
Definition: Label.hpp:47
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 getAutoSize() const
Returns whether the label is auto-sized or not.
LabelRenderer * getRenderer()
Returns the renderer, which gives access to functions that determine how the widget is displayed.
VerticalAlignment getVerticalAlignment() const
Gets the current vertical text alignment.
Scrollbar::Policy getScrollbarPolicy() const
Returns when the vertical scrollbar should be displayed.
LabelRenderer * getSharedRenderer()
Returns the renderer, which gives access to functions that determine how the widget is displayed.
void setSize(const Layout2d &size) override
Changes the area of the text that will be drawn.
static Label::Ptr create(String text="")
Creates a new label widget.
void rendererChanged(const String &property) override
Function called when one of the properties of the renderer is changed.
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 setHorizontalAlignment(HorizontalAlignment alignment)
Changes the horizontal text alignment.
HorizontalAlignment
The horizontal text alignment.
Definition: Label.hpp:54
Class to store the position or size of a widget.
Definition: Layout.hpp:262
Definition: Outline.hpp:39
Policy
Defines when the scrollbar shows up.
Definition: Scrollbar.hpp:50
@ Automatic
Show the scrollbar only when needed (default)
Signal to which the user can subscribe to get callbacks from.
Definition: Signal.hpp:58
Definition: Sprite.hpp:49
Wrapper class to store strings.
Definition: String.hpp:74
Wrapper for text styles.
Definition: TextStyle.hpp:58
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
States used for drawing.
Definition: RenderStates.hpp:39