]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/sizer.tex
unified wxFRAME_EX_CONTEXTHELP and wxDIALOG_EX_CONTEXTHELP in a single wxWS_EX_CONTEX...
[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 \pythonnote{If you wish to create a sizer class in wxPython you should
35 derive the class from {\tt wxPySizer} in order to get Python-aware
36 capabilities for the various virtual methods.}
37
38 \wxheading{Derived from}
39
40 \helpref{wxObject}{wxobject}\\
41 \helpref{wxClientDataContainer}{wxclientdatacontainer}
42
43 \wxheading{Include files}
44
45 <wx/sizer.h>
46
47 \wxheading{See also}
48
49 \helpref{Sizer overview}{sizeroverview}
50
51 \latexignore{\rtfignore{\wxheading{Members}}}
52
53
54 \membersection{wxSizer::wxSizer}\label{wxsizerwxsizer}
55
56 \func{}{wxSizer}{\void}
57
58 The constructor. Note that wxSizer is an abstract base class and may not
59 be instantiated.
60
61
62 \membersection{wxSizer::\destruct{wxSizer}}\label{wxsizerdtor}
63
64 \func{}{\destruct{wxSizer}}{\void}
65
66 The destructor.
67
68
69 \membersection{wxSizer::Add}\label{wxsizeradd}
70
71 \func{wxSizerItem*}{Add}{\param{wxWindow* }{window}, \param{const wxSizerFlags\& }{flags}}
72
73 \func{wxSizerItem*}{Add}{\param{wxWindow* }{window}, \param{int }{proportion = 0},\param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
74
75 \func{wxSizerItem*}{Add}{\param{wxSizer* }{sizer}, \param{const wxSizerFlags\& }{flags}}
76
77 \func{wxSizerItem*}{Add}{\param{wxSizer* }{sizer}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
78
79 \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}}
80
81 Appends a child to the sizer. wxSizer itself is an abstract class, but the parameters are
82 equivalent in the derived classes that you will instantiate to use it so they are described
83 here:
84
85 \docparam{window}{The window to be added to the sizer. Its initial size (either set explicitly by the
86 user or calculated internally when using wxDefaultSize) is interpreted as the minimal and in many
87 cases also the initial size. This is particularly useful in connection with \helpref{SetSizeHints}{wxsizersetsizehints}.}
88
89 \docparam{sizer}{The (child-)sizer to be added to the sizer. This allows placing a child sizer in a
90 sizer and thus to create hierarchies of sizers (typically a vertical box as the top sizer and several
91 horizontal boxes on the level beneath).}
92
93 \docparam{width and height}{The dimension of a spacer to be added to the sizer. Adding spacers to sizers
94 gives more flexibility in the design of dialogs; imagine for example a horizontal box with two buttons at the
95 bottom of a dialog: you might want to insert a space between the two buttons and make that space stretchable
96 using the \arg{proportion} flag and the result will be that the left button will be aligned with the left
97 side of the dialog and the right button with the right side - the space in between will shrink and grow with
98 the dialog.}
99
100 \docparam{proportion}{Although the meaning of this parameter is undefined in wxSizer, it is used in wxBoxSizer
101 to indicate if a child of a sizer can change its size in the main orientation of the wxBoxSizer - where
102 0 stands for not changeable and a value of more than zero is interpreted relative to the value of other
103 children of the same wxBoxSizer. For example, you might have a horizontal wxBoxSizer with three children, two
104 of which are supposed to change their size with the sizer. Then the two stretchable windows would get a
105 value of 1 each to make them grow and shrink equally with the sizer's horizontal dimension.}
106
107 \docparam{flag}{This parameter can be used to set a number of flags
108 which can be combined using the binary OR operator |. Two main
109 behaviours are defined using these flags. One is the border around a
110 window: the \arg{border} parameter determines the border width whereas
111 the flags given here determine which side(s) of the item that the
112 border will be added. The other flags determine how the sizer item
113 behaves when the space allotted to the sizer changes, and is somewhat
114 dependent on the specific kind of sizer used.
115
116 \twocolwidtha{5cm}%
117 \begin{twocollist}\itemsep=0pt
118 \twocolitem{\windowstyle{wxTOP}\\
119 \windowstyle{wxBOTTOM}\\
120 \windowstyle{wxLEFT}\\
121 \windowstyle{wxRIGHT}\\
122 \windowstyle{wxALL}}{These flags are used to specify which side(s) of
123 the sizer item the \arg{border} width will apply to. }
124
125 \twocolitem{\windowstyle{wxEXPAND}}{The item will be expanded to fill
126 the space assigned to the item.}
127 \twocolitem{\windowstyle{wxSHAPED}}{The item will be expanded as much
128 as possible while also maintaining its aspect ratio}
129 \twocolitem{\windowstyle{wxFIXED\_MINSIZE}}{Normally wxSizers will use
130 \helpref{GetAdjustedBestSize}{wxwindowgetadjustedbestsize} to
131 determine what the minimal size of window items should be, and will
132 use that size to calculate the layout. This allows layouts to
133 adjust when an item changes and its \arg{best size} becomes
134 different. If you would rather have a window item stay the size it
135 started with then use wxFIXED\_MINSIZE.}
136 \twocolitem{\windowstyle{wxALIGN\_CENTER wxALIGN\_CENTRE}\\
137 \windowstyle{wxALIGN\_LEFT}\\
138 \windowstyle{wxALIGN\_RIGHT}\\
139 \windowstyle{wxALIGN\_TOP}\\
140 \windowstyle{wxALIGN\_BOTTOM}\\
141 \windowstyle{wxALIGN\_CENTER\_VERTICAL wxALIGN\_CENTRE\_VERTICAL}\\
142 \windowstyle{wxALIGN\_CENTER\_HORIZONTAL wxALIGN\_CENTRE\_HORIZONTAL}}{The wxALIGN flags allow you to
143 specify the alignment of the item within the space allotted to it by
144 the sizer, adjusted for the border if any.}
145 \end{twocollist}
146 }
147
148 \docparam{border}{Determines the border width, if the \arg{flag}
149 parameter is set to include any border flag.}
150
151 \docparam{userData}{Allows an extra object to be attached to the sizer
152 item, for use in derived classes when sizing information is more
153 complex than the \arg{proportion} and \arg{flag} will allow for.}
154
155 \docparam{flags}{A \helpref{wxSizerFlags}{wxsizerflags} object that
156 enables you to specify most of the above parameters more conveniently.}
157
158 \membersection{wxSizer::AddSpacer}\label{wxsizeraddspacer}
159
160 \func{wxSizerItem*}{AddSpacer}{\param{int }{size}}
161
162 Adds non-stretchable space to the sizer. More readable way of calling
163 \helpref{Add}{wxsizeradd}(size, size, 0).
164
165
166 \membersection{wxSizer::AddStretchSpacer}\label{wxsizeraddstretchspacer}
167
168 \func{wxSizerItem*}{AddStretchSpacer}{\param{int }{prop = 1}}
169
170 Adds stretchable space to the sizer. More readable way of calling
171 \helpref{Add}{wxsizeradd}(0, 0, prop).
172
173
174 \membersection{wxSizer::CalcMin}\label{wxsizercalcmin}
175
176 \func{wxSize}{CalcMin}{\void}
177
178 This method is abstract and has to be overwritten by any derived class.
179 Here, the sizer will do the actual calculation of its children minimal sizes.
180
181
182 \membersection{wxSizer::Clear}\label{wxsizerclear}
183
184 \func{void}{Clear}{\param{bool }{delete\_windows = false}}
185
186 Detaches all children from the sizer. If \arg{delete\_windows} is \true then child windows will also be deleted.
187
188
189 \membersection{wxSizer::Detach}\label{wxsizerdetach}
190
191 \func{bool}{Detach}{\param{wxWindow* }{window}}
192
193 \func{bool}{Detach}{\param{wxSizer* }{sizer}}
194
195 \func{bool}{Detach}{\param{size\_t }{index}}
196
197 Detach a child from the sizer without destroying it. \arg{window} is the window to be
198 detached, \arg{sizer} is the equivalent sizer and \arg{index} is the position of
199 the child in the sizer, typically 0 for the first item. This method does not
200 cause any layout or resizing to take place, call \helpref{wxSizer::Layout}{wxsizerlayout}
201 to update the layout "on screen" after detaching a child from the sizer.
202
203 Returns true if the child item was found and detached, false otherwise.
204
205 \wxheading{See also}
206
207 \helpref{wxSizer::Remove}{wxsizerremove}
208
209
210 \membersection{wxSizer::Fit}\label{wxsizerfit}
211
212 \func{wxSize}{Fit}{\param{wxWindow* }{window}}
213
214 Tell the sizer to resize the \arg{window} to match the sizer's minimal size. This
215 is commonly done in the constructor of the window itself, see sample in the description
216 of \helpref{wxBoxSizer}{wxboxsizer}. Returns the new size.
217
218 For a top level window this is the total window size, not client size.
219
220
221 \membersection{wxSizer::FitInside}\label{wxsizerfitinside}
222
223 \func{void}{FitInside}{\param{wxWindow* }{window}}
224
225 Tell the sizer to resize the virtual size of the \arg{window} to match the sizer's
226 minimal size. This will not alter the on screen size of the window, but may cause
227 the addition/removal/alteration of scrollbars required to view the virtual area in
228 windows which manage it.
229
230 \wxheading{See also}
231
232 \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars},\rtfsp
233 \helpref{wxSizer::SetVirtualSizeHints}{wxsizersetvirtualsizehints}
234
235
236 \membersection{wxSizer::GetItem}\label{wxsizergetitem}
237
238 \func{wxSizerItem *}{GetItem}{\param{wxWindow* }{window}, \param{bool }{recursive = false}}
239
240 \func{wxSizerItem *}{GetItem}{\param{wxSizer* }{sizer}, \param{bool }{recursive = false}}
241
242 \func{wxSizerItem *}{GetItem}{\param{size\_t }{index}}
243
244 Finds item of the sizer which holds given \arg{window}, \arg{sizer} or is located
245 in sizer at position \arg{index}.
246 Use parameter \arg{recursive} to search in subsizers too.
247
248 Returns pointer to item or NULL.
249
250
251 \membersection{wxSizer::GetSize}\label{wxsizergetsize}
252
253 \func{wxSize}{GetSize}{\void}
254
255 Returns the current size of the sizer.
256
257
258 \membersection{wxSizer::GetPosition}\label{wxsizergetposition}
259
260 \func{wxPoint}{GetPosition}{\void}
261
262 Returns the current position of the sizer.
263
264
265 \membersection{wxSizer::GetMinSize}\label{wxsizergetminsize}
266
267 \func{wxSize}{GetMinSize}{\void}
268
269 Returns the minimal size of the sizer. This is either the combined minimal
270 size of all the children and their borders or the minimal size set by
271 \helpref{SetMinSize}{wxsizersetminsize}, depending on which is bigger.
272
273
274 \membersection{wxSizer::Hide}\label{wxsizerhide}
275
276 \func{bool}{Hide}{\param{wxWindow* }{window}, \param{bool }{recursive = false}}
277
278 \func{bool}{Hide}{\param{wxSizer* }{sizer}, \param{bool }{recursive = false}}
279
280 \func{bool}{Hide}{\param{size\_t }{index}}
281
282 Hides the \arg{window}, \arg{sizer}, or item at \arg{index}.
283 To make a sizer item disappear, use Hide() followed by \helpref{Layout()}{wxsizerlayout}.
284 Use parameter \arg{recursive} to hide elements found in subsizers.
285
286 Returns \true if the child item was found, \false otherwise.
287
288 \wxheading{See also}
289
290 \helpref{wxSizer::IsShown}{wxsizerisshown},\rtfsp
291 \helpref{wxSizer::Show}{wxsizershow}
292
293
294 \membersection{wxSizer::Insert}\label{wxsizerinsert}
295
296 \func{wxSizerItem*}{Insert}{\param{size\_t }{index}, \param{wxWindow* }{window}, \param{const wxSizerFlags\& }{flags}}
297
298 \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}}
299
300 \func{wxSizerItem*}{Insert}{\param{size\_t }{index}, \param{wxSizer* }{sizer}, \param{const wxSizerFlags\& }{flags}}
301
302 \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}}
303
304 \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}}
305
306 Insert a child into the sizer before any existing item at \arg{index}.
307
308 \docparam{index}{The position this child should assume in the sizer.}
309
310 See \helpref{wxSizer::Add}{wxsizeradd} for the meaning of the other parameters.
311
312
313 \membersection{wxSizer::InsertSpacer}\label{wxsizerinsertspacer}
314
315 \func{wxSizerItem*}{InsertSpacer}{\param{size\_t }{index}, \param{int }{size}}
316
317 Inserts non-stretchable space to the sizer. More readable way of calling
318 \helpref{Insert}{wxsizerinsert}(size, size, 0).
319
320
321 \membersection{wxSizer::InsertStretchSpacer}\label{wxsizerinsertstretchspacer}
322
323 \func{wxSizerItem*}{InsertStretchSpacer}{\param{size\_t }{index}, \param{int }{prop = 1}}
324
325 Inserts stretchable space to the sizer. More readable way of calling
326 \helpref{Insert}{wxsizerinsert}(0, 0, prop).
327
328
329 \membersection{wxSizer::IsShown}\label{wxsizerisshown}
330
331 \constfunc{bool}{IsShown}{\param{wxWindow* }{window}}
332
333 \constfunc{bool}{IsShown}{\param{wxSizer* }{sizer}}
334
335 \constfunc{bool}{IsShown}{\param{size\_t }{index}}
336
337 Returns \true if the \arg{window}, \arg{sizer}, or item at \arg{index} is shown.
338
339 \wxheading{See also}
340
341 \helpref{wxSizer::Hide}{wxsizerhide},\rtfsp
342 \helpref{wxSizer::Show}{wxsizershow}
343
344
345 \membersection{wxSizer::Layout}\label{wxsizerlayout}
346
347 \func{void}{Layout}{\void}
348
349 Call this to force layout of the children anew, e.g. after having added a child
350 to or removed a child (window, other sizer or space) from the sizer while keeping
351 the current dimension.
352
353
354 \membersection{wxSizer::Prepend}\label{wxsizerprepend}
355
356 \func{wxSizerItem*}{Prepend}{\param{wxWindow* }{window}, \param{const wxSizerFlags\& }{flags}}
357
358 \func{wxSizerItem*}{Prepend}{\param{wxWindow* }{window}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
359
360 \func{wxSizerItem*}{Prepend}{\param{wxSizer* }{sizer}, \param{const wxSizerFlags\& }{flags}}
361
362 \func{wxSizerItem*}{Prepend}{\param{wxSizer* }{sizer}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
363
364 \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}}
365
366 Same as \helpref{wxSizer::Add}{wxsizeradd}, but prepends the items to the beginning of the
367 list of items (windows, subsizers or spaces) owned by this sizer.
368
369
370 \membersection{wxSizer::PrependSpacer}\label{wxsizerprependspacer}
371
372 \func{wxSizerItem*}{PrependSpacer}{\param{int }{size}}
373
374 Prepends non-stretchable space to the sizer. More readable way of calling
375 \helpref{Prepend}{wxsizerprepend}(size, size, 0).
376
377
378 \membersection{wxSizer::PrependStretchSpacer}\label{wxsizerprependstretchspacer}
379
380 \func{wxSizerItem*}{PrependStretchSpacer}{\param{int }{prop = 1}}
381
382 Prepends stretchable space to the sizer. More readable way of calling
383 \helpref{Prepend}{wxsizerprepend}(0, 0, prop).
384
385
386 \membersection{wxSizer::RecalcSizes}\label{wxsizerrecalcsizes}
387
388 \func{void}{RecalcSizes}{\void}
389
390 This method is abstract and has to be overwritten by any derived class.
391 Here, the sizer will do the actual calculation of its children's positions
392 and sizes.
393
394
395 \membersection{wxSizer::Remove}\label{wxsizerremove}
396
397 \func{bool}{Remove}{\param{wxWindow* }{window}}
398
399 \func{bool}{Remove}{\param{wxSizer* }{sizer}}
400
401 \func{bool}{Remove}{\param{size\_t }{index}}
402
403 Removes a child from the sizer and destroys it if it is a sizer or a spacer,
404 but not if it is a window (because windows are owned by their parent window,
405 not the sizer). \arg{sizer} is the wxSizer to be removed,
406 \arg{index} is the position of the child in the sizer, e.g. $0$ for the first item.
407 This method does not cause any layout or resizing to take place, call
408 \helpref{wxSizer::Layout}{wxsizerlayout} to update the layout "on screen" after removing a
409 child from the sizer.
410
411 {\bf NB:} The method taking a wxWindow* parameter is deprecated as it does not
412 destroy the window as would usually be expected from Remove. You should use
413 \helpref{wxSizer::Detach}{wxsizerdetach} in new code instead. There is
414 currently no wxSizer method that will both detach and destroy a wxWindow item.
415
416 Returns true if the child item was found and removed, false otherwise.
417
418
419 \membersection{wxSizer::SetDimension}\label{wxsizersetdimension}
420
421 \func{void}{SetDimension}{\param{int }{x}, \param{int }{y}, \param{int }{width}, \param{int }{height}}
422
423 Call this to force the sizer to take the given dimension and thus force the items owned
424 by the sizer to resize themselves according to the rules defined by the parameter in the
425 \helpref{Add}{wxsizeradd} and \helpref{Prepend}{wxsizerprepend} methods.
426
427
428 \membersection{wxSizer::SetMinSize}\label{wxsizersetminsize}
429
430 \func{void}{SetMinSize}{\param{int }{width}, \param{int }{height}}
431
432 \func{void}{SetMinSize}{\param{const wxSize\& }{size}}
433
434 Call this to give the sizer a minimal size. Normally, the sizer will calculate its
435 minimal size based purely on how much space its children need. After calling this
436 method \helpref{GetMinSize}{wxsizergetminsize} will return either the minimal size
437 as requested by its children or the minimal size set here, depending on which is
438 bigger.
439
440
441 \membersection{wxSizer::SetItemMinSize}\label{wxsizersetitemminsize}
442
443 \func{void}{SetItemMinSize}{\param{wxWindow* }{window}, \param{int}{ width}, \param{int}{ height}}
444
445 \func{void}{SetItemMinSize}{\param{wxSizer* }{sizer}, \param{int}{ width}, \param{int}{ height}}
446
447 \func{void}{SetItemMinSize}{\param{size\_t }{index}, \param{int}{ width}, \param{int}{ height}}
448
449 Set an item's minimum size by window, sizer, or position. The item will be found recursively
450 in the sizer's descendants. This function enables an application to set the size of an item
451 after initial creation.
452
453
454 \membersection{wxSizer::SetSizeHints}\label{wxsizersetsizehints}
455
456 \func{void}{SetSizeHints}{\param{wxWindow* }{window}}
457
458 Tell the sizer to set (and \helpref{Fit}{wxsizerfit}) the minimal size of the \arg{window} to
459 match the sizer's minimal size. This is commonly done in the constructor of the window itself,
460 see sample in the description of \helpref{wxBoxSizer}{wxboxsizer} if the window is resizable
461 (as are many dialogs under Unix and frames on probably all platforms).
462
463
464 \membersection{wxSizer::SetVirtualSizeHints}\label{wxsizersetvirtualsizehints}
465
466 \func{void}{SetVirtualSizeHints}{\param{wxWindow* }{window}}
467
468 Tell the sizer to set the minimal size of the \arg{window} virtual area to match the sizer's
469 minimal size. For windows with managed scrollbars this will set them appropriately.
470
471 \wxheading{See also}
472
473 \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars}
474
475
476 \membersection{wxSizer::Show}\label{wxsizershow}
477
478 \func{bool}{Show}{\param{wxWindow* }{window}, \param{bool }{show = true}, \param{bool }{recursive = false}}
479
480 \func{bool}{Show}{\param{wxSizer* }{sizer}, \param{bool }{show = true}, \param{bool }{recursive = false}}
481
482 \func{bool}{Show}{\param{size\_t }{index}, \param{bool }{show = true}}
483
484 Shows or hides the \arg{window}, \arg{sizer}, or item at \arg{index}.
485 To make a sizer item disappear or reappear, use Show() followed by \helpref{Layout()}{wxsizerlayout}.
486 Use parameter \arg{recursive} to show or hide elements found in subsizers.
487
488 Returns true if the child item was found, false otherwise.
489
490 \wxheading{See also}
491
492 \helpref{wxSizer::Hide}{wxsizerhide},\rtfsp
493 \helpref{wxSizer::IsShown}{wxsizerisshown}
494
495
496
497
498 \section{\class{wxSizerFlags}}\label{wxsizerflags}
499
500 PRELIMINARY.
501
502 Normally, when you add something to a sizer via \helpref{wxSizer::Add}{wxsizeradd}, you have to specify a lot of flags and parameters. This can be unwieldy.
503
504 This is where wxSizerFlags comes in. Instead of a bunch of flags and other stuff, you can use wxSizerFlags, which is a convenient class for doing so.
505
506 Note that by specification, all methods of wxSizerFlags return the wxSizerFlags object itself to ease the calling of multiple methods at a time.
507
508
509 \membersection{wxSizerFlags::wxSizerFlags}\label{wxsizerflagsctor}
510
511 \func{}{wxSizerFlags}{\param{int }{proportion = 0}}
512
513 Creates the wxSizer with the proportion specified by \tt{proportion}.
514
515
516 \membersection{wxSizerFlags::Align}\label{wxsizerflagsalign}
517
518 \func{wxSizerFlags\& }{Align}{\param{int }{align = 0}}
519
520 Sets the alignment of this wxSizerFlags to \tt{align}.
521
522 Note that if this method is not called, the wxSizerFlags has no specified alignment.
523
524 \wxheading{See also}
525
526 \helpref{Left}{wxsizerflagsleft},\\
527 \helpref{Right}{wxsizerflagsright},\\
528 \helpref{Centre}{wxsizerflagscentre}
529
530
531 \membersection{wxSizerFlags::Border}\label{wxsizerflagsborder}
532
533 \func{wxSizerFlags\& }{Border}{\param{int }{direction}, \param{int }{borderinpixels}}
534
535 Sets the wxSizerFlags to have a border of a number of pixels specified by \tt{borderinpixels} with the directions specified by \tt{direction}.
536
537 \func{wxSizerFlags\& }{Border}{\param{int }{direction = wxALL}}
538
539 Sets the wxSizerFlags to have a border of a default size with the directions specified by \tt{direction}.
540
541
542 \membersection{wxSizerFlags::Center}\label{wxsizerflagscenter}
543
544 \func{wxSizerFlags\& }{Center}{\void}
545
546 Sets the object of the wxSizerFlags to center itself in the area it is given.
547
548
549 \membersection{wxSizerFlags::Centre}\label{wxsizerflagscentre}
550
551 \func{wxSizerFlags\& }{Centre}{\void}
552
553 \helpref{wxSizerFlags::Center}{wxsizerflagscenter} for people with the other dialect of english.
554
555
556 \membersection{wxSizerFlags::Expand}\label{wxsizerflagsexpand}
557
558 \func{wxSizerFlags\& }{Expand}{\void}
559
560 Sets the object of the wxSizerFlags to expand to fill as much area as it can.
561
562
563 \membersection{wxSizerFlags::Left}\label{wxsizerflagsleft}
564
565 \func{wxSizerFlags\& }{Left}{\void}
566
567 Aligns the object to the left, shortcut for \texttt{Align(wxALIGN\_LEFT)}
568
569 \wxheading{See also}
570
571 \helpref{Align}{wxsizerflagsalign}
572
573
574 \membersection{wxSizerFlags::Proportion}\label{wxsizerflagsproportion}
575
576 \func{wxSizerFlags\& }{Proportion}{\param{int }{proportion = 0}}
577
578 Sets the proportion of this wxSizerFlags to \tt{proportion}
579
580
581 \membersection{wxSizerFlags::Right}\label{wxsizerflagsright}
582
583 \func{wxSizerFlags\& }{Right}{\void}
584
585 Aligns the object to the right, shortcut for \texttt{Align(wxALIGN\_RIGHT)}
586
587 \wxheading{See also}
588
589 \helpref{Align}{wxsizerflagsalign}
590