]>
Commit | Line | Data |
---|---|---|
8fe05782 VZ |
1 | \section{\class{wxSizer}}\label{wxsizer} |
2 | ||
7e9a386e | 3 | wxSizer is the abstract base class used for laying out subwindows in a window. You |
3baaf313 VZ |
4 | cannot use wxSizer directly; instead, you will have to use one of the sizer |
5 | classes derived from it. Currently there are \helpref{wxBoxSizer}{wxboxsizer}, | |
6 | \helpref{wxStaticBoxSizer}{wxstaticboxsizer}, | |
c6eb7785 | 7 | \helpref{wxGridSizer}{wxgridsizer} |
b19d7524 | 8 | \helpref{wxFlexGridSizer}{wxflexgridsizer} and \helpref{wxGridBagSizer}{wxgridbagsizer}. |
515da557 | 9 | |
fc2171bd | 10 | The layout algorithm used by sizers in wxWidgets is closely related to layout |
515da557 RR |
11 | in other GUI toolkits, such as Java's AWT, the GTK toolkit or the Qt toolkit. It is |
12 | based upon the idea of the individual subwindows reporting their minimal required | |
13 | size and their ability to get stretched if the size of the parent window has changed. | |
749bb9f1 DS |
14 | This will most often mean that the programmer does not set the original size of |
15 | a dialog in the beginning, rather the dialog will be assigned a sizer and this sizer | |
1193d8fa RR |
16 | will be queried about the recommended size. The sizer in turn will query its |
17 | children, which can be normal windows, empty space or other sizers, so that | |
18 | a hierarchy of sizers can be constructed. Note that wxSizer does not derive from wxWindow | |
749bb9f1 | 19 | and thus does not interfere with tab ordering and requires very little resources compared |
515da557 RR |
20 | to a real window on screen. |
21 | ||
fc2171bd | 22 | What makes sizers so well fitted for use in wxWidgets is the fact that every control |
515da557 RR |
23 | reports its own minimal size and the algorithm can handle differences in font sizes |
24 | or different window (dialog item) sizes on different platforms without problems. If e.g. | |
25 | the standard font as well as the overall design of Motif widgets requires more space than | |
f6bcfd97 | 26 | on Windows, the initial dialog size will automatically be bigger on Motif than on Windows. |
8fe05782 | 27 | |
e6994168 VZ |
28 | Sizers may also be used to control the layout of custom drawn items on the window. The |
29 | Add, Insert, and Prepend functions return a pointer to the newly added wxSizerItem. Just | |
30 | add empty space of the desired size and attributes, and then use the wxSizerItem::GetRect | |
31 | method to determine where the drawing operations should take place. | |
32 | ||
33 | ||
76e1c2de | 34 | \pythonnote{If you wish to create a sizer class in wxPython you should |
c9110876 | 35 | derive the class from {\tt wxPySizer} in order to get Python-aware |
76e1c2de RD |
36 | capabilities 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 |
58 | The constructor. Note that wxSizer is an abstract base class and may not |
59 | be instantiated. | |
8fe05782 | 60 | |
02c6137e | 61 | |
8fe05782 VZ |
62 | \membersection{wxSizer::\destruct{wxSizer}}\label{wxsizerdtor} |
63 | ||
64 | \func{}{\destruct{wxSizer}}{\void} | |
65 | ||
9c884972 | 66 | The 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 |
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: | |
8fe05782 | 84 | |
4130b487 RR |
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 | |
f6bcfd97 | 87 | cases 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 | |
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 | |
2edb0bde | 94 | gives more flexibility in the design of dialogs; imagine for example a horizontal box with two buttons at the |
4130b487 | 95 | bottom of a dialog: you might want to insert a space between the two buttons and make that space stretchable |
e3950b18 | 96 | using the \arg{proportion} flag and the result will be that the left button will be aligned with the left |
4130b487 RR |
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 | ||
2b5f62a0 | 100 | \docparam{proportion}{Although the meaning of this parameter is undefined in wxSizer, it is used in wxBoxSizer |
a6f3598d | 101 | to indicate if a child of a sizer can change its size in the main orientation of the wxBoxSizer - where |
2edb0bde | 102 | 0 stands for not changeable and a value of more than zero is interpreted relative to the value of other |
f6bcfd97 BP |
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 | |
fc9c7c09 | 105 | value 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 |
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 | |
e3950b18 | 110 | window: the \arg{border} parameter determines the border width whereas |
caa251e0 RD |
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 | |
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 |
126 | the space assigned to the item.} | |
caa251e0 RD |
127 | \twocolitem{\windowstyle{wxSHAPED}}{The item will be expanded as much |
128 | as possible while also maintaining its aspect ratio} | |
2fa2b11b JS |
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 | |
e3950b18 | 133 | adjust when an item changes and its \arg{best size} becomes |
2fa2b11b JS |
134 | different. If you would rather have a window item stay the size it |
135 | started 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 |
143 | specify the alignment of the item within the space allotted to it by |
144 | the 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 |
152 | item, for use in derived classes when sizing information is more | |
e3950b18 | 153 | complex than the \arg{proportion} and \arg{flag} will allow for.} |
f6bcfd97 | 154 | |
40210d8a RN |
155 | \docparam{flags}{A \helpref{wxSizerFlags}{wxsizerflags} object that |
156 | enables 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 | |
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 | ||
56eee37f | 168 | \func{wxSizerItem*}{AddStretchSpacer}{\param{int }{prop = 1}} |
749bb9f1 DS |
169 | |
170 | Adds 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 | ||
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 | ||
02c6137e | 181 | |
e3950b18 VZ |
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 | ||
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 |
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 | |
00976fe5 RL |
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 | ||
cc81d32f | 203 | Returns 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 | 214 | Tell the sizer to resize the \arg{window} to match the sizer's minimal size. This |
f6bcfd97 | 215 | is commonly done in the constructor of the window itself, see sample in the description |
e5251d4f | 216 | of \helpref{wxBoxSizer}{wxboxsizer}. Returns the new size. |
f6bcfd97 | 217 | |
02c6137e VZ |
218 | For 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 | 225 | Tell the sizer to resize the virtual size of the \arg{window} to match the sizer's |
566d84a7 RL |
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 | ||
02c6137e | 235 | |
e8cfff87 VZ |
236 | \membersection{wxSizer::GetContainingWindow}\label{wxsizergetcontainingwindow} |
237 | ||
238 | \constfunc{wxWindow *}{GetContainingWindow}{\void} | |
239 | ||
240 | Returns the window this sizer is used in or \NULL if none. | |
241 | ||
242 | ||
9f13661f WS |
243 | \membersection{wxSizer::GetItem}\label{wxsizergetitem} |
244 | ||
245 | \func{wxSizerItem *}{GetItem}{\param{wxWindow* }{window}, \param{bool }{recursive = false}} | |
246 | ||
247 | \func{wxSizerItem *}{GetItem}{\param{wxSizer* }{sizer}, \param{bool }{recursive = false}} | |
248 | ||
249 | \func{wxSizerItem *}{GetItem}{\param{size\_t }{index}} | |
250 | ||
e3950b18 VZ |
251 | Finds item of the sizer which holds given \arg{window}, \arg{sizer} or is located |
252 | in sizer at position \arg{index}. | |
253 | Use parameter \arg{recursive} to search in subsizers too. | |
9f13661f WS |
254 | |
255 | Returns pointer to item or NULL. | |
256 | ||
257 | ||
f6bcfd97 BP |
258 | \membersection{wxSizer::GetSize}\label{wxsizergetsize} |
259 | ||
260 | \func{wxSize}{GetSize}{\void} | |
261 | ||
262 | Returns the current size of the sizer. | |
263 | ||
02c6137e | 264 | |
f6bcfd97 BP |
265 | \membersection{wxSizer::GetPosition}\label{wxsizergetposition} |
266 | ||
267 | \func{wxPoint}{GetPosition}{\void} | |
268 | ||
269 | Returns the current position of the sizer. | |
270 | ||
02c6137e | 271 | |
f6bcfd97 BP |
272 | \membersection{wxSizer::GetMinSize}\label{wxsizergetminsize} |
273 | ||
274 | \func{wxSize}{GetMinSize}{\void} | |
275 | ||
276 | Returns the minimal size of the sizer. This is either the combined minimal | |
277 | size of all the children and their borders or the minimal size set by | |
278 | \helpref{SetMinSize}{wxsizersetminsize}, depending on which is bigger. | |
279 | ||
02c6137e | 280 | |
e3950b18 VZ |
281 | \membersection{wxSizer::Hide}\label{wxsizerhide} |
282 | ||
283 | \func{bool}{Hide}{\param{wxWindow* }{window}, \param{bool }{recursive = false}} | |
284 | ||
285 | \func{bool}{Hide}{\param{wxSizer* }{sizer}, \param{bool }{recursive = false}} | |
286 | ||
287 | \func{bool}{Hide}{\param{size\_t }{index}} | |
288 | ||
289 | Hides the \arg{window}, \arg{sizer}, or item at \arg{index}. | |
290 | To make a sizer item disappear, use Hide() followed by \helpref{Layout()}{wxsizerlayout}. | |
291 | Use parameter \arg{recursive} to hide elements found in subsizers. | |
292 | ||
293 | Returns \true if the child item was found, \false otherwise. | |
294 | ||
295 | \wxheading{See also} | |
296 | ||
297 | \helpref{wxSizer::IsShown}{wxsizerisshown},\rtfsp | |
298 | \helpref{wxSizer::Show}{wxsizershow} | |
299 | ||
300 | ||
00976fe5 RL |
301 | \membersection{wxSizer::Insert}\label{wxsizerinsert} |
302 | ||
40210d8a RN |
303 | \func{wxSizerItem*}{Insert}{\param{size\_t }{index}, \param{wxWindow* }{window}, \param{const wxSizerFlags\& }{flags}} |
304 | ||
56eee37f | 305 | \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 | 306 | |
40210d8a RN |
307 | \func{wxSizerItem*}{Insert}{\param{size\_t }{index}, \param{wxSizer* }{sizer}, \param{const wxSizerFlags\& }{flags}} |
308 | ||
56eee37f | 309 | \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 | 310 | |
56eee37f | 311 | \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 | 312 | |
e3950b18 | 313 | Insert a child into the sizer before any existing item at \arg{index}. |
00976fe5 | 314 | |
12a3f227 | 315 | \docparam{index}{The position this child should assume in the sizer.} |
00976fe5 RL |
316 | |
317 | See \helpref{wxSizer::Add}{wxsizeradd} for the meaning of the other parameters. | |
318 | ||
02c6137e | 319 | |
749bb9f1 DS |
320 | \membersection{wxSizer::InsertSpacer}\label{wxsizerinsertspacer} |
321 | ||
56eee37f | 322 | \func{wxSizerItem*}{InsertSpacer}{\param{size\_t }{index}, \param{int }{size}} |
749bb9f1 DS |
323 | |
324 | Inserts non-stretchable space to the sizer. More readable way of calling | |
325 | \helpref{Insert}{wxsizerinsert}(size, size, 0). | |
326 | ||
327 | ||
328 | \membersection{wxSizer::InsertStretchSpacer}\label{wxsizerinsertstretchspacer} | |
329 | ||
56eee37f | 330 | \func{wxSizerItem*}{InsertStretchSpacer}{\param{size\_t }{index}, \param{int }{prop = 1}} |
749bb9f1 DS |
331 | |
332 | Inserts stretchable space to the sizer. More readable way of calling | |
333 | \helpref{Insert}{wxsizerinsert}(0, 0, prop). | |
334 | ||
335 | ||
e3950b18 VZ |
336 | \membersection{wxSizer::IsShown}\label{wxsizerisshown} |
337 | ||
338 | \constfunc{bool}{IsShown}{\param{wxWindow* }{window}} | |
339 | ||
340 | \constfunc{bool}{IsShown}{\param{wxSizer* }{sizer}} | |
341 | ||
342 | \constfunc{bool}{IsShown}{\param{size\_t }{index}} | |
343 | ||
344 | Returns \true if the \arg{window}, \arg{sizer}, or item at \arg{index} is shown. | |
345 | ||
346 | \wxheading{See also} | |
347 | ||
348 | \helpref{wxSizer::Hide}{wxsizerhide},\rtfsp | |
349 | \helpref{wxSizer::Show}{wxsizershow} | |
350 | ||
351 | ||
f6bcfd97 BP |
352 | \membersection{wxSizer::Layout}\label{wxsizerlayout} |
353 | ||
354 | \func{void}{Layout}{\void} | |
355 | ||
356 | Call this to force layout of the children anew, e.g. after having added a child | |
357 | to or removed a child (window, other sizer or space) from the sizer while keeping | |
358 | the current dimension. | |
76e1c2de | 359 | |
02c6137e | 360 | |
9c884972 | 361 | \membersection{wxSizer::Prepend}\label{wxsizerprepend} |
8fe05782 | 362 | |
40210d8a RN |
363 | \func{wxSizerItem*}{Prepend}{\param{wxWindow* }{window}, \param{const wxSizerFlags\& }{flags}} |
364 | ||
56eee37f | 365 | \func{wxSizerItem*}{Prepend}{\param{wxWindow* }{window}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}} |
8fe05782 | 366 | |
40210d8a RN |
367 | \func{wxSizerItem*}{Prepend}{\param{wxSizer* }{sizer}, \param{const wxSizerFlags\& }{flags}} |
368 | ||
56eee37f | 369 | \func{wxSizerItem*}{Prepend}{\param{wxSizer* }{sizer}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}} |
9c884972 | 370 | |
56eee37f | 371 | \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 |
372 | |
373 | Same as \helpref{wxSizer::Add}{wxsizeradd}, but prepends the items to the beginning of the | |
4130b487 | 374 | list of items (windows, subsizers or spaces) owned by this sizer. |
8fe05782 | 375 | |
02c6137e | 376 | |
749bb9f1 DS |
377 | \membersection{wxSizer::PrependSpacer}\label{wxsizerprependspacer} |
378 | ||
56eee37f | 379 | \func{wxSizerItem*}{PrependSpacer}{\param{int }{size}} |
749bb9f1 DS |
380 | |
381 | Prepends non-stretchable space to the sizer. More readable way of calling | |
382 | \helpref{Prepend}{wxsizerprepend}(size, size, 0). | |
383 | ||
384 | ||
385 | \membersection{wxSizer::PrependStretchSpacer}\label{wxsizerprependstretchspacer} | |
386 | ||
56eee37f | 387 | \func{wxSizerItem*}{PrependStretchSpacer}{\param{int }{prop = 1}} |
749bb9f1 DS |
388 | |
389 | Prepends stretchable space to the sizer. More readable way of calling | |
390 | \helpref{Prepend}{wxsizerprepend}(0, 0, prop). | |
391 | ||
392 | ||
f6bcfd97 BP |
393 | \membersection{wxSizer::RecalcSizes}\label{wxsizerrecalcsizes} |
394 | ||
395 | \func{void}{RecalcSizes}{\void} | |
396 | ||
397 | This method is abstract and has to be overwritten by any derived class. | |
398 | Here, the sizer will do the actual calculation of its children's positions | |
399 | and sizes. | |
400 | ||
02c6137e | 401 | |
9c884972 RR |
402 | \membersection{wxSizer::Remove}\label{wxsizerremove} |
403 | ||
404 | \func{bool}{Remove}{\param{wxWindow* }{window}} | |
405 | ||
406 | \func{bool}{Remove}{\param{wxSizer* }{sizer}} | |
407 | ||
12a3f227 | 408 | \func{bool}{Remove}{\param{size\_t }{index}} |
9c884972 | 409 | |
8258c3dd VZ |
410 | Removes a child from the sizer and destroys it if it is a sizer or a spacer, |
411 | but not if it is a window (because windows are owned by their parent window, | |
412 | not the sizer). \arg{sizer} is the wxSizer to be removed, | |
413 | \arg{index} is the position of the child in the sizer, e.g. $0$ for the first item. | |
12a3f227 | 414 | This method does not cause any layout or resizing to take place, call |
00976fe5 RL |
415 | \helpref{wxSizer::Layout}{wxsizerlayout} to update the layout "on screen" after removing a |
416 | child from the sizer. | |
417 | ||
8258c3dd VZ |
418 | {\bf NB:} The method taking a wxWindow* parameter is deprecated as it does not |
419 | destroy the window as would usually be expected from Remove. You should use | |
420 | \helpref{wxSizer::Detach}{wxsizerdetach} in new code instead. There is | |
421 | currently no wxSizer method that will both detach and destroy a wxWindow item. | |
9c884972 | 422 | |
cc81d32f | 423 | Returns true if the child item was found and removed, false otherwise. |
8fe05782 | 424 | |
02c6137e | 425 | |
eae0338f RR |
426 | \membersection{wxSizer::Replace}\label{wxsizerreplace} |
427 | ||
428 | \func{bool}{Replace}{\param{wxWindow* }{oldwin}, \param{wxWindow* }{newwin}, \param{bool }{recursive = false}} | |
429 | ||
430 | \func{bool}{Replace}{\param{wxSizer* }{oldsz}, \param{wxSizer* }{newsz}, \param{bool }{recursive = false}} | |
431 | ||
432 | \func{bool}{Remove}{\param{size\_t }{oldindex}, \param{wxSizerItem* }{newitem}} | |
433 | ||
434 | Detaches the given \arg{oldwin}, \arg{oldsz} child from the sizer and | |
435 | replaces it with the given window, sizer, or wxSizerItem. | |
436 | ||
437 | The detached child is removed {\bf only} if it is a sizer or a spacer | |
438 | (because windows are owned by their parent window, not the sizer). | |
439 | ||
440 | Use parameter \arg{recursive} to search the given element recursively in subsizers. | |
441 | ||
442 | ||
443 | This method does not cause any layout or resizing to take place, call | |
444 | \helpref{wxSizer::Layout}{wxsizerlayout} to update the layout "on screen" after replacing a | |
445 | child from the sizer. | |
446 | ||
447 | Returns true if the child item was found and removed, false otherwise. | |
448 | ||
449 | ||
8fe05782 VZ |
450 | \membersection{wxSizer::SetDimension}\label{wxsizersetdimension} |
451 | ||
452 | \func{void}{SetDimension}{\param{int }{x}, \param{int }{y}, \param{int }{width}, \param{int }{height}} | |
453 | ||
9c884972 | 454 | Call this to force the sizer to take the given dimension and thus force the items owned |
2edb0bde | 455 | by the sizer to resize themselves according to the rules defined by the parameter in the |
f6bcfd97 | 456 | \helpref{Add}{wxsizeradd} and \helpref{Prepend}{wxsizerprepend} methods. |
8fe05782 | 457 | |
02c6137e | 458 | |
f6bcfd97 | 459 | \membersection{wxSizer::SetMinSize}\label{wxsizersetminsize} |
8fe05782 | 460 | |
f6bcfd97 | 461 | \func{void}{SetMinSize}{\param{int }{width}, \param{int }{height}} |
8fe05782 | 462 | |
fbfb8bcc | 463 | \func{void}{SetMinSize}{\param{const wxSize\& }{size}} |
8fe05782 | 464 | |
f6bcfd97 BP |
465 | Call this to give the sizer a minimal size. Normally, the sizer will calculate its |
466 | minimal size based purely on how much space its children need. After calling this | |
467 | method \helpref{GetMinSize}{wxsizergetminsize} will return either the minimal size | |
468 | as requested by its children or the minimal size set here, depending on which is | |
469 | bigger. | |
8fe05782 | 470 | |
02c6137e | 471 | |
f6bcfd97 | 472 | \membersection{wxSizer::SetItemMinSize}\label{wxsizersetitemminsize} |
8fe05782 | 473 | |
f6bcfd97 | 474 | \func{void}{SetItemMinSize}{\param{wxWindow* }{window}, \param{int}{ width}, \param{int}{ height}} |
8fe05782 | 475 | |
f6bcfd97 | 476 | \func{void}{SetItemMinSize}{\param{wxSizer* }{sizer}, \param{int}{ width}, \param{int}{ height}} |
8fe05782 | 477 | |
12a3f227 | 478 | \func{void}{SetItemMinSize}{\param{size\_t }{index}, \param{int}{ width}, \param{int}{ height}} |
8fe05782 | 479 | |
f6bcfd97 BP |
480 | Set an item's minimum size by window, sizer, or position. The item will be found recursively |
481 | in the sizer's descendants. This function enables an application to set the size of an item | |
482 | after initial creation. | |
8fe05782 | 483 | |
02c6137e | 484 | |
8fe05782 VZ |
485 | \membersection{wxSizer::SetSizeHints}\label{wxsizersetsizehints} |
486 | ||
487 | \func{void}{SetSizeHints}{\param{wxWindow* }{window}} | |
488 | ||
e3950b18 | 489 | Tell the sizer to set (and \helpref{Fit}{wxsizerfit}) the minimal size of the \arg{window} to |
566d84a7 RL |
490 | match the sizer's minimal size. This is commonly done in the constructor of the window itself, |
491 | see sample in the description of \helpref{wxBoxSizer}{wxboxsizer} if the window is resizable | |
492 | (as are many dialogs under Unix and frames on probably all platforms). | |
493 | ||
02c6137e | 494 | |
566d84a7 RL |
495 | \membersection{wxSizer::SetVirtualSizeHints}\label{wxsizersetvirtualsizehints} |
496 | ||
497 | \func{void}{SetVirtualSizeHints}{\param{wxWindow* }{window}} | |
498 | ||
e3950b18 | 499 | Tell the sizer to set the minimal size of the \arg{window} virtual area to match the sizer's |
2b5f62a0 | 500 | minimal size. For windows with managed scrollbars this will set them appropriately. |
566d84a7 RL |
501 | |
502 | \wxheading{See also} | |
503 | ||
504 | \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars} | |
7e9a386e | 505 | |
02c6137e | 506 | |
2b5f62a0 VZ |
507 | \membersection{wxSizer::Show}\label{wxsizershow} |
508 | ||
8b2bac62 | 509 | \func{bool}{Show}{\param{wxWindow* }{window}, \param{bool }{show = true}, \param{bool }{recursive = false}} |
2b5f62a0 | 510 | |
8b2bac62 | 511 | \func{bool}{Show}{\param{wxSizer* }{sizer}, \param{bool }{show = true}, \param{bool }{recursive = false}} |
2b5f62a0 | 512 | |
8b2bac62 | 513 | \func{bool}{Show}{\param{size\_t }{index}, \param{bool }{show = true}} |
12a3f227 | 514 | |
e3950b18 VZ |
515 | Shows or hides the \arg{window}, \arg{sizer}, or item at \arg{index}. |
516 | To make a sizer item disappear or reappear, use Show() followed by \helpref{Layout()}{wxsizerlayout}. | |
517 | Use parameter \arg{recursive} to show or hide elements found in subsizers. | |
8b2bac62 WS |
518 | |
519 | Returns true if the child item was found, false otherwise. | |
2b5f62a0 | 520 | |
e3950b18 VZ |
521 | \wxheading{See also} |
522 | ||
523 | \helpref{wxSizer::Hide}{wxsizerhide},\rtfsp | |
524 | \helpref{wxSizer::IsShown}{wxsizerisshown} | |
0497e172 | 525 | |
2a3c8b65 RN |
526 | |
527 | ||
528 | ||
529 | \section{\class{wxSizerFlags}}\label{wxsizerflags} | |
530 | ||
40210d8a RN |
531 | PRELIMINARY. |
532 | ||
2a3c8b65 RN |
533 | 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. |
534 | ||
535 | 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. | |
536 | ||
f2fe4f67 | 537 | Note that by specification, all methods of wxSizerFlags return the wxSizerFlags object itself to ease the calling of multiple methods at a time. |
2a3c8b65 | 538 | |
f2fe4f67 | 539 | |
9a75ba66 | 540 | \membersection{wxSizerFlags::wxSizerFlags}\label{wxsizerflagsctor} |
2a3c8b65 RN |
541 | |
542 | \func{}{wxSizerFlags}{\param{int }{proportion = 0}} | |
543 | ||
544 | Creates the wxSizer with the proportion specified by \tt{proportion}. | |
545 | ||
546 | ||
f2fe4f67 | 547 | \membersection{wxSizerFlags::Align}\label{wxsizerflagsalign} |
2a3c8b65 RN |
548 | |
549 | \func{wxSizerFlags\& }{Align}{\param{int }{align = 0}} | |
550 | ||
551 | Sets the alignment of this wxSizerFlags to \tt{align}. | |
552 | ||
553 | Note that if this method is not called, the wxSizerFlags has no specified alignment. | |
554 | ||
e72ac082 VZ |
555 | \wxheading{See also} |
556 | ||
557 | \helpref{Left}{wxsizerflagsleft},\\ | |
558 | \helpref{Right}{wxsizerflagsright},\\ | |
559 | \helpref{Centre}{wxsizerflagscentre} | |
560 | ||
2a3c8b65 | 561 | |
f2fe4f67 | 562 | \membersection{wxSizerFlags::Border}\label{wxsizerflagsborder} |
2a3c8b65 RN |
563 | |
564 | \func{wxSizerFlags\& }{Border}{\param{int }{direction}, \param{int }{borderinpixels}} | |
565 | ||
566 | Sets the wxSizerFlags to have a border of a number of pixels specified by \tt{borderinpixels} with the directions specified by \tt{direction}. | |
567 | ||
568 | \func{wxSizerFlags\& }{Border}{\param{int }{direction = wxALL}} | |
569 | ||
570 | Sets the wxSizerFlags to have a border of a default size with the directions specified by \tt{direction}. | |
571 | ||
572 | ||
f2fe4f67 | 573 | \membersection{wxSizerFlags::Center}\label{wxsizerflagscenter} |
2a3c8b65 RN |
574 | |
575 | \func{wxSizerFlags\& }{Center}{\void} | |
576 | ||
577 | Sets the object of the wxSizerFlags to center itself in the area it is given. | |
578 | ||
579 | ||
f2fe4f67 | 580 | \membersection{wxSizerFlags::Centre}\label{wxsizerflagscentre} |
2a3c8b65 RN |
581 | |
582 | \func{wxSizerFlags\& }{Centre}{\void} | |
583 | ||
584 | \helpref{wxSizerFlags::Center}{wxsizerflagscenter} for people with the other dialect of english. | |
585 | ||
586 | ||
f2fe4f67 | 587 | \membersection{wxSizerFlags::Expand}\label{wxsizerflagsexpand} |
2a3c8b65 | 588 | |
0f353563 | 589 | \func{wxSizerFlags\& }{Expand}{\void} |
2a3c8b65 RN |
590 | |
591 | Sets the object of the wxSizerFlags to expand to fill as much area as it can. | |
592 | ||
593 | ||
e72ac082 VZ |
594 | \membersection{wxSizerFlags::Left}\label{wxsizerflagsleft} |
595 | ||
596 | \func{wxSizerFlags\& }{Left}{\void} | |
597 | ||
598 | Aligns the object to the left, shortcut for \texttt{Align(wxALIGN\_LEFT)} | |
599 | ||
600 | \wxheading{See also} | |
601 | ||
602 | \helpref{Align}{wxsizerflagsalign} | |
603 | ||
604 | ||
f2fe4f67 | 605 | \membersection{wxSizerFlags::Proportion}\label{wxsizerflagsproportion} |
2a3c8b65 RN |
606 | |
607 | \func{wxSizerFlags\& }{Proportion}{\param{int }{proportion = 0}} | |
608 | ||
609 | Sets the proportion of this wxSizerFlags to \tt{proportion} | |
610 | ||
611 | ||
e72ac082 VZ |
612 | \membersection{wxSizerFlags::Right}\label{wxsizerflagsright} |
613 | ||
614 | \func{wxSizerFlags\& }{Right}{\void} | |
615 | ||
616 | Aligns the object to the right, shortcut for \texttt{Align(wxALIGN\_RIGHT)} | |
617 | ||
618 | \wxheading{See also} | |
619 | ||
620 | \helpref{Align}{wxsizerflagsalign} | |
2a3c8b65 | 621 |