xref: /haiku/docs/user/interface/GridLayoutBuilder.dox (revision cb29eafe2586fdb2d7685afa69fdab5d88a8b576)
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/GridLayoutBuilder.h	hrev38512
10 *		src/kits/interface/GridLayoutBuilder.cpp	hrev45833
11 */
12
13
14/*!
15	\file GridLayoutBuilder.h
16	\ingroup layout
17	\brief Undocumented file.
18
19	\since Haiku R1
20*/
21
22
23/*!
24	\class BGridLayoutBuilder
25	\ingroup layout
26	\ingroup libbe
27	\brief Undocumented class.
28
29	\since Haiku R1
30*/
31
32
33/*!
34	\fn BGridLayoutBuilder::BGridLayoutBuilder(float horizontal=B_USE_DEFAULT_SPACING, float vertical=B_USE_DEFAULT_SPACING)
35	\brief Undocumented public method
36
37	\param horizontal Undocumented
38	\param vertical Undocumented
39
40	\return Undocumented
41	\retval <value> Undocumented
42
43	\since Haiku R1
44*/
45
46
47/*!
48	\fn BGridLayoutBuilder::BGridLayoutBuilder(BGridLayout *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 BGridLayoutBuilder::BGridLayoutBuilder(BGridView *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 BGridLayout* BGridLayoutBuilder::GridLayout() 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 BGridLayoutBuilder& BGridLayoutBuilder::GetGridLayout(BGridLayout **_layout)
86	\brief Undocumented public method
87
88	\param _layout Undocumented
89
90	\return Undocumented
91	\retval <value> Undocumented
92
93	\since Haiku R1
94*/
95
96
97/*!
98	\fn BView* BGridLayoutBuilder::View() const
99	\brief Undocumented public method
100
101	\return Undocumented
102	\retval <value> Undocumented
103
104	\since Haiku R1
105*/
106
107
108/*!
109	\fn BGridLayoutBuilder& BGridLayoutBuilder::GetView(BView **_view)
110	\brief Undocumented public method
111
112	\param _view Undocumented
113
114	\return Undocumented
115	\retval <value> Undocumented
116
117	\since Haiku R1
118*/
119
120
121/*!
122	\fn BGridLayoutBuilder& BGridLayoutBuilder::Add(BView *view, int32 column, int32 row, int32 columnCount=1, int32 rowCount=1)
123	\brief Undocumented public method
124
125	\param view Undocumented
126	\param column Undocumented
127	\param row Undocumented
128	\param columnCount Undocumented
129	\param rowCount Undocumented
130
131	\return Undocumented
132	\retval <value> Undocumented
133
134	\since Haiku R1
135*/
136
137
138/*!
139	\fn BGridLayoutBuilder& BGridLayoutBuilder::Add(BLayoutItem *item, int32 column, int32 row, int32 columnCount=1, int32 rowCount=1)
140	\brief Undocumented public method
141
142	\param item Undocumented
143	\param column Undocumented
144	\param row Undocumented
145	\param columnCount Undocumented
146	\param rowCount Undocumented
147
148	\return Undocumented
149	\retval <value> Undocumented
150
151	\since Haiku R1
152*/
153
154
155/*!
156	\fn BGridLayoutBuilder& BGridLayoutBuilder::SetColumnWeight(int32 column, float weight)
157	\brief Undocumented public method
158
159	\param column Undocumented
160	\param weight Undocumented
161
162	\return Undocumented
163	\retval <value> Undocumented
164
165	\since Haiku R1
166*/
167
168
169/*!
170	\fn BGridLayoutBuilder& BGridLayoutBuilder::SetRowWeight(int32 row, float weight)
171	\brief Undocumented public method
172
173	\param row Undocumented
174	\param weight Undocumented
175
176	\return Undocumented
177	\retval <value> Undocumented
178
179	\since Haiku R1
180*/
181
182
183/*!
184	\fn BGridLayoutBuilder& BGridLayoutBuilder::SetInsets(float left, float top, float right, float bottom)
185	\brief Undocumented public method
186
187	\param left Undocumented
188	\param top Undocumented
189	\param right Undocumented
190	\param bottom Undocumented
191
192	\return Undocumented
193	\retval <value> Undocumented
194
195	\since Haiku R1
196*/
197
198
199/*!
200	\fn BGridLayoutBuilder::operator BGridLayout *()
201	\brief Undocumented public method
202
203	\return Undocumented
204	\retval <value> Undocumented
205
206	\since Haiku R1
207*/
208