TGUI  1.5
Loading...
Searching...
No Matches
Container.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2024 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#ifndef TGUI_CONTAINER_HPP
26#define TGUI_CONTAINER_HPP
27
28#include <TGUI/Widget.hpp>
29
30#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
31 #include <list>
32#endif
33
35
36TGUI_MODULE_EXPORT namespace tgui
37{
47 class TGUI_API Container : public Widget
48 {
49 public:
50
51 using Ptr = std::shared_ptr<Container>;
52 using ConstPtr = std::shared_ptr<const Container>;
53
61 Container(const char* typeName, bool initRenderer);
62
66 Container(const Container& copy);
67
71 Container(Container&& copy) noexcept;
72
76 ~Container() override;
77
81 Container& operator= (const Container& right);
82
86 Container& operator= (Container&& right) noexcept;
87
92 void setSize(const Layout2d& size) override;
93 using Widget::setSize;
94
100 TGUI_NODISCARD const std::vector<Widget::Ptr>& getWidgets() const
101 {
102 return m_widgets;
103 }
104
111 template<typename Function>
112 void sortWidgets(Function&& function)
113 {
114 std::sort(m_widgets.begin(), m_widgets.end(), std::forward<Function>(function));
115 }
116
128 virtual void add(const Widget::Ptr& widgetPtr, const String& widgetName = "");
129
142 TGUI_NODISCARD Widget::Ptr get(const String& widgetName) const;
143
157 template <class WidgetType>
158 TGUI_NODISCARD typename WidgetType::Ptr get(const String& widgetName) const
159 {
160 return std::dynamic_pointer_cast<WidgetType>(get(widgetName));
161 }
162
170 virtual bool remove(const Widget::Ptr& widget);
171
175 virtual void removeAllWidgets();
176
181 TGUI_NODISCARD virtual Vector2f getInnerSize() const;
182
189 TGUI_NODISCARD virtual Vector2f getChildWidgetsOffset() const
190 {
191 return Vector2f{0, 0};
192 }
193
202 void loadWidgetsFromFile(const String& filename, bool replaceExisting = true);
203
211 void saveWidgetsToFile(const String& filename);
212
219 void loadWidgetsFromStream(std::stringstream& stream, bool replaceExisting = true);
220
227 void loadWidgetsFromStream(std::stringstream&& stream, bool replaceExisting = true);
228
235 void saveWidgetsToStream(std::stringstream& stream, const String& rootDirectory = "") const;
236
247 void loadWidgetsFromNodeTree(const std::unique_ptr<DataIO::Node>& rootNode, bool replaceExisting = true);
248
260 TGUI_NODISCARD std::unique_ptr<DataIO::Node> saveWidgetsToNodeTree(const String& rootDirectory = "") const;
261
269 void moveWidgetToFront(const Widget::Ptr& widget);
270
278 void moveWidgetToBack(const Widget::Ptr& widget);
279
290 std::size_t moveWidgetForward(const Widget::Ptr& widget);
291
302 std::size_t moveWidgetBackward(const Widget::Ptr& widget);
303
314 virtual bool setWidgetIndex(const Widget::Ptr& widget, std::size_t index);
315
321 TGUI_NODISCARD int getWidgetIndex(const Widget::Ptr& widget) const;
322
331 TGUI_NODISCARD Widget::Ptr getFocusedChild() const;
332
341 TGUI_NODISCARD Widget::Ptr getFocusedLeaf() const;
342
343#ifndef TGUI_REMOVE_DEPRECATED_CODE
353 TGUI_DEPRECATED("Use getWidgetAtPos instead") TGUI_NODISCARD virtual Widget::Ptr getWidgetAtPosition(Vector2f pos) const;
354#endif
367 TGUI_NODISCARD virtual Widget::Ptr getWidgetAtPos(Vector2f pos, bool recursive) const;
368
377 bool focusNextWidget(bool recursive = true);
378
387 bool focusPreviousWidget(bool recursive = true);
388
397 void setFocused(bool focused) override;
398
405
413
421
429 bool processScrollEvent(float delta, Vector2f pos, bool touch);
430
437
443 bool processTextEnteredEvent(char32_t key);
444
449 void childWidgetFocused(const Widget::Ptr& child);
450
454 bool leftMousePressed(Vector2f pos) override;
455
459 void rightMousePressed(Vector2f pos) override;
460
464 void leftMouseReleased(Vector2f pos) override;
465
469 void rightMouseReleased(Vector2f pos) override;
470
474 void mouseMoved(Vector2f pos) override;
475
479 void keyPressed(const Event::KeyEvent& event) override;
480
490 bool canHandleKeyPress(const Event::KeyEvent& event) override;
491
495 void textEntered(char32_t key) override;
496
500 bool scrolled(float delta, Vector2f pos, bool touch) override;
501
505 void mouseNoLongerOnWidget() override;
506
510 void leftMouseButtonNoLongerDown() override;
511
515 void rightMouseButtonNoLongerDown() override;
516
519 // Shows the tool tip when the widget is located below the mouse.
520 // Returns its tool tip or the tool tip from a child widget if the mouse is on top of the widget.
521 // A nullptr is returned when the mouse is not on top of the widget or when the tool tip is empty.
523 TGUI_NODISCARD Widget::Ptr askToolTip(Vector2f mousePos) override;
524
527 // This function is called every frame with the time passed since the last frame.
529 bool updateTime(Duration elapsedTime) override;
530
535 void setParent(Container* parent) override;
536
541 void setParentGui(BackendGui* gui);
542
548 void updateChildrenWithAutoLayout();
549
551 protected:
552
558 void rendererChanged(const String& property) override;
559
566 void draw(BackendRenderTarget& target, RenderStates states) const override;
567
571 TGUI_NODISCARD std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
572
576 void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
577
581 void updateTextSize() override;
582
584 // Checks above which widget the mouse is standing.
585 // If there is no widget below the mouse then this function will return a null pointer.
587 TGUI_NODISCARD Widget::Ptr getWidgetBelowMouse(Vector2f mousePos) const;
588
590 // Checks which widget is below the mouse and updates the cached value.
591 // Note that a nullptr is stored and returned if the widget that is found by getWidgetBelowMouse is disabled.
593 Widget::Ptr updateWidgetBelowMouse(Vector2f mousePos);
594
596 // Find out what the index of the focused widget is. Returns 0 when no widget is focused and index+1 otherwise.
598 TGUI_NODISCARD std::size_t getFocusedWidgetIndex() const;
599
601 // Try to focus the given child widget
603 bool tryFocusWidget(const Widget::Ptr &widget, bool reverseWidgetOrder, bool recursive);
604
606 // Transform the mouse position for the child widget based its origin, rotation and scaling.
608 TGUI_NODISCARD Vector2f transformMousePos(const Widget::Ptr& widget, Vector2f mousePos) const;
609
611 // Finishes adding a widget to the container
613 void widgetAdded(const Widget::Ptr& widgetPtr);
614
616 // Turns texture and font filenames into paths relative to the form file
618 void injectFormFilePath(const std::unique_ptr<DataIO::Node>& node, const String& path, std::map<String, bool>& checkedFilenames) const;
619
621 // Mutual code in loadWidgetsFromFile and loadWidgetsFromStream
623 void loadWidgetsImpl(const std::unique_ptr<DataIO::Node>& rootNode, bool replaceExisting);
624
626 protected:
627
628 std::vector<Widget::Ptr> m_widgets;
629
630 Widget::Ptr m_widgetBelowMouse;
631 Widget::Ptr m_widgetWithLeftMouseDown;
632 Widget::Ptr m_widgetWithRightMouseDown;
633 Widget::Ptr m_focusedWidget;
634 bool m_draggingWidget = false;
635
636 Vector2f m_prevInnerSize;
637
638 // Does focusing the next widget always keep a widget from this container focused (e.g. in a ChildWindow)?
639 bool m_isolatedFocus = false;
640
641 friend class SubwidgetContainer; // Needs access to save and load functions
642
644 };
645
649 class TGUI_API RootContainer : public Container
650 {
651 public:
652
653 using Ptr = std::shared_ptr<RootContainer>;
654 using ConstPtr = std::shared_ptr<const RootContainer>;
655
656 static constexpr const char StaticWidgetType[] = "RootContainer";
657
665 RootContainer(const char* typeName = StaticWidgetType, bool initRenderer = true);
666
673 void setFocused(bool focused) override;
674
682 TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override;
683
687 void mouseNoLongerOnWidget() override;
688
695 void draw(BackendRenderTarget& target, RenderStates states) const override;
696
698 private:
699
701 // Returns a nullptr.
703 Widget::Ptr clone() const override
704 {
705 return nullptr;
706 }
707
709 };
710
712}
713
715
716#endif // TGUI_CONTAINER_HPP
Base class for the Gui.
Definition BackendGui.hpp:47
Base class for render targets.
Definition BackendRenderTarget.hpp:46
Container widget.
Definition Container.hpp:48
virtual bool remove(const Widget::Ptr &widget)
Removes a single widget that was added to the container.
bool processMousePressEvent(Event::MouseButton button, Vector2f pos)
Inform the container about a mouse press event.
Container(const Container &copy)
Copy constructor.
TGUI_NODISCARD WidgetType::Ptr get(const String &widgetName) const
Returns a pointer to a widget that was added earlier.
Definition Container.hpp:158
bool processMouseReleaseEvent(Event::MouseButton button, Vector2f pos)
Inform the container about a mouse release event.
Container(Container &&copy) noexcept
Move constructor.
std::size_t moveWidgetBackward(const Widget::Ptr &widget)
Places a widget one step backward in the z-order.
virtual TGUI_NODISCARD Widget::Ptr getWidgetAtPos(Vector2f pos, bool recursive) const
Returns the widget that is located at the given position.
bool focusPreviousWidget(bool recursive=true)
Focuses the previous widget in this container.
~Container() override
Destructor.
TGUI_NODISCARD Widget::Ptr getFocusedLeaf() const
Returns the leaf child widget that is focused inside this container.
bool canHandleKeyPress(const Event::KeyEvent &event) override
Called by the parent of the widget to check if keyPressed would process the event.
void draw(BackendRenderTarget &target, RenderStates states) const override
Draw the child widgets to a render target.
std::shared_ptr< Container > Ptr
Shared widget pointer.
Definition Container.hpp:51
bool processScrollEvent(float delta, Vector2f pos, bool touch)
Inform the container about a scroll event (either mouse wheel or two finger scrolling on touchscreen)
void rendererChanged(const String &property) override
Function called when one of the properties of the renderer is changed.
TGUI_NODISCARD Widget::Ptr getFocusedChild() const
Returns the child widget that is focused inside this container.
virtual void add(const Widget::Ptr &widgetPtr, const String &widgetName="")
Adds a widget to the container.
virtual void removeAllWidgets()
Removes all widgets that were added to the container.
TGUI_NODISCARD 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.
void loadWidgetsFromStream(std::stringstream &&stream, bool replaceExisting=true)
Loads the child widgets from a string stream.
TGUI_NODISCARD const std::vector< Widget::Ptr > & getWidgets() const
Returns a list of all the widgets in this container.
Definition Container.hpp:100
bool focusNextWidget(bool recursive=true)
Focuses the next widget in this container.
void loadWidgetsFromNodeTree(const std::unique_ptr< DataIO::Node > &rootNode, bool replaceExisting=true)
Loads the child widgets from a tree of nodes that contain all information about the widgets.
void sortWidgets(Function &&function)
Sorts a list of all the widgets in this container.
Definition Container.hpp:112
void load(const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
Loads the widget from a tree of nodes.
void moveWidgetToFront(const Widget::Ptr &widget)
Places a widget before all other widgets, to the front of the z-order.
void loadWidgetsFromFile(const String &filename, bool replaceExisting=true)
Loads the child widgets from a text file.
void moveWidgetToBack(const Widget::Ptr &widget)
Places a widget behind all other widgets, to the back of the z-order.
virtual bool setWidgetIndex(const Widget::Ptr &widget, std::size_t index)
Changes the index of a widget in this container.
TGUI_NODISCARD Widget::Ptr get(const String &widgetName) const
Returns a pointer to a widget that was added earlier.
virtual TGUI_NODISCARD Vector2f getInnerSize() const
Returns the space available for widgets inside the container.
std::size_t moveWidgetForward(const Widget::Ptr &widget)
Places a widget one step forward in the z-order.
TGUI_NODISCARD int getWidgetIndex(const Widget::Ptr &widget) const
Returns the current index of a widget in this container.
bool leftMousePressed(Vector2f pos) override
Called by the parent when the left mouse button goes down on top of the widget.
void updateTextSize() override
Called when the text size is changed (either by setTextSize or via the renderer)
bool processTextEnteredEvent(char32_t key)
Inform the container about a key press event.
void setFocused(bool focused) override
Focus or unfocus the widget.
bool processKeyPressEvent(Event::KeyEvent event)
Inform the container about a key press event.
bool scrolled(float delta, Vector2f pos, bool touch) override
Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touch...
void saveWidgetsToFile(const String &filename)
Saves the child widgets to a text file.
void saveWidgetsToStream(std::stringstream &stream, const String &rootDirectory="") const
Saves the child widgets to a text file.
void setSize(const Layout2d &size) override
Changes the size of the container.
void loadWidgetsFromStream(std::stringstream &stream, bool replaceExisting=true)
Loads the child widgets from a string stream.
bool processMouseMoveEvent(Vector2f pos)
Inform the container about a mouse move event.
virtual TGUI_NODISCARD Vector2f getChildWidgetsOffset() const
Returns the distance between the position of the container and a widget that would be drawn inside th...
Definition Container.hpp:189
TGUI_NODISCARD std::unique_ptr< DataIO::Node > saveWidgetsToNodeTree(const String &rootDirectory="") const
Saves the child widgets to a tree of nodes that contain all information about the widgets.
std::shared_ptr< const Container > ConstPtr
Shared constant widget pointer.
Definition Container.hpp:52
Wrapper for durations.
Definition Duration.hpp:55
Class to store the position or size of a widget.
Definition Layout.hpp:313
Definition Container.hpp:650
std::shared_ptr< RootContainer > Ptr
Shared widget pointer.
Definition Container.hpp:653
std::shared_ptr< const RootContainer > ConstPtr
Shared constant widget pointer.
Definition Container.hpp:654
TGUI_NODISCARD 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 draw(BackendRenderTarget &target, RenderStates states) const override
Draws all widgets to a render target.
void setFocused(bool focused) override
Focus or unfocus the widget.
Wrapper class to store strings.
Definition String.hpp:96
Base class for widgets that consist of subwidgets that act together as if they are a single widget.
Definition SubwidgetContainer.hpp:41
The parent class for every widget.
Definition Widget.hpp:83
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition Widget.hpp:86
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:38
KeyPressed event parameters.
Definition Event.hpp:168
MouseButton
Mouse buttons.
Definition Event.hpp:149
States used for drawing.
Definition RenderStates.hpp:38