TGUI  1.3.0
Loading...
Searching...
No Matches
Group.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
26#ifndef TGUI_GROUP_HPP
27#define TGUI_GROUP_HPP
28
29
30#include <TGUI/Container.hpp>
31#include <TGUI/Renderers/GroupRenderer.hpp>
32
34
35TGUI_MODULE_EXPORT namespace tgui
36{
43 class TGUI_API Group : public Container
44 {
45 public:
46
47 using Ptr = std::shared_ptr<Group>;
48 using ConstPtr = std::shared_ptr<const Group>;
49
50 static constexpr const char StaticWidgetType[] = "Group";
51
52
60 Group(const char* typeName = StaticWidgetType, bool initRenderer = true);
61
62
71 TGUI_NODISCARD static Group::Ptr create(const Layout2d& size = {"100%", "100%"});
72
73
82 TGUI_NODISCARD static Group::Ptr copy(const Group::ConstPtr& group);
83
84
89 TGUI_NODISCARD GroupRenderer* getSharedRenderer() override;
90 TGUI_NODISCARD const GroupRenderer* getSharedRenderer() const override;
91
97 TGUI_NODISCARD GroupRenderer* getRenderer() override;
98
99
106 void setSize(const Layout2d& size) override;
107 using Widget::setSize;
108
109
114 TGUI_NODISCARD Vector2f getInnerSize() const override;
115
116
124 TGUI_NODISCARD Vector2f getChildWidgetsOffset() const override;
125
126
133 TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override;
134
135
143 void draw(BackendRenderTarget& target, RenderStates states) const override;
144
145
147 protected:
148
155 void rendererChanged(const String& property) override;
156
157
159 // Makes a copy of the widget
161 TGUI_NODISCARD Widget::Ptr clone() const override;
162
163
165 protected:
166
167 // Cached renderer properties
168 Padding m_paddingCached;
169
170
172 };
173
175}
176
178
179#endif // TGUI_GROUP_HPP
Base class for render targets.
Definition BackendRenderTarget.hpp:48
Container widget.
Definition Container.hpp:49
Definition GroupRenderer.hpp:37
Group widget.
Definition Group.hpp:44
TGUI_NODISCARD Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
void setSize(const Layout2d &size) override
Changes the size of the group.
TGUI_NODISCARD Vector2f getInnerSize() const override
Returns the space available for widgets inside the container.
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 rendererChanged(const String &property) override
Function called when one of the properties of the renderer is changed.
TGUI_NODISCARD Vector2f getChildWidgetsOffset() const override
Returns the distance between the position of the container and a widget that would be drawn inside th...
TGUI_NODISCARD GroupRenderer * getSharedRenderer() override
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 child widgets to a render target.
static TGUI_NODISCARD Group::Ptr create(const Layout2d &size={"100%", "100%"})
Creates a new group.
std::shared_ptr< const Group > ConstPtr
Shared constant widget pointer.
Definition Group.hpp:48
std::shared_ptr< Group > Ptr
Shared widget pointer.
Definition Group.hpp:47
TGUI_NODISCARD GroupRenderer * getRenderer() override
Returns the renderer, which gives access to functions that determine how the widget is displayed.
static TGUI_NODISCARD Group::Ptr copy(const Group::ConstPtr &group)
Makes a copy of another group.
Class to store the position or size of a widget.
Definition Layout.hpp:328
Definition Outline.hpp:39
Wrapper class to store strings.
Definition String.hpp:101
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition Widget.hpp:87
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:39
States used for drawing.
Definition RenderStates.hpp:39