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