1/**************************************************************************/
2/* box_container.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef BOX_CONTAINER_H
32#define BOX_CONTAINER_H
33
34#include "scene/gui/container.h"
35
36class BoxContainer : public Container {
37 GDCLASS(BoxContainer, Container);
38
39public:
40 enum AlignmentMode {
41 ALIGNMENT_BEGIN,
42 ALIGNMENT_CENTER,
43 ALIGNMENT_END
44 };
45
46private:
47 bool vertical = false;
48 AlignmentMode alignment = ALIGNMENT_BEGIN;
49
50 struct ThemeCache {
51 int separation = 0;
52 } theme_cache;
53
54 void _resort();
55
56protected:
57 bool is_fixed = false;
58
59 void _notification(int p_what);
60 void _validate_property(PropertyInfo &p_property) const;
61 static void _bind_methods();
62
63public:
64 Control *add_spacer(bool p_begin = false);
65
66 void set_alignment(AlignmentMode p_alignment);
67 AlignmentMode get_alignment() const;
68
69 void set_vertical(bool p_vertical);
70 bool is_vertical() const;
71
72 virtual Size2 get_minimum_size() const override;
73
74 virtual Vector<int> get_allowed_size_flags_horizontal() const override;
75 virtual Vector<int> get_allowed_size_flags_vertical() const override;
76
77 BoxContainer(bool p_vertical = false);
78};
79
80class HBoxContainer : public BoxContainer {
81 GDCLASS(HBoxContainer, BoxContainer);
82
83public:
84 HBoxContainer() :
85 BoxContainer(false) { is_fixed = true; }
86};
87
88class MarginContainer;
89class VBoxContainer : public BoxContainer {
90 GDCLASS(VBoxContainer, BoxContainer);
91
92public:
93 MarginContainer *add_margin_child(const String &p_label, Control *p_control, bool p_expand = false);
94
95 VBoxContainer() :
96 BoxContainer(true) { is_fixed = true; }
97};
98
99VARIANT_ENUM_CAST(BoxContainer::AlignmentMode);
100
101#endif // BOX_CONTAINER_H
102