1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
.. _boxlayouts:
Box Layouts
===========
.. rst-class:: tw-flex-imgs
* .. figure:: tpi/boxlayouts-intro-v.tpi
vertical box layout with spacing 1
* .. figure:: tpi/boxlayouts-intro-h.tpi
horizontal box layout with spacing 1
Box layouts are basic building blocks for dynamic widget layouting.
Box layouts either stack widgets vertically (:cpp:class:`Tui::ZVBoxLayout`) or place them side by side horizontally
(:cpp:class:`Tui::ZHBoxLayout`).
Additionally they allow to add automatic spacing between widgets, manual spacing between widgets and stretch spacing
that acts a bit like a spring.
..
TODO: Add more details.
Stretch
-------
.. rst-class:: tw-figure-left
.. figure:: tpi/boxlayouts-stretch-start.tpi
Horizontal box layout with stretch before 2 buttons
.. collapsable:: Example Code
.. literalinclude:: examples/widgets/boxlayout.cpp
:start-after: // snippet-stretchstart-start
:end-before: // snippet-stretchstart-end
:dedent:
.. raw:: html
<p> </p>
.. rst-class:: tw-figure-left
.. figure:: tpi/boxlayouts-stretch-mid.tpi
Horizontal box layout with stretch between 2 buttons
.. collapsable:: Example Code
.. literalinclude:: examples/widgets/boxlayout.cpp
:start-after: // snippet-stretchmid-start
:end-before: // snippet-stretchmid-end
:dedent:
Stretch elements allow creating space between items in the layout that expands to fill the available width.
They take space at the same priority as widgets using a expanding size policy.
Typical usage is placing a stretch element as left most element to align the following widgets to the right.
Placing one stretch element between widgets creates a space in the middle and pushes the widgets towards the edge
of the layout.
Nested
------
.. rst-class:: tw-figure-left
.. figure:: tpi/boxlayouts-nested1.tpi
Horizontal box layout nested within vertial box layout.
.. collapsable:: Example Code
.. literalinclude:: examples/widgets/boxlayout.cpp
:start-after: // snippet-nestedvh-start
:end-before: // snippet-nestedvh-end
:dedent:
.. raw:: html
<p> </p>
.. rst-class:: tw-figure-left
.. figure:: tpi/boxlayouts-nested2.tpi
Vertial box layout nested within horizontal box layout.
.. collapsable:: Example Code
.. literalinclude:: examples/widgets/boxlayout.cpp
:start-after: // snippet-nestedhv-start
:end-before: // snippet-nestedhv-end
:dedent:
Nesting layouts allows for more complex arrangements of widgets.
It is important to consider in which order the items are nested, because nested box layouts do not create a grid, but
each layout's items are layouted individually.
ZVBoxLayout
-----------
.. cpp:class:: Tui::ZHBoxLayout : public Tui::ZLayout
This layout arranges items horizontally.
Items are placed from left to right.
.. cpp:function:: int spacing() const
.. cpp:function:: void setSpacing(int sp)
The ``spacing`` determines the amount of blank cells betweeen layouted items.
It does not apply if one of the adjacent items itself is a spacer (according to
:cpp:func:`bool Tui::ZLayoutItem::isSpacer() const`).
.. cpp:function:: void addWidget(ZWidget *w)
Adds a widget to be layouted.
.. cpp:function:: void add(ZLayout *l)
Adds a sub layout to be layouted.
.. cpp:function:: void addSpacing(int size)
Add manual spacing of ``size`` blank cells.
Spacing set via :cpp:func::`void setSpacing(int sp)`` does not apply for this spacing.
.. cpp:function:: void addStretch()
Add a stretch item that acts like a spring in the layout and takes additional space with the same priority as
:cpp:enumerator:`Expanding <Tui::SizePolicy::Expanding>` items.
ZHBoxLayout
-----------
.. cpp:class:: Tui::ZVBoxLayout : public Tui::ZLayout
This layout arranges items vertically.
Items are placed from top to bottom.
.. cpp:function:: int spacing() const
.. cpp:function:: void setSpacing(int sp)
The ``spacing`` determines the amount of blank cells betweeen layouted items.
It does not apply if one of the adjacent items itself is a spacer (according to
:cpp:func:`bool Tui::ZLayoutItem::isSpacer() const`).
.. cpp:function:: void addWidget(ZWidget *w)
Adds a widget to be layouted.
.. cpp:function:: void add(ZLayout *l)
Adds a sub layout to be layouted.
.. cpp:function:: void addSpacing(int size)
Add manual spacing of ``size`` blank cells.
Spacing set via :cpp:func::`void setSpacing(int sp)` does not apply for this spacing.
.. cpp:function:: void addStretch()
Add a stretch item that acts like a spring in the layout and takes additional space with the same priority as
:cpp:enumerator::`Expanding <Tui::SizePolicy::Expanding>` items.
|
