TGUI  0.8.5
ChildWindow.hpp
1 //
3 // TGUI - Texus' Graphical User Interface
4 // Copyright (C) 2012-2019 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_CHILD_WINDOW_HPP
27 #define TGUI_CHILD_WINDOW_HPP
28 
29 
30 #include <TGUI/CopiedSharedPtr.hpp>
31 #include <TGUI/Container.hpp>
32 #include <TGUI/Widgets/Button.hpp>
33 #include <TGUI/Renderers/ChildWindowRenderer.hpp>
34 #include <limits>
35 
37 
38 namespace tgui
39 {
43  class TGUI_API ChildWindow : public Container
44  {
45  public:
46 
47  typedef std::shared_ptr<ChildWindow> Ptr;
48  typedef std::shared_ptr<const ChildWindow> ConstPtr;
49 
50 
52  enum class TitleAlignment
53  {
54  Left,
55  Center,
56  Right
57  };
58 
59 
62  {
63  None = 0,
64  Close = 1 << 0,
65  Maximize = 1 << 1,
66  Minimize = 1 << 2
67  };
68 
70  // Default constructor
72  ChildWindow(const sf::String& title = "", unsigned int titleButtons = TitleButton::Close);
73 
74 
81  static ChildWindow::Ptr create(const sf::String& title = "", unsigned int titleButtons = TitleButton::Close);
82 
83 
92  static ChildWindow::Ptr copy(ChildWindow::ConstPtr childWindow);
93 
94 
99  ChildWindowRenderer* getSharedRenderer();
100  const ChildWindowRenderer* getSharedRenderer() const;
101 
107  ChildWindowRenderer* getRenderer();
108  const ChildWindowRenderer* getRenderer() const;
109 
110 
123  void setPosition(const Layout2d& position) override;
124  using Widget::setPosition;
125 
126 
135  void setSize(const Layout2d& size) override;
136  using Widget::setSize;
137 
138 
147  Vector2f getFullSize() const override;
148 
149 
159  void setMaximumSize(Vector2f size);
160 
161 
170  Vector2f getMaximumSize() const;
171 
172 
182  void setMinimumSize(Vector2f size);
183 
184 
193  Vector2f getMinimumSize() const;
194 
195 
202  void setTitle(const sf::String& title);
203 
204 
211  const sf::String& getTitle() const;
212 
213 
219  void setTitleTextSize(unsigned int size);
220 
221 
226  unsigned int getTitleTextSize() const;
227 
228 
235  void setTitleAlignment(TitleAlignment alignment);
236 
237 
244  TitleAlignment getTitleAlignment() const;
245 
246 
259  void setTitleButtons(unsigned int buttons);
260 
261 
268  unsigned int getTitleButtons() const;
269 
270 
276  void close();
277 
278 
287  void destroy();
288 
289 
296  void setResizable(bool resizable = true);
297 
298 
305  bool isResizable() const;
306 
307 
314  void setPositionLocked(bool positionLocked = true);
315 
316 
321  bool isPositionLocked() const;
322 
323 
331  void setKeepInParent(bool enabled = true);
332 
333 
341  bool isKeptInParent() const;
342 
343 
351  Vector2f getChildWidgetsOffset() const override;
352 
353 
359  void setParent(Container* parent) override;
360 
361 
368  bool mouseOnWidget(Vector2f pos) const override;
369 
373  void leftMousePressed(Vector2f pos) override;
374 
378  void leftMouseReleased(Vector2f pos) override;
379 
383  void mouseMoved(Vector2f pos) override;
384 
388  void keyPressed(const sf::Event::KeyEvent& event) override;
389 
393  void mouseNoLongerOnWidget() override;
394 
398  void mouseNoLongerDown() override;
399 
400 
408  void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
409 
410 
412  protected:
413 
415  // Updates the title bar texture, text and buttons after the title bar height has changed.
417  void updateTitleBarHeight();
418 
419 
429  Signal& getSignal(std::string signalName) override;
430 
431 
438  void rendererChanged(const std::string& property) override;
439 
440 
444  std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
445 
446 
450  void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
451 
452 
454  // Makes a copy of the widget
456  Widget::Ptr clone() const override
457  {
458  return std::make_shared<ChildWindow>(*this);
459  }
460 
461 
463  public:
464 
465  Signal onMousePress = {"MousePressed"};
466  SignalChildWindow onClose = {"Closed"};
467  SignalChildWindow onMinimize = {"Minimized"};
468  SignalChildWindow onMaximize = {"Maximized"};
469  SignalChildWindow onEscapeKeyPressed = {"EscapeKeyPressed"};
470 
471 
473  protected:
474 
475  enum ResizeDirection
476  {
477  ResizeNone = 0,
478  ResizeLeft = 1,
479  ResizeTop = 2,
480  ResizeRight = 4,
481  ResizeBottom = 8
482  };
483 
484 
486  protected:
487 
488  Text m_titleText;
489  Vector2f m_draggingPosition;
490  Vector2f m_maximumSize = {std::numeric_limits<float>::infinity(), std::numeric_limits<float>::infinity()};
491  Vector2f m_minimumSize = {0, 0};
492  TitleAlignment m_titleAlignment = TitleAlignment::Center;
493  unsigned int m_titleButtons = TitleButton::Close;
494  unsigned int m_titleTextSize = 0;
495 
496  CopiedSharedPtr<Button> m_closeButton;
497  CopiedSharedPtr<Button> m_minimizeButton;
498  CopiedSharedPtr<Button> m_maximizeButton;
499 
500  bool m_mouseDownOnTitleBar = false;
501  bool m_keepInParent = false;
502 
503  bool m_positionLocked = false;
504  bool m_resizable = false;
505  int m_resizeDirection = ResizeNone;
506 
507  Sprite m_spriteTitleBar;
508 
509  // Cached renderer properties
510  Borders m_bordersCached;
511  Color m_borderColorCached;
512  Color m_borderColorFocusedCached;
513  Color m_titleColorCached;
514  Color m_titleBarColorCached;
515  Color m_backgroundColorCached;
516  float m_titleBarHeightCached = 20;
517  float m_borderBelowTitleBarCached = 0;
518  float m_distanceToSideCached = 0;
519  float m_paddingBetweenButtonsCached = 0;
520  float m_minimumResizableBorderWidthCached = 5;
521  bool m_showTextOnTitleButtonsCached = false;
522 
524  };
525 
527 }
528 
530 
531 #endif // TGUI_CHILD_WINDOW_HPP
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:36
Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
Definition: ChildWindow.hpp:456
Child window widget.
Definition: ChildWindow.hpp:43
Class to store the position or size of a widget.
Definition: Layout.hpp:258
Definition: Vector2f.hpp:37
virtual void setPosition(const Layout2d &position)
sets the position of the widget
TitleButton
Title buttons (use bitwise OR to combine)
Definition: ChildWindow.hpp:61
virtual void setSize(const Layout2d &size)
Changes the size of the widget.
std::shared_ptr< ChildWindow > Ptr
Shared widget pointer.
Definition: ChildWindow.hpp:47
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition: Widget.hpp:76
Container widget.
Definition: Container.hpp:47
Signal to which the user can subscribe to get callbacks from.
Definition: Signal.hpp:59
Signal to which the user can subscribe to get callbacks from.
Definition: Signal.hpp:404
Definition: ChildWindowRenderer.hpp:36
std::shared_ptr< const ChildWindow > ConstPtr
Shared constant widget pointer.
Definition: ChildWindow.hpp:48
TitleAlignment
Title alignments, possible options for the setTitleAlignment function.
Definition: ChildWindow.hpp:52