1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxStdDialogButtonSizer
4 // Author: wxWidgets team
6 // Licence: wxWindows licence
7 /////////////////////////////////////////////////////////////////////////////
13 wxSizer is the abstract base class used for laying out subwindows in a window.
14 You cannot use wxSizer directly; instead, you will have to use one of the sizer
15 classes derived from it. Currently there are wxBoxSizer, wxStaticBoxSizer,
16 wxGridSizer, wxFlexGridSizer, wxWrapSizer and wxGridBagSizer.
18 The layout algorithm used by sizers in wxWidgets is closely related to layout
19 in other GUI toolkits, such as Java's AWT, the GTK toolkit or the Qt toolkit.
20 It is based upon the idea of the individual subwindows reporting their minimal
21 required size and their ability to get stretched if the size of the parent window
24 This will most often mean that the programmer does not set the original size of
25 a dialog in the beginning, rather the dialog will be assigned a sizer and this
26 sizer will be queried about the recommended size. The sizer in turn will query
27 its children, which can be normal windows, empty space or other sizers, so that
28 a hierarchy of sizers can be constructed. Note that wxSizer does not derive
29 from wxWindow and thus does not interfere with tab ordering and requires very little
30 resources compared to a real window on screen.
32 What makes sizers so well fitted for use in wxWidgets is the fact that every
33 control reports its own minimal size and the algorithm can handle differences in
34 font sizes or different window (dialog item) sizes on different platforms without
35 problems. If e.g. the standard font as well as the overall design of Motif widgets
36 requires more space than on Windows, the initial dialog size will automatically
37 be bigger on Motif than on Windows.
39 Sizers may also be used to control the layout of custom drawn items on the
40 window. The wxSizer::Add(), wxSizer::Insert(), and wxSizer::Prepend() functions
41 return a pointer to the newly added wxSizerItem.
42 Just add empty space of the desired size and attributes, and then use the
43 wxSizerItem::GetRect() method to determine where the drawing operations
46 Please notice that sizers, like child windows, are owned by the library and
47 will be deleted by it which implies that they must be allocated on the heap.
48 However if you create a sizer and do not add it to another sizer or
49 window, the library wouldn't be able to delete such an orphan sizer and in
50 this, and only this, case it should be deleted explicitly.
53 If you wish to create a sizer class in wxPython you should
54 derive the class from @c wxPySizer in order to get Python-aware
55 capabilities for the various virtual methods.
58 @section wxsizer_flags wxSizer flags
60 The "flag" argument accepted by wxSizeItem constructors and other
61 functions, e.g. wxSizer::Add(), is OR-combination of the following flags.
62 Two main behaviours are defined using these flags. One is the border around
63 a window: the border parameter determines the border width whereas the
64 flags given here determine which side(s) of the item that the border will
65 be added. The other flags determine how the sizer item behaves when the
66 space allotted to the sizer changes, and is somewhat dependent on the
67 specific kind of sizer used.
75 These flags are used to specify which side(s) of the sizer item
76 the border width will apply to.}
78 The item will be expanded to fill the space assigned to the item.}
80 The item will be expanded as much as possible while also
81 maintaining its aspect ratio.}
82 @itemdef{wxFIXED_MINSIZE,
83 Normally wxSizers will use GetAdjustedBestSize() to determine what
84 the minimal size of window items should be, and will use that size
85 to calculate the layout. This allows layouts to adjust when an
86 item changes and its best size becomes different. If you would
87 rather have a window item stay the size it started with then use
89 @itemdef{wxRESERVE_SPACE_EVEN_IF_HIDDEN,
90 Normally wxSizers don't allocate space for hidden windows or other
91 items. This flag overrides this behaviour so that sufficient space
92 is allocated for the window even if it isn't visible. This makes
93 it possible to dynamically show and hide controls without resizing
94 parent dialog, for example. (Available since 2.8.8.)}
95 @itemdef{wxALIGN_CENTER<br>
101 wxALIGN_CENTER_VERTICAL<br>
102 wxALIGN_CENTRE_VERTICAL<br>
103 wxALIGN_CENTER_HORIZONTAL<br>
104 wxALIGN_CENTRE_HORIZONTAL,
105 The @c wxALIGN_* flags allow you to specify the alignment of the item
106 within the space allotted to it by the sizer, adjusted for the
113 @see @ref overview_sizer
115 class wxSizer
: public wxObject
120 Note that wxSizer is an abstract base class and may not be instantiated.
130 Appends a child to the sizer.
132 wxSizer itself is an abstract class, but the parameters are equivalent
133 in the derived classes that you will instantiate to use it so they are
137 The window to be added to the sizer. Its initial size (either set
138 explicitly by the user or calculated internally when using
139 wxDefaultSize) is interpreted as the minimal and in many cases also
142 A wxSizerFlags object that enables you to specify most of the above
143 parameters more conveniently.
145 wxSizerItem
* Add(wxWindow
* window
, const wxSizerFlags
& flags
);
148 Appends a child to the sizer.
150 wxSizer itself is an abstract class, but the parameters are equivalent
151 in the derived classes that you will instantiate to use it so they are
155 The window to be added to the sizer. Its initial size (either set
156 explicitly by the user or calculated internally when using
157 wxDefaultSize) is interpreted as the minimal and in many cases also
160 Although the meaning of this parameter is undefined in wxSizer, it
161 is used in wxBoxSizer to indicate if a child of a sizer can change
162 its size in the main orientation of the wxBoxSizer - where 0 stands
163 for not changeable and a value of more than zero is interpreted
164 relative to the value of other children of the same wxBoxSizer. For
165 example, you might have a horizontal wxBoxSizer with three
166 children, two of which are supposed to change their size with the
167 sizer. Then the two stretchable windows would get a value of 1 each
168 to make them grow and shrink equally with the sizer's horizontal
171 OR-combination of flags affecting sizer's behaviour. See
172 @ref wxsizer_flags "wxSizer flags list" for details.
174 Determines the border width, if the flag parameter is set to
175 include any border flag.
177 Allows an extra object to be attached to the sizer item, for use in
178 derived classes when sizing information is more complex than the
179 proportion and flag will allow for.
181 wxSizerItem
* Add(wxWindow
* window
,
185 wxObject
* userData
= NULL
);
188 Appends a child to the sizer.
190 wxSizer itself is an abstract class, but the parameters are equivalent
191 in the derived classes that you will instantiate to use it so they are
195 The (child-)sizer to be added to the sizer. This allows placing a
196 child sizer in a sizer and thus to create hierarchies of sizers
197 (typically a vertical box as the top sizer and several horizontal
198 boxes on the level beneath).
200 A wxSizerFlags object that enables you to specify most of the above
201 parameters more conveniently.
203 wxSizerItem
* Add(wxSizer
* sizer
, const wxSizerFlags
& flags
);
206 Appends a child to the sizer.
208 wxSizer itself is an abstract class, but the parameters are equivalent
209 in the derived classes that you will instantiate to use it so they are
213 The (child-)sizer to be added to the sizer. This allows placing a
214 child sizer in a sizer and thus to create hierarchies of sizers
215 (typically a vertical box as the top sizer and several horizontal
216 boxes on the level beneath).
218 Although the meaning of this parameter is undefined in wxSizer, it
219 is used in wxBoxSizer to indicate if a child of a sizer can change
220 its size in the main orientation of the wxBoxSizer - where 0 stands
221 for not changeable and a value of more than zero is interpreted
222 relative to the value of other children of the same wxBoxSizer. For
223 example, you might have a horizontal wxBoxSizer with three
224 children, two of which are supposed to change their size with the
225 sizer. Then the two stretchable windows would get a value of 1 each
226 to make them grow and shrink equally with the sizer's horizontal
229 OR-combination of flags affecting sizer's behaviour. See
230 @ref wxsizer_flags "wxSizer flags list" for details.
232 Determines the border width, if the flag parameter is set to
233 include any border flag.
235 Allows an extra object to be attached to the sizer item, for use in
236 derived classes when sizing information is more complex than the
237 proportion and flag will allow for.
239 wxSizerItem
* Add(wxSizer
* sizer
,
243 wxObject
* userData
= NULL
);
246 Appends a spacer child to the sizer.
248 wxSizer itself is an abstract class, but the parameters are equivalent
249 in the derived classes that you will instantiate to use it so they are
252 @a width and @a height specify the dimension of a spacer to be added to
253 the sizer. Adding spacers to sizers gives more flexibility in the
254 design of dialogs; imagine for example a horizontal box with two
255 buttons at the bottom of a dialog: you might want to insert a space
256 between the two buttons and make that space stretchable using the
257 proportion flag and the result will be that the left button will be
258 aligned with the left side of the dialog and the right button with the
259 right side - the space in between will shrink and grow with the dialog.
264 Height of the spacer.
266 Although the meaning of this parameter is undefined in wxSizer, it
267 is used in wxBoxSizer to indicate if a child of a sizer can change
268 its size in the main orientation of the wxBoxSizer - where 0 stands
269 for not changeable and a value of more than zero is interpreted
270 relative to the value of other children of the same wxBoxSizer. For
271 example, you might have a horizontal wxBoxSizer with three
272 children, two of which are supposed to change their size with the
273 sizer. Then the two stretchable windows would get a value of 1 each
274 to make them grow and shrink equally with the sizer's horizontal
277 OR-combination of flags affecting sizer's behaviour. See
278 @ref wxsizer_flags "wxSizer flags list" for details.
280 Determines the border width, if the flag parameter is set to
281 include any border flag.
283 Allows an extra object to be attached to the sizer item, for use in
284 derived classes when sizing information is more complex than the
285 proportion and flag will allow for.
287 wxSizerItem
* Add(int width
, int height
,
291 wxObject
* userData
= NULL
);
294 This base function adds non-stretchable space to both the horizontal
295 and vertical orientation of the sizer.
296 More readable way of calling:
298 wxSizer::Add(size, size, 0).
300 @see wxBoxSizer::AddSpacer()
302 virtual wxSizerItem
*AddSpacer(int size
);
305 Adds stretchable space to the sizer.
306 More readable way of calling:
308 wxSizer::Add(0, 0, prop).
311 wxSizerItem
* AddStretchSpacer(int prop
= 1);
314 This method is abstract and has to be overwritten by any derived class.
315 Here, the sizer will do the actual calculation of its children's minimal sizes.
317 virtual wxSize
CalcMin() = 0;
320 Detaches all children from the sizer.
321 If @a delete_windows is @true then child windows will also be deleted.
323 virtual void Clear(bool delete_windows
= false);
326 Computes client area size for @a window so that it matches the sizer's
327 minimal size. Unlike GetMinSize(), this method accounts for other
328 constraints imposed on @e window, namely display's size (returned size
329 will never be too large for the display) and maximum window size if
330 previously set by wxWindow::SetMaxSize().
332 The returned value is suitable for passing to wxWindow::SetClientSize() or
333 wxWindow::SetMinClientSize().
337 @see ComputeFittingWindowSize(), Fit()
339 wxSize
ComputeFittingClientSize(wxWindow
* window
);
342 Like ComputeFittingClientSize(), but converts the result into window
343 size. The returned value is suitable for passing to wxWindow::SetSize()
344 or wxWindow::SetMinSize().
348 @see ComputeFittingClientSize(), Fit()
350 wxSize
ComputeFittingWindowSize(wxWindow
* window
);
353 Detach the child @a window from the sizer without destroying it.
355 This method does not cause any layout or resizing to take place, call Layout()
356 to update the layout "on screen" after detaching a child from the sizer.
358 Returns @true if the child item was found and detached, @false otherwise.
362 virtual bool Detach(wxWindow
* window
);
365 Detach the child @a sizer from the sizer without destroying it.
367 This method does not cause any layout or resizing to take place, call Layout()
368 to update the layout "on screen" after detaching a child from the sizer.
370 Returns @true if the child item was found and detached, @false otherwise.
374 virtual bool Detach(wxSizer
* sizer
);
377 Detach a item at position @a index from the sizer without destroying it.
379 This method does not cause any layout or resizing to take place, call Layout()
380 to update the layout "on screen" after detaching a child from the sizer.
381 Returns @true if the child item was found and detached, @false otherwise.
385 virtual bool Detach(int index
);
388 Tell the sizer to resize the @a window so that its client area matches the
389 sizer's minimal size (ComputeFittingClientSize() is called to determine it).
390 This is commonly done in the constructor of the window itself, see sample
391 in the description of wxBoxSizer.
393 @return The new window size.
395 @see ComputeFittingClientSize(), ComputeFittingWindowSize()
397 wxSize
Fit(wxWindow
* window
);
400 Tell the sizer to resize the virtual size of the @a window to match the sizer's
401 minimal size. This will not alter the on screen size of the window, but may
402 cause the addition/removal/alteration of scrollbars required to view the virtual
403 area in windows which manage it.
405 @see wxScrolled::SetScrollbars(), SetVirtualSizeHints()
407 void FitInside(wxWindow
* window
);
411 Returns the list of the items in this sizer.
413 The elements of type-safe wxList @c wxSizerItemList are pointers to
414 objects of type wxSizerItem.
416 wxSizerItemList
& GetChildren();
417 const wxSizerItemList
& GetChildren() const;
421 Returns the window this sizer is used in or @NULL if none.
423 wxWindow
* GetContainingWindow() const;
426 Returns the number of items in the sizer.
428 If you just need to test whether the sizer is empty or not you can also
429 use IsEmpty() function.
431 size_t GetItemCount() const;
434 Finds wxSizerItem which holds the given @a window.
435 Use parameter @a recursive to search in subsizers too.
436 Returns pointer to item or @NULL.
438 wxSizerItem
* GetItem(wxWindow
* window
, bool recursive
= false);
441 Finds wxSizerItem which holds the given @a sizer.
442 Use parameter @a recursive to search in subsizers too.
443 Returns pointer to item or @NULL.
446 wxSizerItem
* GetItem(wxSizer
* sizer
, bool recursive
= false);
449 Finds wxSizerItem which is located in the sizer at position @a index.
450 Use parameter @a recursive to search in subsizers too.
451 Returns pointer to item or @NULL.
453 wxSizerItem
* GetItem(size_t index
);
456 Finds item of the sizer which has the given @e id.
457 This @a id is not the window id but the id of the wxSizerItem itself.
458 This is mainly useful for retrieving the sizers created from XRC resources.
459 Use parameter @a recursive to search in subsizers too.
460 Returns pointer to item or @NULL.
462 wxSizerItem
* GetItemById(int id
, bool recursive
= false);
465 Returns the minimal size of the sizer.
467 This is either the combined minimal size of all the children and their
468 borders or the minimal size set by SetMinSize(), depending on which is bigger.
469 Note that the returned value is client size, not window size.
470 In particular, if you use the value to set toplevel window's minimal or
471 actual size, use wxWindow::SetMinClientSize() or wxWindow::SetClientSize(),
472 not wxWindow::SetMinSize() or wxWindow::SetSize().
477 Returns the current position of the sizer.
479 wxPoint
GetPosition() const;
482 Returns the current size of the sizer.
484 wxSize
GetSize() const;
487 Hides the child @a window.
489 To make a sizer item disappear, use Hide() followed by Layout().
491 Use parameter @a recursive to hide elements found in subsizers.
492 Returns @true if the child item was found, @false otherwise.
494 @see IsShown(), Show()
496 bool Hide(wxWindow
* window
, bool recursive
= false);
499 Hides the child @a sizer.
501 To make a sizer item disappear, use Hide() followed by Layout().
503 Use parameter @a recursive to hide elements found in subsizers.
504 Returns @true if the child item was found, @false otherwise.
506 @see IsShown(), Show()
508 bool Hide(wxSizer
* sizer
, bool recursive
= false);
511 Hides the item at position @a index.
513 To make a sizer item disappear, use Hide() followed by Layout().
515 Use parameter @a recursive to hide elements found in subsizers.
516 Returns @true if the child item was found, @false otherwise.
518 @see IsShown(), Show()
520 bool Hide(size_t index
);
523 Insert a child into the sizer before any existing item at @a index.
525 See Add() for the meaning of the other parameters.
527 wxSizerItem
* Insert(size_t index
, wxWindow
* window
,
528 const wxSizerFlags
& flags
);
531 Insert a child into the sizer before any existing item at @a index.
533 See Add() for the meaning of the other parameters.
535 wxSizerItem
* Insert(size_t index
, wxWindow
* window
,
539 wxObject
* userData
= NULL
);
542 Insert a child into the sizer before any existing item at @a index.
544 See Add() for the meaning of the other parameters.
546 wxSizerItem
* Insert(size_t index
, wxSizer
* sizer
,
547 const wxSizerFlags
& flags
);
550 Insert a child into the sizer before any existing item at @a index.
552 See Add() for the meaning of the other parameters.
554 wxSizerItem
* Insert(size_t index
, wxSizer
* sizer
,
558 wxObject
* userData
= NULL
);
561 Insert a child into the sizer before any existing item at @a index.
563 See Add() for the meaning of the other parameters.
565 wxSizerItem
* Insert(size_t index
, int width
, int height
,
569 wxObject
* userData
= NULL
);
572 Inserts non-stretchable space to the sizer.
573 More readable way of calling wxSizer::Insert(index, size, size).
575 wxSizerItem
* InsertSpacer(size_t index
, int size
);
578 Inserts stretchable space to the sizer.
579 More readable way of calling wxSizer::Insert(0, 0, prop).
581 wxSizerItem
* InsertStretchSpacer(size_t index
, int prop
= 1);
584 Return @true if the sizer has no elements.
588 bool IsEmpty() const;
591 Returns @true if the @a window is shown.
593 @see Hide(), Show(), wxSizerItem::IsShown()
595 bool IsShown(wxWindow
* window
) const;
598 Returns @true if the @a sizer is shown.
600 @see Hide(), Show(), wxSizerItem::IsShown()
602 bool IsShown(wxSizer
* sizer
) const;
605 Returns @true if the item at @a index is shown.
607 @see Hide(), Show(), wxSizerItem::IsShown()
609 bool IsShown(size_t index
) const;
612 Call this to force layout of the children anew, e.g. after having added a child
613 to or removed a child (window, other sizer or space) from the sizer while
614 keeping the current dimension.
616 virtual void Layout();
619 Same as Add(), but prepends the items to the beginning of the
620 list of items (windows, subsizers or spaces) owned by this sizer.
622 wxSizerItem
* Prepend(wxWindow
* window
, const wxSizerFlags
& flags
);
625 Same as Add(), but prepends the items to the beginning of the
626 list of items (windows, subsizers or spaces) owned by this sizer.
628 wxSizerItem
* Prepend(wxWindow
* window
, int proportion
= 0,
631 wxObject
* userData
= NULL
);
634 Same as Add(), but prepends the items to the beginning of the
635 list of items (windows, subsizers or spaces) owned by this sizer.
637 wxSizerItem
* Prepend(wxSizer
* sizer
,
638 const wxSizerFlags
& flags
);
641 Same as Add(), but prepends the items to the beginning of the
642 list of items (windows, subsizers or spaces) owned by this sizer.
644 wxSizerItem
* Prepend(wxSizer
* sizer
, int proportion
= 0,
647 wxObject
* userData
= NULL
);
650 Same as Add(), but prepends the items to the beginning of the
651 list of items (windows, subsizers or spaces) owned by this sizer.
653 wxSizerItem
* Prepend(int width
, int height
,
657 wxObject
* userData
= NULL
);
660 Prepends non-stretchable space to the sizer.
661 More readable way of calling wxSizer::Prepend(size, size, 0).
663 wxSizerItem
* PrependSpacer(int size
);
666 Prepends stretchable space to the sizer.
667 More readable way of calling wxSizer::Prepend(0, 0, prop).
669 wxSizerItem
* PrependStretchSpacer(int prop
= 1);
672 This method is abstract and has to be overwritten by any derived class.
673 Here, the sizer will do the actual calculation of its children's
676 virtual void RecalcSizes() = 0;
679 Removes a child window from the sizer, but does @b not destroy it
680 (because windows are owned by their parent window, not the sizer).
683 The overload of this method taking a wxWindow* parameter
684 is deprecated as it does not destroy the window as would usually be
685 expected from Remove(). You should use Detach() in new code instead.
686 There is currently no wxSizer method that will both detach and destroy
689 @note This method does not cause any layout or resizing to take
690 place, call Layout() to update the layout "on screen" after
691 removing a child from the sizer.
693 @return @true if the child item was found and removed, @false otherwise.
695 virtual bool Remove(wxWindow
* window
);
698 Removes a sizer child from the sizer and destroys it.
700 @note This method does not cause any layout or resizing to take
701 place, call Layout() to update the layout "on screen" after
702 removing a child from the sizer.
704 @param sizer The wxSizer to be removed.
706 @return @true if the child item was found and removed, @false otherwise.
708 virtual bool Remove(wxSizer
* sizer
);
711 Removes a child from the sizer and destroys it if it is a sizer or a
712 spacer, but not if it is a window (because windows are owned by their
713 parent window, not the sizer).
715 @note This method does not cause any layout or resizing to take
716 place, call Layout() to update the layout "on screen" after
717 removing a child from the sizer.
720 The position of the child in the sizer, e.g. 0 for the first item.
722 @return @true if the child item was found and removed, @false otherwise.
724 virtual bool Remove(int index
);
727 Detaches the given @a oldwin from the sizer and replaces it with the
728 given @a newwin. The detached child window is @b not deleted (because
729 windows are owned by their parent window, not the sizer).
731 Use parameter @a recursive to search the given element recursively in subsizers.
733 This method does not cause any layout or resizing to take place,
734 call Layout() to update the layout "on screen" after replacing a
735 child from the sizer.
737 Returns @true if the child item was found and removed, @false otherwise.
739 virtual bool Replace(wxWindow
* oldwin
, wxWindow
* newwin
,
740 bool recursive
= false);
743 Detaches the given @a oldsz from the sizer and replaces it with the
744 given @a newsz. The detached child sizer is deleted.
746 Use parameter @a recursive to search the given element recursively in subsizers.
748 This method does not cause any layout or resizing to take place,
749 call Layout() to update the layout "on screen" after replacing a
750 child from the sizer.
752 Returns @true if the child item was found and removed, @false otherwise.
754 virtual bool Replace(wxSizer
* oldsz
, wxSizer
* newsz
,
755 bool recursive
= false);
758 Detaches the given item at position @a index from the sizer and
759 replaces it with the given wxSizerItem @a newitem.
761 The detached child is deleted @b only if it is a sizer or a spacer
762 (but not if it is a wxWindow because windows are owned by their
763 parent window, not the sizer).
765 This method does not cause any layout or resizing to take place,
766 call Layout() to update the layout "on screen" after replacing a
767 child from the sizer.
769 Returns @true if the child item was found and removed, @false otherwise.
771 virtual bool Replace(size_t index
, wxSizerItem
* newitem
);
774 Call this to force the sizer to take the given dimension and thus force
775 the items owned by the sizer to resize themselves according to the
776 rules defined by the parameter in the Add() and Prepend() methods.
778 void SetDimension(int x
, int y
, int width
, int height
);
783 void SetDimension(const wxPoint
& pos
, const wxSize
& size
);
786 Set an item's minimum size by window, sizer, or position.
788 This function enables an application to set the size of an item after
791 The @a window or @a sizer will be found recursively in the sizer's
794 @see wxSizerItem::SetMinSize()
797 @true if the minimal size was successfully set or @false if the
801 bool SetItemMinSize(wxWindow
* window
, int width
, int height
);
802 bool SetItemMinSize(wxWindow
* window
, const wxSize
& size
);
804 bool SetItemMinSize(wxSizer
* sizer
, int width
, int height
);
805 bool SetItemMinSize(wxSizer
* sizer
, const wxSize
& size
);
807 bool SetItemMinSize(size_t index
, int width
, int height
);
808 bool SetItemMinSize(size_t index
, const wxSize
& size
);
812 Call this to give the sizer a minimal size.
814 Normally, the sizer will calculate its minimal size based purely on how
815 much space its children need. After calling this method GetMinSize()
816 will return either the minimal size as requested by its children or the
817 minimal size set here, depending on which is bigger.
819 void SetMinSize(const wxSize
& size
);
824 void SetMinSize(int width
, int height
);
827 This method first calls Fit() and then wxTopLevelWindow::SetSizeHints()
828 on the @a window passed to it.
830 This only makes sense when @a window is actually a wxTopLevelWindow such
831 as a wxFrame or a wxDialog, since SetSizeHints only has any effect in these classes.
832 It does nothing in normal windows or controls.
834 This method is implicitly used by wxWindow::SetSizerAndFit() which is
835 commonly invoked in the constructor of a toplevel window itself (see
836 the sample in the description of wxBoxSizer) if the toplevel window is
839 void SetSizeHints(wxWindow
* window
);
842 Tell the sizer to set the minimal size of the @a window virtual area to match
843 the sizer's minimal size. For windows with managed scrollbars this will set them
846 @deprecated This is exactly the same as FitInside() in wxWidgets 2.9
847 and later, please replace calls to it with FitInside().
849 @see wxScrolled::SetScrollbars()
851 void SetVirtualSizeHints(wxWindow
* window
);
854 Shows or hides the @a window.
855 To make a sizer item disappear or reappear, use Show() followed by Layout().
857 Use parameter @a recursive to show or hide elements found in subsizers.
859 Returns @true if the child item was found, @false otherwise.
861 @see Hide(), IsShown()
863 bool Show(wxWindow
* window
, bool show
= true,
864 bool recursive
= false);
867 Shows or hides @a sizer.
868 To make a sizer item disappear or reappear, use Show() followed by Layout().
870 Use parameter @a recursive to show or hide elements found in subsizers.
872 Returns @true if the child item was found, @false otherwise.
874 @see Hide(), IsShown()
876 bool Show(wxSizer
* sizer
, bool show
= true,
877 bool recursive
= false);
880 Shows the item at @a index.
881 To make a sizer item disappear or reappear, use Show() followed by Layout().
883 Returns @true if the child item was found, @false otherwise.
885 @see Hide(), IsShown()
887 bool Show(size_t index
, bool show
= true);
892 @class wxStdDialogButtonSizer
894 This class creates button layouts which conform to the standard button spacing
895 and ordering defined by the platform or toolkit's user interface guidelines
896 (if such things exist). By using this class, you can ensure that all your
897 standard dialogs look correct on all major platforms. Currently it conforms to
898 the Windows, GTK+ and Mac OS X human interface guidelines.
900 When there aren't interface guidelines defined for a particular platform or
901 toolkit, wxStdDialogButtonSizer reverts to the Windows implementation.
903 To use this class, first add buttons to the sizer by calling
904 wxStdDialogButtonSizer::AddButton (or wxStdDialogButtonSizer::SetAffirmativeButton,
905 wxStdDialogButtonSizer::SetNegativeButton or wxStdDialogButtonSizer::SetCancelButton)
906 and then call Realize in order to create the actual button layout used.
907 Other than these special operations, this sizer works like any other sizer.
909 If you add a button with wxID_SAVE, on Mac OS X the button will be renamed to
910 "Save" and the wxID_NO button will be renamed to "Don't Save" in accordance
911 with the Mac OS X Human Interface Guidelines.
916 @see wxSizer, @ref overview_sizer, wxDialog::CreateButtonSizer
918 class wxStdDialogButtonSizer
: public wxBoxSizer
922 Constructor for a wxStdDialogButtonSizer.
924 wxStdDialogButtonSizer();
927 Adds a button to the wxStdDialogButtonSizer. The @a button must have
928 one of the following identifiers:
939 void AddButton(wxButton
* button
);
942 Rearranges the buttons and applies proper spacing between buttons to make
943 them match the platform or toolkit's interface guidelines.
948 Sets the affirmative button for the sizer.
950 This allows you to use identifiers other than the standard identifiers
953 void SetAffirmativeButton(wxButton
* button
);
956 Sets the cancel button for the sizer.
958 This allows you to use identifiers other than the standard identifiers
961 void SetCancelButton(wxButton
* button
);
964 Sets the negative button for the sizer.
966 This allows you to use identifiers other than the standard identifiers
969 void SetNegativeButton(wxButton
* button
);
977 The wxSizerItem class is used to track the position, size and other
978 attributes of each item managed by a wxSizer.
980 It is not usually necessary to use this class because the sizer elements can
981 also be identified by their positions or window or sizer pointers but sometimes
982 it may be more convenient to use it directly.
987 class wxSizerItem
: public wxObject
991 Construct a sizer item for tracking a spacer.
993 wxSizerItem(int width
, int height
, int proportion
, int flag
,
994 int border
, wxObject
* userData
);
998 Construct a sizer item for tracking a window.
1000 wxSizerItem(wxWindow
* window
, const wxSizerFlags
& flags
);
1001 wxSizerItem(wxWindow
* window
, int proportion
, int flag
,
1003 wxObject
* userData
);
1008 Construct a sizer item for tracking a subsizer.
1010 wxSizerItem(wxSizer
* window
, const wxSizerFlags
& flags
);
1011 wxSizerItem(wxSizer
* sizer
, int proportion
, int flag
,
1013 wxObject
* userData
);
1017 Deletes the user data and subsizer, if any.
1019 virtual ~wxSizerItem();
1022 Set the window to be tracked by this item.
1024 The old window isn't deleted as it is now owned by the sizer item.
1026 void AssignWindow(wxWindow
*window
);
1029 Set the sizer tracked by this item.
1031 Old sizer, if any, is deleted.
1033 void AssignSizer(wxSizer
*sizer
);
1037 Set the size of the spacer tracked by this item.
1039 Old spacer, if any, is deleted.
1041 void AssignSpacer(const wxSize
& size
);
1042 void AssignSpacer(int w
, int h
) { AssignSpacer(wxSize(w
, h
)); }
1046 Calculates the minimum desired size for the item, including any space
1049 virtual wxSize
CalcMin();
1052 Destroy the window or the windows in a subsizer, depending on the type
1055 virtual void DeleteWindows();
1058 Enable deleting the SizerItem without destroying the contained sizer.
1063 Return the border attribute.
1065 int GetBorder() const;
1068 Return the flags attribute.
1070 See @ref wxsizer_flags "wxSizer flags list" for details.
1072 int GetFlag() const;
1075 Return the numeric id of wxSizerItem, or @c wxID_NONE if the id has
1081 Get the minimum size needed for the item.
1083 wxSize
GetMinSize() const;
1086 Sets the minimum size to be allocated for this item.
1088 If this item is a window, the @a size is also passed to
1089 wxWindow::SetMinSize().
1091 void SetMinSize(const wxSize
& size
);
1096 void SetMinSize(int x
, int y
);
1099 What is the current position of the item, as set in the last Layout.
1101 wxPoint
GetPosition() const;
1104 Get the proportion item attribute.
1106 int GetProportion() const;
1109 Get the ration item attribute.
1111 float GetRatio() const;
1114 Get the rectangle of the item on the parent window, excluding borders.
1116 virtual wxRect
GetRect();
1119 Get the current size of the item, as set in the last Layout.
1121 virtual wxSize
GetSize() const;
1124 If this item is tracking a sizer, return it. @NULL otherwise.
1126 wxSizer
* GetSizer() const;
1129 If this item is tracking a spacer, return its size.
1131 wxSize
GetSpacer() const;
1134 Get the userData item attribute.
1136 wxObject
* GetUserData() const;
1139 If this item is tracking a window then return it. @NULL otherwise.
1141 wxWindow
* GetWindow() const;
1144 Returns @true if this item is a window or a spacer and it is shown or
1145 if this item is a sizer and not all of its elements are hidden.
1147 In other words, for sizer items, all of the child elements must be
1148 hidden for the sizer itself to be considered hidden.
1150 As an exception, if the @c wxRESERVE_SPACE_EVEN_IF_HIDDEN flag was
1151 used for this sizer item, then IsShown() always returns @true for it
1152 (see wxSizerFlags::ReserveSpaceEvenIfHidden()).
1154 bool IsShown() const;
1157 Is this item a sizer?
1159 bool IsSizer() const;
1162 Is this item a spacer?
1164 bool IsSpacer() const;
1167 Is this item a window?
1169 bool IsWindow() const;
1172 Set the border item attribute.
1174 void SetBorder(int border
);
1177 Set the position and size of the space allocated to the sizer, and
1178 adjust the position and size of the item to be within that space
1179 taking alignment and borders into account.
1181 virtual void SetDimension(const wxPoint
& pos
, const wxSize
& size
);
1184 Set the flag item attribute.
1186 void SetFlag(int flag
);
1189 Sets the numeric id of the wxSizerItem to @e id.
1196 void SetInitSize(int x
, int y
);
1199 Set the proportion item attribute.
1201 void SetProportion(int proportion
);
1205 Set the ratio item attribute.
1207 void SetRatio(int width
, int height
);
1208 void SetRatio(wxSize size
);
1209 void SetRatio(float ratio
);
1213 Set the sizer tracked by this item.
1215 @deprecated This function does not free the old sizer which may result
1216 in memory leaks, use AssignSizer() which does free it instead.
1218 void SetSizer(wxSizer
* sizer
);
1221 Set the size of the spacer tracked by this item.
1223 @deprecated This function does not free the old spacer which may result
1224 in memory leaks, use AssignSpacer() which does free it instead.
1226 void SetSpacer(const wxSize
& size
);
1228 void SetUserData(wxObject
* userData
);
1231 Set the window to be tracked by this item.
1232 @deprecated @todo provide deprecation description
1234 void SetWindow(wxWindow
* window
);
1237 Set the show item attribute, which sizers use to determine if the item
1238 is to be made part of the layout or not. If the item is tracking a
1239 window then it is shown or hidden as needed.
1241 void Show(bool show
);
1249 Container for sizer items flags providing readable names for them.
1251 Normally, when you add an item to a sizer via wxSizer::Add, you have to
1252 specify a lot of flags and parameters which can be unwieldy. This is where
1253 wxSizerFlags comes in: it allows you to specify all parameters using the
1254 named methods instead. For example, instead of
1257 sizer->Add(ctrl, 0, wxEXPAND | wxALL, 10);
1263 sizer->Add(ctrl, wxSizerFlags().Expand().Border(wxALL, 10));
1266 This is more readable and also allows you to create wxSizerFlags objects which
1267 can be reused for several sizer items.
1270 wxSizerFlags flagsExpand(1);
1271 flagsExpand.Expand().Border(wxALL, 10);
1273 sizer->Add(ctrl1, flagsExpand);
1274 sizer->Add(ctrl2, flagsExpand);
1277 Note that by specification, all methods of wxSizerFlags return the wxSizerFlags
1278 object itself to allowing chaining multiple methods calls like in the examples
1282 @category{winlayout}
1290 Creates the wxSizer with the proportion specified by @a proportion.
1292 wxSizerFlags(int proportion
= 0);
1295 Sets the alignment of this wxSizerFlags to @a align.
1297 This method replaces the previously set alignment with the specified one.
1300 Combination of @c wxALIGN_XXX bit masks.
1302 @see Top(), Left(), Right(), Bottom(), Centre()
1304 wxSizerFlags
& Align(int alignment
);
1307 Sets the wxSizerFlags to have a border of a number of pixels specified
1308 by @a borderinpixels with the directions specified by @a direction.
1310 wxSizerFlags
& Border(int direction
, int borderinpixels
);
1313 Sets the wxSizerFlags to have a border with size as returned by
1317 Direction(s) to apply the border in.
1319 wxSizerFlags
& Border(int direction
= wxALL
);
1322 Aligns the object to the bottom, similar for @c Align(wxALIGN_BOTTOM).
1324 Unlike Align(), this method doesn't change the horizontal alignment of
1327 wxSizerFlags
& Bottom();
1330 Sets the object of the wxSizerFlags to center itself in the area it is
1333 wxSizerFlags
& Center();
1336 Center() for people with the other dialect of English.
1338 wxSizerFlags
& Centre();
1341 Sets the border in the given @a direction having twice the default
1344 wxSizerFlags
& DoubleBorder(int direction
= wxALL
);
1347 Sets the border in left and right directions having twice the default
1350 wxSizerFlags
& DoubleHorzBorder();
1353 Sets the object of the wxSizerFlags to expand to fill as much area as
1356 wxSizerFlags
& Expand();
1359 Set the @c wxFIXED_MINSIZE flag which indicates that the initial size
1360 of the window should be also set as its minimal size.
1362 wxSizerFlags
& FixedMinSize();
1365 Set the @c wxRESERVE_SPACE_EVEN_IF_HIDDEN flag. Normally wxSizers
1366 don't allocate space for hidden windows or other items. This flag
1367 overrides this behaviour so that sufficient space is allocated for the
1368 window even if it isn't visible. This makes it possible to dynamically
1369 show and hide controls without resizing parent dialog, for example.
1373 wxSizerFlags
& ReserveSpaceEvenIfHidden();
1376 Returns the border used by default in Border() method.
1378 static int GetDefaultBorder();
1381 Aligns the object to the left, similar for @c Align(wxALIGN_LEFT).
1383 Unlike Align(), this method doesn't change the vertical alignment of
1386 wxSizerFlags
& Left();
1389 Sets the proportion of this wxSizerFlags to @e proportion
1391 wxSizerFlags
& Proportion(int proportion
);
1394 Aligns the object to the right, similar for @c Align(wxALIGN_RIGHT).
1396 Unlike Align(), this method doesn't change the vertical alignment of
1399 wxSizerFlags
& Right();
1402 Set the @c wx_SHAPED flag which indicates that the elements should
1403 always keep the fixed width to height ratio equal to its original value.
1405 wxSizerFlags
& Shaped();
1408 Aligns the object to the top, similar for @c Align(wxALIGN_TOP).
1410 Unlike Align(), this method doesn't change the horizontal alignment of
1413 wxSizerFlags
& Top();
1416 Sets the border in the given @a direction having thrice the default
1419 wxSizerFlags
& TripleBorder(int direction
= wxALL
);
1424 Values which define the behaviour for resizing wxFlexGridSizer cells in the
1425 "non-flexible" direction.
1427 enum wxFlexSizerGrowMode
1429 /// Don't resize the cells in non-flexible direction at all.
1430 wxFLEX_GROWMODE_NONE
,
1432 /// Uniformly resize only the specified ones (default).
1433 wxFLEX_GROWMODE_SPECIFIED
,
1435 /// Uniformly resize all cells.
1440 @class wxFlexGridSizer
1442 A flex grid sizer is a sizer which lays out its children in a two-dimensional
1443 table with all table fields in one row having the same height and all fields
1444 in one column having the same width, but all rows or all columns are not
1445 necessarily the same height or width as in the wxGridSizer.
1447 Since wxWidgets 2.5.0, wxFlexGridSizer can also size items equally in one
1448 direction but unequally ("flexibly") in the other. If the sizer is only
1449 flexible in one direction (this can be changed using wxFlexGridSizer::SetFlexibleDirection),
1450 it needs to be decided how the sizer should grow in the other ("non-flexible")
1451 direction in order to fill the available space.
1452 The wxFlexGridSizer::SetNonFlexibleGrowMode() method serves this purpose.
1455 @category{winlayout}
1457 @see wxSizer, @ref overview_sizer
1459 class wxFlexGridSizer
: public wxGridSizer
1464 wxFlexGridSizer constructors.
1466 Please see wxGridSizer::wxGridSizer documentation.
1468 @since 2.9.1 (except for the four argument overload)
1470 wxFlexGridSizer( int cols
, int vgap
, int hgap
);
1471 wxFlexGridSizer( int cols
, const wxSize
& gap
= wxSize(0, 0) );
1473 wxFlexGridSizer( int rows
, int cols
, int vgap
, int hgap
);
1474 wxFlexGridSizer( int rows
, int cols
, const wxSize
& gap
);
1478 Specifies that column @a idx (starting from zero) should be grown if
1479 there is extra space available to the sizer.
1481 The @a proportion parameter has the same meaning as the stretch factor
1482 for the sizers (see wxBoxSizer) except that if all proportions are 0,
1483 then all columns are resized equally (instead of not being resized at all).
1485 Notice that the column must not be already growable, if you need to change
1486 the proportion you must call RemoveGrowableCol() first and then make it
1487 growable (with a different proportion) again. You can use IsColGrowable()
1488 to check whether a column is already growable.
1490 void AddGrowableCol(size_t idx
, int proportion
= 0);
1493 Specifies that row idx (starting from zero) should be grown if there
1494 is extra space available to the sizer.
1496 This is identical to AddGrowableCol() except that it works with rows
1499 void AddGrowableRow(size_t idx
, int proportion
= 0);
1502 Returns a ::wxOrientation value that specifies whether the sizer flexibly
1503 resizes its columns, rows, or both (default).
1506 One of the following values:
1507 - wxVERTICAL: Rows are flexibly sized.
1508 - wxHORIZONTAL: Columns are flexibly sized.
1509 - wxBOTH: Both rows and columns are flexibly sized (this is the default value).
1511 @see SetFlexibleDirection()
1513 int GetFlexibleDirection() const;
1516 Returns the value that specifies how the sizer grows in the "non-flexible"
1517 direction if there is one.
1519 The behaviour of the elements in the flexible direction (i.e. both rows
1520 and columns by default, or rows only if GetFlexibleDirection() is
1521 @c wxVERTICAL or columns only if it is @c wxHORIZONTAL) is always governed
1522 by their proportion as specified in the call to AddGrowableRow() or
1523 AddGrowableCol(). What happens in the other direction depends on the
1524 value of returned by this function as described below.
1527 One of the following values:
1528 - wxFLEX_GROWMODE_NONE: Sizer doesn't grow its elements at all in
1529 the non-flexible direction.
1530 - wxFLEX_GROWMODE_SPECIFIED: Sizer honors growable columns/rows set
1531 with AddGrowableCol() and AddGrowableRow() in the non-flexible
1532 direction as well. In this case equal sizing applies to minimum
1533 sizes of columns or rows (this is the default value).
1534 - wxFLEX_GROWMODE_ALL: Sizer equally stretches all columns or rows in
1535 the non-flexible direction, independently of the proportions
1536 applied in the flexible direction.
1538 @see SetFlexibleDirection(), SetNonFlexibleGrowMode()
1540 wxFlexSizerGrowMode
GetNonFlexibleGrowMode() const;
1543 Returns @true if column @a idx is growable.
1547 bool IsColGrowable(size_t idx
);
1550 Returns @true if row @a idx is growable.
1554 bool IsRowGrowable(size_t idx
);
1557 Specifies that the @a idx column index is no longer growable.
1559 void RemoveGrowableCol(size_t idx
);
1562 Specifies that the @a idx row index is no longer growable.
1564 void RemoveGrowableRow(size_t idx
);
1567 Specifies whether the sizer should flexibly resize its columns, rows, or both.
1569 Argument @a direction can be @c wxVERTICAL, @c wxHORIZONTAL or @c wxBOTH
1570 (which is the default value). Any other value is ignored.
1572 See GetFlexibleDirection() for the explanation of these values.
1573 Note that this method does not trigger relayout.
1575 void SetFlexibleDirection(int direction
);
1578 Specifies how the sizer should grow in the non-flexible direction if
1579 there is one (so SetFlexibleDirection() must have been called previously).
1581 Argument @a mode can be one of those documented in GetNonFlexibleGrowMode(),
1582 please see there for their explanation.
1583 Note that this method does not trigger relayout.
1585 void SetNonFlexibleGrowMode(wxFlexSizerGrowMode mode
);
1587 virtual void RecalcSizes();
1589 virtual wxSize
CalcMin();
1597 A grid sizer is a sizer which lays out its children in a two-dimensional
1598 table with all table fields having the same size, i.e. the width of each
1599 field is the width of the widest child, the height of each field is the
1600 height of the tallest child.
1603 @category{winlayout}
1605 @see wxSizer, @ref overview_sizer
1607 class wxGridSizer
: public wxSizer
1612 wxGridSizer constructors.
1614 Usually only the number of columns in the flex grid sizer needs to be
1615 specified using @a cols argument. The number of rows will be deduced
1616 automatically depending on the number of the elements added to the
1619 If a constructor form with @a rows parameter is used (and the value of
1620 @a rows argument is not zero, meaning "unspecified") the sizer will
1621 check that no more than @c cols*rows elements are added to it, i.e.
1622 that no more than the given number of @a rows is used. Adding less than
1623 maximally allowed number of items is not an error however.
1625 Finally, it is also possible to specify the number of rows and use 0
1626 for @a cols. In this case, the sizer will use the given fixed number of
1627 rows and as many columns as necessary.
1629 The @a gap (or @a vgap and @a hgap, which correspond to the height and
1630 width of the wxSize object) argument defines the size of the padding
1631 between the rows (its vertical component, or @a vgap) and columns
1632 (its horizontal component, or @a hgap), in pixels.
1635 @since 2.9.1 (except for the four argument overload)
1637 wxGridSizer( int cols
, int vgap
, int hgap
);
1638 wxGridSizer( int cols
, const wxSize
& gap
= wxSize(0, 0) );
1640 wxGridSizer( int rows
, int cols
, int vgap
, int hgap
);
1641 wxGridSizer( int rows
, int cols
, const wxSize
& gap
);
1645 Returns the number of columns that has been specified for the
1648 Returns zero if the sizer is automatically adjusting the number of
1649 columns depending on number of its children. To get the effective
1650 number of columns or rows being currently used, see GetEffectiveColsCount()
1652 int GetCols() const;
1655 Returns the number of rows that has been specified for the
1658 Returns zero if the sizer is automatically adjusting the number of
1659 rows depending on number of its children. To get the effective
1660 number of columns or rows being currently used, see GetEffectiveRowsCount().
1662 int GetRows() const;
1665 Returns the number of columns currently used by the sizer.
1667 This will depend on the number of children the sizer has if
1668 the sizer is automatically adjusting the number of columns/rows.
1672 int GetEffectiveColsCount() const;
1675 Returns the number of rows currently used by the sizer.
1677 This will depend on the number of children the sizer has if
1678 the sizer is automatically adjusting the number of columns/rows.
1682 int GetEffectiveRowsCount() const;
1685 Returns the horizontal gap (in pixels) between cells in the sizer.
1687 int GetHGap() const;
1690 Returns the vertical gap (in pixels) between the cells in the sizer.
1692 int GetVGap() const;
1695 Sets the number of columns in the sizer.
1697 void SetCols(int cols
);
1700 Sets the horizontal gap (in pixels) between cells in the sizer.
1702 void SetHGap(int gap
);
1705 Sets the number of rows in the sizer.
1707 void SetRows(int rows
);
1710 Sets the vertical gap (in pixels) between the cells in the sizer.
1712 void SetVGap(int gap
);
1718 @class wxStaticBoxSizer
1720 wxStaticBoxSizer is a sizer derived from wxBoxSizer but adds a static box around
1723 The static box may be either created independently or the sizer may create it
1724 itself as a convenience. In any case, the sizer owns the wxStaticBox control
1725 and will delete it in the wxStaticBoxSizer destructor.
1727 Note that since wxWidgets 2.9.1 you are encouraged to create the windows
1728 which are added to wxStaticBoxSizer as children of wxStaticBox itself, see
1729 this class documentation for more details.
1731 Example of use of this class:
1733 void MyFrame::CreateControls()
1735 wxPanel *panel = new wxPanel(this);
1737 wxStaticBoxSizer *sz = new wxStaticBoxSizer(wxVERTICAL, panel, "Box");
1738 sz->Add(new wxStaticText(sz->GetStaticBox(), wxID_ANY,
1739 "This window is a child of the staticbox"));
1745 @category{winlayout}
1747 @see wxSizer, wxStaticBox, wxBoxSizer, @ref overview_sizer
1749 class wxStaticBoxSizer
: public wxBoxSizer
1753 This constructor uses an already existing static box.
1756 The static box to associate with the sizer (which will take its
1759 Can be either @c wxVERTICAL or @c wxHORIZONTAL.
1761 wxStaticBoxSizer(wxStaticBox
* box
, int orient
);
1764 This constructor creates a new static box with the given label and parent window.
1766 wxStaticBoxSizer(int orient
, wxWindow
*parent
,
1767 const wxString
& label
= wxEmptyString
);
1770 Returns the static box associated with the sizer.
1772 wxStaticBox
* GetStaticBox() const;
1780 The basic idea behind a box sizer is that windows will most often be laid out
1781 in rather simple basic geometry, typically in a row or a column or several
1782 hierarchies of either.
1784 For more information, please see @ref overview_sizer_box.
1787 @category{winlayout}
1789 @see wxSizer, @ref overview_sizer
1791 class wxBoxSizer
: public wxSizer
1795 Constructor for a wxBoxSizer. @a orient may be either of wxVERTICAL
1796 or wxHORIZONTAL for creating either a column sizer or a row sizer.
1798 wxBoxSizer(int orient
);
1801 Adds non-stretchable space to the main orientation of the sizer only.
1802 More readable way of calling:
1804 if ( wxBoxSizer::IsVertical() )
1806 wxBoxSizer::Add(0, size, 0).
1810 wxBoxSizer::Add(size, 0, 0).
1814 virtual wxSizerItem
*AddSpacer(int size
);
1817 Implements the calculation of a box sizer's minimal.
1819 It is used internally only and must not be called by the user.
1820 Documented for information.
1822 virtual wxSize
CalcMin();
1825 Returns the orientation of the box sizer, either wxVERTICAL
1828 int GetOrientation() const;
1831 Implements the calculation of a box sizer's dimensions and then sets
1832 the size of its children (calling wxWindow::SetSize if the child is a window).
1834 It is used internally only and must not be called by the user
1835 (call Layout() if you want to resize). Documented for information.