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