xref: /haiku/docs/user/interface/GroupLayoutBuilder.dox (revision 69f814cded60c5f977a61a2ab747e4456323e6f2)
1/*
2 * Copyright 2019 Haiku, Inc. All rights reserved.
3 * Distributed under the terms of the MIT License.
4 *
5 * Authors:
6 *		Name, email@email.com
7 *
8 * Corresponds to:
9 *		headers/os/interface/GroupLayoutBuilder.h	hrev45833
10 *		src/kits/<kitname>/GroupLayoutBuilder.cpp	hrev38207
11 */
12
13
14/*!
15	\file GroupLayoutBuilder.h
16	\ingroup layout
17	\brief Undocumented file.
18
19	\since Haiku R1
20*/
21
22
23/*!
24	\class BGroupLayoutBuilder
25	\ingroup layout
26	\ingroup libbe
27	\brief Undocumented class.
28
29	\since Haiku R1
30*/
31
32
33/*!
34	\fn BGroupLayoutBuilder::BGroupLayoutBuilder(orientation orientation=B_HORIZONTAL, float spacing=B_USE_DEFAULT_SPACING)
35	\brief Undocumented public method
36
37	\param orientation Undocumented
38	\param spacing Undocumented
39
40	\return Undocumented
41	\retval <value> Undocumented
42
43	\since Haiku R1
44*/
45
46
47/*!
48	\fn BGroupLayoutBuilder::BGroupLayoutBuilder(BGroupLayout *layout)
49	\brief Undocumented public method
50
51	\param layout Undocumented
52
53	\return Undocumented
54	\retval <value> Undocumented
55
56	\since Haiku R1
57*/
58
59
60/*!
61	\fn BGroupLayoutBuilder::BGroupLayoutBuilder(BGroupView *view)
62	\brief Undocumented public method
63
64	\param view Undocumented
65
66	\return Undocumented
67	\retval <value> Undocumented
68
69	\since Haiku R1
70*/
71
72
73/*!
74	\fn BGroupLayout* BGroupLayoutBuilder::RootLayout() const
75	\brief Undocumented public method
76
77	\return Undocumented
78	\retval <value> Undocumented
79
80	\since Haiku R1
81*/
82
83
84/*!
85	\fn BGroupLayout* BGroupLayoutBuilder::TopLayout() const
86	\brief Undocumented public method
87
88	\return Undocumented
89	\retval <value> Undocumented
90
91	\since Haiku R1
92*/
93
94
95/*!
96	\fn BGroupLayoutBuilder& BGroupLayoutBuilder::GetTopLayout(BGroupLayout **_layout)
97	\brief Undocumented public method
98
99	\param _layout Undocumented
100
101	\return Undocumented
102	\retval <value> Undocumented
103
104	\since Haiku R1
105*/
106
107
108/*!
109	\fn BView* BGroupLayoutBuilder::TopView() const
110	\brief Undocumented public method
111
112	\return Undocumented
113	\retval <value> Undocumented
114
115	\since Haiku R1
116*/
117
118
119/*!
120	\fn BGroupLayoutBuilder& BGroupLayoutBuilder::GetTopView(BView **_view)
121	\brief Undocumented public method
122
123	\param _view Undocumented
124
125	\return Undocumented
126	\retval <value> Undocumented
127
128	\since Haiku R1
129*/
130
131
132/*!
133	\fn BGroupLayoutBuilder& BGroupLayoutBuilder::Add(BView *view)
134	\brief Undocumented public method
135
136	\param view Undocumented
137
138	\return Undocumented
139	\retval <value> Undocumented
140
141	\since Haiku R1
142*/
143
144
145/*!
146	\fn BGroupLayoutBuilder& BGroupLayoutBuilder::Add(BView *view, float weight)
147	\brief Undocumented public method
148
149	\param view Undocumented
150	\param weight Undocumented
151
152	\return Undocumented
153	\retval <value> Undocumented
154
155	\since Haiku R1
156*/
157
158
159/*!
160	\fn BGroupLayoutBuilder& BGroupLayoutBuilder::Add(BLayoutItem *item)
161	\brief Undocumented public method
162
163	\param item Undocumented
164
165	\return Undocumented
166	\retval <value> Undocumented
167
168	\since Haiku R1
169*/
170
171
172/*!
173	\fn BGroupLayoutBuilder& BGroupLayoutBuilder::Add(BLayoutItem *item, float weight)
174	\brief Undocumented public method
175
176	\param item Undocumented
177	\param weight Undocumented
178
179	\return Undocumented
180	\retval <value> Undocumented
181
182	\since Haiku R1
183*/
184
185
186/*!
187	\fn BGroupLayoutBuilder& BGroupLayoutBuilder::AddGroup(orientation orientation, float spacing=B_USE_DEFAULT_SPACING, float weight=1.0f)
188	\brief Undocumented public method
189
190	\param orientation Undocumented
191	\param spacing Undocumented
192	\param weight Undocumented
193
194	\return Undocumented
195	\retval <value> Undocumented
196
197	\since Haiku R1
198*/
199
200
201/*!
202	\fn BGroupLayoutBuilder& BGroupLayoutBuilder::End()
203	\brief Undocumented public method
204
205	\return Undocumented
206	\retval <value> Undocumented
207
208	\since Haiku R1
209*/
210
211
212/*!
213	\fn BGroupLayoutBuilder& BGroupLayoutBuilder::AddGlue(float weight=1.0f)
214	\brief Undocumented public method
215
216	\param weight Undocumented
217
218	\return Undocumented
219	\retval <value> Undocumented
220
221	\since Haiku R1
222*/
223
224
225/*!
226	\fn BGroupLayoutBuilder& BGroupLayoutBuilder::AddStrut(float size)
227	\brief Undocumented public method
228
229	\param size Undocumented
230
231	\return Undocumented
232	\retval <value> Undocumented
233
234	\since Haiku R1
235*/
236
237
238/*!
239	\fn BGroupLayoutBuilder& BGroupLayoutBuilder::SetInsets(float left, float top, float right, float bottom)
240	\brief Undocumented public method
241
242	\param left Undocumented
243	\param top Undocumented
244	\param right Undocumented
245	\param bottom Undocumented
246
247	\return Undocumented
248	\retval <value> Undocumented
249
250	\since Haiku R1
251*/
252
253
254/*!
255	\fn BGroupLayoutBuilder::operator BGroupLayout *()
256	\brief Undocumented public method
257
258	\return Undocumented
259	\retval <value> Undocumented
260
261	\since Haiku R1
262*/
263