xref: /haiku/docs/user/interface/Alignment.dox (revision ed24eb5ff12640d052171c6a7feba37fab8a75d1)
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/Alignment.h	 hrev32745
10 *		src/kits/interface/Alignment.cpp	 hrev18649
11 */
12
13
14/*!
15	\file Alignment.h
16	\ingroup interface
17	\brief Undocumented file.
18
19	\since Haiku R1
20*/
21
22
23/*!
24	\class BAlignment
25	\ingroup interface
26	\ingroup libbe
27	\brief Undocumented class.
28
29	\since Haiku R1
30*/
31
32
33/*!
34	\var alignment BAlignment::horizontal
35	\brief Undocumented public variable
36
37	\since Haiku R1
38*/
39
40
41/*!
42	\var vertical_alignment BAlignment::vertical
43	\brief Undocumented public variable
44
45	\since Haiku R1
46*/
47
48
49/*!
50	\fn BAlignment::BAlignment()
51	\brief Undocumented public method
52
53	\return Undocumented
54	\retval <value> Undocumented
55
56	\since Haiku R1
57*/
58
59
60/*!
61	\fn BAlignment::BAlignment(const BAlignment &other)
62	\brief Undocumented public method
63
64	\param other Undocumented
65
66	\return Undocumented
67	\retval <value> Undocumented
68
69	\since Haiku R1
70*/
71
72
73/*!
74	\fn BAlignment::BAlignment(alignment horizontal, vertical_alignment vertical)
75	\brief Undocumented public method
76
77	\param horizontal Undocumented
78	\param vertical Undocumented
79
80	\return Undocumented
81	\retval <value> Undocumented
82
83	\since Haiku R1
84*/
85
86
87/*!
88	\fn alignment BAlignment::Horizontal() const
89	\brief Undocumented public method
90
91	\return Undocumented
92	\retval <value> Undocumented
93
94	\since Haiku R1
95*/
96
97
98/*!
99	\fn vertical_alignment BAlignment::Vertical() const
100	\brief Undocumented public method
101
102	\return Undocumented
103	\retval <value> Undocumented
104
105	\since Haiku R1
106*/
107
108
109/*!
110	\fn float BAlignment::RelativeHorizontal() const
111	\brief Undocumented public method
112
113	\return Undocumented
114	\retval <value> Undocumented
115
116	\since Haiku R1
117*/
118
119
120/*!
121	\fn float BAlignment::RelativeVertical() const
122	\brief Undocumented public method
123
124	\return Undocumented
125	\retval <value> Undocumented
126
127	\since Haiku R1
128*/
129
130
131/*!
132	\fn void BAlignment::SetHorizontal(alignment horizontal)
133	\brief Undocumented public method
134
135	\param horizontal Undocumented
136
137	\since Haiku R1
138*/
139
140
141/*!
142	\fn void BAlignment::SetVertical(vertical_alignment vertical)
143	\brief Undocumented public method
144
145	\param vertical Undocumented
146
147	\since Haiku R1
148*/
149
150
151/*!
152	\fn bool BAlignment::IsHorizontalSet() const
153	\brief Undocumented public method
154
155	\return Undocumented
156	\retval <value> Undocumented
157
158	\since Haiku R1
159*/
160
161
162/*!
163	\fn bool BAlignment::IsVerticalSet() const
164	\brief Undocumented public method
165
166	\return Undocumented
167	\retval <value> Undocumented
168
169	\since Haiku R1
170*/
171
172
173/*!
174	\fn bool BAlignment::operator==(const BAlignment &other) const
175	\brief Undocumented public method
176
177	\param other Undocumented
178
179	\return Undocumented
180	\retval <value> Undocumented
181
182	\since Haiku R1
183*/
184
185
186/*!
187	\fn bool BAlignment::operator!=(const BAlignment &other) const
188	\brief Undocumented public method
189
190	\param other Undocumented
191
192	\return Undocumented
193	\retval <value> Undocumented
194
195	\since Haiku R1
196*/
197
198
199/*!
200	\fn BAlignment & BAlignment::operator=(const BAlignment &other)
201	\brief Undocumented public method
202
203	\param other Undocumented
204
205	\return Undocumented
206	\retval <value> Undocumented
207
208	\since Haiku R1
209*/
210