]>
Commit | Line | Data |
---|---|---|
8fe05782 VZ |
1 | \section{\class{wxSizer}}\label{wxsizer} |
2 | ||
7e9a386e | 3 | wxSizer is the abstract base class used for laying out subwindows in a window. You |
3baaf313 VZ |
4 | cannot use wxSizer directly; instead, you will have to use one of the sizer |
5 | classes derived from it. Currently there are \helpref{wxBoxSizer}{wxboxsizer}, | |
6 | \helpref{wxStaticBoxSizer}{wxstaticboxsizer}, | |
c6eb7785 | 7 | \helpref{wxGridSizer}{wxgridsizer} |
b19d7524 | 8 | \helpref{wxFlexGridSizer}{wxflexgridsizer} and \helpref{wxGridBagSizer}{wxgridbagsizer}. |
515da557 | 9 | |
fc2171bd | 10 | The layout algorithm used by sizers in wxWidgets is closely related to layout |
515da557 RR |
11 | in other GUI toolkits, such as Java's AWT, the GTK toolkit or the Qt toolkit. It is |
12 | based upon the idea of the individual subwindows reporting their minimal required | |
13 | size and their ability to get stretched if the size of the parent window has changed. | |
749bb9f1 DS |
14 | This will most often mean that the programmer does not set the original size of |
15 | a dialog in the beginning, rather the dialog will be assigned a sizer and this sizer | |
1193d8fa RR |
16 | will be queried about the recommended size. The sizer in turn will query its |
17 | children, which can be normal windows, empty space or other sizers, so that | |
18 | a hierarchy of sizers can be constructed. Note that wxSizer does not derive from wxWindow | |
749bb9f1 | 19 | and thus does not interfere with tab ordering and requires very little resources compared |
515da557 RR |
20 | to a real window on screen. |
21 | ||
fc2171bd | 22 | What makes sizers so well fitted for use in wxWidgets is the fact that every control |
515da557 RR |
23 | reports its own minimal size and the algorithm can handle differences in font sizes |
24 | or different window (dialog item) sizes on different platforms without problems. If e.g. | |
25 | the standard font as well as the overall design of Motif widgets requires more space than | |
f6bcfd97 | 26 | on Windows, the initial dialog size will automatically be bigger on Motif than on Windows. |
8fe05782 | 27 | |
e6994168 VZ |
28 | Sizers may also be used to control the layout of custom drawn items on the window. The |
29 | Add, Insert, and Prepend functions return a pointer to the newly added wxSizerItem. Just | |
30 | add empty space of the desired size and attributes, and then use the wxSizerItem::GetRect | |
31 | method to determine where the drawing operations should take place. | |
32 | ||
33 | ||
c1073b57 VZ |
34 | Please notice that sizers, like child windows, are owned by the library and |
35 | will be deleted by it which implies that they must be allocated on the heap. | |
36 | However if you create a sizer and do not add it to another sizer or window, the | |
37 | library wouldn't be able to delete such an orphan sizer and in this, and only | |
38 | this, case it should be deleted explicitly. | |
39 | ||
76e1c2de | 40 | \pythonnote{If you wish to create a sizer class in wxPython you should |
c9110876 | 41 | derive the class from {\tt wxPySizer} in order to get Python-aware |
76e1c2de RD |
42 | capabilities for the various virtual methods.} |
43 | ||
8fe05782 VZ |
44 | \wxheading{Derived from} |
45 | ||
749bb9f1 DS |
46 | \helpref{wxObject}{wxobject}\\ |
47 | \helpref{wxClientDataContainer}{wxclientdatacontainer} | |
8fe05782 | 48 | |
0bf97466 RN |
49 | \wxheading{Include files} |
50 | ||
51 | <wx/sizer.h> | |
52 | ||
a7af285d VZ |
53 | \wxheading{Library} |
54 | ||
55 | \helpref{wxCore}{librarieslist} | |
56 | ||
1c0c339c JS |
57 | \wxheading{See also} |
58 | ||
59 | \helpref{Sizer overview}{sizeroverview} | |
60 | ||
8fe05782 VZ |
61 | \latexignore{\rtfignore{\wxheading{Members}}} |
62 | ||
02c6137e | 63 | |
8fe05782 VZ |
64 | \membersection{wxSizer::wxSizer}\label{wxsizerwxsizer} |
65 | ||
66 | \func{}{wxSizer}{\void} | |
67 | ||
9c884972 RR |
68 | The constructor. Note that wxSizer is an abstract base class and may not |
69 | be instantiated. | |
8fe05782 | 70 | |
02c6137e | 71 | |
8fe05782 VZ |
72 | \membersection{wxSizer::\destruct{wxSizer}}\label{wxsizerdtor} |
73 | ||
74 | \func{}{\destruct{wxSizer}}{\void} | |
75 | ||
9c884972 | 76 | The destructor. |
8fe05782 | 77 | |
02c6137e | 78 | |
8fe05782 VZ |
79 | \membersection{wxSizer::Add}\label{wxsizeradd} |
80 | ||
40210d8a RN |
81 | \func{wxSizerItem*}{Add}{\param{wxWindow* }{window}, \param{const wxSizerFlags\& }{flags}} |
82 | ||
56eee37f | 83 | \func{wxSizerItem*}{Add}{\param{wxWindow* }{window}, \param{int }{proportion = 0},\param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}} |
8fe05782 | 84 | |
40210d8a RN |
85 | \func{wxSizerItem*}{Add}{\param{wxSizer* }{sizer}, \param{const wxSizerFlags\& }{flags}} |
86 | ||
56eee37f | 87 | \func{wxSizerItem*}{Add}{\param{wxSizer* }{sizer}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}} |
8fe05782 | 88 | |
56eee37f | 89 | \func{wxSizerItem*}{Add}{\param{int }{width}, \param{int }{height}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}} |
8fe05782 | 90 | |
00976fe5 RL |
91 | Appends a child to the sizer. wxSizer itself is an abstract class, but the parameters are |
92 | equivalent in the derived classes that you will instantiate to use it so they are described | |
93 | here: | |
8fe05782 | 94 | |
4130b487 RR |
95 | \docparam{window}{The window to be added to the sizer. Its initial size (either set explicitly by the |
96 | user or calculated internally when using wxDefaultSize) is interpreted as the minimal and in many | |
fd52f255 | 97 | cases also the initial size.} |
4130b487 RR |
98 | |
99 | \docparam{sizer}{The (child-)sizer to be added to the sizer. This allows placing a child sizer in a | |
100 | sizer and thus to create hierarchies of sizers (typically a vertical box as the top sizer and several | |
101 | horizontal boxes on the level beneath).} | |
102 | ||
103 | \docparam{width and height}{The dimension of a spacer to be added to the sizer. Adding spacers to sizers | |
2edb0bde | 104 | gives more flexibility in the design of dialogs; imagine for example a horizontal box with two buttons at the |
4130b487 | 105 | bottom of a dialog: you might want to insert a space between the two buttons and make that space stretchable |
e3950b18 | 106 | using the \arg{proportion} flag and the result will be that the left button will be aligned with the left |
4130b487 RR |
107 | side of the dialog and the right button with the right side - the space in between will shrink and grow with |
108 | the dialog.} | |
109 | ||
2b5f62a0 | 110 | \docparam{proportion}{Although the meaning of this parameter is undefined in wxSizer, it is used in wxBoxSizer |
a6f3598d | 111 | to indicate if a child of a sizer can change its size in the main orientation of the wxBoxSizer - where |
2edb0bde | 112 | 0 stands for not changeable and a value of more than zero is interpreted relative to the value of other |
f6bcfd97 BP |
113 | children of the same wxBoxSizer. For example, you might have a horizontal wxBoxSizer with three children, two |
114 | of which are supposed to change their size with the sizer. Then the two stretchable windows would get a | |
fc9c7c09 | 115 | value of 1 each to make them grow and shrink equally with the sizer's horizontal dimension.} |
a6f3598d | 116 | |
caa251e0 RD |
117 | \docparam{flag}{This parameter can be used to set a number of flags |
118 | which can be combined using the binary OR operator |. Two main | |
119 | behaviours are defined using these flags. One is the border around a | |
e3950b18 | 120 | window: the \arg{border} parameter determines the border width whereas |
caa251e0 RD |
121 | the flags given here determine which side(s) of the item that the |
122 | border will be added. The other flags determine how the sizer item | |
123 | behaves when the space allotted to the sizer changes, and is somewhat | |
124 | dependent on the specific kind of sizer used. | |
125 | ||
126 | \twocolwidtha{5cm}% | |
127 | \begin{twocollist}\itemsep=0pt | |
128 | \twocolitem{\windowstyle{wxTOP}\\ | |
129 | \windowstyle{wxBOTTOM}\\ | |
130 | \windowstyle{wxLEFT}\\ | |
131 | \windowstyle{wxRIGHT}\\ | |
132 | \windowstyle{wxALL}}{These flags are used to specify which side(s) of | |
e3950b18 | 133 | the sizer item the \arg{border} width will apply to. } |
75173186 | 134 | |
a70b2f80 DS |
135 | \twocolitem{\windowstyle{wxEXPAND}}{The item will be expanded to fill |
136 | the space assigned to the item.} | |
caa251e0 RD |
137 | \twocolitem{\windowstyle{wxSHAPED}}{The item will be expanded as much |
138 | as possible while also maintaining its aspect ratio} | |
2fa2b11b JS |
139 | \twocolitem{\windowstyle{wxFIXED\_MINSIZE}}{Normally wxSizers will use |
140 | \helpref{GetAdjustedBestSize}{wxwindowgetadjustedbestsize} to | |
141 | determine what the minimal size of window items should be, and will | |
142 | use that size to calculate the layout. This allows layouts to | |
e3950b18 | 143 | adjust when an item changes and its \arg{best size} becomes |
2fa2b11b JS |
144 | different. If you would rather have a window item stay the size it |
145 | started with then use wxFIXED\_MINSIZE.} | |
b219a1a9 | 146 | \twocolitem{\windowstyle{wxALIGN\_CENTER wxALIGN\_CENTRE}\\ |
caa251e0 RD |
147 | \windowstyle{wxALIGN\_LEFT}\\ |
148 | \windowstyle{wxALIGN\_RIGHT}\\ | |
149 | \windowstyle{wxALIGN\_TOP}\\ | |
150 | \windowstyle{wxALIGN\_BOTTOM}\\ | |
b219a1a9 VZ |
151 | \windowstyle{wxALIGN\_CENTER\_VERTICAL wxALIGN\_CENTRE\_VERTICAL}\\ |
152 | \windowstyle{wxALIGN\_CENTER\_HORIZONTAL wxALIGN\_CENTRE\_HORIZONTAL}}{The wxALIGN flags allow you to | |
2fa2b11b JS |
153 | specify the alignment of the item within the space allotted to it by |
154 | the sizer, adjusted for the border if any.} | |
caa251e0 RD |
155 | \end{twocollist} |
156 | } | |
157 | ||
e3950b18 | 158 | \docparam{border}{Determines the border width, if the \arg{flag} |
caa251e0 | 159 | parameter is set to include any border flag.} |
a6f3598d | 160 | |
76e1c2de RD |
161 | \docparam{userData}{Allows an extra object to be attached to the sizer |
162 | item, for use in derived classes when sizing information is more | |
e3950b18 | 163 | complex than the \arg{proportion} and \arg{flag} will allow for.} |
f6bcfd97 | 164 | |
40210d8a RN |
165 | \docparam{flags}{A \helpref{wxSizerFlags}{wxsizerflags} object that |
166 | enables you to specify most of the above parameters more conveniently.} | |
02c6137e | 167 | |
749bb9f1 DS |
168 | \membersection{wxSizer::AddSpacer}\label{wxsizeraddspacer} |
169 | ||
56eee37f | 170 | \func{wxSizerItem*}{AddSpacer}{\param{int }{size}} |
749bb9f1 DS |
171 | |
172 | Adds non-stretchable space to the sizer. More readable way of calling | |
173 | \helpref{Add}{wxsizeradd}(size, size, 0). | |
174 | ||
175 | ||
176 | \membersection{wxSizer::AddStretchSpacer}\label{wxsizeraddstretchspacer} | |
177 | ||
56eee37f | 178 | \func{wxSizerItem*}{AddStretchSpacer}{\param{int }{prop = 1}} |
749bb9f1 DS |
179 | |
180 | Adds stretchable space to the sizer. More readable way of calling | |
181 | \helpref{Add}{wxsizeradd}(0, 0, prop). | |
182 | ||
183 | ||
f6bcfd97 BP |
184 | \membersection{wxSizer::CalcMin}\label{wxsizercalcmin} |
185 | ||
186 | \func{wxSize}{CalcMin}{\void} | |
187 | ||
188 | This method is abstract and has to be overwritten by any derived class. | |
189 | Here, the sizer will do the actual calculation of its children minimal sizes. | |
190 | ||
02c6137e | 191 | |
e3950b18 VZ |
192 | \membersection{wxSizer::Clear}\label{wxsizerclear} |
193 | ||
194 | \func{void}{Clear}{\param{bool }{delete\_windows = false}} | |
195 | ||
196 | Detaches all children from the sizer. If \arg{delete\_windows} is \true then child windows will also be deleted. | |
197 | ||
198 | ||
00976fe5 RL |
199 | \membersection{wxSizer::Detach}\label{wxsizerdetach} |
200 | ||
201 | \func{bool}{Detach}{\param{wxWindow* }{window}} | |
202 | ||
203 | \func{bool}{Detach}{\param{wxSizer* }{sizer}} | |
204 | ||
12a3f227 | 205 | \func{bool}{Detach}{\param{size\_t }{index}} |
00976fe5 | 206 | |
e3950b18 VZ |
207 | Detach a child from the sizer without destroying it. \arg{window} is the window to be |
208 | detached, \arg{sizer} is the equivalent sizer and \arg{index} is the position of | |
00976fe5 RL |
209 | the child in the sizer, typically 0 for the first item. This method does not |
210 | cause any layout or resizing to take place, call \helpref{wxSizer::Layout}{wxsizerlayout} | |
211 | to update the layout "on screen" after detaching a child from the sizer. | |
212 | ||
cc81d32f | 213 | Returns true if the child item was found and detached, false otherwise. |
00976fe5 RL |
214 | |
215 | \wxheading{See also} | |
216 | ||
217 | \helpref{wxSizer::Remove}{wxsizerremove} | |
218 | ||
02c6137e | 219 | |
f6bcfd97 BP |
220 | \membersection{wxSizer::Fit}\label{wxsizerfit} |
221 | ||
e5251d4f | 222 | \func{wxSize}{Fit}{\param{wxWindow* }{window}} |
f6bcfd97 | 223 | |
e3950b18 | 224 | Tell the sizer to resize the \arg{window} to match the sizer's minimal size. This |
f6bcfd97 | 225 | is commonly done in the constructor of the window itself, see sample in the description |
e5251d4f | 226 | of \helpref{wxBoxSizer}{wxboxsizer}. Returns the new size. |
f6bcfd97 | 227 | |
02c6137e VZ |
228 | For a top level window this is the total window size, not client size. |
229 | ||
230 | ||
566d84a7 RL |
231 | \membersection{wxSizer::FitInside}\label{wxsizerfitinside} |
232 | ||
233 | \func{void}{FitInside}{\param{wxWindow* }{window}} | |
234 | ||
e3950b18 | 235 | Tell the sizer to resize the virtual size of the \arg{window} to match the sizer's |
566d84a7 RL |
236 | minimal size. This will not alter the on screen size of the window, but may cause |
237 | the addition/removal/alteration of scrollbars required to view the virtual area in | |
238 | windows which manage it. | |
239 | ||
240 | \wxheading{See also} | |
241 | ||
242 | \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars},\rtfsp | |
243 | \helpref{wxSizer::SetVirtualSizeHints}{wxsizersetvirtualsizehints} | |
244 | ||
02c6137e | 245 | |
f86d9a8b VZ |
246 | \membersection{wxSizer::GetChildren}\label{wxsizergetchildren} |
247 | ||
f9b5691a VZ |
248 | \constfunc{const wxSizerItemList\&}{GetChildren}{\void} |
249 | ||
f86d9a8b VZ |
250 | \func{wxSizerItemList\&}{GetChildren}{\void} |
251 | ||
252 | Returns the list of the items in this sizer. The elements of type-safe | |
253 | \helpref{wxList}{wxlist} \texttt{wxSizerItemList} are objects of type | |
254 | \helpref{wxSizerItem *}{wxsizeritem}. | |
255 | ||
256 | ||
e8cfff87 VZ |
257 | \membersection{wxSizer::GetContainingWindow}\label{wxsizergetcontainingwindow} |
258 | ||
259 | \constfunc{wxWindow *}{GetContainingWindow}{\void} | |
260 | ||
261 | Returns the window this sizer is used in or \NULL if none. | |
262 | ||
263 | ||
9f13661f WS |
264 | \membersection{wxSizer::GetItem}\label{wxsizergetitem} |
265 | ||
266 | \func{wxSizerItem *}{GetItem}{\param{wxWindow* }{window}, \param{bool }{recursive = false}} | |
267 | ||
268 | \func{wxSizerItem *}{GetItem}{\param{wxSizer* }{sizer}, \param{bool }{recursive = false}} | |
269 | ||
270 | \func{wxSizerItem *}{GetItem}{\param{size\_t }{index}} | |
271 | ||
e3950b18 VZ |
272 | Finds item of the sizer which holds given \arg{window}, \arg{sizer} or is located |
273 | in sizer at position \arg{index}. | |
274 | Use parameter \arg{recursive} to search in subsizers too. | |
9f13661f WS |
275 | |
276 | Returns pointer to item or NULL. | |
277 | ||
278 | ||
f6bcfd97 BP |
279 | \membersection{wxSizer::GetSize}\label{wxsizergetsize} |
280 | ||
281 | \func{wxSize}{GetSize}{\void} | |
282 | ||
283 | Returns the current size of the sizer. | |
284 | ||
02c6137e | 285 | |
f6bcfd97 BP |
286 | \membersection{wxSizer::GetPosition}\label{wxsizergetposition} |
287 | ||
288 | \func{wxPoint}{GetPosition}{\void} | |
289 | ||
290 | Returns the current position of the sizer. | |
291 | ||
02c6137e | 292 | |
f6bcfd97 BP |
293 | \membersection{wxSizer::GetMinSize}\label{wxsizergetminsize} |
294 | ||
295 | \func{wxSize}{GetMinSize}{\void} | |
296 | ||
297 | Returns the minimal size of the sizer. This is either the combined minimal | |
298 | size of all the children and their borders or the minimal size set by | |
299 | \helpref{SetMinSize}{wxsizersetminsize}, depending on which is bigger. | |
300 | ||
02c6137e | 301 | |
e3950b18 VZ |
302 | \membersection{wxSizer::Hide}\label{wxsizerhide} |
303 | ||
304 | \func{bool}{Hide}{\param{wxWindow* }{window}, \param{bool }{recursive = false}} | |
305 | ||
306 | \func{bool}{Hide}{\param{wxSizer* }{sizer}, \param{bool }{recursive = false}} | |
307 | ||
308 | \func{bool}{Hide}{\param{size\_t }{index}} | |
309 | ||
310 | Hides the \arg{window}, \arg{sizer}, or item at \arg{index}. | |
311 | To make a sizer item disappear, use Hide() followed by \helpref{Layout()}{wxsizerlayout}. | |
312 | Use parameter \arg{recursive} to hide elements found in subsizers. | |
313 | ||
314 | Returns \true if the child item was found, \false otherwise. | |
315 | ||
316 | \wxheading{See also} | |
317 | ||
318 | \helpref{wxSizer::IsShown}{wxsizerisshown},\rtfsp | |
319 | \helpref{wxSizer::Show}{wxsizershow} | |
320 | ||
321 | ||
00976fe5 RL |
322 | \membersection{wxSizer::Insert}\label{wxsizerinsert} |
323 | ||
40210d8a RN |
324 | \func{wxSizerItem*}{Insert}{\param{size\_t }{index}, \param{wxWindow* }{window}, \param{const wxSizerFlags\& }{flags}} |
325 | ||
56eee37f | 326 | \func{wxSizerItem*}{Insert}{\param{size\_t }{index}, \param{wxWindow* }{window}, \param{int }{proportion = 0},\param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}} |
00976fe5 | 327 | |
40210d8a RN |
328 | \func{wxSizerItem*}{Insert}{\param{size\_t }{index}, \param{wxSizer* }{sizer}, \param{const wxSizerFlags\& }{flags}} |
329 | ||
56eee37f | 330 | \func{wxSizerItem*}{Insert}{\param{size\_t }{index}, \param{wxSizer* }{sizer}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}} |
00976fe5 | 331 | |
56eee37f | 332 | \func{wxSizerItem*}{Insert}{\param{size\_t }{index}, \param{int }{width}, \param{int }{height}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}} |
00976fe5 | 333 | |
e3950b18 | 334 | Insert a child into the sizer before any existing item at \arg{index}. |
00976fe5 | 335 | |
12a3f227 | 336 | \docparam{index}{The position this child should assume in the sizer.} |
00976fe5 RL |
337 | |
338 | See \helpref{wxSizer::Add}{wxsizeradd} for the meaning of the other parameters. | |
339 | ||
02c6137e | 340 | |
749bb9f1 DS |
341 | \membersection{wxSizer::InsertSpacer}\label{wxsizerinsertspacer} |
342 | ||
56eee37f | 343 | \func{wxSizerItem*}{InsertSpacer}{\param{size\_t }{index}, \param{int }{size}} |
749bb9f1 DS |
344 | |
345 | Inserts non-stretchable space to the sizer. More readable way of calling | |
346 | \helpref{Insert}{wxsizerinsert}(size, size, 0). | |
347 | ||
348 | ||
349 | \membersection{wxSizer::InsertStretchSpacer}\label{wxsizerinsertstretchspacer} | |
350 | ||
56eee37f | 351 | \func{wxSizerItem*}{InsertStretchSpacer}{\param{size\_t }{index}, \param{int }{prop = 1}} |
749bb9f1 DS |
352 | |
353 | Inserts stretchable space to the sizer. More readable way of calling | |
354 | \helpref{Insert}{wxsizerinsert}(0, 0, prop). | |
355 | ||
356 | ||
e3950b18 VZ |
357 | \membersection{wxSizer::IsShown}\label{wxsizerisshown} |
358 | ||
359 | \constfunc{bool}{IsShown}{\param{wxWindow* }{window}} | |
360 | ||
361 | \constfunc{bool}{IsShown}{\param{wxSizer* }{sizer}} | |
362 | ||
363 | \constfunc{bool}{IsShown}{\param{size\_t }{index}} | |
364 | ||
365 | Returns \true if the \arg{window}, \arg{sizer}, or item at \arg{index} is shown. | |
366 | ||
367 | \wxheading{See also} | |
368 | ||
369 | \helpref{wxSizer::Hide}{wxsizerhide},\rtfsp | |
370 | \helpref{wxSizer::Show}{wxsizershow} | |
371 | ||
372 | ||
f6bcfd97 BP |
373 | \membersection{wxSizer::Layout}\label{wxsizerlayout} |
374 | ||
375 | \func{void}{Layout}{\void} | |
376 | ||
377 | Call this to force layout of the children anew, e.g. after having added a child | |
378 | to or removed a child (window, other sizer or space) from the sizer while keeping | |
379 | the current dimension. | |
76e1c2de | 380 | |
02c6137e | 381 | |
9c884972 | 382 | \membersection{wxSizer::Prepend}\label{wxsizerprepend} |
8fe05782 | 383 | |
40210d8a RN |
384 | \func{wxSizerItem*}{Prepend}{\param{wxWindow* }{window}, \param{const wxSizerFlags\& }{flags}} |
385 | ||
56eee37f | 386 | \func{wxSizerItem*}{Prepend}{\param{wxWindow* }{window}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}} |
8fe05782 | 387 | |
40210d8a RN |
388 | \func{wxSizerItem*}{Prepend}{\param{wxSizer* }{sizer}, \param{const wxSizerFlags\& }{flags}} |
389 | ||
56eee37f | 390 | \func{wxSizerItem*}{Prepend}{\param{wxSizer* }{sizer}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}} |
9c884972 | 391 | |
56eee37f | 392 | \func{wxSizerItem*}{Prepend}{\param{int }{width}, \param{int }{height}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border= 0}, \param{wxObject* }{userData = NULL}} |
9c884972 RR |
393 | |
394 | Same as \helpref{wxSizer::Add}{wxsizeradd}, but prepends the items to the beginning of the | |
4130b487 | 395 | list of items (windows, subsizers or spaces) owned by this sizer. |
8fe05782 | 396 | |
02c6137e | 397 | |
749bb9f1 DS |
398 | \membersection{wxSizer::PrependSpacer}\label{wxsizerprependspacer} |
399 | ||
56eee37f | 400 | \func{wxSizerItem*}{PrependSpacer}{\param{int }{size}} |
749bb9f1 DS |
401 | |
402 | Prepends non-stretchable space to the sizer. More readable way of calling | |
403 | \helpref{Prepend}{wxsizerprepend}(size, size, 0). | |
404 | ||
405 | ||
406 | \membersection{wxSizer::PrependStretchSpacer}\label{wxsizerprependstretchspacer} | |
407 | ||
56eee37f | 408 | \func{wxSizerItem*}{PrependStretchSpacer}{\param{int }{prop = 1}} |
749bb9f1 DS |
409 | |
410 | Prepends stretchable space to the sizer. More readable way of calling | |
411 | \helpref{Prepend}{wxsizerprepend}(0, 0, prop). | |
412 | ||
413 | ||
f6bcfd97 BP |
414 | \membersection{wxSizer::RecalcSizes}\label{wxsizerrecalcsizes} |
415 | ||
416 | \func{void}{RecalcSizes}{\void} | |
417 | ||
418 | This method is abstract and has to be overwritten by any derived class. | |
419 | Here, the sizer will do the actual calculation of its children's positions | |
420 | and sizes. | |
421 | ||
02c6137e | 422 | |
9c884972 RR |
423 | \membersection{wxSizer::Remove}\label{wxsizerremove} |
424 | ||
425 | \func{bool}{Remove}{\param{wxWindow* }{window}} | |
426 | ||
427 | \func{bool}{Remove}{\param{wxSizer* }{sizer}} | |
428 | ||
12a3f227 | 429 | \func{bool}{Remove}{\param{size\_t }{index}} |
9c884972 | 430 | |
8258c3dd VZ |
431 | Removes a child from the sizer and destroys it if it is a sizer or a spacer, |
432 | but not if it is a window (because windows are owned by their parent window, | |
433 | not the sizer). \arg{sizer} is the wxSizer to be removed, | |
434 | \arg{index} is the position of the child in the sizer, e.g. $0$ for the first item. | |
12a3f227 | 435 | This method does not cause any layout or resizing to take place, call |
00976fe5 RL |
436 | \helpref{wxSizer::Layout}{wxsizerlayout} to update the layout "on screen" after removing a |
437 | child from the sizer. | |
438 | ||
8258c3dd VZ |
439 | {\bf NB:} The method taking a wxWindow* parameter is deprecated as it does not |
440 | destroy the window as would usually be expected from Remove. You should use | |
441 | \helpref{wxSizer::Detach}{wxsizerdetach} in new code instead. There is | |
442 | currently no wxSizer method that will both detach and destroy a wxWindow item. | |
9c884972 | 443 | |
cc81d32f | 444 | Returns true if the child item was found and removed, false otherwise. |
8fe05782 | 445 | |
02c6137e | 446 | |
eae0338f RR |
447 | \membersection{wxSizer::Replace}\label{wxsizerreplace} |
448 | ||
449 | \func{bool}{Replace}{\param{wxWindow* }{oldwin}, \param{wxWindow* }{newwin}, \param{bool }{recursive = false}} | |
450 | ||
451 | \func{bool}{Replace}{\param{wxSizer* }{oldsz}, \param{wxSizer* }{newsz}, \param{bool }{recursive = false}} | |
452 | ||
453 | \func{bool}{Remove}{\param{size\_t }{oldindex}, \param{wxSizerItem* }{newitem}} | |
454 | ||
455 | Detaches the given \arg{oldwin}, \arg{oldsz} child from the sizer and | |
456 | replaces it with the given window, sizer, or wxSizerItem. | |
457 | ||
458 | The detached child is removed {\bf only} if it is a sizer or a spacer | |
459 | (because windows are owned by their parent window, not the sizer). | |
460 | ||
461 | Use parameter \arg{recursive} to search the given element recursively in subsizers. | |
462 | ||
463 | ||
464 | This method does not cause any layout or resizing to take place, call | |
465 | \helpref{wxSizer::Layout}{wxsizerlayout} to update the layout "on screen" after replacing a | |
466 | child from the sizer. | |
467 | ||
468 | Returns true if the child item was found and removed, false otherwise. | |
469 | ||
470 | ||
8fe05782 VZ |
471 | \membersection{wxSizer::SetDimension}\label{wxsizersetdimension} |
472 | ||
473 | \func{void}{SetDimension}{\param{int }{x}, \param{int }{y}, \param{int }{width}, \param{int }{height}} | |
474 | ||
9c884972 | 475 | Call this to force the sizer to take the given dimension and thus force the items owned |
2edb0bde | 476 | by the sizer to resize themselves according to the rules defined by the parameter in the |
f6bcfd97 | 477 | \helpref{Add}{wxsizeradd} and \helpref{Prepend}{wxsizerprepend} methods. |
8fe05782 | 478 | |
02c6137e | 479 | |
f6bcfd97 | 480 | \membersection{wxSizer::SetMinSize}\label{wxsizersetminsize} |
8fe05782 | 481 | |
f6bcfd97 | 482 | \func{void}{SetMinSize}{\param{int }{width}, \param{int }{height}} |
8fe05782 | 483 | |
fbfb8bcc | 484 | \func{void}{SetMinSize}{\param{const wxSize\& }{size}} |
8fe05782 | 485 | |
f6bcfd97 BP |
486 | Call this to give the sizer a minimal size. Normally, the sizer will calculate its |
487 | minimal size based purely on how much space its children need. After calling this | |
488 | method \helpref{GetMinSize}{wxsizergetminsize} will return either the minimal size | |
489 | as requested by its children or the minimal size set here, depending on which is | |
490 | bigger. | |
8fe05782 | 491 | |
02c6137e | 492 | |
f6bcfd97 | 493 | \membersection{wxSizer::SetItemMinSize}\label{wxsizersetitemminsize} |
8fe05782 | 494 | |
f6bcfd97 | 495 | \func{void}{SetItemMinSize}{\param{wxWindow* }{window}, \param{int}{ width}, \param{int}{ height}} |
8fe05782 | 496 | |
f6bcfd97 | 497 | \func{void}{SetItemMinSize}{\param{wxSizer* }{sizer}, \param{int}{ width}, \param{int}{ height}} |
8fe05782 | 498 | |
12a3f227 | 499 | \func{void}{SetItemMinSize}{\param{size\_t }{index}, \param{int}{ width}, \param{int}{ height}} |
8fe05782 | 500 | |
f6bcfd97 BP |
501 | Set an item's minimum size by window, sizer, or position. The item will be found recursively |
502 | in the sizer's descendants. This function enables an application to set the size of an item | |
503 | after initial creation. | |
8fe05782 | 504 | |
02c6137e | 505 | |
8fe05782 VZ |
506 | \membersection{wxSizer::SetSizeHints}\label{wxsizersetsizehints} |
507 | ||
508 | \func{void}{SetSizeHints}{\param{wxWindow* }{window}} | |
509 | ||
fd52f255 RR |
510 | This method first calls \helpref{wxSizer::Fit}{wxsizerfit} and then |
511 | \helpref{SetSizeHints}{wxtoplevelwindowsetsizehints} on the {\it window} | |
512 | passed to it. This only makes sense when {\it window} is actually a | |
513 | \helpref{wxTopLevelWindow}{wxtoplevelwindow} such as a wxFrame or a | |
514 | wxDialog, since SetSizeHints only has any effect in these classes. | |
515 | It does nothing in normal windows or controls. | |
566d84a7 | 516 | |
fd52f255 RR |
517 | This method is commonly invoked in the constructor of a toplevel window itself |
518 | (see the sample in the description of \helpref{wxBoxSizer}{wxboxsizer}) if the | |
519 | toplevel window is resizable. | |
02c6137e | 520 | |
566d84a7 RL |
521 | \membersection{wxSizer::SetVirtualSizeHints}\label{wxsizersetvirtualsizehints} |
522 | ||
523 | \func{void}{SetVirtualSizeHints}{\param{wxWindow* }{window}} | |
524 | ||
e3950b18 | 525 | Tell the sizer to set the minimal size of the \arg{window} virtual area to match the sizer's |
2b5f62a0 | 526 | minimal size. For windows with managed scrollbars this will set them appropriately. |
566d84a7 RL |
527 | |
528 | \wxheading{See also} | |
529 | ||
530 | \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars} | |
7e9a386e | 531 | |
02c6137e | 532 | |
2b5f62a0 VZ |
533 | \membersection{wxSizer::Show}\label{wxsizershow} |
534 | ||
8b2bac62 | 535 | \func{bool}{Show}{\param{wxWindow* }{window}, \param{bool }{show = true}, \param{bool }{recursive = false}} |
2b5f62a0 | 536 | |
8b2bac62 | 537 | \func{bool}{Show}{\param{wxSizer* }{sizer}, \param{bool }{show = true}, \param{bool }{recursive = false}} |
2b5f62a0 | 538 | |
8b2bac62 | 539 | \func{bool}{Show}{\param{size\_t }{index}, \param{bool }{show = true}} |
12a3f227 | 540 | |
e3950b18 VZ |
541 | Shows or hides the \arg{window}, \arg{sizer}, or item at \arg{index}. |
542 | To make a sizer item disappear or reappear, use Show() followed by \helpref{Layout()}{wxsizerlayout}. | |
543 | Use parameter \arg{recursive} to show or hide elements found in subsizers. | |
8b2bac62 WS |
544 | |
545 | Returns true if the child item was found, false otherwise. | |
2b5f62a0 | 546 | |
e3950b18 VZ |
547 | \wxheading{See also} |
548 | ||
549 | \helpref{wxSizer::Hide}{wxsizerhide},\rtfsp | |
550 | \helpref{wxSizer::IsShown}{wxsizerisshown} | |
0497e172 | 551 | |
2a3c8b65 RN |
552 | |
553 | ||
554 | ||
555 | \section{\class{wxSizerFlags}}\label{wxsizerflags} | |
556 | ||
62637495 VZ |
557 | Normally, when you add an item to a sizer via |
558 | \helpref{wxSizer::Add}{wxsizeradd}, you have to specify a lot of flags and | |
559 | parameters which can be unwieldy. This is where wxSizerFlags comes in: it | |
560 | allows you to specify all parameters using the named methods instead. For | |
561 | example, instead of | |
40210d8a | 562 | |
62637495 | 563 | \begin{verbatim} |
58611b5a | 564 | sizer->Add(ctrl, 0, wxEXPAND | wxALL, 10); |
62637495 | 565 | \end{verbatim} |
2a3c8b65 | 566 | |
62637495 | 567 | you can now write |
2a3c8b65 | 568 | |
62637495 VZ |
569 | \begin{verbatim} |
570 | sizer->Add(ctrl, wxSizerFlags().Expand().Border(10)); | |
571 | \end{verbatim} | |
572 | ||
573 | This is more readable and also allows you to create wxSizerFlags objects which | |
574 | can be reused for several sizer items. | |
575 | \begin{verbatim} | |
576 | wxSizerFlags flagsExpand(1); | |
577 | flagsExpand.Expand().Border(10); | |
578 | ||
579 | sizer->Add(ctrl1, flagsExpand); | |
580 | sizer->Add(ctrl2, flagsExpand); | |
581 | \end{verbatim} | |
582 | ||
583 | Note that by specification, all methods of wxSizerFlags return the wxSizerFlags | |
584 | object itself to allowing chaining multiple methods calls like in the examples | |
585 | above. | |
2a3c8b65 | 586 | |
991ad6cd VZ |
587 | \wxheading{See also} |
588 | ||
589 | \helpref{wxSizer}{wxsizer} | |
590 | ||
591 | \wxheading{Derived from} | |
592 | ||
593 | No base class | |
594 | ||
595 | \wxheading{Include files} | |
596 | ||
597 | <wx/sizer.h> | |
598 | ||
a7af285d VZ |
599 | \wxheading{Library} |
600 | ||
601 | \helpref{wxCore}{librarieslist} | |
602 | ||
991ad6cd | 603 | \latexignore{\rtfignore{\wxheading{Members}}} |
f2fe4f67 | 604 | |
9a75ba66 | 605 | \membersection{wxSizerFlags::wxSizerFlags}\label{wxsizerflagsctor} |
2a3c8b65 RN |
606 | |
607 | \func{}{wxSizerFlags}{\param{int }{proportion = 0}} | |
608 | ||
2be7beda | 609 | Creates the wxSizer with the proportion specified by \arg{proportion}. |
2a3c8b65 RN |
610 | |
611 | ||
f2fe4f67 | 612 | \membersection{wxSizerFlags::Align}\label{wxsizerflagsalign} |
2a3c8b65 RN |
613 | |
614 | \func{wxSizerFlags\& }{Align}{\param{int }{align = 0}} | |
615 | ||
2be7beda | 616 | Sets the alignment of this wxSizerFlags to \arg{align}. |
2a3c8b65 RN |
617 | |
618 | Note that if this method is not called, the wxSizerFlags has no specified alignment. | |
619 | ||
e72ac082 VZ |
620 | \wxheading{See also} |
621 | ||
ccee328e | 622 | \helpref{Top}{wxsizerflagstop},\\ |
e72ac082 VZ |
623 | \helpref{Left}{wxsizerflagsleft},\\ |
624 | \helpref{Right}{wxsizerflagsright},\\ | |
ccee328e | 625 | \helpref{Bottom}{wxsizerflagsbottom},\\ |
e72ac082 VZ |
626 | \helpref{Centre}{wxsizerflagscentre} |
627 | ||
2a3c8b65 | 628 | |
f2fe4f67 | 629 | \membersection{wxSizerFlags::Border}\label{wxsizerflagsborder} |
2a3c8b65 RN |
630 | |
631 | \func{wxSizerFlags\& }{Border}{\param{int }{direction}, \param{int }{borderinpixels}} | |
632 | ||
2a3c8b65 RN |
633 | \func{wxSizerFlags\& }{Border}{\param{int }{direction = wxALL}} |
634 | ||
2be7beda VZ |
635 | Sets the wxSizerFlags to have a border of a number of pixels specified by |
636 | \arg{borderinpixels} with the directions specified by \arg{direction}. | |
637 | ||
638 | In the overloaded version without \arg{borderinpixels} parameter, the border of | |
639 | default size, as returned by \helpref{GetDefaultBorder}{wxsizerflagsgetdefaultborder}, | |
640 | is used. | |
2a3c8b65 RN |
641 | |
642 | ||
ccee328e VZ |
643 | \membersection{wxSizerFlags::Bottom}\label{wxsizerflagsbottom} |
644 | ||
645 | \func{wxSizerFlags\& }{Bottom}{\void} | |
646 | ||
647 | Aligns the object to the bottom, shortcut for \texttt{Align(wxALIGN\_BOTTOM)} | |
648 | ||
649 | \wxheading{See also} | |
650 | ||
651 | \helpref{Align}{wxsizerflagsalign} | |
652 | ||
653 | ||
f2fe4f67 | 654 | \membersection{wxSizerFlags::Center}\label{wxsizerflagscenter} |
2a3c8b65 RN |
655 | |
656 | \func{wxSizerFlags\& }{Center}{\void} | |
657 | ||
658 | Sets the object of the wxSizerFlags to center itself in the area it is given. | |
659 | ||
660 | ||
f2fe4f67 | 661 | \membersection{wxSizerFlags::Centre}\label{wxsizerflagscentre} |
2a3c8b65 RN |
662 | |
663 | \func{wxSizerFlags\& }{Centre}{\void} | |
664 | ||
665 | \helpref{wxSizerFlags::Center}{wxsizerflagscenter} for people with the other dialect of english. | |
666 | ||
667 | ||
25eb10d2 VZ |
668 | \membersection{wxSizerFlags::DoubleBorder}\label{wxsizerflagsdoubleborder} |
669 | ||
670 | \func{wxSizerFlags\& }{DoubleBorder}{\param{int }{direction = wxALL}} | |
671 | ||
672 | Sets the border in the given \arg{direction} having twice the default border | |
673 | size. | |
674 | ||
675 | ||
676 | \membersection{wxSizerFlags::DoubleHorzBorder}\label{wxsizerflagsdoublehorzborder} | |
677 | ||
678 | \func{wxSizerFlags\& }{DoubleHorzBorder}{\void} | |
679 | ||
680 | Sets the border in left and right directions having twice the default border | |
681 | size. | |
682 | ||
683 | ||
f2fe4f67 | 684 | \membersection{wxSizerFlags::Expand}\label{wxsizerflagsexpand} |
2a3c8b65 | 685 | |
0f353563 | 686 | \func{wxSizerFlags\& }{Expand}{\void} |
2a3c8b65 RN |
687 | |
688 | Sets the object of the wxSizerFlags to expand to fill as much area as it can. | |
689 | ||
690 | ||
2be7beda VZ |
691 | \membersection{wxSizerFlags::GetDefaultBorder}\label{wxsizerflagsgetdefaultborder} |
692 | ||
693 | \func{static int}{GetDefaultBorder}{\void} | |
694 | ||
695 | Returns the border used by default in \helpref{Border}{wxsizerflagsborder} method. | |
696 | ||
697 | ||
e72ac082 VZ |
698 | \membersection{wxSizerFlags::Left}\label{wxsizerflagsleft} |
699 | ||
700 | \func{wxSizerFlags\& }{Left}{\void} | |
701 | ||
702 | Aligns the object to the left, shortcut for \texttt{Align(wxALIGN\_LEFT)} | |
703 | ||
704 | \wxheading{See also} | |
705 | ||
706 | \helpref{Align}{wxsizerflagsalign} | |
707 | ||
708 | ||
d95527de VZ |
709 | \membersection{wxSizerFlags::FixedMinSize}\label{wxsizerflagsfixedminsize} |
710 | ||
711 | \func{wxSizerFlags\& }{FixedMinSize}{\void} | |
712 | ||
713 | Set the \texttt{wxFIXED\_MINSIZE} flag which indicates that the initial size of | |
714 | the window should be also set as its minimal size. | |
715 | ||
716 | ||
f2fe4f67 | 717 | \membersection{wxSizerFlags::Proportion}\label{wxsizerflagsproportion} |
2a3c8b65 RN |
718 | |
719 | \func{wxSizerFlags\& }{Proportion}{\param{int }{proportion = 0}} | |
720 | ||
2be7beda | 721 | Sets the proportion of this wxSizerFlags to \arg{proportion} |
2a3c8b65 RN |
722 | |
723 | ||
e72ac082 VZ |
724 | \membersection{wxSizerFlags::Right}\label{wxsizerflagsright} |
725 | ||
726 | \func{wxSizerFlags\& }{Right}{\void} | |
727 | ||
728 | Aligns the object to the right, shortcut for \texttt{Align(wxALIGN\_RIGHT)} | |
729 | ||
730 | \wxheading{See also} | |
731 | ||
732 | \helpref{Align}{wxsizerflagsalign} | |
2a3c8b65 | 733 | |
25eb10d2 | 734 | |
d95527de VZ |
735 | \membersection{wxSizerFlags::Shaped}\label{wxsizerflagsshaped} |
736 | ||
737 | \func{wxSizerFlags\& }{Shaped}{\void} | |
738 | ||
739 | Set the \texttt{wx\_SHAPED} flag which indicates that the elements should | |
740 | always keep the fixed width to height ratio equal to its original value. | |
741 | ||
742 | ||
ccee328e VZ |
743 | \membersection{wxSizerFlags::Top}\label{wxsizerflagstop} |
744 | ||
745 | \func{wxSizerFlags\& }{Top}{\void} | |
746 | ||
747 | Aligns the object to the top, shortcut for \texttt{Align(wxALIGN\_TOP)} | |
748 | ||
749 | \wxheading{See also} | |
750 | ||
751 | \helpref{Align}{wxsizerflagsalign} | |
752 | ||
753 | ||
25eb10d2 VZ |
754 | \membersection{wxSizerFlags::TripleBorder}\label{wxsizerflagstriplebleborder} |
755 | ||
756 | \func{wxSizerFlags\& }{TripleBorder}{\param{int }{direction = wxALL}} | |
757 | ||
758 | Sets the border in the given \arg{direction} having thrice the default border | |
759 | size. | |
760 | ||
761 |