undo the last change as it results in buildbot configuration error

[wxWidgets.git] / interface / wx / sizer.h

diff --git a/interface/wx/sizer.h b/interface/wx/sizer.h
index 355305d996897b82b2019bfe764cc8f0131bdcd9..9fbb06d67bbaacc1142910866f87f046f8408c9e 100644 (file)
--- a/interface/wx/sizer.h
+++ b/interface/wx/sizer.h
@@ -6,1561 +6,1585 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

-/**
-    @class wxStdDialogButtonSizer
-
-    This class creates button layouts which conform to the standard button spacing
-    and ordering defined by the platform
-    or toolkit's user interface guidelines (if such things exist). By using this
-    class, you can ensure that all your
-    standard dialogs look correct on all major platforms. Currently it conforms to
-    the Windows, GTK+ and Mac OS X
-    human interface guidelines.
-
-    When there aren't interface guidelines defined for a particular platform or
-    toolkit, wxStdDialogButtonSizer reverts
-    to the Windows implementation.
-
-    To use this class, first add buttons to the sizer by calling AddButton (or
-    SetAffirmativeButton, SetNegativeButton,
-    or SetCancelButton) and then call Realize in order to create the actual button
-    layout used. Other than these special
-    operations, this sizer works like any other sizer.

 
 

-    If you add a button with wxID_SAVE, on Mac OS X the button will be renamed to
-    "Save" and
-    the wxID_NO button will be renamed to "Don't Save" in accordance with the Mac
-    OS X Human Interface Guidelines.
-
-    @library{wxcore}
-    @category{winlayout}
+/**
+    @class wxSizer

 
 

-    @see wxSizer, @ref overview_sizer "Sizer Overview",
-    wxDialog::CreateButtonSizer
-*/
-class wxStdDialogButtonSizer : public wxBoxSizer
-{
-public:
-    /**
-        Constructor for a wxStdDialogButtonSizer.
-    */
-    wxStdDialogButtonSizer();
+    wxSizer is the abstract base class used for laying out subwindows in a window.
+    You cannot use wxSizer directly; instead, you will have to use one of the sizer
+    classes derived from it. Currently there are wxBoxSizer, wxStaticBoxSizer,
+    wxGridSizer, wxFlexGridSizer, wxWrapSizer and wxGridBagSizer.

 
 

-    /**
-        Adds a button to the wxStdDialogButtonSizer. The @a button must have
-        one of the following identifiers:
-         wxID_OK
-         wxID_YES
-         wxID_SAVE
-         wxID_APPLY
-         wxID_CLOSE
-         wxID_NO
-         wxID_CANCEL
-         wxID_HELP
-         wxID_CONTEXT_HELP
-    */
-    void AddButton(wxButton* button);
+    The layout algorithm used by sizers in wxWidgets is closely related to layout
+    in other GUI toolkits, such as Java's AWT, the GTK toolkit or the Qt toolkit.
+    It is based upon the idea of the individual subwindows reporting their minimal
+    required size and their ability to get stretched if the size of the parent window
+    has changed.

 
 

-    /**
-        Rearranges the buttons and applies proper spacing between buttons to make them
-        match the platform or toolkit's interface guidelines.
-    */
-    void Realize();
+    This will most often mean that the programmer does not set the original size of
+    a dialog in the beginning, rather the dialog will be assigned a sizer and this
+    sizer will be queried about the recommended size. The sizer in turn will query
+    its children, which can be normal windows, empty space or other sizers, so that
+    a hierarchy of sizers can be constructed. Note that wxSizer does not derive
+    from wxWindow and thus does not interfere with tab ordering and requires very little
+    resources compared to a real window on screen.

 
 

-    /**
-        Sets the affirmative button for the sizer. This allows you to use identifiers
-        other than the standard identifiers outlined above.
-    */
-    void SetAffirmativeButton(wxButton* button);
+    What makes sizers so well fitted for use in wxWidgets is the fact that every
+    control reports its own minimal size and the algorithm can handle differences in
+    font sizes or different window (dialog item) sizes on different platforms without
+    problems. If e.g. the standard font as well as the overall design of Motif widgets
+    requires more space than on Windows, the initial dialog size will automatically
+    be bigger on Motif than on Windows.

 
 

-    /**
-        Sets the cancel button for the sizer. This allows you to use identifiers other
-        than the standard identifiers outlined above.
-    */
-    void SetCancelButton(wxButton* button);
+    Sizers may also be used to control the layout of custom drawn items on the
+    window. The wxSizer::Add(), wxSizer::Insert(), and wxSizer::Prepend() functions
+    return a pointer to the newly added wxSizerItem.
+    Just add empty space of the desired size and attributes, and then use the
+    wxSizerItem::GetRect() method to determine where the drawing operations
+    should take place.

 
 

-    /**
-        Sets the negative button for the sizer. This allows you to use identifiers
-        other than the standard identifiers outlined above.
-    */
-    void SetNegativeButton(wxButton* button);
-};
+    Please notice that sizers, like child windows, are owned by the library and
+    will be deleted by it which implies that they must be allocated on the heap.
+    However if you create a sizer and do not add it to another sizer or
+    window, the library wouldn't be able to delete such an orphan sizer and in
+    this, and only this, case it should be deleted explicitly.

 
 

+    @beginWxPythonOnly
+    If you wish to create a sizer class in wxPython you should
+    derive the class from @c wxPySizer in order to get Python-aware
+    capabilities for the various virtual methods.
+    @endWxPythonOnly

 
 

+    @section wxsizer_flags wxSizer flags

 
 

-/**
-    @class wxSizerItem
+    The "flag" argument accepted by wxSizeItem constructors and other
+    functions, e.g. wxSizer::Add(), is OR-combination of the following flags.
+    Two main behaviours are defined using these flags. One is the border around
+    a window: the border parameter determines the border width whereas the
+    flags given here determine which side(s) of the item that the border will
+    be added.  The other flags determine how the sizer item behaves when the
+    space allotted to the sizer changes, and is somewhat dependent on the
+    specific kind of sizer used.

 
 

-    The wxSizerItem class is used to track the position, size and other
-    attributes of each item managed by a wxSizer. It is not usually necessary
-    to use this class because the sizer elements can also be identified by
-    their positions or window or sizer pointers but sometimes it may be more
-    convenient to use it directly.
+    @beginDefList
+    @itemdef{wxTOP<br>
+             wxBOTTOM<br>
+             wxLEFT<br>
+             wxRIGHT<br>
+             wxALL,
+             These flags are used to specify which side(s) of the sizer item
+             the border width will apply to.}
+    @itemdef{wxEXPAND,
+             The item will be expanded to fill the space assigned to the item.}
+    @itemdef{wxSHAPED,
+             The item will be expanded as much as possible while also
+             maintaining its aspect ratio.}
+    @itemdef{wxFIXED_MINSIZE,
+             Normally wxSizers will use GetAdjustedBestSize() to determine what
+             the minimal size of window items should be, and will use that size
+             to calculate the layout. This allows layouts to adjust when an
+             item changes and its best size becomes different. If you would
+             rather have a window item stay the size it started with then use
+             @c wxFIXED_MINSIZE.}
+    @itemdef{wxRESERVE_SPACE_EVEN_IF_HIDDEN,
+             Normally wxSizers don't allocate space for hidden windows or other
+             items. This flag overrides this behavior so that sufficient space
+             is allocated for the window even if it isn't visible. This makes
+             it possible to dynamically show and hide controls without resizing
+             parent dialog, for example. (Available since 2.8.8.)}
+    @itemdef{wxALIGN_CENTER<br>
+             wxALIGN_CENTRE<br>
+             wxALIGN_LEFT<br>
+             wxALIGN_RIGHT<br>
+             wxALIGN_TOP<br>
+             wxALIGN_BOTTOM<br>
+             wxALIGN_CENTER_VERTICAL<br>
+             wxALIGN_CENTRE_VERTICAL<br>
+             wxALIGN_CENTER_HORIZONTAL<br>
+             wxALIGN_CENTRE_HORIZONTAL,
+             The @c wxALIGN_* flags allow you to specify the alignment of the item
+             within the space allotted to it by the sizer, adjusted for the
+             border if any.}
+    @endDefList

 
     @library{wxcore}
     @category{winlayout}
 
     @library{wxcore}
     @category{winlayout}

+
+    @see @ref overview_sizer

 */
 */

-class wxSizerItem : public wxObject
+class wxSizer : public wxObject

 {
 public:
 {
 public:

-    //@{

     /**
     /**

-        Construct a sizer item for tracking a subsizer.
+        The constructor.
+        Note that wxSizer is an abstract base class and may not be instantiated.

     */
     */

-    wxSizerItem(int width, int height, int proportion, int flag,
-                int border, wxObject* userData);
-    wxSizerItem(wxWindow* window, const wxSizerFlags& flags);
-    wxSizerItem(wxWindow* window, int proportion, int flag,
-                int border,
-                wxObject* userData);
-    wxSizerItem(wxSizer* window, const wxSizerFlags& flags);
-    wxSizerItem(wxSizer* sizer, int proportion, int flag,
-                int border,
-                wxObject* userData);
-    //@}
+    wxSizer();

 
     /**
 
     /**

-        Deletes the user data and subsizer, if any.
+        The destructor.

     */
     */

-    ~wxSizerItem();
+    virtual ~wxSizer();

 
     /**
 
     /**

-        Calculates the minimum desired size for the item, including any space
-        needed by borders.
-    */
-    virtual wxSize CalcMin();
+        Appends a child to the sizer.

 
 

-    /**
-        Destroy the window or the windows in a subsizer, depending on the type
-        of item.
-    */
-    void DeleteWindows();
+        wxSizer itself is an abstract class, but the parameters are equivalent
+        in the derived classes that you will instantiate to use it so they are
+        described here:

 
 

-    /**
-        Enable deleting the SizerItem without destroying the contained sizer.
+        @param window
+            The window to be added to the sizer. Its initial size (either set
+            explicitly by the user or calculated internally when using
+            wxDefaultSize) is interpreted as the minimal and in many cases also
+            the initial size.
+        @param flags
+            A wxSizerFlags object that enables you to specify most of the above
+            parameters more conveniently.

     */
     */

-    void DetachSizer();
+    wxSizerItem* Add(wxWindow* window, const wxSizerFlags& flags);

 
     /**
 
     /**

-        Return the border attribute.
-    */
-    int GetBorder() const;
+        Appends a child to the sizer.

 
 

-    /**
-        Return the flags attribute.
+        wxSizer itself is an abstract class, but the parameters are equivalent
+        in the derived classes that you will instantiate to use it so they are
+        described here:

 
 

-        See @ref wxsizer_flags "wxSizer flags list" for details.
+        @param window
+            The window to be added to the sizer. Its initial size (either set
+            explicitly by the user or calculated internally when using
+            wxDefaultSize) is interpreted as the minimal and in many cases also
+            the initial size.
+        @param proportion
+            Although the meaning of this parameter is undefined in wxSizer, it
+            is used in wxBoxSizer to indicate if a child of a sizer can change
+            its size in the main orientation of the wxBoxSizer - where 0 stands
+            for not changeable and a value of more than zero is interpreted
+            relative to the value of other children of the same wxBoxSizer. For
+            example, you might have a horizontal wxBoxSizer with three
+            children, two of which are supposed to change their size with the
+            sizer. Then the two stretchable windows would get a value of 1 each
+            to make them grow and shrink equally with the sizer's horizontal
+            dimension.
+        @param flag
+            OR-combination of flags affecting sizer's behavior. See
+            @ref wxsizer_flags "wxSizer flags list" for details.
+        @param border
+            Determines the border width, if the flag parameter is set to
+            include any border flag.
+        @param userData
+            Allows an extra object to be attached to the sizer item, for use in
+            derived classes when sizing information is more complex than the
+            proportion and flag will allow for.

     */
     */

-    int GetFlag() const;
+    wxSizerItem* Add(wxWindow* window,
+                     int proportion = 0,
+                     int flag = 0,
+                     int border = 0,
+                     wxObject* userData = NULL);

 
     /**
 
     /**

-        Return the numeric id of wxSizerItem, or @c wxID_NONE if the id has
-        not been set.
-    */
-    int GetId() const;
+        Appends a child to the sizer.

 
 

-    /**
-        Get the minimum size needed for the item.
+        wxSizer itself is an abstract class, but the parameters are equivalent
+        in the derived classes that you will instantiate to use it so they are
+        described here:
+
+        @param sizer
+            The (child-)sizer to be added to the sizer. This allows placing a
+            child sizer in a sizer and thus to create hierarchies of sizers
+            (typically a vertical box as the top sizer and several horizontal
+            boxes on the level beneath).
+        @param flags
+            A wxSizerFlags object that enables you to specify most of the above
+            parameters more conveniently.

     */
     */

-    wxSize GetMinSize() const;
+    wxSizerItem* Add(wxSizer* sizer, const wxSizerFlags& flags);

 
     /**
 
     /**

-        Sets the minimum size to be allocated for this item.
-
-        If this item is a window, the @a size is also passed to
-        wxWindow::SetMinSize().
-     */
-    void SetMinSize(const wxSize& size);
+        Appends a child to the sizer.

 
 

-    /**
-        @overload
-     */
-    void SetMinSize(int x, int y);
+        wxSizer itself is an abstract class, but the parameters are equivalent
+        in the derived classes that you will instantiate to use it so they are
+        described here:

 
 

-    /**
-        What is the current position of the item, as set in the last Layout.
+        @param sizer
+            The (child-)sizer to be added to the sizer. This allows placing a
+            child sizer in a sizer and thus to create hierarchies of sizers
+            (typically a vertical box as the top sizer and several horizontal
+            boxes on the level beneath).
+        @param proportion
+            Although the meaning of this parameter is undefined in wxSizer, it
+            is used in wxBoxSizer to indicate if a child of a sizer can change
+            its size in the main orientation of the wxBoxSizer - where 0 stands
+            for not changeable and a value of more than zero is interpreted
+            relative to the value of other children of the same wxBoxSizer. For
+            example, you might have a horizontal wxBoxSizer with three
+            children, two of which are supposed to change their size with the
+            sizer. Then the two stretchable windows would get a value of 1 each
+            to make them grow and shrink equally with the sizer's horizontal
+            dimension.
+        @param flag
+            OR-combination of flags affecting sizer's behavior. See
+            @ref wxsizer_flags "wxSizer flags list" for details.
+        @param border
+            Determines the border width, if the flag parameter is set to
+            include any border flag.
+        @param userData
+            Allows an extra object to be attached to the sizer item, for use in
+            derived classes when sizing information is more complex than the
+            proportion and flag will allow for.

     */
     */

-    wxPoint GetPosition() const;
+    wxSizerItem* Add(wxSizer* sizer,
+                     int proportion = 0,
+                     int flag = 0,
+                     int border = 0,
+                     wxObject* userData = NULL);

 
     /**
 
     /**

-        Get the proportion item attribute.
-    */
-    int GetProportion() const;
+        Appends a spacer child to the sizer.

 
 

-    /**
-        Get the ration item attribute.
-    */
-    float GetRatio() const;
+        wxSizer itself is an abstract class, but the parameters are equivalent
+        in the derived classes that you will instantiate to use it so they are
+        described here.

 
 

-    /**
-        Get the rectangle of the item on the parent window, excluding borders.
+        @a width and @a height specify the dimension of a spacer to be added to
+        the sizer. Adding spacers to sizers gives more flexibility in the
+        design of dialogs; imagine for example a horizontal box with two
+        buttons at the bottom of a dialog: you might want to insert a space
+        between the two buttons and make that space stretchable using the
+        proportion flag and the result will be that the left button will be
+        aligned with the left side of the dialog and the right button with the
+        right side - the space in between will shrink and grow with the dialog.
+
+        @param width
+            Width of the spacer.
+        @param height
+            Height of the spacer.
+        @param proportion
+            Although the meaning of this parameter is undefined in wxSizer, it
+            is used in wxBoxSizer to indicate if a child of a sizer can change
+            its size in the main orientation of the wxBoxSizer - where 0 stands
+            for not changeable and a value of more than zero is interpreted
+            relative to the value of other children of the same wxBoxSizer. For
+            example, you might have a horizontal wxBoxSizer with three
+            children, two of which are supposed to change their size with the
+            sizer. Then the two stretchable windows would get a value of 1 each
+            to make them grow and shrink equally with the sizer's horizontal
+            dimension.
+        @param flag
+            OR-combination of flags affecting sizer's behavior. See
+            @ref wxsizer_flags "wxSizer flags list" for details.
+        @param border
+            Determines the border width, if the flag parameter is set to
+            include any border flag.
+        @param userData
+            Allows an extra object to be attached to the sizer item, for use in
+            derived classes when sizing information is more complex than the
+            proportion and flag will allow for.

     */
     */

-    wxRect GetRect();
+    wxSizerItem* Add(int width, int height,
+                     int proportion = 0,
+                     int flag = 0,
+                     int border = 0,
+                     wxObject* userData = NULL);

 
     /**
 
     /**

-        Get the current size of the item, as set in the last Layout.
+        Adds non-stretchable space to the sizer.
+        More readable way of calling:
+        @code
+        wxSizer::Add(size, size, 0).
+        @endcode

     */
     */

-    wxSize GetSize() const;
+    wxSizerItem* AddSpacer(int size);

 
     /**
 
     /**

-        If this item is tracking a sizer, return it.  @NULL otherwise.
+        Adds stretchable space to the sizer.
+        More readable way of calling:
+        @code
+        wxSizer::Add(0, 0, prop).
+        @endcode

     */
     */

-    wxSizer* GetSizer() const;
+    wxSizerItem* AddStretchSpacer(int prop = 1);

 
     /**
 
     /**

-        If this item is tracking a spacer, return its size.
+        This method is abstract and has to be overwritten by any derived class.
+        Here, the sizer will do the actual calculation of its children's minimal sizes.

     */
     */

-    const wxSize GetSpacer() const;
+    virtual wxSize CalcMin() = 0;

 
     /**
 
     /**

-        Get the userData item attribute.
+        Detaches all children from the sizer.
+        If @a delete_windows is @true then child windows will also be deleted.

     */
     */

-    wxObject* GetUserData() const;
+    virtual void Clear(bool delete_windows = false);

 
     /**
 
     /**

-        If this item is tracking a window then return it.  @NULL otherwise.
+        Computes client area size for @a window so that it matches the sizer's
+        minimal size. Unlike GetMinSize(), this method accounts for other
+        constraints imposed on @e window, namely display's size (returned size
+        will never be too large for the display) and maximum window size if
+        previously set by wxWindow::SetMaxSize().
+
+        The returned value is suitable for passing to wxWindow::SetClientSize() or
+        wxWindow::SetMinClientSize().
+
+        @since 2.8.8
+
+        @see ComputeFittingWindowSize(), Fit()

     */
     */

-    wxWindow* GetWindow() const;
+    wxSize ComputeFittingClientSize(wxWindow* window);

 
     /**
 
     /**

-        Returns @true if this item is a window or a spacer and it is shown or
-        if this item is a sizer and not all of its elements are hidden.
+        Like ComputeFittingClientSize(), but converts the result into window
+        size. The returned value is suitable for passing to wxWindow::SetSize()
+        or wxWindow::SetMinSize().

 
 

-        In other words, for sizer items, all of the child elements must be
-        hidden for the sizer itself to be considered hidden.
+        @since 2.8.8

 
 

-        As an exception, if the @c wxRESERVE_SPACE_EVEN_IF_HIDDEN flag was
-        used for this sizer item, then IsShown() always returns @true for it
-        (see wxSizerFlags::ReserveSpaceEvenIfHidden()).
+        @see ComputeFittingClientSize(), Fit()

     */
     */

-    bool IsShown() const;
+    wxSize ComputeFittingWindowSize(wxWindow* window);

 
     /**
 
     /**

-        Is this item a sizer?
+        Detach the child @a window from the sizer without destroying it.
+
+        This method does not cause any layout or resizing to take place, call Layout()
+        to update the layout "on screen" after detaching a child from the sizer.
+
+        Returns @true if the child item was found and detached, @false otherwise.
+
+        @see Remove()

     */
     */

-    bool IsSizer() const;
+    virtual bool Detach(wxWindow* window);

 
     /**
 
     /**

-        Is this item a spacer?
+        Detach the child @a sizer from the sizer without destroying it.
+
+        This method does not cause any layout or resizing to take place, call Layout()
+        to update the layout "on screen" after detaching a child from the sizer.
+
+        Returns @true if the child item was found and detached, @false otherwise.
+
+        @see Remove()

     */
     */

-    bool IsSpacer() const;
+    virtual bool Detach(wxSizer* sizer);

 
     /**
 
     /**

-        Is this item a window?
+        Detach a item at position @a index from the sizer without destroying it.
+
+        This method does not cause any layout or resizing to take place, call Layout()
+        to update the layout "on screen" after detaching a child from the sizer.
+        Returns @true if the child item was found and detached, @false otherwise.
+
+        @see Remove()

     */
     */

-    bool IsWindow() const;
+    virtual bool Detach(int index);

 
     /**
 
     /**

-        Set the border item attribute.
+        Tell the sizer to resize the @a window so that its client area matches the
+        sizer's minimal size (ComputeFittingClientSize() is called to determine it).
+        This is commonly done in the constructor of the window itself, see sample
+        in the description of wxBoxSizer.
+
+        @return The new window size.
+
+        @see ComputeFittingClientSize(), ComputeFittingWindowSize()

     */
     */

-    void SetBorder(int border);
+    wxSize Fit(wxWindow* window);

 
     /**
 
     /**

-        Set the position and size of the space allocated to the sizer, and
-        adjust the position and size of the item to be within that space
-        taking alignment and borders into account.
+        Tell the sizer to resize the virtual size of the @a window to match the sizer's
+        minimal size. This will not alter the on screen size of the window, but may
+        cause the addition/removal/alteration of scrollbars required to view the virtual
+        area in windows which manage it.
+
+        @see wxScrolled::SetScrollbars(), SetVirtualSizeHints()

     */
     */

-    void SetDimension(const wxPoint& pos, const wxSize& size);
+    void FitInside(wxWindow* window);

 
 

+    //@{

     /**
     /**

-        Set the flag  item attribute.
+        Returns the list of the items in this sizer.
+
+        The elements of type-safe wxList @c wxSizerItemList are pointers to
+        objects of type wxSizerItem.

     */
     */

-    void SetFlag(int flag);
+    wxSizerItemList& GetChildren();
+    const wxSizerItemList& GetChildren() const;
+    //@}

 
     /**
 
     /**

-        Sets the numeric id of the wxSizerItem to @e id.
+        Returns the window this sizer is used in or @NULL if none.

     */
     */

-    void SetId(int id);
+    wxWindow* GetContainingWindow() const;

 
     /**
 
     /**

+       Returns the number of items in the sizer.

 
 

+       If you just need to test whether the sizer is empty or not you can also
+       use IsEmpty() function.

     */
     */

-    void SetInitSize(int x, int y);
+    size_t GetItemCount() const;

 
     /**
 
     /**

-        Set the proportion item attribute.
+        Finds wxSizerItem which holds the given @a window.
+        Use parameter @a recursive to search in subsizers too.
+        Returns pointer to item or @NULL.

     */
     */

-    void SetProportion(int proportion);
+    wxSizerItem* GetItem(wxWindow* window, bool recursive = false);

 
 

-    //@{

     /**
     /**

-        Set the ratio item attribute.
+        Finds wxSizerItem which holds the given @a sizer.
+        Use parameter @a recursive to search in subsizers too.
+        Returns pointer to item or @NULL.

     */
     */

-    void SetRatio(int width, int height);
-    void SetRatio(wxSize size);
-    void SetRatio(float ratio);
-    //@}
+
+    wxSizerItem* GetItem(wxSizer* sizer, bool recursive = false);

 
     /**
 
     /**

-        Set the sizer tracked by this item.
+        Finds wxSizerItem which is located in the sizer at position @a index.
+        Use parameter @a recursive to search in subsizers too.
+        Returns pointer to item or @NULL.

     */
     */

-    void SetSizer(wxSizer* sizer);
+    wxSizerItem* GetItem(size_t index);

 
     /**
 
     /**

-        Set the size of the spacer tracked by this item.
+        Finds item of the sizer which has the given @e id.
+        This @a id is not the window id but the id of the wxSizerItem itself.
+        This is mainly useful for retrieving the sizers created from XRC resources.
+        Use parameter @a recursive to search in subsizers too.
+        Returns pointer to item or @NULL.

     */
     */

-    void SetSpacer(const wxSize& size);
+    wxSizerItem* GetItemById(int id, bool recursive = false);

 
     /**
 
     /**

-        Set the window to be tracked by this item.
+        Returns the minimal size of the sizer.
+
+        This is either the combined minimal size of all the children and their
+        borders or the minimal size set by SetMinSize(), depending on which is bigger.
+        Note that the returned value is client size, not window size.
+        In particular, if you use the value to set toplevel window's minimal or
+        actual size, use wxWindow::SetMinClientSize() or wxWindow::SetClientSize(),
+        not wxWindow::SetMinSize() or wxWindow::SetSize().

     */
     */

-    void SetWindow(wxWindow* window);
+    wxSize GetMinSize();

 
     /**
 
     /**

-        Set the show item attribute, which sizers use to determine if the item
-        is to be made part of the layout or not.  If the item is tracking a
-        window then it is shown or hidden as needed.
+        Returns the current position of the sizer.

     */
     */

-    void Show(bool show);
-};
-
-
-
-/**
-    @class wxSizerFlags
-
-    Container for sizer items flags providing readable names for them.
-
-    Normally, when you add an item to a sizer via wxSizer::Add, you have to
-    specify a lot of flags and parameters which can be unwieldy. This is where
-    wxSizerFlags comes in: it allows you to specify all parameters using the
-    named methods instead. For example, instead of
+    wxPoint GetPosition() const;

 
 

-    @code
-    sizer->Add(ctrl, 0, wxEXPAND | wxALL, 10);
-    @endcode
+    /**
+        Returns the current size of the sizer.
+    */
+    wxSize GetSize() const;

 
 

-    you can now write
+    /**
+        Hides the child @a window.

 
 

-    @code
-    sizer->Add(ctrl, wxSizerFlags().Expand().Border(wxALL, 10));
-    @endcode
+        To make a sizer item disappear, use Hide() followed by Layout().

 
 

-    This is more readable and also allows you to create wxSizerFlags objects which
-    can be reused for several sizer items.
+        Use parameter @a recursive to hide elements found in subsizers.
+        Returns @true if the child item was found, @false otherwise.

 
 

-    @code
-    wxSizerFlags flagsExpand(1);
-        flagsExpand.Expand().Border(wxALL, 10);
+        @see IsShown(), Show()
+    */
+    bool Hide(wxWindow* window, bool recursive = false);

 
 

-        sizer->Add(ctrl1, flagsExpand);
-        sizer->Add(ctrl2, flagsExpand);
-    @endcode
+    /**
+        Hides the child @a sizer.

 
 

-    Note that by specification, all methods of wxSizerFlags return the wxSizerFlags
-    object itself to allowing chaining multiple methods calls like in the examples
-    above.
+        To make a sizer item disappear, use Hide() followed by Layout().

 
 

-    @library{wxcore}
-    @category{winlayout}
+        Use parameter @a recursive to hide elements found in subsizers.
+        Returns @true if the child item was found, @false otherwise.

 
 

-    @see wxSizer
-*/
-class wxSizerFlags
-{
-public:
-    /**
-        Creates the wxSizer with the proportion specified by @e proportion.
+        @see IsShown(), Show()

     */
     */

-    wxSizerFlags(int proportion = 0);
+    bool Hide(wxSizer* sizer, bool recursive = false);

 
     /**
 
     /**

-        Sets the alignment of this wxSizerFlags to @e align.
+        Hides the item at position @a index.

 
 

-        This method replaces the previously set alignment with the specified
-        one.
+        To make a sizer item disappear, use Hide() followed by Layout().

 
 

-        @see Top(), Left(), Right(), Bottom(), Centre()
+        Use parameter @a recursive to hide elements found in subsizers.
+        Returns @true if the child item was found, @false otherwise.

 
 

-        @param align Combination of @c wxALIGN_XXX bit masks.
+        @see IsShown(), Show()

     */
     */

-    wxSizerFlags& Align(int align = 0);
+    bool Hide(size_t index);

 
     /**
 
     /**

-        Sets the wxSizerFlags to have a border of a number of pixels specified
-        by @a borderinpixels with the directions specified by @e direction.
+        Insert a child into the sizer before any existing item at @a index.
+
+        See Add() for the meaning of the other parameters.

     */
     */

-    wxSizerFlags& Border(int direction, int borderinpixels);
+    wxSizerItem* Insert(size_t index, wxWindow* window,
+                        const wxSizerFlags& flags);

 
     /**
 
     /**

-        Sets the wxSizerFlags to have a border with size as returned by
-        GetDefaultBorder().
+        Insert a child into the sizer before any existing item at @a index.

 
 

-        @param direction Direction(s) to apply the border in.
+        See Add() for the meaning of the other parameters.

     */
     */

-    wxSizerFlags& Border(int direction = wxALL);
-
+    wxSizerItem* Insert(size_t index, wxWindow* window,
+                        int proportion = 0,
+                        int flag = 0,
+                        int border = 0,
+                        wxObject* userData = NULL);
+

     /**
     /**

-        Aligns the object to the bottom, similar for @c Align(wxALIGN_BOTTOM).
+        Insert a child into the sizer before any existing item at @a index.

 
 

-        Unlike Align(), this method doesn't change the horizontal alignment of
-        the item.
+        See Add() for the meaning of the other parameters.

     */
     */

-    wxSizerFlags& Bottom();
+    wxSizerItem* Insert(size_t index, wxSizer* sizer,
+                        const wxSizerFlags& flags);

 
     /**
 
     /**

-        Sets the object of the wxSizerFlags to center itself in the area it is
-        given.
+        Insert a child into the sizer before any existing item at @a index.
+
+        See Add() for the meaning of the other parameters.

     */
     */

-    wxSizerFlags& Center();
+    wxSizerItem* Insert(size_t index, wxSizer* sizer,
+                        int proportion = 0,
+                        int flag = 0,
+                        int border = 0,
+                        wxObject* userData = NULL);

 
     /**
 
     /**

-        Center() for people with the other dialect of English.
+        Insert a child into the sizer before any existing item at @a index.
+
+        See Add() for the meaning of the other parameters.

     */
     */

-    wxSizerFlags& Centre();
+    wxSizerItem* Insert(size_t index, int width, int height,
+                        int proportion = 0,
+                        int flag = 0,
+                        int border = 0,
+                        wxObject* userData = NULL);

 
     /**
 
     /**

-        Sets the border in the given @a direction having twice the default
-        border size.
+        Inserts non-stretchable space to the sizer.
+        More readable way of calling wxSizer::Insert(size, size, 0).

     */
     */

-    wxSizerFlags& DoubleBorder(int direction = wxALL);
+    wxSizerItem* InsertSpacer(size_t index, int size);

 
     /**
 
     /**

-        Sets the border in left and right directions having twice the default
-        border size.
+        Inserts stretchable space to the sizer.
+        More readable way of calling wxSizer::Insert(0, 0, prop).

     */
     */

-    wxSizerFlags& DoubleHorzBorder();
+    wxSizerItem* InsertStretchSpacer(size_t index, int prop = 1);

 
     /**
 
     /**

-        Sets the object of the wxSizerFlags to expand to fill as much area as
-        it can.
-    */
-    wxSizerFlags& Expand();
+        Return @true if the sizer has no elements.
+
+        @see GetItemCount()
+     */
+    bool IsEmpty() const;

 
     /**
 
     /**

-        Set the @c wxFIXED_MINSIZE flag which indicates that the initial size
-        of the window should be also set as its minimal size.
+        Returns @true if the @a window is shown.
+
+        @see Hide(), Show(), wxSizerItem::IsShown()

     */
     */

-    wxSizerFlags& FixedMinSize();
+    bool IsShown(wxWindow* window) const;

 
     /**
 
     /**

-        Set the @c wxRESERVE_SPACE_EVEN_IF_HIDDEN flag. Normally wxSizers
-        don't allocate space for hidden windows or other items. This flag
-        overrides this behavior so that sufficient space is allocated for the
-        window even if it isn't visible. This makes it possible to dynamically
-        show and hide controls without resizing parent dialog, for example.
+        Returns @true if the @a sizer is shown.

 
 

-        @since 2.8.8
+        @see Hide(), Show(), wxSizerItem::IsShown()

     */
     */

-    wxSizerFlags& ReserveSpaceEvenIfHidden();
+    bool IsShown(wxSizer* sizer) const;

 
     /**
 
     /**

-        Returns the border used by default in Border() method.
+        Returns @true if the item at @a index is shown.
+
+        @see Hide(), Show(), wxSizerItem::IsShown()

     */
     */

-    static int GetDefaultBorder();
+    bool IsShown(size_t index) const;

 
     /**
 
     /**

-        Aligns the object to the left, similar for @c Align(wxALIGN_LEFT).
+        Call this to force layout of the children anew, e.g. after having added a child
+        to or removed a child (window, other sizer or space) from the sizer while
+        keeping the current dimension.
+    */
+    virtual void Layout();

 
 

-        Unlike Align(), this method doesn't change the vertical alignment of
-        the item.
+    /**
+        Same as Add(), but prepends the items to the beginning of the
+        list of items (windows, subsizers or spaces) owned by this sizer.

     */
     */

-    wxSizerFlags& Left();
+    wxSizerItem* Prepend(wxWindow* window, const wxSizerFlags& flags);

 
     /**
 
     /**

-        Sets the proportion of this wxSizerFlags to @e proportion
+        Same as Add(), but prepends the items to the beginning of the
+        list of items (windows, subsizers or spaces) owned by this sizer.

     */
     */

-    wxSizerFlags& Proportion(int proportion = 0);
+    wxSizerItem* Prepend(wxWindow* window, int proportion = 0,
+                         int flag = 0,
+                         int border = 0,
+                         wxObject* userData = NULL);

 
     /**
 
     /**

-        Aligns the object to the right, similar for @c Align(wxALIGN_RIGHT).
+        Same as Add(), but prepends the items to the beginning of the
+        list of items (windows, subsizers or spaces) owned by this sizer.
+    */
+    wxSizerItem* Prepend(wxSizer* sizer,
+                         const wxSizerFlags& flags);

 
 

-        Unlike Align(), this method doesn't change the vertical alignment of
-        the item.
+    /**
+        Same as Add(), but prepends the items to the beginning of the
+        list of items (windows, subsizers or spaces) owned by this sizer.

     */
     */

-    wxSizerFlags& Right();
+    wxSizerItem* Prepend(wxSizer* sizer, int proportion = 0,
+                         int flag = 0,
+                         int border = 0,
+                         wxObject* userData = NULL);

 
     /**
 
     /**

-        Set the @c wx_SHAPED flag which indicates that the elements should
-        always keep the fixed width to height ratio equal to its original value.
+        Same as Add(), but prepends the items to the beginning of the
+        list of items (windows, subsizers or spaces) owned by this sizer.

     */
     */

-    wxSizerFlags& Shaped();
+    wxSizerItem* Prepend(int width, int height,
+                         int proportion = 0,
+                         int flag = 0,
+                         int border = 0,
+                         wxObject* userData = NULL);

 
     /**
 
     /**

-        Aligns the object to the top, similar for @c Align(wxALIGN_TOP).
+        Prepends non-stretchable space to the sizer.
+        More readable way of calling wxSizer::Prepend(size, size, 0).
+    */
+    wxSizerItem* PrependSpacer(int size);

 
 

-        Unlike Align(), this method doesn't change the horizontal alignment of
-        the item.
+    /**
+        Prepends stretchable space to the sizer.
+        More readable way of calling wxSizer::Prepend(0, 0, prop).

     */
     */

-    wxSizerFlags& Top();
+    wxSizerItem* PrependStretchSpacer(int prop = 1);

 
     /**
 
     /**

-        Sets the border in the given @a direction having thrice the default
-        border size.
+        This method is abstract and has to be overwritten by any derived class.
+        Here, the sizer will do the actual calculation of its children's
+        positions and sizes.

     */
     */

-    wxSizerFlags& TripleBorder(int direction = wxALL);
-};
+    virtual void RecalcSizes() = 0;
+
+    /**
+        Removes a child window from the sizer, but does @b not destroy it
+        (because windows are owned by their parent window, not the sizer).

 
 

+        @deprecated
+        The overload of this method taking a wxWindow* parameter
+        is deprecated as it does not destroy the window as would usually be
+        expected from Remove(). You should use Detach() in new code instead.
+        There is currently no wxSizer method that will both detach and destroy
+        a wxWindow item.

 
 

+        @note This method does not cause any layout or resizing to take
+              place, call Layout() to update the layout "on screen" after
+              removing a child from the sizer.

 
 

-/**
-    @class wxNotebookSizer
+        @return @true if the child item was found and removed, @false otherwise.
+    */
+    virtual bool Remove(wxWindow* window);

 
 

-    @deprecated
-    This class is deprecated and should not be used in new code! It is no
-    longer needed, wxNotebook control can be inserted
-    into any sizer class and its minimal size will be determined correctly.
+    /**
+        Removes a sizer child from the sizer and destroys it.

 
 

-    wxNotebookSizer is a specialized sizer to make sizers work in connection
-    with using notebooks. This sizer is different from any other sizer as you
-    must not add any children to it - instead, it queries the notebook class
-    itself.  The only thing this sizer does is to determine the size of the
-    biggest page of the notebook and report an adjusted minimal size to a more
-    toplevel sizer.
+        @note This method does not cause any layout or resizing to take
+              place, call Layout() to update the layout "on screen" after
+              removing a child from the sizer.

 
 

-    @library{wxbase}
-    @category{winlayout}
+        @param sizer The wxSizer to be removed.

 
 

-    @see wxSizer, wxNotebook,
-         @ref overview_sizer "Sizers overview"
-*/
-class wxNotebookSizer : public wxSizer
-{
-public:
-    /**
-        Constructor. It takes an associated notebook as its only parameter.
+        @return @true if the child item was found and removed, @false otherwise.

     */
     */

-    wxNotebookSizer(wxNotebook* notebook);
+    virtual bool Remove(wxSizer* sizer);

 
     /**
 
     /**

-        Returns the notebook associated with the sizer.
-    */
-    wxNotebook* GetNotebook();
-};
+        Removes a child from the sizer and destroys it if it is a sizer or a
+        spacer, but not if it is a window (because windows are owned by their
+        parent window, not the sizer).

 
 

+        @note This method does not cause any layout or resizing to take
+              place, call Layout() to update the layout "on screen" after
+              removing a child from the sizer.

 
 

+        @param index
+            The position of the child in the sizer, e.g. 0 for the first item.

 
 

-/**
-    @class wxFlexGridSizer
+        @return @true if the child item was found and removed, @false otherwise.
+    */
+    virtual bool Remove(int index);

 
 

-    A flex grid sizer is a sizer which lays out its children in a two-dimensional
-    table with all table fields in one row having the same
-    height and all fields in one column having the same width, but all
-    rows or all columns are not necessarily the same height or width as in
-    the wxGridSizer.
+    /**
+        Detaches the given @a oldwin from the sizer and replaces it with the
+        given @a newwin. The detached child window is @b not deleted (because
+        windows are owned by their parent window, not the sizer).

 
 

-    Since wxWidgets 2.5.0, wxFlexGridSizer can also size items equally in one
-    direction but unequally ("flexibly") in the other. If the sizer is only
-    flexible in one direction (this can be changed using
-    wxFlexGridSizer::SetFlexibleDirection),
-    it needs to be decided how the sizer should grow in the other ("non-flexible")
-    direction in order to fill the available space. The
-    wxFlexGridSizer::SetNonFlexibleGrowMode method
-    serves this purpose.
+        Use parameter @a recursive to search the given element recursively in subsizers.

 
 

-    @library{wxcore}
-    @category{winlayout}
+        This method does not cause any layout or resizing to take place,
+        call Layout() to update the layout "on screen" after replacing a
+        child from the sizer.

 
 

-    @see wxSizer, @ref overview_sizer "Sizer Overview"
-*/
-class wxFlexGridSizer : public wxGridSizer
-{
-public:
-    //@{
-    /**
-        Constructor for a wxGridSizer. @a rows and @a cols determine the number of
-        columns and rows in the sizer - if either of the parameters is zero, it will be
-        calculated to form the total number of children in the sizer, thus making the
-        sizer grow dynamically. @a vgap and @a hgap define extra space between
-        all children.
+        Returns @true if the child item was found and removed, @false otherwise.

     */
     */

-    wxFlexGridSizer(int rows, int cols, int vgap, int hgap);
-    wxFlexGridSizer(int cols, int vgap = 0, int hgap = 0);
-    //@}
+    virtual bool Replace(wxWindow* oldwin, wxWindow* newwin,
+                         bool recursive = false);

 
     /**
 
     /**

-        Specifies that column @a idx (starting from zero) should be grown if
-        there is extra space available to the sizer.
+        Detaches the given @a oldsz from the sizer and replaces it with the
+        given @a newsz. The detached child sizer is deleted.

 
 

-        The @a proportion parameter has the same meaning as the stretch factor
-        for the sizers() except that if all proportions are 0, then all columns
-        are resized equally (instead of not being resized at all).
+        Use parameter @a recursive to search the given element recursively in subsizers.

 
 

-        Notice that the row must not be already growable, if you need to change
-        the proportion you must call RemoveGrowableCol() first and then make it
-        growable (with a different proportion) again. You can use IsColGrowable()
-        to check whether a column is already growable.
+        This method does not cause any layout or resizing to take place,
+        call Layout() to update the layout "on screen" after replacing a
+        child from the sizer.
+
+        Returns @true if the child item was found and removed, @false otherwise.

     */
     */

-    void AddGrowableCol(size_t idx, int proportion = 0);
+    virtual bool Replace(wxSizer* oldsz, wxSizer* newsz,
+                         bool recursive = false);

 
     /**
 
     /**

-        Specifies that row idx (starting from zero) should be grown if there
-        is extra space available to the sizer.
+        Detaches the given item at position @a index from the sizer and
+        replaces it with the given wxSizerItem @a newitem.

 
 

-        This is identical to AddGrowableCol() except that it works with rows
-        and not columns.
-    */
-    void AddGrowableRow(size_t idx, int proportion = 0);
+        The detached child is deleted @b only if it is a sizer or a spacer
+        (but not if it is a wxWindow because windows are owned by their
+        parent window, not the sizer).

 
 

-    /**
-        Returns a wxOrientation value that specifies whether the sizer flexibly
-        resizes its columns, rows, or both (default).
+        This method does not cause any layout or resizing to take place,
+        call Layout() to update the layout "on screen" after replacing a
+        child from the sizer.

 
 

-        @return One of the following values:
+        Returns @true if the child item was found and removed, @false otherwise.
+    */
+    virtual bool Replace(size_t index, wxSizerItem* newitem);

 
 

-        @see SetFlexibleDirection()
+    /**
+        Call this to force the sizer to take the given dimension and thus force
+        the items owned by the sizer to resize themselves according to the
+        rules defined by the parameter in the Add() and Prepend() methods.

     */
     */

-    int GetFlexibleDirection() const;
+    void SetDimension(int x, int y, int width, int height);

 
     /**
 
     /**

-        Returns the value that specifies how the sizer grows in the "non-flexible"
-        direction if there is one.
+        @overload
+     */
+    void SetDimension(const wxPoint& pos, const wxSize& size);
+
+    /**
+        Set an item's minimum size by window, sizer, or position.

 
 

-        @return One of the following values:
+        The item will be found recursively in the sizer's descendants.
+        This function enables an application to set the size of an item after
+        initial creation.

 
 

-        @see SetFlexibleDirection(),
-             SetNonFlexibleGrowMode()
+        @see wxSizerItem::SetMinSize()

     */
     */

-    int GetNonFlexibleGrowMode() const;
+    bool SetItemMinSize(wxWindow* window, int width, int height);

 
     /**
 
     /**

-        Returns @true if column @a idx is growable.
+        Set an item's minimum size by window, sizer, or position.

 
 

-        @since 2.9.0
+        The item will be found recursively in the sizer's descendants.
+        This function enables an application to set the size of an item after
+        initial creation.
+
+        @see wxSizerItem::SetMinSize()

     */
     */

-    bool IsColGrowable(size_t idx);
+    bool SetItemMinSize(wxSizer* sizer, int width, int height);

 
     /**
 
     /**

-        Returns @true if row @a idx is growable.
+        Set an item's minimum size by window, sizer, or position.

 
 

-        @since 2.9.0
+        The item will be found recursively in the sizer's descendants.
+        This function enables an application to set the size of an item after
+        initial creation.
+
+        @see wxSizerItem::SetMinSize()

     */
     */

-    bool IsRowGrowable(size_t idx);
+    bool SetItemMinSize(size_t index, int width, int height);

 
     /**
 
     /**

-        Specifies that column idx is no longer growable.
+        Call this to give the sizer a minimal size.
+
+        Normally, the sizer will calculate its minimal size based purely on how
+        much space its children need. After calling this method GetMinSize()
+        will return either the minimal size as requested by its children or the
+        minimal size set here, depending on which is bigger.

     */
     */

-    void RemoveGrowableCol(size_t idx);
+    void SetMinSize(const wxSize& size);

 
     /**
 
     /**

-        Specifies that row idx is no longer growable.
-    */
-    void RemoveGrowableRow(size_t idx);
+        @overload
+     */
+    void SetMinSize(int width, int height);

 
     /**
 
     /**

-        Specifies whether the sizer should flexibly resize its columns, rows, or
-        both. Argument @c direction can be @c wxVERTICAL, @c wxHORIZONTAL
-        or @c wxBOTH (which is the default value). Any other value is ignored. See
-        @ref GetFlexibleDirection() GetFlexibleDirection for the
-        explanation of these values.
-        Note that this method does not trigger relayout.
+        This method first calls Fit() and then wxTopLevelWindow::SetSizeHints()
+        on the @a window passed to it.
+
+        This only makes sense when @a window is actually a wxTopLevelWindow such
+        as a wxFrame or a wxDialog, since SetSizeHints only has any effect in these classes.
+        It does nothing in normal windows or controls.
+
+        This method is implicitly used by wxWindow::SetSizerAndFit() which is
+        commonly invoked in the constructor of a toplevel window itself (see
+        the sample in the description of wxBoxSizer) if the toplevel window is
+        resizable.

     */
     */

-    void SetFlexibleDirection(int direction);
+    void SetSizeHints(wxWindow* window);

 
     /**
 
     /**

-        Specifies how the sizer should grow in the non-flexible direction if
-        there is one (so
-        SetFlexibleDirection() must have
-        been called previously). Argument @a mode can be one of those documented in
-        GetNonFlexibleGrowMode(), please
-        see there for their explanation.
-        Note that this method does not trigger relayout.
+        Tell the sizer to set the minimal size of the @a window virtual area to match
+        the sizer's minimal size. For windows with managed scrollbars this will set them
+        appropriately.
+
+        @deprecated @todo provide deprecation description
+
+        @see wxScrolled::SetScrollbars()

     */
     */

-    void SetNonFlexibleGrowMode(wxFlexSizerGrowMode mode);
-};
+    void SetVirtualSizeHints(wxWindow* window);

 
 

+    /**
+        Shows or hides the @a window.
+        To make a sizer item disappear or reappear, use Show() followed by Layout().

 
 

+        Use parameter @a recursive to show or hide elements found in subsizers.

 
 

-/**
-    @class wxSizer
+        Returns @true if the child item was found, @false otherwise.

 
 

-    wxSizer is the abstract base class used for laying out subwindows in a window.
-    You
-    cannot use wxSizer directly; instead, you will have to use one of the sizer
-    classes derived from it. Currently there are wxBoxSizer,
-    wxStaticBoxSizer,
-    wxGridSizer,
-    wxFlexGridSizer,
-    wxWrapSizer
-     and wxGridBagSizer.
+        @see Hide(), IsShown()
+    */
+    bool Show(wxWindow* window, bool show = true,
+              bool recursive = false);

 
 

-    The layout algorithm used by sizers in wxWidgets is closely related to layout
-    in other GUI toolkits, such as Java's AWT, the GTK toolkit or the Qt toolkit.
-    It is
-    based upon the idea of the individual subwindows reporting their minimal
-    required
-    size and their ability to get stretched if the size of the parent window has
-    changed.
-    This will most often mean that the programmer does not set the original size of
-    a dialog in the beginning, rather the dialog will be assigned a sizer and this
-    sizer
-    will be queried about the recommended size. The sizer in turn will query its
-    children, which can be normal windows, empty space or other sizers, so that
-    a hierarchy of sizers can be constructed. Note that wxSizer does not derive
-    from wxWindow
-    and thus does not interfere with tab ordering and requires very little
-    resources compared
-    to a real window on screen.
+    /**
+        Shows or hides @a sizer.
+        To make a sizer item disappear or reappear, use Show() followed by Layout().

 
 

-    What makes sizers so well fitted for use in wxWidgets is the fact that every
-    control
-    reports its own minimal size and the algorithm can handle differences in font
-    sizes
-    or different window (dialog item) sizes on different platforms without
-    problems. If e.g.
-    the standard font as well as the overall design of Motif widgets requires more
-    space than
-    on Windows, the initial dialog size will automatically be bigger on Motif than
-    on Windows.
+        Use parameter @a recursive to show or hide elements found in subsizers.

 
 

-    Sizers may also be used to control the layout of custom drawn items on the
-    window.  The Add(), Insert(), and Prepend() functions return a pointer to
-    the newly added wxSizerItem. Just add empty space of the desired size and
-    attributes, and then use the wxSizerItem::GetRect() method to determine
-    where the drawing operations should take place.
+        Returns @true if the child item was found, @false otherwise.

 
 

-    Please notice that sizers, like child windows, are owned by the library and
-    will be deleted by it which implies that they must be allocated on the
-    heap.  However if you create a sizer and do not add it to another sizer or
-    window, the library wouldn't be able to delete such an orphan sizer and in
-    this, and only this, case it should be deleted explicitly.
+        @see Hide(), IsShown()
+    */
+    bool Show(wxSizer* sizer, bool show = true,
+              bool recursive = false);

 
 

-    @b wxPython note: If you wish to create a sizer class in wxPython you should
-    derive the class from @c wxPySizer in order to get Python-aware
-    capabilities for the various virtual methods.
+    /**
+        Shows the item at @a index.
+        To make a sizer item disappear or reappear, use Show() followed by Layout().

 
 

-    @anchor wxsizer_flags
-    @par wxSizer flags
-    The "flag" argument accepted by wxSizeItem constructors and other
-    functions, e.g. wxSizer::Add(), is OR-combination of the following flags.
-    Two main behaviours are defined using these flags. One is the border around
-    a window: the border parameter determines the border width whereas the
-    flags given here determine which side(s) of the item that the border will
-    be added.  The other flags determine how the sizer item behaves when the
-    space allotted to the sizer changes, and is somewhat dependent on the
-    specific kind of sizer used.
-    @beginDefList
-    @itemdef{wxTOP<br>
-             wxBOTTOM<br>
-             wxLEFT<br>
-             wxRIGHT<br>
-             wxALL,
-             These flags are used to specify which side(s) of the sizer item
-             the border width will apply to.}
-    @itemdef{wxEXPAND,
-             The item will be expanded to fill the space assigned to the item.}
-    @itemdef{wxSHAPED,
-             The item will be expanded as much as possible while also
-             maintaining its aspect ratio.}
-    @itemdef{wxFIXED_MINSIZE,
-             Normally wxSizers will use GetAdjustedBestSize() to determine what
-             the minimal size of window items should be, and will use that size
-             to calculate the layout. This allows layouts to adjust when an
-             item changes and its best size becomes different. If you would
-             rather have a window item stay the size it started with then use
-             wxFIXED_MINSIZE.}
-    @itemdef{wxRESERVE_SPACE_EVEN_IF_HIDDEN,
-             Normally wxSizers don't allocate space for hidden windows or other
-             items. This flag overrides this behavior so that sufficient space
-             is allocated for the window even if it isn't visible. This makes
-             it possible to dynamically show and hide controls without resizing
-             parent dialog, for example. (Available since 2.8.8.)
-             }
-    @itemdef{wxALIGN_CENTER<br>
-             wxALIGN_CENTRE<br>
-             wxALIGN_LEFT<br>
-             wxALIGN_RIGHT<br>
-             wxALIGN_TOP<br>
-             wxALIGN_BOTTOM<br>
-             wxALIGN_CENTER_VERTICAL<br>
-             wxALIGN_CENTRE_VERTICAL<br>
-             wxALIGN_CENTER_HORIZONTAL<br>
-             wxALIGN_CENTRE_HORIZONTAL,
-             The wxALIGN flags allow you to specify the alignment of the item
-             within the space allotted to it by the sizer, adjusted for the
-             border if any.}
-    @endDefList
+        Returns @true if the child item was found, @false otherwise.
+
+        @see Hide(), IsShown()
+    */
+    bool Show(size_t index, bool show = true);
+};
+
+
+/**
+    @class wxStdDialogButtonSizer
+
+    This class creates button layouts which conform to the standard button spacing
+    and ordering defined by the platform or toolkit's user interface guidelines
+    (if such things exist). By using this class, you can ensure that all your
+    standard dialogs look correct on all major platforms. Currently it conforms to
+    the Windows, GTK+ and Mac OS X human interface guidelines.
+
+    When there aren't interface guidelines defined for a particular platform or
+    toolkit, wxStdDialogButtonSizer reverts to the Windows implementation.

 
 

+    To use this class, first add buttons to the sizer by calling
+    wxStdDialogButtonSizer::AddButton (or wxStdDialogButtonSizer::SetAffirmativeButton,
+    wxStdDialogButtonSizer::SetNegativeButton or wxStdDialogButtonSizer::SetCancelButton)
+    and then call Realize in order to create the actual button layout used.
+    Other than these special operations, this sizer works like any other sizer.
+
+    If you add a button with wxID_SAVE, on Mac OS X the button will be renamed to
+    "Save" and the wxID_NO button will be renamed to "Don't Save" in accordance
+    with the Mac OS X Human Interface Guidelines.

 
     @library{wxcore}
     @category{winlayout}
 
 
     @library{wxcore}
     @category{winlayout}
 

-    @see @ref overview_sizer "Sizer Overview"
+    @see wxSizer, @ref overview_sizer, wxDialog::CreateButtonSizer

 */
 */

-class wxSizer : public wxObject
+class wxStdDialogButtonSizer : public wxBoxSizer

 {
 public:
     /**
 {
 public:
     /**

-        The constructor. Note that wxSizer is an abstract base class and may not
-        be instantiated.
+        Constructor for a wxStdDialogButtonSizer.

     */
     */

-    wxSizer();
+    wxStdDialogButtonSizer();

 
     /**
 
     /**

-        The destructor.
+        Adds a button to the wxStdDialogButtonSizer. The @a button must have
+        one of the following identifiers:
+         - wxID_OK
+         - wxID_YES
+         - wxID_SAVE
+         - wxID_APPLY
+         - wxID_CLOSE
+         - wxID_NO
+         - wxID_CANCEL
+         - wxID_HELP
+         - wxID_CONTEXT_HELP

     */
     */

-    ~wxSizer();
+    void AddButton(wxButton* button);

 
     /**
 
     /**

-        Appends a child to the sizer.
+        Rearranges the buttons and applies proper spacing between buttons to make
+        them match the platform or toolkit's interface guidelines.
+    */
+    void Realize();

 
 

-        wxSizer itself is an abstract class, but the parameters are equivalent
-        in the derived classes that you will instantiate to use it so they are
-        described here:
+    /**
+        Sets the affirmative button for the sizer.

 
 

-        @param window
-            The window to be added to the sizer. Its initial size (either set
-            explicitly by the user or calculated internally when using
-            wxDefaultSize) is interpreted as the minimal and in many cases also
-            the initial size.
-        @param flags
-            A wxSizerFlags object that enables you to specify most of the above
-            parameters more conveniently.
+        This allows you to use identifiers other than the standard identifiers
+        outlined above.

     */
     */

-    wxSizerItem* Add(wxWindow* window, const wxSizerFlags& flags);
+    void SetAffirmativeButton(wxButton* button);

 
     /**
 
     /**

-        Appends a child to the sizer.
+        Sets the cancel button for the sizer.

 
 

-        wxSizer itself is an abstract class, but the parameters are equivalent
-        in the derived classes that you will instantiate to use it so they are
-        described here:
+        This allows you to use identifiers other than the standard identifiers
+        outlined above.
+    */
+    void SetCancelButton(wxButton* button);

 
 

-        @param window
-            The window to be added to the sizer. Its initial size (either set
-            explicitly by the user or calculated internally when using
-            wxDefaultSize) is interpreted as the minimal and in many cases also
-            the initial size.
-        @param proportion
-            Although the meaning of this parameter is undefined in wxSizer, it
-            is used in wxBoxSizer to indicate if a child of a sizer can change
-            its size in the main orientation of the wxBoxSizer - where 0 stands
-            for not changeable and a value of more than zero is interpreted
-            relative to the value of other children of the same wxBoxSizer. For
-            example, you might have a horizontal wxBoxSizer with three
-            children, two of which are supposed to change their size with the
-            sizer. Then the two stretchable windows would get a value of 1 each
-            to make them grow and shrink equally with the sizer's horizontal
-            dimension.
-        @param flag
-            OR-combination of flags affecting sizer's behavior. See
-            @ref wxsizer_flags "wxSizer flags list" for details.
-        @param border
-            Determines the border width, if the flag parameter is set to
-            include any border flag.
-        @param userData
-            Allows an extra object to be attached to the sizer item, for use in
-            derived classes when sizing information is more complex than the
-            proportion and flag will allow for.
+    /**
+        Sets the negative button for the sizer.
+
+        This allows you to use identifiers other than the standard identifiers
+        outlined above.

     */
     */

-    wxSizerItem* Add(wxWindow* window, int proportion = 0,
-                     int flag = 0,
-                     int border = 0,
-                     wxObject* userData = NULL);
+    void SetNegativeButton(wxButton* button);
+};
+
+
+
+/**
+    @class wxSizerItem
+
+    The wxSizerItem class is used to track the position, size and other
+    attributes of each item managed by a wxSizer.

 
 

+    It is not usually necessary to use this class because the sizer elements can
+    also be identified by their positions or window or sizer pointers but sometimes
+    it may be more convenient to use it directly.
+
+    @library{wxcore}
+    @category{winlayout}
+*/
+class wxSizerItem : public wxObject
+{
+public:

     /**
     /**

-        Appends a child to the sizer.
+        Construct a sizer item for tracking a spacer.
+    */
+    wxSizerItem(int width, int height, int proportion, int flag,
+                int border, wxObject* userData);

 
 

-        wxSizer itself is an abstract class, but the parameters are equivalent
-        in the derived classes that you will instantiate to use it so they are
-        described here:
+    //@{
+    /**
+        Construct a sizer item for tracking a window.
+    */
+    wxSizerItem(wxWindow* window, const wxSizerFlags& flags);
+    wxSizerItem(wxWindow* window, int proportion, int flag,
+                int border,
+                wxObject* userData);
+    //@}

 
 

-        @param sizer
-            The (child-)sizer to be added to the sizer. This allows placing a
-            child sizer in a sizer and thus to create hierarchies of sizers
-            (typically a vertical box as the top sizer and several horizontal
-            boxes on the level beneath).
-        @param flags
-            A wxSizerFlags object that enables you to specify most of the above
-            parameters more conveniently.
+    //@{
+    /**
+        Construct a sizer item for tracking a subsizer.

     */
     */

-    wxSizerItem* Add(wxSizer* sizer, const wxSizerFlags& flags);
+    wxSizerItem(wxSizer* window, const wxSizerFlags& flags);
+    wxSizerItem(wxSizer* sizer, int proportion, int flag,
+                int border,
+                wxObject* userData);
+    //@}

 
     /**
 
     /**

-        Appends a child to the sizer.
+        Deletes the user data and subsizer, if any.
+    */
+    virtual ~wxSizerItem();

 
 

-        wxSizer itself is an abstract class, but the parameters are equivalent
-        in the derived classes that you will instantiate to use it so they are
-        described here:
+    /**
+        Calculates the minimum desired size for the item, including any space
+        needed by borders.
+    */
+    virtual wxSize CalcMin();

 
 

-        @param sizer
-            The (child-)sizer to be added to the sizer. This allows placing a
-            child sizer in a sizer and thus to create hierarchies of sizers
-            (typically a vertical box as the top sizer and several horizontal
-            boxes on the level beneath).
-        @param proportion
-            Although the meaning of this parameter is undefined in wxSizer, it
-            is used in wxBoxSizer to indicate if a child of a sizer can change
-            its size in the main orientation of the wxBoxSizer - where 0 stands
-            for not changeable and a value of more than zero is interpreted
-            relative to the value of other children of the same wxBoxSizer. For
-            example, you might have a horizontal wxBoxSizer with three
-            children, two of which are supposed to change their size with the
-            sizer. Then the two stretchable windows would get a value of 1 each
-            to make them grow and shrink equally with the sizer's horizontal
-            dimension.
-        @param flag
-            OR-combination of flags affecting sizer's behavior. See
-            @ref wxsizer_flags "wxSizer flags list" for details.
-        @param border
-            Determines the border width, if the flag parameter is set to
-            include any border flag.
-        @param userData
-            Allows an extra object to be attached to the sizer item, for use in
-            derived classes when sizing information is more complex than the
-            proportion and flag will allow for.
+    /**
+        Destroy the window or the windows in a subsizer, depending on the type
+        of item.

     */
     */

-    wxSizerItem* Add(wxSizer* sizer, int proportion = 0,
-                     int flag = 0,
-                     int border = 0,
-                     wxObject* userData = NULL);
+    virtual void DeleteWindows();

 
     /**
 
     /**

-        Appends a spacer child to the sizer.
+        Enable deleting the SizerItem without destroying the contained sizer.
+    */
+    void DetachSizer();

 
 

-        wxSizer itself is an abstract class, but the parameters are equivalent
-        in the derived classes that you will instantiate to use it so they are
-        described here.
+    /**
+        Return the border attribute.
+    */
+    int GetBorder() const;

 
 

-        @a width and @a height specify the dimension of a spacer to be added to
-        the sizer. Adding spacers to sizers gives more flexibility in the
-        design of dialogs; imagine for example a horizontal box with two
-        buttons at the bottom of a dialog: you might want to insert a space
-        between the two buttons and make that space stretchable using the
-        proportion flag and the result will be that the left button will be
-        aligned with the left side of the dialog and the right button with the
-        right side - the space in between will shrink and grow with the dialog.
+    /**
+        Return the flags attribute.

 
 

-        @param width
-            Width of the spacer.
-        @param height
-            Height of the spacer.
-        @param proportion
-            Although the meaning of this parameter is undefined in wxSizer, it
-            is used in wxBoxSizer to indicate if a child of a sizer can change
-            its size in the main orientation of the wxBoxSizer - where 0 stands
-            for not changeable and a value of more than zero is interpreted
-            relative to the value of other children of the same wxBoxSizer. For
-            example, you might have a horizontal wxBoxSizer with three
-            children, two of which are supposed to change their size with the
-            sizer. Then the two stretchable windows would get a value of 1 each
-            to make them grow and shrink equally with the sizer's horizontal
-            dimension.
-        @param flag
-            OR-combination of flags affecting sizer's behavior. See
-            @ref wxsizer_flags "wxSizer flags list" for details.
-        @param border
-            Determines the border width, if the flag parameter is set to
-            include any border flag.
-        @param userData
-            Allows an extra object to be attached to the sizer item, for use in
-            derived classes when sizing information is more complex than the
-            proportion and flag will allow for.
+        See @ref wxsizer_flags "wxSizer flags list" for details.

     */
     */

-    wxSizerItem* Add(int width, int height, int proportion = 0,
-                     int flag = 0,
-                     int border = 0,
-                     wxObject* userData = NULL);
+    int GetFlag() const;
+
+    /**
+        Return the numeric id of wxSizerItem, or @c wxID_NONE if the id has
+        not been set.
+    */
+    int GetId() const;
+
+    /**
+        Get the minimum size needed for the item.
+    */
+    wxSize GetMinSize() const;
+
+    /**
+        Sets the minimum size to be allocated for this item.
+
+        If this item is a window, the @a size is also passed to
+        wxWindow::SetMinSize().
+     */
+    void SetMinSize(const wxSize& size);
+
+    /**
+        @overload
+     */
+    void SetMinSize(int x, int y);
+
+    /**
+        What is the current position of the item, as set in the last Layout.
+    */
+    wxPoint GetPosition() const;

 
     /**
 
     /**

-        Adds non-stretchable space to the sizer. More readable way of calling
-        wxSizer::Add(size, size, 0).
+        Get the proportion item attribute.

     */
     */

-    wxSizerItem* AddSpacer(int size);
+    int GetProportion() const;

 
     /**
 
     /**

-        Adds stretchable space to the sizer. More readable way of calling
-        wxSizer::Add(0, 0, prop).
+        Get the ration item attribute.

     */
     */

-    wxSizerItem* AddStretchSpacer(int prop = 1);
+    float GetRatio() const;

 
     /**
 
     /**

-        This method is abstract and has to be overwritten by any derived class.
-        Here, the sizer will do the actual calculation of its children's minimal sizes.
+        Get the rectangle of the item on the parent window, excluding borders.

     */
     */

-    virtual wxSize CalcMin();
+    virtual wxRect GetRect();

 
     /**
 
     /**

-        Detaches all children from the sizer. If @a delete_windows is @true then
-        child windows will also be deleted.
+        Get the current size of the item, as set in the last Layout.

     */
     */

-    void Clear(bool delete_windows = false);
+    virtual wxSize GetSize() const;

 
     /**
 
     /**

-        Computes client area size for @a window so that it matches the sizer's
-        minimal size. Unlike GetMinSize(), this method accounts for other
-        constraints imposed on @e window, namely display's size (returned size
-        will never be too large for the display) and maximum window size if
-        previously set by wxWindow::SetMaxSize(). The returned value is
-        suitable for passing to wxWindow::SetClientSize() or
-        wxWindow::SetMinClientSize().
-
-        @since 2.8.8
-
-        @see ComputeFittingWindowSize(), Fit()
+        If this item is tracking a sizer, return it.  @NULL otherwise.

     */
     */

-    wxSize ComputeFittingClientSize(wxWindow* window);
+    wxSizer* GetSizer() const;

 
     /**
 
     /**

-        Like ComputeFittingClientSize(), but converts the result into window
-        size. The returned value is suitable for passing to wxWindow::SetSize()
-        or wxWindow::SetMinSize().
-
-        @since 2.8.8
-
-        @see ComputeFittingClientSize(), Fit()
+        If this item is tracking a spacer, return its size.

     */
     */

-    wxSize ComputeFittingWindowSize(wxWindow* window);
+    wxSize GetSpacer() const;

 
     /**
 
     /**

-        Detach the child @a window from the sizer without destroying it.
-
-        This method does not cause any layout or resizing to take place, call Layout()
-        to update the layout "on screen" after detaching a child from the sizer.
-
-        Returns @true if the child item was found and detached, @false otherwise.
-
-        @see Remove()
+        Get the userData item attribute.

     */
     */

-    bool Detach(wxWindow* window);
+    wxObject* GetUserData() const;

 
     /**
 
     /**

-        Detach the child @a sizer from the sizer without destroying it.
-
-        This method does not cause any layout or resizing to take place, call Layout()
-        to update the layout "on screen" after detaching a child from the sizer.
-
-        Returns @true if the child item was found and detached, @false otherwise.
-
-        @see Remove()
+        If this item is tracking a window then return it. @NULL otherwise.

     */
     */

-    bool Detach(wxSizer* sizer);
+    wxWindow* GetWindow() const;

 
     /**
 
     /**

-        Detach a item at position @a index from the sizer without destroying it.
+        Returns @true if this item is a window or a spacer and it is shown or
+        if this item is a sizer and not all of its elements are hidden.

 
 

-        This method does not cause any layout or resizing to take place, call Layout()
-        to update the layout "on screen" after detaching a child from the sizer.
-        Returns @true if the child item was found and detached, @false otherwise.
+        In other words, for sizer items, all of the child elements must be
+        hidden for the sizer itself to be considered hidden.

 
 

-        @see Remove()
+        As an exception, if the @c wxRESERVE_SPACE_EVEN_IF_HIDDEN flag was
+        used for this sizer item, then IsShown() always returns @true for it
+        (see wxSizerFlags::ReserveSpaceEvenIfHidden()).

     */
     */

-    bool Detach(size_t index);
+    bool IsShown() const;

 
     /**
 
     /**

-        Tell the sizer to resize the @a window so that its client area matches the
-        sizer's minimal size
-        (ComputeFittingClientSize() is called
-        to determine it).
-        This is commonly done in the constructor of the window
-        itself, see sample in the description
-        of wxBoxSizer. Returns the new window size.
-
-        @see ComputeFittingClientSize(), ComputeFittingWindowSize()
+        Is this item a sizer?

     */
     */

-    wxSize Fit(wxWindow* window);
+    bool IsSizer() const;

 
     /**
 
     /**

-        Tell the sizer to resize the virtual size of the @a window to match the sizer's
-        minimal size.  This will not alter the on screen size of the window, but may
-        cause the addition/removal/alteration of scrollbars required to view the virtual
-        area in windows which manage it.
-
-        @see wxScrolled::SetScrollbars(), SetVirtualSizeHints()
+        Is this item a spacer?

     */
     */

-    void FitInside(wxWindow* window);
+    bool IsSpacer() const;

 
     /**
 
     /**

-        Returns the list of the items in this sizer. The elements of type-safe
-        wxList @a wxSizerItemList are pointers to objects of type
-        @ref wxSizerItem "wxSizerItem".
+        Is this item a window?

     */
     */

-    wxSizerItemList& GetChildren();
+    bool IsWindow() const;

 
     /**
 
     /**

-        Returns the list of the items in this sizer. The elements of type-safe
-        wxList @a wxSizerItemList are pointers to objects of type
-        @ref wxSizerItem "wxSizerItem".
+        Set the border item attribute.

     */
     */

-    const wxSizerItemList& GetChildren() const;
+    void SetBorder(int border);

 
     /**
 
     /**

-        Returns the window this sizer is used in or @NULL if none.
+        Set the position and size of the space allocated to the sizer, and
+        adjust the position and size of the item to be within that space
+        taking alignment and borders into account.

     */
     */

-    wxWindow* GetContainingWindow() const;
+    virtual void SetDimension(const wxPoint& pos, const wxSize& size);

 
     /**
 
     /**

-        Finds wxSizerItem which holds the given @a window
-        Use parameter @a recursive to search in subsizers too.
-        Returns pointer to item or @NULL.
+        Set the flag item attribute.

     */
     */

-    wxSizerItem* GetItem(wxWindow* window, bool recursive = false);
+    void SetFlag(int flag);

 
     /**
 
     /**

-        Finds wxSizerItem which holds the given @a sizer
-        Use parameter @a recursive to search in subsizers too.
-        Returns pointer to item or @NULL.
+        Sets the numeric id of the wxSizerItem to @e id.

     */
     */

+    void SetId(int id);

 
 

-    wxSizerItem* GetItem(wxSizer* sizer, bool recursive = false);

     /**
     /**

-        Finds wxSizerItem which is located in the sizer at position
-        @a index.
-        Use parameter @a recursive to search in subsizers too.
-        Returns pointer to item or @NULL.
+        @todo docme.

     */
     */

-    wxSizerItem* GetItem(size_t index);
+    void SetInitSize(int x, int y);

 
     /**
 
     /**

-        Finds item of the sizer which has the given @e id.  This @a id is not the
-        window id but the id of the wxSizerItem itself.  This is mainly useful for
-        retrieving the sizers created from XRC resources.
-        Use parameter @a recursive to search in subsizers too.
-        Returns pointer to item or @NULL.
+        Set the proportion item attribute.

     */
     */

-    wxSizerItem* GetItemById(int id, bool recursive = false);
+    void SetProportion(int proportion);

 
 

+    //@{

     /**
     /**

-        Returns the minimal size of the sizer. This is either the combined minimal
-        size of all the children and their borders or the minimal size set by
-        SetMinSize(), depending on which is bigger.
-        Note that the returned value is client size, not window size.
-        In particular, if you use the value to set toplevel window's minimal or
-        actual size, use wxWindow::SetMinClientSize
-        or wxWindow::SetClientSize, not
-        wxWindow::SetMinSize
-        or wxWindow::SetSize.
+        Set the ratio item attribute.

     */
     */

-    wxSize GetMinSize();
+    void SetRatio(int width, int height);
+    void SetRatio(wxSize size);
+    void SetRatio(float ratio);
+    //@}

 
     /**
 
     /**

-        Returns the current position of the sizer.
+        Set the sizer tracked by this item.
+        @deprecated @todo provide deprecation description

     */
     */

-    wxPoint GetPosition();
+    void SetSizer(wxSizer* sizer);

 
     /**
 
     /**

-        Returns the current size of the sizer.
+        Set the size of the spacer tracked by this item.
+        @deprecated @todo provide deprecation description

     */
     */

-    wxSize GetSize();
+    void SetSpacer(const wxSize& size);

 
     /**
 
     /**

-        Hides the child @a window.
-
-        To make a sizer item disappear, use Hide() followed by Layout().
-
-        Use parameter @a recursive to hide elements found in subsizers.
-        Returns @true if the child item was found, @false otherwise.
-
-        @see IsShown(), Show()
+        Set the window to be tracked by this item.
+        @deprecated @todo provide deprecation description

     */
     */

-    bool Hide(wxWindow* window, bool recursive = false);
+    void SetWindow(wxWindow* window);

 
     /**
 
     /**

-        Hides the child @a sizer.
+        Set the show item attribute, which sizers use to determine if the item
+        is to be made part of the layout or not. If the item is tracking a
+        window then it is shown or hidden as needed.
+    */
+    void Show(bool show);
+};

 
 

-        To make a sizer item disappear, use Hide() followed by Layout().

 
 

-        Use parameter @a recursive to hide elements found in subsizers.
-        Returns @true if the child item was found, @false otherwise.

 
 

-        @see IsShown(), Show()
-    */
-    bool Hide(wxSizer* sizer, bool recursive = false);
+/**
+    @class wxSizerFlags

 
 

-    /**
-        Hides the item at position @a index.
+    Container for sizer items flags providing readable names for them.

 
 

-        To make a sizer item disappear, use Hide() followed by Layout().
+    Normally, when you add an item to a sizer via wxSizer::Add, you have to
+    specify a lot of flags and parameters which can be unwieldy. This is where
+    wxSizerFlags comes in: it allows you to specify all parameters using the
+    named methods instead. For example, instead of

 
 

-        Use parameter @a recursive to hide elements found in subsizers.
-        Returns @true if the child item was found, @false otherwise.
+    @code
+    sizer->Add(ctrl, 0, wxEXPAND | wxALL, 10);
+    @endcode

 
 

-        @see IsShown(), Show()
-    */
-    bool Hide(size_t index);
+    you can now write

 
 

-    /**
-        Insert a child into the sizer before any existing item at @a index.
+    @code
+    sizer->Add(ctrl, wxSizerFlags().Expand().Border(wxALL, 10));
+    @endcode

 
 

-        See Add() for the meaning of the other parameters.
-    */
-    wxSizerItem* Insert(size_t index, wxWindow* window,
-                        const wxSizerFlags& flags);
+    This is more readable and also allows you to create wxSizerFlags objects which
+    can be reused for several sizer items.

 
 

-    /**
-        Insert a child into the sizer before any existing item at @a index.
+    @code
+    wxSizerFlags flagsExpand(1);
+        flagsExpand.Expand().Border(wxALL, 10);

 
 

-        See Add() for the meaning of the other parameters.
-    */
-    wxSizerItem* Insert(size_t index, wxWindow* window,
-                        int proportion = 0,
-                        int flag = 0,
-                        int border = 0,
-                        wxObject* userData = NULL);
+        sizer->Add(ctrl1, flagsExpand);
+        sizer->Add(ctrl2, flagsExpand);
+    @endcode

 
 

-    /**
-        Insert a child into the sizer before any existing item at @a index.
+    Note that by specification, all methods of wxSizerFlags return the wxSizerFlags
+    object itself to allowing chaining multiple methods calls like in the examples
+    above.

 
 

-        See Add() for the meaning of the other parameters.
-    */
-    wxSizerItem* Insert(size_t index, wxSizer* sizer,
-                        const wxSizerFlags& flags);
+    @library{wxcore}
+    @category{winlayout}

 
 

+    @see wxSizer
+*/
+class wxSizerFlags
+{
+public:

     /**
     /**

-        Insert a child into the sizer before any existing item at @a index.
-
-        See Add() for the meaning of the other parameters.
+        Creates the wxSizer with the proportion specified by @a proportion.

     */
     */

-    wxSizerItem* Insert(size_t index, wxSizer* sizer,
-                        int proportion = 0,
-                        int flag = 0,
-                        int border = 0,
-                        wxObject* userData = NULL);
+    wxSizerFlags(int proportion = 0);

 
     /**
 
     /**

-        Insert a child into the sizer before any existing item at @a index.
+        Sets the alignment of this wxSizerFlags to @a align.

 
 

-        See Add() for the meaning of the other parameters.
-    */
-    wxSizerItem* Insert(size_t index, int width, int height,
-                        int proportion = 0,
-                        int flag = 0,
-                        int border = 0,
-                        wxObject* userData = NULL);
+        This method replaces the previously set alignment with the specified one.

 
 

-    /**
-        Inserts non-stretchable space to the sizer. More readable way of calling
-        wxSizer::Insert(size, size, 0).
-    */
-    wxSizerItem* InsertSpacer(size_t index, int size);
+        @param alignment
+            Combination of @c wxALIGN_XXX bit masks.

 
 

-    /**
-        Inserts stretchable space to the sizer. More readable way of calling
-        wxSizer::Insert(0, 0, prop).
+        @see Top(), Left(), Right(), Bottom(), Centre()

     */
     */

-    wxSizerItem* InsertStretchSpacer(size_t index, int prop = 1);
+    wxSizerFlags& Align(int alignment);

 
     /**
 
     /**

-        Returns @true if the @e window is shown.
-
-        @see Hide(), Show(), wxSizerItem::IsShown()
+        Sets the wxSizerFlags to have a border of a number of pixels specified
+        by @a borderinpixels with the directions specified by @a direction.

     */
     */

-    bool IsShown(wxWindow* window) const;
+    wxSizerFlags& Border(int direction, int borderinpixels);

 
     /**
 
     /**

-        Returns @true if the @e sizer is shown.
+        Sets the wxSizerFlags to have a border with size as returned by
+        GetDefaultBorder().

 
 

-        @see Hide(), Show(), wxSizerItem::IsShown()
+        @param direction
+            Direction(s) to apply the border in.

     */
     */

-    bool IsShown(wxSizer* sizer) const;
+    wxSizerFlags& Border(int direction = wxALL);

 
     /**
 
     /**

-        Returns @true if the item at @a index is shown.
-
-        @see Hide(), Show(), wxSizerItem::IsShown()
-    */
-    bool IsShown(size_t index) const;
+        Aligns the object to the bottom, similar for @c Align(wxALIGN_BOTTOM).

 
 

-    /**
-        Call this to force layout of the children anew, e.g. after having added a child
-        to or removed a child (window, other sizer or space) from the sizer while
-        keeping
-        the current dimension.
+        Unlike Align(), this method doesn't change the horizontal alignment of
+        the item.

     */
     */

-    void Layout();
+    wxSizerFlags& Bottom();

 
     /**
 
     /**

-        Same as Add(), but prepends the items to the beginning of the
-        list of items (windows, subsizers or spaces) owned by this sizer.
+        Sets the object of the wxSizerFlags to center itself in the area it is
+        given.

     */
     */

-    wxSizerItem* Prepend(wxWindow* window, const wxSizerFlags& flags);
+    wxSizerFlags& Center();

 
     /**
 
     /**

-        Same as Add(), but prepends the items to the beginning of the
-        list of items (windows, subsizers or spaces) owned by this sizer.
+        Center() for people with the other dialect of English.

     */
     */

-    wxSizerItem* Prepend(wxWindow* window, int proportion = 0,
-                         int flag = 0,
-                         int border = 0,
-                         wxObject* userData = NULL);
+    wxSizerFlags& Centre();

 
     /**
 
     /**

-        Same as Add(), but prepends the items to the beginning of the
-        list of items (windows, subsizers or spaces) owned by this sizer.
+        Sets the border in the given @a direction having twice the default
+        border size.

     */
     */

-    wxSizerItem* Prepend(wxSizer* sizer,
-                         const wxSizerFlags& flags);
+    wxSizerFlags& DoubleBorder(int direction = wxALL);

 
     /**
 
     /**

-        Same as Add(), but prepends the items to the beginning of the
-        list of items (windows, subsizers or spaces) owned by this sizer.
+        Sets the border in left and right directions having twice the default
+        border size.

     */
     */

-    wxSizerItem* Prepend(wxSizer* sizer, int proportion = 0,
-                         int flag = 0,
-                         int border = 0,
-                         wxObject* userData = NULL);
+    wxSizerFlags& DoubleHorzBorder();

 
     /**
 
     /**

-        Same as Add(), but prepends the items to the beginning of the
-        list of items (windows, subsizers or spaces) owned by this sizer.
+        Sets the object of the wxSizerFlags to expand to fill as much area as
+        it can.

     */
     */

-    wxSizerItem* Prepend(int width, int height,
-                         int proportion = 0,
-                         int flag = 0,
-                         int border = 0,
-                         wxObject* userData = NULL);
+    wxSizerFlags& Expand();

 
     /**
 
     /**

-        Prepends non-stretchable space to the sizer. More readable way of
-        calling wxSizer::Prepend(size, size, 0).
+        Set the @c wxFIXED_MINSIZE flag which indicates that the initial size
+        of the window should be also set as its minimal size.

     */
     */

-    wxSizerItem* PrependSpacer(int size);
+    wxSizerFlags& FixedMinSize();

 
     /**
 
     /**

-        Prepends stretchable space to the sizer. More readable way of calling
-        wxSizer::Prepend(0, 0, prop).
+        Set the @c wxRESERVE_SPACE_EVEN_IF_HIDDEN flag. Normally wxSizers
+        don't allocate space for hidden windows or other items. This flag
+        overrides this behavior so that sufficient space is allocated for the
+        window even if it isn't visible. This makes it possible to dynamically
+        show and hide controls without resizing parent dialog, for example.
+
+        @since 2.8.8

     */
     */

-    wxSizerItem* PrependStretchSpacer(int prop = 1);
+    wxSizerFlags& ReserveSpaceEvenIfHidden();

 
     /**
 
     /**

-        This method is abstract and has to be overwritten by any derived class.
-        Here, the sizer will do the actual calculation of its children's
-        positions and sizes.
+        Returns the border used by default in Border() method.

     */
     */

-    virtual void RecalcSizes();
+    static int GetDefaultBorder();

 
     /**
 
     /**

-        Removes a child window from the sizer, but does @b not destroy it
-        (because windows are owned by their parent window, not the sizer).
-
-        @deprecated
-        The overload of this method taking a wxWindow* parameter
-        is deprecated as it does not destroy the window as would usually be
-        expected from Remove(). You should use Detach() in new code instead.
-        There is currently no wxSizer method that will both detach and destroy
-        a wxWindow item.
-
-        @note This method does not cause any layout or resizing to take
-              place, call Layout() to update the layout "on screen" after
-              removing a child from the sizer.
+        Aligns the object to the left, similar for @c Align(wxALIGN_LEFT).

 
 

-        @return @true if the child item was found and removed, @false otherwise.
+        Unlike Align(), this method doesn't change the vertical alignment of
+        the item.

     */
     */

-    bool Remove(wxWindow* window);
+    wxSizerFlags& Left();

 
     /**
 
     /**

-        Removes a sizer child from the sizer and destroys it.
-
-        @note This method does not cause any layout or resizing to take
-              place, call Layout() to update the layout "on screen" after
-              removing a child from the sizer.
+        Sets the proportion of this wxSizerFlags to @e proportion
+    */
+    wxSizerFlags& Proportion(int proportion);

 
 

-        @param sizer The wxSizer to be removed.
+    /**
+        Aligns the object to the right, similar for @c Align(wxALIGN_RIGHT).

 
 

-        @return @true if the child item was found and removed, @false otherwise.
+        Unlike Align(), this method doesn't change the vertical alignment of
+        the item.

     */
     */

-    bool Remove(wxSizer* sizer);
+    wxSizerFlags& Right();

 
     /**
 
     /**

-        Removes a child from the sizer and destroys it if it is a sizer or a
-        spacer, but not if it is a window (because windows are owned by their
-        parent window, not the sizer).
-
-        @note This method does not cause any layout or resizing to take
-              place, call Layout() to update the layout "on screen" after
-              removing a child from the sizer.
+        Set the @c wx_SHAPED flag which indicates that the elements should
+        always keep the fixed width to height ratio equal to its original value.
+    */
+    wxSizerFlags& Shaped();

 
 

-        @param index  The position of the child in the sizer, e.g. 0 for the
-                      first item.
+    /**
+        Aligns the object to the top, similar for @c Align(wxALIGN_TOP).

 
 

-        @return @true if the child item was found and removed, @false otherwise.
+        Unlike Align(), this method doesn't change the horizontal alignment of
+        the item.

     */
     */

-    bool Remove(size_t index);
+    wxSizerFlags& Top();

 
     /**
 
     /**

-        Detaches the given @a oldwin from the sizer and
-        replaces it with the given @a newwin. The detached
-        child window is @b not deleted (because windows are
-        owned by their parent window, not the sizer).
+        Sets the border in the given @a direction having thrice the default
+        border size.
+    */
+    wxSizerFlags& TripleBorder(int direction = wxALL);
+};

 
 

-        Use parameter @a recursive to search the given element recursively in subsizers.

 
 

-        This method does not cause any layout or resizing to take place,
-        call Layout() to update the layout "on screen" after replacing a
-        child from the sizer.
+/**
+    Values which define the behaviour for resizing wxFlexGridSizer cells in the
+    "non-flexible" direction.
+*/
+enum wxFlexSizerGrowMode
+{
+    /// Don't resize the cells in non-flexible direction at all.
+    wxFLEX_GROWMODE_NONE,

 
 

-        Returns @true if the child item was found and removed, @false otherwise.
-    */
-    bool Replace(wxWindow* oldwin, wxWindow* newwin,
-                 bool recursive = false);
+    /// Uniformly resize only the specified ones (default).
+    wxFLEX_GROWMODE_SPECIFIED,

 
 

-    /**
-        Detaches the given @a oldsz from the sizer and
-        replaces it with the given @a newsz. The detached
-        child sizer is deleted.
+    /// Uniformly resize all cells.
+    wxFLEX_GROWMODE_ALL
+};

 
 

-        Use parameter @a recursive to search the given element recursively in subsizers.
+/**
+    @class wxFlexGridSizer

 
 

-        This method does not cause any layout or resizing to take place,
-        call Layout() to update the layout "on screen" after replacing a
-        child from the sizer.
+    A flex grid sizer is a sizer which lays out its children in a two-dimensional
+    table with all table fields in one row having the same height and all fields
+    in one column having the same width, but all rows or all columns are not
+    necessarily the same height or width as in the wxGridSizer.

 
 

-        Returns @true if the child item was found and removed, @false otherwise.
-    */
-    bool Replace(wxSizer* oldsz, wxSizer* newsz,
-                 bool recursive = false);
+    Since wxWidgets 2.5.0, wxFlexGridSizer can also size items equally in one
+    direction but unequally ("flexibly") in the other. If the sizer is only
+    flexible in one direction (this can be changed using wxFlexGridSizer::SetFlexibleDirection),
+    it needs to be decided how the sizer should grow in the other ("non-flexible")
+    direction in order to fill the available space.
+    The wxFlexGridSizer::SetNonFlexibleGrowMode() method serves this purpose.

 
 

-    /**
-        Detaches the given item at position @a index from the sizer and
-        replaces it with the given wxSizerItem @a newitem.
+    @library{wxcore}
+    @category{winlayout}

 
 

-        The detached child is deleted @b only if it is a sizer or a spacer
-        (but not if it is a wxWindow because windows are owned by their
-        parent window, not the sizer).
+    @see wxSizer, @ref overview_sizer
+*/
+class wxFlexGridSizer : public wxGridSizer
+{
+public:
+    //@{
+    /**
+        Constructor for a wxFlexGridSizer.

 
 

-        This method does not cause any layout or resizing to take place,
-        call Layout() to update the layout "on screen" after replacing a
-        child from the sizer.
+        @a rows and @a cols determine the number of columns and rows in the sizer -
+        if either of the parameters is zero, it will be calculated to form the
+        total number of children in the sizer, thus making the sizer grow
+        dynamically.

 
 

-        Returns @true if the child item was found and removed, @false otherwise.
+        @a vgap and @a hgap define extra space between all children.

     */
     */

-    bool Replace(size_t index, wxSizerItem* newitem);
+    wxFlexGridSizer(int rows, int cols, int vgap, int hgap);
+    wxFlexGridSizer(int cols, int vgap = 0, int hgap = 0);
+    //@}

 
     /**
 
     /**

-        Call this to force the sizer to take the given dimension and thus force
-        the items owned by the sizer to resize themselves according to the
-        rules defined by the parameter in the Add() and Prepend() methods.
-    */
-    void SetDimension(int x, int y, int width, int height);
+        Specifies that column @a idx (starting from zero) should be grown if
+        there is extra space available to the sizer.

 
 

-    /**
-        @overload
-     */
-    void SetDimension(const wxPoint& pos, const wxSize& size);
+        The @a proportion parameter has the same meaning as the stretch factor
+        for the sizers (see wxBoxSizer) except that if all proportions are 0,
+        then all columns are resized equally (instead of not being resized at all).

 
 

-    /**
-        Set an item's minimum size by window, sizer, or position.
+        Notice that the column must not be already growable, if you need to change
+        the proportion you must call RemoveGrowableCol() first and then make it
+        growable (with a different proportion) again. You can use IsColGrowable()
+        to check whether a column is already growable.
+    */
+    void AddGrowableCol(size_t idx, int proportion = 0);

 
 

-        The item will be found recursively in the sizer's descendants. This
-        function enables an application to set the size of an item after
-        initial creation.
+    /**
+        Specifies that row idx (starting from zero) should be grown if there
+        is extra space available to the sizer.

 
 

-        @see wxSizerItem::SetMinSize()
+        This is identical to AddGrowableCol() except that it works with rows
+        and not columns.

     */
     */

-    void SetItemMinSize(wxWindow* window, int width, int height);
+    void AddGrowableRow(size_t idx, int proportion = 0);

 
     /**
 
     /**

-        Set an item's minimum size by window, sizer, or position.
+        Returns a ::wxOrientation value that specifies whether the sizer flexibly
+        resizes its columns, rows, or both (default).

 
 

-        The item will be found recursively in the sizer's descendants. This
-        function enables an application to set the size of an item after
-        initial creation.
+        @return
+            One of the following values:
+            - wxVERTICAL: Rows are flexibly sized.
+            - wxHORIZONTAL: Columns are flexibly sized.
+            - wxBOTH: Both rows and columns are flexibly sized (this is the default value).

 
 

-        @see wxSizerItem::SetMinSize()
+        @see SetFlexibleDirection()

     */
     */

-    void SetItemMinSize(wxSizer* sizer, int width, int height);
+    int GetFlexibleDirection() const;

 
     /**
 
     /**

-        Set an item's minimum size by window, sizer, or position.
+        Returns the value that specifies how the sizer grows in the "non-flexible"
+        direction if there is one.

 
 

-        The item will be found recursively in the sizer's descendants. This
-        function enables an application to set the size of an item after
-        initial creation.
+        The behaviour of the elements in the flexible direction (i.e. both rows
+        and columns by default, or rows only if GetFlexibleDirection() is
+        @c wxVERTICAL or columns only if it is @c wxHORIZONTAL) is always governed
+        by their proportion as specified in the call to AddGrowableRow() or
+        AddGrowableCol(). What happens in the other direction depends on the
+        value of returned by this function as described below.

 
 

-        @see wxSizerItem::SetMinSize()
-    */
-    void SetItemMinSize(size_t index, int width, int height);
+        @return
+            One of the following values:
+            - wxFLEX_GROWMODE_NONE: Sizer doesn't grow its elements at all in
+              the non-flexible direction.
+            - wxFLEX_GROWMODE_SPECIFIED: Sizer honors growable columns/rows set
+              with AddGrowableCol() and AddGrowableRow() in the non-flexible
+              direction as well. In this case equal sizing applies to minimum
+              sizes of columns or rows (this is the default value).
+            - wxFLEX_GROWMODE_ALL: Sizer equally stretches all columns or rows in
+              the non-flexible direction, independently of the proportions
+              applied in the flexible direction.

 
 

-    /**
-        Call this to give the sizer a minimal size. Normally, the sizer will
-        calculate its minimal size based purely on how much space its children
-        need. After calling this method GetMinSize() will return either the
-        minimal size as requested by its children or the minimal size set here,
-        depending on which is bigger.
+        @see SetFlexibleDirection(), SetNonFlexibleGrowMode()

     */
     */

-    void SetMinSize(const wxSize& size);
+    wxFlexSizerGrowMode GetNonFlexibleGrowMode() const;

 
     /**
 
     /**

-        @overload
-     */
-    void SetMinSize(int width, int height);
+        Returns @true if column @a idx is growable.

 
 

-    /**
-        This method first calls Fit() and then
-        wxTopLevelWindow::SetSizeHints on the @e window
-        passed to it. This only makes sense when @a window is actually a
-        wxTopLevelWindow such as a wxFrame or a
-        wxDialog, since SetSizeHints only has any effect in these classes.
-        It does nothing in normal windows or controls.
-        This method is implicitly used by wxWindow::SetSizerAndFit
-        which is commonly invoked in the constructor of a toplevel window itself (see
-        the sample in the description of wxBoxSizer) if the
-        toplevel window is resizable.
+        @since 2.9.0

     */
     */

-    void SetSizeHints(wxWindow* window);
+    bool IsColGrowable(size_t idx);

 
     /**
 
     /**

-        Tell the sizer to set the minimal size of the @a window virtual area to match
-        the sizer's
-        minimal size. For windows with managed scrollbars this will set them
-        appropriately.
+        Returns @true if row @a idx is growable.

 
 

-        @see wxScrolled::SetScrollbars()
+        @since 2.9.0

     */
     */

-    void SetVirtualSizeHints(wxWindow* window);
+    bool IsRowGrowable(size_t idx);

 
     /**
 
     /**

-        Shows or hides the @a window.
-        To make a sizer item disappear or reappear, use Show() followed by Layout().
-
-        Use parameter @a recursive to show or hide elements found in subsizers.
-
-        Returns @true if the child item was found, @false otherwise.
-
-        @see Hide(), IsShown()
+        Specifies that the @a idx column index is no longer growable.

     */
     */

-    bool Show(wxWindow* window, bool show = true,
-              bool recursive = false);
+    void RemoveGrowableCol(size_t idx);

 
     /**
 
     /**

-        Shows or hides @a sizer.
-        To make a sizer item disappear or reappear, use Show() followed by Layout().
+        Specifies that the @a idx row index is no longer growable.
+    */
+    void RemoveGrowableRow(size_t idx);

 
 

-        Use parameter @a recursive to show or hide elements found in subsizers.
+    /**
+        Specifies whether the sizer should flexibly resize its columns, rows, or both.

 
 

-        Returns @true if the child item was found, @false otherwise.
+        Argument @a direction can be @c wxVERTICAL, @c wxHORIZONTAL or @c wxBOTH
+        (which is the default value). Any other value is ignored.

 
 

-        @see Hide(), IsShown()
+        See GetFlexibleDirection() for the explanation of these values.
+        Note that this method does not trigger relayout.

     */
     */

-    bool Show(wxSizer* sizer, bool show = true,
-              bool recursive = false);
+    void SetFlexibleDirection(int direction);

 
     /**
 
     /**

-        Shows the item at @a index.
-        To make a sizer item disappear or reappear, use Show() followed by Layout().
-
-        Returns @true if the child item was found, @false otherwise.
+        Specifies how the sizer should grow in the non-flexible direction if
+        there is one (so SetFlexibleDirection() must have been called previously).

 
 

-        @see Hide(), IsShown()
+        Argument @a mode can be one of those documented in GetNonFlexibleGrowMode(),
+        please see there for their explanation.
+        Note that this method does not trigger relayout.

     */
     */

-    bool Show(size_t index, bool show = true);
+    void SetNonFlexibleGrowMode(wxFlexSizerGrowMode mode);

 };
 
 
 };
 
 

-

 /**
     @class wxGridSizer
 
     A grid sizer is a sizer which lays out its children in a two-dimensional
 /**
     @class wxGridSizer
 
     A grid sizer is a sizer which lays out its children in a two-dimensional

-    table with all table fields having the same size,
-    i.e. the width of each field is the width of the widest child,
-    the height of each field is the height of the tallest child.
+    table with all table fields having the same size, i.e. the width of each
+    field is the width of the widest child, the height of each field is the
+    height of the tallest child.

 
     @library{wxcore}
     @category{winlayout}
 
 
     @library{wxcore}
     @category{winlayout}
 

-    @see wxSizer, @ref overview_sizer "Sizer Overview"
+    @see wxSizer, @ref overview_sizer

 */
 class wxGridSizer : public wxSizer
 {
 public:
     //@{
     /**
 */
 class wxGridSizer : public wxSizer
 {
 public:
     //@{
     /**

-        Constructor for a wxGridSizer. @a rows and @a cols determine the number of
-        columns and rows in the sizer - if either of the parameters is zero, it will be
-        calculated to form the total number of children in the sizer, thus making the
-        sizer grow dynamically. @a vgap and @a hgap define extra space between
-        all children.
+        Constructor for a wxGridSizer.
+
+        @a rows and @a cols determine the number of columns and rows in the sizer -
+        if either of the parameters is zero, it will be calculated to form the
+        total number of children in the sizer, thus making the sizer grow dynamically.
+
+        @a vgap and @a hgap define extra space between all children.

     */
     wxGridSizer(int rows, int cols, int vgap, int hgap);
     wxGridSizer(int cols, int vgap = 0, int hgap = 0);
     */
     wxGridSizer(int rows, int cols, int vgap, int hgap);
     wxGridSizer(int cols, int vgap = 0, int hgap = 0);


@@ -1569,22 +1593,22 @@ public:
     /**
         Returns the number of columns in the sizer.
     */
     /**
         Returns the number of columns in the sizer.
     */

-    int GetCols();
+    int GetCols() const;

 
     /**
         Returns the horizontal gap (in pixels) between cells in the sizer.
     */
 
     /**
         Returns the horizontal gap (in pixels) between cells in the sizer.
     */

-    int GetHGap();
+    int GetHGap() const;

 
     /**
         Returns the number of rows in the sizer.
     */
 
     /**
         Returns the number of rows in the sizer.
     */

-    int GetRows();
+    int GetRows() const;

 
     /**
         Returns the vertical gap (in pixels) between the cells in the sizer.
     */
 
     /**
         Returns the vertical gap (in pixels) between the cells in the sizer.
     */

-    int GetVGap();
+    int GetVGap() const;

 
     /**
         Sets the number of columns in the sizer.
 
     /**
         Sets the number of columns in the sizer.


@@ -1612,37 +1636,55 @@ public:
 /**
     @class wxStaticBoxSizer
 
 /**
     @class wxStaticBoxSizer
 

-    wxStaticBoxSizer is a sizer derived from wxBoxSizer but adds a static
-    box around the sizer. This static box may be either created independently or
-    the sizer may create it itself as a convenience. In any case, the sizer owns
-    the wxStaticBox control and will delete it if it is
-    deleted.
+    wxStaticBoxSizer is a sizer derived from wxBoxSizer but adds a static box around 
+    the sizer.
+
+    The static box may be either created independently or the sizer may create it 
+    itself as a convenience. In any case, the sizer owns the wxStaticBox control
+    and will delete it in the wxStaticBoxSizer destructor.
+    
+    Note that since wxWidgets 2.9.0 you are encouraged to build the windows which are
+    placed inside wxStaticBoxes as children of the wxStaticBox itself:
+    @code
+        ...
+        wxStaticBoxSizer *sz = new wxStaticBoxSizer(wxVERTICAL, parentWindow, "StaticBox");
+        sz->Add(new wxStaticText(sz->GetStaticBox(), "This window is a child of the staticbox"));
+        ...
+    @endcode
+    
+    Creating the windows which are placed inside wxStaticBoxes as siblings of the
+    wxStaticBox is still allowed but it's deprecated as it gives some problems
+    (e.g. relative to tooltips) on some ports.

 
     @library{wxcore}
     @category{winlayout}
 
     @see wxSizer, wxStaticBox, wxBoxSizer, @ref overview_sizer
 
     @library{wxcore}
     @category{winlayout}
 
     @see wxSizer, wxStaticBox, wxBoxSizer, @ref overview_sizer

-    "Sizer Overview"

 */
 class wxStaticBoxSizer : public wxBoxSizer
 {
 public:
 */
 class wxStaticBoxSizer : public wxBoxSizer
 {
 public:

-    //@{

     /**
     /**

-        The first constructor uses an already existing static box. It takes the
-        associated static box and the orientation @e orient, which can be either
-        @c wxVERTICAL or @c wxHORIZONTAL as parameters.
-        The second one creates a new static box with the given label and parent window.
+        This constructor uses an already existing static box.
+
+        @param box
+            The static box to associate with the sizer (which will take its
+            ownership).
+        @param orient
+            Can be either @c wxVERTICAL or @c wxHORIZONTAL.

     */
     wxStaticBoxSizer(wxStaticBox* box, int orient);
     */
     wxStaticBoxSizer(wxStaticBox* box, int orient);

-    wxStaticBoxSizer(int orient, wxWindow parent,
+
+    /**
+        This constructor creates a new static box with the given label and parent window.
+    */
+    wxStaticBoxSizer(int orient, wxWindow *parent,

                      const wxString& label = wxEmptyString);
                      const wxString& label = wxEmptyString);

-    //@}

 
     /**
         Returns the static box associated with the sizer.
     */
 
     /**
         Returns the static box associated with the sizer.
     */

-    wxStaticBox* GetStaticBox();
+    wxStaticBox* GetStaticBox() const;

 };
 
 
 };
 
 


@@ -1651,17 +1693,15 @@ public:
     @class wxBoxSizer
 
     The basic idea behind a box sizer is that windows will most often be laid out
     @class wxBoxSizer
 
     The basic idea behind a box sizer is that windows will most often be laid out

-    in rather
-    simple basic geometry, typically in a row or a column or several hierarchies of
-    either.
+    in rather simple basic geometry, typically in a row or a column or several
+    hierarchies of either.

 
 

-    For more information, please see @ref overview_sizer_box
-    "Programming with wxBoxSizer".
+    For more information, please see @ref overview_sizer_box.

 
     @library{wxcore}
     @category{winlayout}
 
 
     @library{wxcore}
     @category{winlayout}
 

-    @see wxSizer, @ref overview_sizer "Sizers Overview"
+    @see wxSizer, @ref overview_sizer

 */
 class wxBoxSizer : public wxSizer
 {
 */
 class wxBoxSizer : public wxSizer
 {


@@ -1673,8 +1713,10 @@ public:
     wxBoxSizer(int orient);
 
     /**
     wxBoxSizer(int orient);
 
     /**

-        Implements the calculation of a box sizer's minimal. It is used internally
-        only and must not be called by the user. Documented for information.
+        Implements the calculation of a box sizer's minimal.
+
+        It is used internally only and must not be called by the user.
+        Documented for information.

     */
     virtual wxSize CalcMin();
 
     */
     virtual wxSize CalcMin();
 


@@ -1686,9 +1728,10 @@ public:
 
     /**
         Implements the calculation of a box sizer's dimensions and then sets
 
     /**
         Implements the calculation of a box sizer's dimensions and then sets

-        the size of its children (calling wxWindow::SetSize
-        if the child is a window). It is used internally only and must not be called
-        by the user (call Layout() if you want to resize). Documented for information.
+        the size of its children (calling wxWindow::SetSize if the child is a window).
+
+        It is used internally only and must not be called by the user
+        (call Layout() if you want to resize). Documented for information.

     */
     void RecalcSizes();
 };
     */
     void RecalcSizes();
 };