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