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