xref: /haiku/docs/user/interface/CardLayout.dox (revision 15fb7d88e971c4d6c787c6a3a5c159afb1ebf77b)
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/CardLayout.h	hrev43514
10 *		src/kits/interface/CardLayout.cpp	hrev49019
11 */
12
13
14/*!
15	\file CardLayout.h
16	\ingroup layout
17	\brief Undocumented file.
18
19	\since Haiku R1
20*/
21
22
23/*!
24	\class BCardLayout
25	\ingroup layout
26	\ingroup libbe
27	\brief Undocumented class.
28
29	\since Haiku R1
30*/
31
32
33/*!
34	\fn BCardLayout::BCardLayout()
35	\brief Undocumented public method
36
37	\return Undocumented
38	\retval <value> Undocumented
39
40	\since Haiku R1
41*/
42
43
44/*!
45	\fn BCardLayout::BCardLayout(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 virtual BCardLayout::~BCardLayout()
59	\brief Undocumented public method
60
61	\return Undocumented
62	\retval <value> Undocumented
63
64	\since Haiku R1
65*/
66
67
68/*!
69	\fn BLayoutItem* BCardLayout::VisibleItem() const
70	\brief Undocumented public method
71
72	\return Undocumented
73	\retval <value> Undocumented
74
75	\since Haiku R1
76*/
77
78
79/*!
80	\fn int32 BCardLayout::VisibleIndex() const
81	\brief Undocumented public method
82
83	\return Undocumented
84	\retval <value> Undocumented
85
86	\since Haiku R1
87*/
88
89
90/*!
91	\fn void BCardLayout::SetVisibleItem(int32 index)
92	\brief Undocumented public method
93
94	\param index Undocumented
95
96	\since Haiku R1
97*/
98
99
100/*!
101	\fn void BCardLayout::SetVisibleItem(BLayoutItem *item)
102	\brief Undocumented public method
103
104	\param item Undocumented
105
106	\since Haiku R1
107*/
108
109
110/*!
111	\fn virtual virtual BSize BCardLayout::BaseMinSize()
112	\brief Undocumented public method
113
114	\return Undocumented
115	\retval <value> Undocumented
116
117	\since Haiku R1
118*/
119
120
121/*!
122	\fn virtual virtual BSize BCardLayout::BaseMaxSize()
123	\brief Undocumented public method
124
125	\return Undocumented
126	\retval <value> Undocumented
127
128	\since Haiku R1
129*/
130
131
132/*!
133	\fn virtual virtual BSize BCardLayout::BasePreferredSize()
134	\brief Undocumented public method
135
136	\return Undocumented
137	\retval <value> Undocumented
138
139	\since Haiku R1
140*/
141
142
143/*!
144	\fn virtual virtual BAlignment BCardLayout::BaseAlignment()
145	\brief Undocumented public method
146
147	\return Undocumented
148	\retval <value> Undocumented
149
150	\since Haiku R1
151*/
152
153
154/*!
155	\fn virtual virtual bool BCardLayout::HasHeightForWidth()
156	\brief Undocumented public method
157
158	\return Undocumented
159	\retval <value> Undocumented
160
161	\since Haiku R1
162*/
163
164
165/*!
166	\fn virtual virtual void BCardLayout::GetHeightForWidth(float width, float *min, float *max, float *preferred)
167	\brief Undocumented public method
168
169	\param width Undocumented
170	\param min Undocumented
171	\param max Undocumented
172	\param preferred Undocumented
173
174	\since Haiku R1
175*/
176
177
178/*!
179	\fn virtual virtual status_t BCardLayout::Archive(BMessage *into, bool deep=true) const
180	\brief Undocumented public method
181
182	\param into Undocumented
183	\param deep Undocumented
184
185	\return Undocumented
186	\retval <value> Undocumented
187
188	\since Haiku R1
189*/
190
191
192/*!
193	\fn virtual virtual status_t BCardLayout::Perform(perform_code d, void *arg)
194	\brief Undocumented public method
195
196	\param d Undocumented
197	\param arg Undocumented
198
199	\return Undocumented
200	\retval <value> Undocumented
201
202	\since Haiku R1
203*/
204
205
206/*!
207	\fn static static BArchivable* BCardLayout::Instantiate(BMessage *from)
208	\brief Undocumented public method
209
210	\param from Undocumented
211
212	\return Undocumented
213	\retval <value> Undocumented
214
215	\since Haiku R1
216*/
217
218
219/*!
220	\fn virtual virtual status_t BCardLayout::AllArchived(BMessage *archive) const
221	\brief Undocumented protected method
222
223	\param archive Undocumented
224
225	\return Undocumented
226	\retval <value> Undocumented
227
228	\since Haiku R1
229*/
230
231
232/*!
233	\fn virtual virtual status_t BCardLayout::AllUnarchived(const BMessage *from)
234	\brief Undocumented protected method
235
236	\param from Undocumented
237
238	\return Undocumented
239	\retval <value> Undocumented
240
241	\since Haiku R1
242*/
243
244
245/*!
246	\fn virtual virtual status_t BCardLayout::ItemArchived(BMessage *into, BLayoutItem *item, int32 index) const
247	\brief Undocumented protected method
248
249	\param into Undocumented
250	\param item Undocumented
251	\param index Undocumented
252
253	\return Undocumented
254	\retval <value> Undocumented
255
256	\since Haiku R1
257*/
258
259
260/*!
261	\fn virtual virtual status_t BCardLayout::ItemUnarchived(const BMessage *from, BLayoutItem *item, int32 index)
262	\brief Undocumented protected method
263
264	\param from Undocumented
265	\param item Undocumented
266	\param index Undocumented
267
268	\return Undocumented
269	\retval <value> Undocumented
270
271	\since Haiku R1
272*/
273
274
275/*!
276	\fn virtual virtual void BCardLayout::LayoutInvalidated(bool children=false)
277	\brief Undocumented protected method
278
279	\param children Undocumented
280
281	\since Haiku R1
282*/
283
284
285/*!
286	\fn virtual virtual void BCardLayout::DoLayout()
287	\brief Undocumented protected method
288
289	\since Haiku R1
290*/
291
292
293/*!
294	\fn virtual virtual bool BCardLayout::ItemAdded(BLayoutItem *item, int32 atIndex)
295	\brief Undocumented protected method
296
297	\param item Undocumented
298	\param atIndex Undocumented
299
300	\return Undocumented
301	\retval <value> Undocumented
302
303	\since Haiku R1
304*/
305
306
307/*!
308	\fn virtual virtual void BCardLayout::ItemRemoved(BLayoutItem *item, int32 fromIndex)
309	\brief Undocumented protected method
310
311	\param item Undocumented
312	\param fromIndex Undocumented
313
314	\since Haiku R1
315*/
316