]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/sizeritem.tex
Fixed two instances of : inbetween wxRect and method name (Inside and Intersects...
[wxWidgets.git] / docs / latex / wx / sizeritem.tex
1
2 \section{\class{wxSizerItem}}\label{wxsizeritem}
3
4 The wxSizerItem class is used to track the position, size and other
5 attributes of each item managed by a \helpref{wxSizer}{wxsizer}. In
6 normal usage user code should never need to deal directly with a
7 wxSizerItem, but derived sizer classes will.
8
9
10 \wxheading{Derived from}
11
12 \helpref{wxObject}{wxobject}
13
14 \wxheading{Include files}
15
16 <wx/sizer.h>
17
18
19 \latexignore{\rtfignore{\wxheading{Members}}}
20
21
22 \membersection{wxSizerItem::wxSizerItem}\label{wxsizeritemwxsizeritem}
23
24 \func{}{wxSizerItem}{\param{int }{width}, \param{int }{height}, \param{int }{proportion}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}}
25
26 Construct a sizer item for tracking a spacer.
27
28
29 \func{}{wxSizerItem}{\param{wxWindow* }{window}, \param{int }{proportion}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}}
30
31 Construct a sizer item for tracking a window.
32
33
34 \func{}{wxSizerItem}{\param{wxSizer* }{sizer}, \param{int }{proportion}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}}
35
36 Construct a sizer item for tracking a subsizer.
37
38
39
40 \membersection{wxSizerItem::\destruct{wxSizerItem}}\label{wxsizeritemdtor}
41
42 \func{}{\destruct{wxSizerItem}}{\void}
43
44 Deletes the user data and subsizer, if any.
45
46
47 \membersection{wxSizerItem::CalcMin}\label{wxsizeritemcalcmin}
48
49 \func{wxSize}{CalcMin}{\void}
50
51 Calculates the minimum desired size for the item, including any space
52 needed by borders.
53
54
55 \membersection{wxSizerItem::DeleteWindows}\label{wxsizeritemdeletewindows}
56
57 \func{void}{DeleteWindows}{\void}
58
59 Destroy the window or the windows in a subsizer, depending on the type
60 of item.
61
62
63 \membersection{wxSizerItem::DetachSizer}\label{wxsizeritemdetachsizer}
64
65 \func{void}{DetachSizer}{\void}
66
67 Enable deleting the SizerItem without destroying the contained sizer.
68
69
70 \membersection{wxSizerItem::GetBorder}\label{wxsizeritemgetborder}
71
72 \constfunc{int}{GetBorder}{\void}
73
74 Return the border attribute.
75
76 \membersection{wxSizerItem::GetFlag}\label{wxsizeritemgetflag}
77
78 \constfunc{int}{GetFlag}{\void}
79
80 Return the flags attribute.
81
82
83 \membersection{wxSizerItem::GetMinSize}\label{wxsizeritemgetminsize}
84
85 \constfunc{wxSize}{GetMinSize}{\void}
86
87 Get the minimum size needed for the item.
88
89 \membersection{wxSizerItem::GetPosition}\label{wxsizeritemgetposition}
90
91 \constfunc{wxPoint}{GetPosition}{\void}
92
93 What is the current position of the item, as set in the last Layout.
94
95 \membersection{wxSizerItem::GetProportion}\label{wxsizeritemgetproportion}
96
97 \constfunc{int}{GetProportion}{\void}
98
99 Get the proportion item attribute.
100
101 \membersection{wxSizerItem::GetRatio}\label{wxsizeritemgetratio}
102
103 \constfunc{float}{GetRatio}{\void}
104
105 Get the ration item attribute.
106
107 \membersection{wxSizerItem::GetRect}\label{wxsizeritemgetrect}
108
109 \func{wxRect}{GetRect}{\void}
110
111 Get the rectangle of the item on the parent window.
112
113 \membersection{wxSizerItem::GetSize}\label{wxsizeritemgetsize}
114
115 \constfunc{wxSize}{GetSize}{\void}
116
117 Get the current size of the item, as set in the last Layout.
118
119 \membersection{wxSizerItem::GetSizer}\label{wxsizeritemgetsizer}
120
121 \constfunc{wxSizer*}{GetSizer}{\void}
122
123 If this item is tracking a sizer, return it. NULL otherwise.
124
125
126 \membersection{wxSizerItem::GetSpacer}\label{wxsizeritemgetspacer}
127
128 \constfunc{const wxSize\&}{GetSpacer}{\void}
129
130 If this item is tracking a spacer, return its size.
131
132
133 \membersection{wxSizerItem::GetUserData}\label{wxsizeritemgetuserdata}
134
135 \constfunc{wxObject*}{GetUserData}{\void}
136
137 Get the userData item attribute.
138
139
140 \membersection{wxSizerItem::GetWindow}\label{wxsizeritemgetwindow}
141
142 \constfunc{wxWindow*}{GetWindow}{\void}
143
144 If this item is trackign a window then return it. NULL otherwise.
145
146 \membersection{wxSizerItem::IsShown}\label{wxsizeritemisshown}
147
148 \constfunc{bool}{IsShown}{\void}
149
150 Is this item shown?
151
152
153 \membersection{wxSizerItem::IsSizer}\label{wxsizeritemissizer}
154
155 \constfunc{bool}{IsSizer}{\void}
156
157 Is this item a sizer?
158
159
160 \membersection{wxSizerItem::IsSpacer}\label{wxsizeritemisspacer}
161
162 \constfunc{bool}{IsSpacer}{\void}
163
164 Is this item a spacer?
165
166
167 \membersection{wxSizerItem::IsWindow}\label{wxsizeritemiswindow}
168
169 \constfunc{bool}{IsWindow}{\void}
170
171 Is this item a window?
172
173
174 \membersection{wxSizerItem::SetBorder}\label{wxsizeritemsetborder}
175
176 \func{void}{SetBorder}{\param{int }{border}}
177
178 Set the border item attribute.
179
180 \membersection{wxSizerItem::SetDimension}\label{wxsizeritemsetdimension}
181
182 \func{void}{SetDimension}{\param{wxPoint }{pos}, \param{wxSize }{size}}
183
184 Set the position and size of the space allocated to the sizer, and
185 adjust the position and size of the item to be within that space
186 taking alignment and borders into account.
187
188
189 \membersection{wxSizerItem::SetFlag}\label{wxsizeritemsetflag}
190
191 \func{void}{SetFlag}{\param{int }{flag}}
192
193 Set the flag item attribute.
194
195
196 \membersection{wxSizerItem::SetInitSize}\label{wxsizeritemsetinitsize}
197
198 \func{void}{SetInitSize}{\param{int }{x}, \param{int }{y}}
199
200
201 \membersection{wxSizerItem::SetProportion}\label{wxsizeritemsetproportion}
202
203 \func{void}{SetProportion}{\param{int }{proportion}}
204
205 Set the proportion item attribute.
206
207 \membersection{wxSizerItem::SetRatio}\label{wxsizeritemsetratio}
208
209 \func{void}{SetRatio}{\param{int }{width}, \param{int }{height}}
210
211 \func{void}{SetRatio}{\param{wxSize }{size}}
212
213 \func{void}{SetRatio}{\param{float }{ratio}}
214
215 Set the ratio item attribute.
216
217
218 \membersection{wxSizerItem::SetSizer}\label{wxsizeritemsetsizer}
219
220 \func{void}{SetSizer}{\param{wxSizer* }{sizer}}
221
222 Set the sizer tracked by this item.
223
224
225 \membersection{wxSizerItem::SetSpacer}\label{wxsizeritemsetspacer}
226
227 \func{void}{SetSpacer}{\param{const wxSize\& }{size}}
228
229 Set the size of the spacer tracked by this item.
230
231
232 \membersection{wxSizerItem::SetWindow}\label{wxsizeritemsetwindow}
233
234 \func{void}{SetWindow}{\param{wxWindow* }{window}}
235
236 Set the window to be tracked by thsi item.
237
238
239 \membersection{wxSizerItem::Show}\label{wxsizeritemshow}
240
241 \func{void}{Show}{\param{bool }{show}}
242
243 Set the show item attribute, which sizers use to determine if the item
244 is to be made part of the layout or not. If the item is tracking a
245 window then it is shown or hidden as needed.
246