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