xref: /haiku/docs/user/interface/SpaceLayoutItem.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/SpaceLayoutItem.h	hrev43514
10 *		src/kits/interface/SpaceLayoutItem.cpp	hrev44346
11 */
12
13
14/*!
15	\file SpaceLayoutItem.h
16	\ingroup layout
17	\brief Undocumented file.
18
19	\since Haiku R1
20*/
21
22
23/*!
24	\class BSpaceLayoutItem
25	\ingroup layout
26	\ingroup libbe
27	\brief Undocumented class.
28
29	\since Haiku R1
30*/
31
32
33/*!
34	\fn BSpaceLayoutItem::BSpaceLayoutItem(BSize minSize, BSize maxSize, BSize preferredSize, BAlignment alignment)
35	\brief Undocumented public method
36
37	\param minSize Undocumented
38	\param maxSize Undocumented
39	\param preferredSize Undocumented
40	\param alignment Undocumented
41
42	\return Undocumented
43	\retval <value> Undocumented
44
45	\since Haiku R1
46*/
47
48
49/*!
50	\fn BSpaceLayoutItem::BSpaceLayoutItem(BMessage *archive)
51	\brief Undocumented public method
52
53	\param archive Undocumented
54
55	\return Undocumented
56	\retval <value> Undocumented
57
58	\since Haiku R1
59*/
60
61
62/*!
63	\fn virtual virtual BSpaceLayoutItem::~BSpaceLayoutItem()
64	\brief Undocumented public method
65
66	\return Undocumented
67	\retval <value> Undocumented
68
69	\since Haiku R1
70*/
71
72
73/*!
74	\fn virtual virtual BSize BSpaceLayoutItem::MinSize()
75	\brief Undocumented public method
76
77	\return Undocumented
78	\retval <value> Undocumented
79
80	\since Haiku R1
81*/
82
83
84/*!
85	\fn virtual virtual BSize BSpaceLayoutItem::MaxSize()
86	\brief Undocumented public method
87
88	\return Undocumented
89	\retval <value> Undocumented
90
91	\since Haiku R1
92*/
93
94
95/*!
96	\fn virtual virtual BSize BSpaceLayoutItem::PreferredSize()
97	\brief Undocumented public method
98
99	\return Undocumented
100	\retval <value> Undocumented
101
102	\since Haiku R1
103*/
104
105
106/*!
107	\fn virtual virtual BAlignment BSpaceLayoutItem::Alignment()
108	\brief Undocumented public method
109
110	\return Undocumented
111	\retval <value> Undocumented
112
113	\since Haiku R1
114*/
115
116
117/*!
118	\fn virtual virtual void BSpaceLayoutItem::SetExplicitMinSize(BSize size)
119	\brief Undocumented public method
120
121	\param size Undocumented
122
123	\since Haiku R1
124*/
125
126
127/*!
128	\fn virtual virtual void BSpaceLayoutItem::SetExplicitMaxSize(BSize size)
129	\brief Undocumented public method
130
131	\param size Undocumented
132
133	\since Haiku R1
134*/
135
136
137/*!
138	\fn virtual virtual void BSpaceLayoutItem::SetExplicitPreferredSize(BSize size)
139	\brief Undocumented public method
140
141	\param size Undocumented
142
143	\since Haiku R1
144*/
145
146
147/*!
148	\fn virtual virtual void BSpaceLayoutItem::SetExplicitAlignment(BAlignment alignment)
149	\brief Undocumented public method
150
151	\param alignment Undocumented
152
153	\since Haiku R1
154*/
155
156
157/*!
158	\fn virtual virtual bool BSpaceLayoutItem::IsVisible()
159	\brief Undocumented public method
160
161	\return Undocumented
162	\retval <value> Undocumented
163
164	\since Haiku R1
165*/
166
167
168/*!
169	\fn virtual virtual void BSpaceLayoutItem::SetVisible(bool visible)
170	\brief Undocumented public method
171
172	\param visible Undocumented
173
174	\since Haiku R1
175*/
176
177
178/*!
179	\fn virtual virtual BRect BSpaceLayoutItem::Frame()
180	\brief Undocumented public method
181
182	\return Undocumented
183	\retval <value> Undocumented
184
185	\since Haiku R1
186*/
187
188
189/*!
190	\fn virtual virtual void BSpaceLayoutItem::SetFrame(BRect frame)
191	\brief Undocumented public method
192
193	\param frame Undocumented
194
195	\since Haiku R1
196*/
197
198
199/*!
200	\fn virtual virtual status_t BSpaceLayoutItem::Archive(BMessage *into, bool deep=true) const
201	\brief Undocumented public method
202
203	\param into Undocumented
204	\param deep Undocumented
205
206	\return Undocumented
207	\retval <value> Undocumented
208
209	\since Haiku R1
210*/
211
212
213/*!
214	\fn static static BSpaceLayoutItem* BSpaceLayoutItem::CreateGlue()
215	\brief Undocumented public method
216
217	\return Undocumented
218	\retval <value> Undocumented
219
220	\since Haiku R1
221*/
222
223
224/*!
225	\fn static static BSpaceLayoutItem* BSpaceLayoutItem::CreateHorizontalStrut(float width)
226	\brief Undocumented public method
227
228	\param width Undocumented
229
230	\return Undocumented
231	\retval <value> Undocumented
232
233	\since Haiku R1
234*/
235
236
237/*!
238	\fn static static BSpaceLayoutItem* BSpaceLayoutItem::CreateVerticalStrut(float height)
239	\brief Undocumented public method
240
241	\param height Undocumented
242
243	\return Undocumented
244	\retval <value> Undocumented
245
246	\since Haiku R1
247*/
248
249
250/*!
251	\fn static static BArchivable* BSpaceLayoutItem::Instantiate(BMessage *from)
252	\brief Undocumented public method
253
254	\param from Undocumented
255
256	\return Undocumented
257	\retval <value> Undocumented
258
259	\since Haiku R1
260*/
261