From: Francesco Montorsi Date: Wed, 28 Jan 2009 00:36:13 +0000 (+0000) Subject: move wxSizer docs to the beginning of the file, before derived classes X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/788194ff7356ce276fad49ab40d2e63cb311e9de move wxSizer docs to the beginning of the file, before derived classes git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58470 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/interface/wx/sizer.h b/interface/wx/sizer.h index 86269f643f..b0a4426808 100644 --- a/interface/wx/sizer.h +++ b/interface/wx/sizer.h @@ -8,1562 +8,1542 @@ /** - A generic orientation value. -*/ -enum wxOrientation -{ - /* don't change the values of these elements, they are used elsewhere */ - wxHORIZONTAL = 0x0004, - wxVERTICAL = 0x0008, + @class wxSizer - wxBOTH = wxVERTICAL | wxHORIZONTAL, + 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. - /* a mask to extract orientation from the combination of flags */ - wxORIENTATION_MASK = wxBOTH -}; + 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. -/** - @class wxStdDialogButtonSizer + 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. - 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. + 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. - When there aren't interface guidelines defined for a particular platform or - toolkit, wxStdDialogButtonSizer reverts to the Windows implementation. + 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. - 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. + @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 - 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. + @section wxsizer_flags 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
+ wxBOTTOM
+ wxLEFT
+ wxRIGHT
+ 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
+ wxALIGN_CENTRE
+ wxALIGN_LEFT
+ wxALIGN_RIGHT
+ wxALIGN_TOP
+ wxALIGN_BOTTOM
+ wxALIGN_CENTER_VERTICAL
+ wxALIGN_CENTRE_VERTICAL
+ wxALIGN_CENTER_HORIZONTAL
+ 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} - @see wxSizer, @ref overview_sizer, wxDialog::CreateButtonSizer + @see @ref overview_sizer */ -class wxStdDialogButtonSizer : public wxBoxSizer +class wxSizer : public wxObject { public: /** - Constructor for a wxStdDialogButtonSizer. + The constructor. + Note that wxSizer is an abstract base class and may not be instantiated. */ - wxStdDialogButtonSizer(); + wxSizer(); /** - 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 + The destructor. */ - void AddButton(wxButton* button); + virtual ~wxSizer(); /** - Rearranges the buttons and applies proper spacing between buttons to make - them match the platform or toolkit's interface guidelines. - */ - void Realize(); + Appends a child to the sizer. - /** - Sets the affirmative 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. + @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 SetAffirmativeButton(wxButton* button); + wxSizerItem* Add(wxWindow* window, const wxSizerFlags& flags); /** - Sets the cancel button for the sizer. - - This allows you to use identifiers other than the standard identifiers - outlined above. - */ - void SetCancelButton(wxButton* button); + Appends a child to the sizer. - /** - Sets the negative 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. + @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. */ - 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. + wxSizerItem* Add(wxWindow* window, + int proportion = 0, + int flag = 0, + int border = 0, + wxObject* userData = NULL); - @library{wxcore} - @category{winlayout} -*/ -class wxSizerItem : public wxObject -{ -public: /** - Construct a sizer item for tracking a spacer. - */ - wxSizerItem(int width, int height, int proportion, int flag, - int border, wxObject* userData); + Appends a child to the sizer. - //@{ - /** - 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); - //@} + 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 subsizer. + @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. */ - wxSizerItem(wxSizer* window, const wxSizerFlags& flags); - wxSizerItem(wxSizer* sizer, int proportion, int flag, - int border, - wxObject* userData); - //@} + wxSizerItem* Add(wxSizer* sizer, const wxSizerFlags& flags); /** - Deletes the user data and subsizer, if any. - */ - virtual ~wxSizerItem(); + Appends a child to the sizer. - /** - Calculates the minimum desired size for the item, including any space - needed by borders. - */ - virtual wxSize CalcMin(); + 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: - /** - Destroy the window or the windows in a subsizer, depending on the type - of item. + @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. */ - virtual void DeleteWindows(); + wxSizerItem* Add(wxSizer* sizer, + int proportion = 0, + int flag = 0, + int border = 0, + wxObject* userData = NULL); /** - Enable deleting the SizerItem without destroying the contained sizer. + Appends a spacer child to 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. + + @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. */ - void DetachSizer(); + wxSizerItem* Add(int width, int height, + int proportion = 0, + int flag = 0, + int border = 0, + wxObject* userData = NULL); /** - Return the border attribute. + Adds non-stretchable space to the sizer. + More readable way of calling: + @code + wxSizer::Add(size, size, 0). + @endcode */ - int GetBorder() const; + wxSizerItem* AddSpacer(int size); /** - Return the flags attribute. - - See @ref wxsizer_flags "wxSizer flags list" for details. + Adds stretchable space to the sizer. + More readable way of calling: + @code + wxSizer::Add(0, 0, prop). + @endcode */ - int GetFlag() const; + wxSizerItem* AddStretchSpacer(int prop = 1); /** - Return the numeric id of wxSizerItem, or @c wxID_NONE if the id has - not been set. + 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. */ - int GetId() const; + virtual wxSize CalcMin() = 0; /** - Get the minimum size needed for the item. + Detaches all children from the sizer. + If @a delete_windows is @true then child windows will also be deleted. */ - wxSize GetMinSize() const; + virtual void Clear(bool delete_windows = false); /** - Sets the minimum size to be allocated for this item. + 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(). - If this item is a window, the @a size is also passed to - wxWindow::SetMinSize(). - */ - void SetMinSize(const wxSize& size); + The returned value is suitable for passing to wxWindow::SetClientSize() or + wxWindow::SetMinClientSize(). - /** - @overload - */ - void SetMinSize(int x, int y); + @since 2.8.8 - /** - What is the current position of the item, as set in the last Layout. + @see ComputeFittingWindowSize(), Fit() */ - wxPoint GetPosition() const; + wxSize ComputeFittingClientSize(wxWindow* window); /** - Get the proportion item attribute. - */ - int GetProportion() const; + Like ComputeFittingClientSize(), but converts the result into window + size. The returned value is suitable for passing to wxWindow::SetSize() + or wxWindow::SetMinSize(). - /** - Get the ration item attribute. - */ - float GetRatio() const; + @since 2.8.8 - /** - Get the rectangle of the item on the parent window, excluding borders. + @see ComputeFittingClientSize(), Fit() */ - virtual wxRect GetRect(); + wxSize ComputeFittingWindowSize(wxWindow* window); /** - Get the current size of the item, as set in the last Layout. - */ - virtual wxSize GetSize() const; + Detach the child @a window from the sizer without destroying it. - /** - If this item is tracking a sizer, return it. @NULL otherwise. - */ - wxSizer* GetSizer() const; + 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. - /** - If this item is tracking a spacer, return its size. - */ - wxSize GetSpacer() const; + Returns @true if the child item was found and detached, @false otherwise. - /** - Get the userData item attribute. + @see Remove() */ - wxObject* GetUserData() const; + virtual bool Detach(wxWindow* window); /** - If this item is tracking a window then return it. @NULL otherwise. + 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() */ - wxWindow* GetWindow() const; + virtual bool Detach(wxSizer* sizer); /** - 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. + Detach a item at position @a index from the sizer without destroying it. - In other words, for sizer items, all of the child elements must be - hidden for the sizer itself to be considered 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. - 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 Remove() */ - bool IsShown() const; + virtual bool Detach(int index); /** - Is this item a sizer? + 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() */ - bool IsSizer() const; + wxSize Fit(wxWindow* window); /** - Is this item a spacer? + 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() */ - bool IsSpacer() const; + void FitInside(wxWindow* window); + //@{ /** - Is this item a window? + Returns the list of the items in this sizer. + + The elements of type-safe wxList @c wxSizerItemList are pointers to + objects of type wxSizerItem. */ - bool IsWindow() const; + wxSizerItemList& GetChildren(); + const wxSizerItemList& GetChildren() const; + //@} /** - Set the border item attribute. + Returns the window this sizer is used in or @NULL if none. */ - void SetBorder(int border); + wxWindow* GetContainingWindow() const; /** - 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. + 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. */ - virtual void SetDimension(const wxPoint& pos, const wxSize& size); + size_t GetItemCount() const; /** - Set the flag 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 SetFlag(int flag); + wxSizerItem* GetItem(wxWindow* window, bool recursive = false); /** - Sets the numeric id of the wxSizerItem to @e id. + Finds wxSizerItem which holds the given @a sizer. + Use parameter @a recursive to search in subsizers too. + Returns pointer to item or @NULL. */ - void SetId(int id); + + wxSizerItem* GetItem(wxSizer* sizer, bool recursive = false); /** - @todo docme. + 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 SetInitSize(int x, int y); + wxSizerItem* GetItem(size_t index); /** - Set the proportion item attribute. + 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 SetProportion(int proportion); + wxSizerItem* GetItemById(int id, bool recursive = false); - //@{ /** - Set the ratio item attribute. - */ - void SetRatio(int width, int height); - void SetRatio(wxSize size); - void SetRatio(float ratio); - //@} + Returns the minimal size of the sizer. - /** - Set the sizer tracked by this item. - @deprecated @todo provide deprecation description + 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 SetSizer(wxSizer* sizer); + wxSize GetMinSize(); /** - Set the size of the spacer tracked by this item. - @deprecated @todo provide deprecation description + Returns the current position of the sizer. */ - void SetSpacer(const wxSize& size); + wxPoint GetPosition() const; /** - Set the window to be tracked by this item. - @deprecated @todo provide deprecation description + Returns the current size of the sizer. */ - void SetWindow(wxWindow* window); + wxSize GetSize() const; /** - 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); -}; - - - -/** - @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 - - @code - sizer->Add(ctrl, 0, wxEXPAND | wxALL, 10); - @endcode - - 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 @a proportion. + @see IsShown(), Show() */ - wxSizerFlags(int proportion = 0); + bool Hide(wxSizer* sizer, bool recursive = false); /** - Sets the alignment of this wxSizerFlags to @a 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(). - @param alignment - Combination of @c wxALIGN_XXX bit masks. + Use parameter @a recursive to hide elements found in subsizers. + Returns @true if the child item was found, @false otherwise. - @see Top(), Left(), Right(), Bottom(), Centre() + @see IsShown(), Show() */ - wxSizerFlags& Align(int alignment); + 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 @a 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. - */ - wxSizerFlags& Center(); + Insert a child into the sizer before any existing item at @a index. - /** - Center() for people with the other dialect of English. + See Add() for the meaning of the other parameters. */ - wxSizerFlags& Centre(); + wxSizerItem* Insert(size_t index, wxSizer* sizer, + 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. + Insert a child into the sizer before any existing item at @a index. + + See Add() for the meaning of the other parameters. */ - wxSizerFlags& DoubleBorder(int direction = wxALL); + 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 left and right directions having twice the default - border size. + Inserts non-stretchable space to the sizer. + More readable way of calling wxSizer::Insert(size, size, 0). */ - wxSizerFlags& DoubleHorzBorder(); + wxSizerItem* InsertSpacer(size_t index, int size); /** - Sets the object of the wxSizerFlags to expand to fill as much area as - it can. + Inserts stretchable space to the sizer. + More readable way of calling wxSizer::Insert(0, 0, prop). */ - wxSizerFlags& Expand(); + wxSizerItem* InsertStretchSpacer(size_t index, int prop = 1); /** - Set the @c wxFIXED_MINSIZE flag which indicates that the initial size - of the window should be also set as its minimal size. - */ - wxSizerFlags& FixedMinSize(); + Return @true if the sizer has no elements. + + @see GetItemCount() + */ + bool IsEmpty() 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 window is shown. - @since 2.8.8 + @see Hide(), Show(), wxSizerItem::IsShown() */ - wxSizerFlags& ReserveSpaceEvenIfHidden(); + bool IsShown(wxWindow* window) const; /** - Returns the border used by default in Border() method. + Returns @true if the @a sizer is shown. + + @see Hide(), Show(), wxSizerItem::IsShown() */ - static int GetDefaultBorder(); + bool IsShown(wxSizer* sizer) const; /** - Aligns the object to the left, similar for @c Align(wxALIGN_LEFT). + Returns @true if the item at @a index is shown. - Unlike Align(), this method doesn't change the vertical alignment of - the item. + @see Hide(), Show(), wxSizerItem::IsShown() */ - wxSizerFlags& Left(); + bool IsShown(size_t index) const; /** - Sets the proportion of this wxSizerFlags to @e proportion + 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. */ - wxSizerFlags& Proportion(int proportion); + virtual void Layout(); /** - Aligns the object to the right, similar for @c Align(wxALIGN_RIGHT). - - 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(wxWindow* window, const wxSizerFlags& flags); /** - 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(wxWindow* window, int proportion = 0, + int flag = 0, + int border = 0, + wxObject* userData = NULL); /** - Aligns the object to the top, similar for @c Align(wxALIGN_TOP). - - Unlike Align(), this method doesn't change the horizontal 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& Top(); + wxSizerItem* Prepend(wxSizer* sizer, + const wxSizerFlags& flags); /** - Sets the border in the given @a direction having thrice the default - border size. + Same as Add(), but prepends the items to the beginning of the + list of items (windows, subsizers or spaces) owned by this sizer. */ - wxSizerFlags& TripleBorder(int direction = wxALL); -}; + wxSizerItem* Prepend(wxSizer* sizer, int proportion = 0, + int flag = 0, + int border = 0, + wxObject* userData = NULL); + /** + 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(int width, int height, + int proportion = 0, + int flag = 0, + int border = 0, + wxObject* userData = NULL); + /** + Prepends non-stretchable space to the sizer. + More readable way of calling wxSizer::Prepend(size, size, 0). + */ + wxSizerItem* PrependSpacer(int size); -/** - @class wxFlexGridSizer + /** + Prepends stretchable space to the sizer. + More readable way of calling wxSizer::Prepend(0, 0, prop). + */ + wxSizerItem* PrependStretchSpacer(int prop = 1); - 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. + /** + 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. + */ + virtual void RecalcSizes() = 0; - 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. + /** + Removes a child window from the sizer, but does @b not destroy it + (because windows are owned by their parent window, not the sizer). - @library{wxcore} - @category{winlayout} + @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. + + @return @true if the child item was found and removed, @false otherwise. + */ + virtual bool Remove(wxWindow* window); - @see wxSizer, @ref overview_sizer -*/ -class wxFlexGridSizer : public wxGridSizer -{ -public: - //@{ /** - Constructor for a wxFlexGridSizer. + Removes a sizer child from the sizer and destroys it. - @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. + @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. - @a vgap and @a hgap define extra space between all children. + @param sizer The wxSizer to be removed. + + @return @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 Remove(wxSizer* sizer); /** - Specifies that column @a idx (starting from zero) should be grown if - there is extra space available to the sizer. + 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). - 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). + @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. - 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. + @param index + The position of the child in the sizer, e.g. 0 for the first item. + + @return @true if the child item was found and removed, @false otherwise. */ - void AddGrowableCol(size_t idx, int proportion = 0); + virtual bool Remove(int index); /** - Specifies that row idx (starting from zero) should be grown if there - is extra space available to the sizer. + 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). - This is identical to AddGrowableCol() except that it works with rows - and not columns. + 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. + + Returns @true if the child item was found and removed, @false otherwise. */ - void AddGrowableRow(size_t idx, int proportion = 0); + virtual bool Replace(wxWindow* oldwin, wxWindow* newwin, + bool recursive = false); /** - Returns a wxOrientation value that specifies whether the sizer flexibly - resizes its columns, rows, or both (default). + Detaches the given @a oldsz from the sizer and replaces it with the + given @a newsz. The detached child sizer is deleted. - @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). + Use parameter @a recursive to search the given element recursively in subsizers. - @see SetFlexibleDirection() + 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. */ - int GetFlexibleDirection() const; + virtual bool Replace(wxSizer* oldsz, wxSizer* newsz, + bool recursive = false); /** - Returns the value that specifies how the sizer grows in the "non-flexible" - direction if there is one. + Detaches the given item at position @a index from the sizer and + replaces it with the given wxSizerItem @a newitem. - 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. + 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). - @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. + 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 SetFlexibleDirection(), SetNonFlexibleGrowMode() + Returns @true if the child item was found and removed, @false otherwise. */ - wxFlexSizerGrowMode GetNonFlexibleGrowMode() const; + virtual bool Replace(size_t index, wxSizerItem* newitem); /** - Returns @true if column @a idx is growable. - - @since 2.9.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. */ - bool IsColGrowable(size_t idx); + void SetDimension(int x, int y, int width, int height); /** - Returns @true if row @a idx is growable. + @overload + */ + void SetDimension(const wxPoint& pos, const wxSize& size); - @since 2.9.0 + /** + Set an item's minimum size by window, sizer, or position. + + 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(wxWindow* window, int width, int height); /** - Specifies that column idx is no longer growable. + Set an item's minimum size by window, sizer, or position. + + 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() */ - void RemoveGrowableCol(size_t idx); + bool SetItemMinSize(wxSizer* sizer, int width, int height); /** - Specifies that row idx is no longer growable. + Set an item's minimum size by window, sizer, or position. + + 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() */ - void RemoveGrowableRow(size_t idx); + bool SetItemMinSize(size_t index, int width, int height); /** - Specifies whether the sizer should flexibly resize its columns, rows, or both. + Call this to give the sizer a minimal size. - Argument @a direction can be @c wxVERTICAL, @c wxHORIZONTAL or @c wxBOTH - (which is the default value). Any other value is ignored. - See GetFlexibleDirection() for the explanation of these values. - Note that this method does not trigger relayout. + 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 SetFlexibleDirection(int direction); + void SetMinSize(const wxSize& size); /** - Specifies how the sizer should grow in the non-flexible direction if - there is one (so SetFlexibleDirection() must have been called previously). + @overload + */ + void SetMinSize(int width, int height); - 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. - */ - void SetNonFlexibleGrowMode(wxFlexSizerGrowMode mode); -}; + /** + 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 SetSizeHints(wxWindow* window); -/** - @class wxSizer + /** + 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. - 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. + @deprecated @todo provide deprecation description - 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. - - 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. - - 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. - - 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 - - @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
- wxBOTTOM
- wxLEFT
- wxRIGHT
- 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
- wxALIGN_CENTRE
- wxALIGN_LEFT
- wxALIGN_RIGHT
- wxALIGN_TOP
- wxALIGN_BOTTOM
- wxALIGN_CENTER_VERTICAL
- wxALIGN_CENTRE_VERTICAL
- wxALIGN_CENTER_HORIZONTAL
- 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 - - @library{wxcore} - @category{winlayout} - - @see @ref overview_sizer -*/ -class wxSizer : public wxObject -{ -public: - /** - The constructor. - Note that wxSizer is an abstract base class and may not be instantiated. + @see wxScrolled::SetScrollbars() */ - wxSizer(); + void SetVirtualSizeHints(wxWindow* window); /** - The destructor. - */ - virtual ~wxSizer(); + Shows or hides the @a window. + To make a sizer item disappear or reappear, use Show() followed by Layout(). - /** - Appends a child to the sizer. + Use parameter @a recursive to show or hide elements found in subsizers. - 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: + Returns @true if the child item was found, @false otherwise. - @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. + @see Hide(), IsShown() */ - wxSizerItem* Add(wxWindow* window, const wxSizerFlags& flags); + bool Show(wxWindow* window, bool show = true, + bool recursive = false); /** - Appends a child to 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: - - @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. - */ - wxSizerItem* Add(wxWindow* window, - int proportion = 0, - int flag = 0, - int border = 0, - wxObject* userData = NULL); + Shows or hides @a sizer. + To make a sizer item disappear or reappear, use Show() followed by Layout(). - /** - Appends a child to the sizer. + Use parameter @a recursive to show or hide elements found in subsizers. - 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: + Returns @true if the child item was found, @false otherwise. - @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. + @see Hide(), IsShown() */ - wxSizerItem* Add(wxSizer* sizer, const wxSizerFlags& flags); + bool Show(wxSizer* sizer, bool show = true, + bool recursive = false); /** - Appends a child to the sizer. + Shows the item at @a index. + To make a sizer item disappear or reappear, use Show() followed by Layout(). - 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: + Returns @true if the child item was found, @false otherwise. - @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. + @see Hide(), IsShown() */ - wxSizerItem* Add(wxSizer* sizer, - int proportion = 0, - int flag = 0, - int border = 0, - wxObject* userData = NULL); + bool Show(size_t index, bool show = true); +}; - /** - Appends a spacer child to 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. +/** + @class wxStdDialogButtonSizer - @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. + 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. - @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. - */ - wxSizerItem* Add(int width, int height, - int proportion = 0, - int flag = 0, - int border = 0, - wxObject* userData = NULL); + When there aren't interface guidelines defined for a particular platform or + toolkit, wxStdDialogButtonSizer reverts to the Windows implementation. - /** - Adds non-stretchable space to the sizer. - More readable way of calling: - @code - wxSizer::Add(size, size, 0). - @endcode - */ - wxSizerItem* AddSpacer(int size); + 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. - /** - Adds stretchable space to the sizer. - More readable way of calling: - @code - wxSizer::Add(0, 0, prop). - @endcode - */ - wxSizerItem* AddStretchSpacer(int prop = 1); + 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} + @see wxSizer, @ref overview_sizer, wxDialog::CreateButtonSizer +*/ +class wxStdDialogButtonSizer : public wxBoxSizer +{ +public: /** - 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. + Constructor for a wxStdDialogButtonSizer. */ - virtual wxSize CalcMin() = 0; + wxStdDialogButtonSizer(); /** - Detaches all children from the sizer. - If @a delete_windows is @true then child windows will also be deleted. + 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 */ - virtual void Clear(bool delete_windows = false); + void AddButton(wxButton* button); /** - 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() + Rearranges the buttons and applies proper spacing between buttons to make + them match the platform or toolkit's interface guidelines. */ - wxSize ComputeFittingClientSize(wxWindow* window); + void Realize(); /** - 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 + Sets the affirmative button for the sizer. - @see ComputeFittingClientSize(), Fit() + This allows you to use identifiers other than the standard identifiers + outlined above. */ - wxSize ComputeFittingWindowSize(wxWindow* window); + void SetAffirmativeButton(wxButton* button); /** - 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. + Sets the cancel button for the sizer. - @see Remove() + This allows you to use identifiers other than the standard identifiers + outlined above. */ - virtual bool Detach(wxWindow* window); + void SetCancelButton(wxButton* button); /** - 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. + Sets the negative button for the sizer. - @see Remove() + This allows you to use identifiers other than the standard identifiers + outlined above. */ - virtual bool Detach(wxSizer* sizer); - - /** - Detach a item at position @a index from the sizer without destroying it. + void SetNegativeButton(wxButton* button); +}; - 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() - */ - virtual bool Detach(int index); - /** - 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. +/** + @class wxSizerItem - @return The new window size. + The wxSizerItem class is used to track the position, size and other + attributes of each item managed by a wxSizer. - @see ComputeFittingClientSize(), ComputeFittingWindowSize() - */ - wxSize Fit(wxWindow* window); + 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: /** - 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() + Construct a sizer item for tracking a spacer. */ - void FitInside(wxWindow* window); + wxSizerItem(int width, int height, int proportion, int flag, + int border, wxObject* userData); //@{ /** - Returns the list of the items in this sizer. - - The elements of type-safe wxList @c wxSizerItemList are pointers to - objects of type wxSizerItem. + Construct a sizer item for tracking a window. */ - wxSizerItemList& GetChildren(); - const wxSizerItemList& GetChildren() const; + wxSizerItem(wxWindow* window, const wxSizerFlags& flags); + wxSizerItem(wxWindow* window, int proportion, int flag, + int border, + wxObject* userData); //@} + //@{ /** - Returns the window this sizer is used in or @NULL if none. + Construct a sizer item for tracking a subsizer. */ - wxWindow* GetContainingWindow() const; + wxSizerItem(wxSizer* window, const wxSizerFlags& flags); + wxSizerItem(wxSizer* sizer, int proportion, int flag, + int border, + wxObject* userData); + //@} /** - 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. + Deletes the user data and subsizer, if any. */ - size_t GetItemCount() const; + virtual ~wxSizerItem(); /** - Finds wxSizerItem which holds the given @a window. - Use parameter @a recursive to search in subsizers too. - Returns pointer to item or @NULL. + Calculates the minimum desired size for the item, including any space + needed by borders. */ - wxSizerItem* GetItem(wxWindow* window, bool recursive = false); + virtual wxSize CalcMin(); /** - Finds wxSizerItem which holds the given @a sizer. - Use parameter @a recursive to search in subsizers too. - Returns pointer to item or @NULL. + Destroy the window or the windows in a subsizer, depending on the type + of item. */ - - wxSizerItem* GetItem(wxSizer* sizer, bool recursive = false); + virtual void DeleteWindows(); /** - 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. + Enable deleting the SizerItem without destroying the contained sizer. */ - wxSizerItem* GetItem(size_t index); + void DetachSizer(); /** - 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. + Return the border attribute. */ - wxSizerItem* GetItemById(int id, bool recursive = false); + int GetBorder() const; /** - Returns the minimal size of the sizer. + Return the flags attribute. - 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(). + See @ref wxsizer_flags "wxSizer flags list" for details. */ - wxSize GetMinSize(); + int GetFlag() const; /** - Returns the current position of the sizer. + Return the numeric id of wxSizerItem, or @c wxID_NONE if the id has + not been set. */ - wxPoint GetPosition() const; + int GetId() const; /** - Returns the current size of the sizer. + Get the minimum size needed for the item. */ - wxSize GetSize() const; + wxSize GetMinSize() const; /** - Hides the child @a window. + Sets the minimum size to be allocated for this item. - To make a sizer item disappear, use Hide() followed by Layout(). + If this item is a window, the @a size is also passed to + wxWindow::SetMinSize(). + */ + void SetMinSize(const wxSize& size); - Use parameter @a recursive to hide elements found in subsizers. - Returns @true if the child item was found, @false otherwise. + /** + @overload + */ + void SetMinSize(int x, int y); - @see IsShown(), Show() + /** + What is the current position of the item, as set in the last Layout. */ - bool Hide(wxWindow* window, bool recursive = false); + wxPoint GetPosition() const; /** - Hides the child @a sizer. - - 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() + Get the proportion item attribute. */ - bool Hide(wxSizer* sizer, bool recursive = false); + int GetProportion() const; /** - Hides the item at position @a index. - - 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. + Get the ration item attribute. + */ + float GetRatio() const; - @see IsShown(), Show() + /** + Get the rectangle of the item on the parent window, excluding borders. */ - bool Hide(size_t index); + virtual wxRect GetRect(); /** - Insert a child into the sizer before any existing item at @a index. + Get the current size of the item, as set in the last Layout. + */ + virtual wxSize GetSize() const; - See Add() for the meaning of the other parameters. + /** + If this item is tracking a sizer, return it. @NULL otherwise. */ - wxSizerItem* Insert(size_t index, wxWindow* window, - const wxSizerFlags& flags); + wxSizer* GetSizer() const; /** - Insert a child into the sizer before any existing item at @a index. + If this item is tracking a spacer, return its size. + */ + wxSize GetSpacer() const; - See Add() for the meaning of the other parameters. + /** + Get the userData item attribute. */ - wxSizerItem* Insert(size_t index, wxWindow* window, - int proportion = 0, - int flag = 0, - int border = 0, - wxObject* userData = NULL); + wxObject* GetUserData() const; /** - Insert a child into the sizer before any existing item at @a index. - - See Add() for the meaning of the other parameters. + If this item is tracking a window then return it. @NULL otherwise. */ - wxSizerItem* Insert(size_t index, wxSizer* sizer, - const wxSizerFlags& flags); + wxWindow* GetWindow() const; /** - Insert a child into the sizer before any existing item at @a index. + 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. - See Add() for the meaning of the other parameters. + In other words, for sizer items, all of the child elements must be + hidden for the sizer itself to be considered hidden. + + 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()). */ - wxSizerItem* Insert(size_t index, wxSizer* sizer, - int proportion = 0, - int flag = 0, - int border = 0, - wxObject* userData = NULL); + bool IsShown() const; /** - Insert a child into the sizer before any existing item at @a index. - - See Add() for the meaning of the other parameters. + Is this item a sizer? */ - wxSizerItem* Insert(size_t index, int width, int height, - int proportion = 0, - int flag = 0, - int border = 0, - wxObject* userData = NULL); + bool IsSizer() const; /** - Inserts non-stretchable space to the sizer. - More readable way of calling wxSizer::Insert(size, size, 0). + Is this item a spacer? */ - wxSizerItem* InsertSpacer(size_t index, int size); + bool IsSpacer() const; /** - Inserts stretchable space to the sizer. - More readable way of calling wxSizer::Insert(0, 0, prop). + Is this item a window? */ - wxSizerItem* InsertStretchSpacer(size_t index, int prop = 1); + bool IsWindow() const; /** - Return @true if the sizer has no elements. - - @see GetItemCount() - */ - bool IsEmpty() const; + Set the border item attribute. + */ + void SetBorder(int border); /** - Returns @true if the @a window is shown. - - @see Hide(), Show(), wxSizerItem::IsShown() + 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. */ - bool IsShown(wxWindow* window) const; + virtual void SetDimension(const wxPoint& pos, const wxSize& size); /** - Returns @true if the @a sizer is shown. - - @see Hide(), Show(), wxSizerItem::IsShown() + Set the flag item attribute. */ - bool IsShown(wxSizer* sizer) const; + void SetFlag(int flag); /** - Returns @true if the item at @a index is shown. + Sets the numeric id of the wxSizerItem to @e id. + */ + void SetId(int id); - @see Hide(), Show(), wxSizerItem::IsShown() + /** + @todo docme. */ - bool IsShown(size_t index) const; + void SetInitSize(int x, int y); /** - 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. + Set the proportion item attribute. */ - virtual void Layout(); + void SetProportion(int proportion); + //@{ /** - Same as Add(), but prepends the items to the beginning of the - list of items (windows, subsizers or spaces) owned by this sizer. + Set the ratio item attribute. */ - wxSizerItem* Prepend(wxWindow* window, const wxSizerFlags& flags); + void SetRatio(int width, int height); + void SetRatio(wxSize size); + void SetRatio(float ratio); + //@} /** - Same as Add(), but prepends the items to the beginning of the - list of items (windows, subsizers or spaces) owned by this sizer. + Set the sizer tracked by this item. + @deprecated @todo provide deprecation description */ - wxSizerItem* Prepend(wxWindow* window, int proportion = 0, - int flag = 0, - int border = 0, - wxObject* userData = NULL); + void SetSizer(wxSizer* sizer); /** - Same as Add(), but prepends the items to the beginning of the - list of items (windows, subsizers or spaces) owned by this sizer. + Set the size of the spacer tracked by this item. + @deprecated @todo provide deprecation description */ - wxSizerItem* Prepend(wxSizer* sizer, - const wxSizerFlags& flags); + void SetSpacer(const wxSize& size); /** - Same as Add(), but prepends the items to the beginning of the - list of items (windows, subsizers or spaces) owned by this sizer. + Set the window to be tracked by this item. + @deprecated @todo provide deprecation description */ - wxSizerItem* Prepend(wxSizer* sizer, int proportion = 0, - int flag = 0, - int border = 0, - wxObject* userData = NULL); + void SetWindow(wxWindow* window); /** - Same as Add(), but prepends the items to the beginning of the - list of items (windows, subsizers or spaces) owned by this 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. */ - wxSizerItem* Prepend(int width, int height, - int proportion = 0, - int flag = 0, - int border = 0, - wxObject* userData = NULL); + 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 + + @code + sizer->Add(ctrl, 0, wxEXPAND | wxALL, 10); + @endcode + + you can now write + + @code + sizer->Add(ctrl, wxSizerFlags().Expand().Border(wxALL, 10)); + @endcode + + This is more readable and also allows you to create wxSizerFlags objects which + can be reused for several sizer items. + + @code + wxSizerFlags flagsExpand(1); + flagsExpand.Expand().Border(wxALL, 10); + + sizer->Add(ctrl1, flagsExpand); + sizer->Add(ctrl2, flagsExpand); + @endcode + + Note that by specification, all methods of wxSizerFlags return the wxSizerFlags + object itself to allowing chaining multiple methods calls like in the examples + above. + + @library{wxcore} + @category{winlayout} + + @see wxSizer +*/ +class wxSizerFlags +{ +public: /** - Prepends non-stretchable space to the sizer. - More readable way of calling wxSizer::Prepend(size, size, 0). + Creates the wxSizer with the proportion specified by @a proportion. */ - wxSizerItem* PrependSpacer(int size); + wxSizerFlags(int proportion = 0); /** - Prepends stretchable space to the sizer. - More readable way of calling wxSizer::Prepend(0, 0, prop). + Sets the alignment of this wxSizerFlags to @a align. + + This method replaces the previously set alignment with the specified one. + + @param alignment + Combination of @c wxALIGN_XXX bit masks. + + @see Top(), Left(), Right(), Bottom(), Centre() */ - wxSizerItem* PrependStretchSpacer(int prop = 1); + wxSizerFlags& Align(int alignment); /** - 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. + Sets the wxSizerFlags to have a border of a number of pixels specified + by @a borderinpixels with the directions specified by @a direction. */ - virtual void RecalcSizes() = 0; + wxSizerFlags& Border(int direction, int borderinpixels); /** - Removes a child window from the sizer, but does @b not destroy it - (because windows are owned by their parent window, not the sizer). + Sets the wxSizerFlags to have a border with size as returned by + GetDefaultBorder(). - @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. + @param direction + Direction(s) to apply the border in. + */ + wxSizerFlags& Border(int direction = wxALL); - @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 bottom, similar for @c Align(wxALIGN_BOTTOM). - @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. */ - virtual bool Remove(wxWindow* window); + wxSizerFlags& Bottom(); /** - Removes a sizer child from the sizer and destroys it. + Sets the object of the wxSizerFlags to center itself in the area it is + given. + */ + wxSizerFlags& Center(); - @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. + /** + Center() for people with the other dialect of English. + */ + wxSizerFlags& Centre(); - @param sizer The wxSizer to be removed. + /** + Sets the border in the given @a direction having twice the default + border size. + */ + wxSizerFlags& DoubleBorder(int direction = wxALL); - @return @true if the child item was found and removed, @false otherwise. + /** + Sets the border in left and right directions having twice the default + border size. */ - virtual bool Remove(wxSizer* sizer); + wxSizerFlags& DoubleHorzBorder(); /** - 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). + Sets the object of the wxSizerFlags to expand to fill as much area as + it can. + */ + wxSizerFlags& Expand(); - @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 wxFIXED_MINSIZE flag which indicates that the initial size + of the window should be also set as its minimal size. + */ + wxSizerFlags& FixedMinSize(); - @param index - The position of the child in the sizer, e.g. 0 for the first item. + /** + 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. - @return @true if the child item was found and removed, @false otherwise. + @since 2.8.8 */ - virtual bool Remove(int index); + wxSizerFlags& ReserveSpaceEvenIfHidden(); /** - 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). - - Use parameter @a recursive to search the given element recursively in subsizers. + Returns the border used by default in Border() method. + */ + static int GetDefaultBorder(); - 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. + /** + Aligns the object to the left, similar for @c Align(wxALIGN_LEFT). - Returns @true if the child item was found and removed, @false otherwise. + Unlike Align(), this method doesn't change the vertical alignment of + the item. */ - virtual bool Replace(wxWindow* oldwin, wxWindow* newwin, - bool recursive = false); + wxSizerFlags& Left(); /** - Detaches the given @a oldsz from the sizer and replaces it with the - given @a newsz. The detached child sizer is deleted. - - Use parameter @a recursive to search the given element recursively in subsizers. + Sets the proportion of this wxSizerFlags to @e proportion + */ + wxSizerFlags& Proportion(int proportion); - 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. + /** + Aligns the object to the right, similar for @c Align(wxALIGN_RIGHT). - Returns @true if the child item was found and removed, @false otherwise. + Unlike Align(), this method doesn't change the vertical alignment of + the item. */ - virtual bool Replace(wxSizer* oldsz, wxSizer* newsz, - bool recursive = false); + wxSizerFlags& Right(); /** - Detaches the given item at position @a index from the sizer and - replaces it with the given wxSizerItem @a newitem. - - 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). + 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(); - 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. + /** + Aligns the object to the top, similar for @c Align(wxALIGN_TOP). - Returns @true if the child item was found and removed, @false otherwise. + Unlike Align(), this method doesn't change the horizontal alignment of + the item. */ - virtual bool Replace(size_t index, wxSizerItem* newitem); + wxSizerFlags& Top(); /** - 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. + Sets the border in the given @a direction having thrice the default + border size. */ - void SetDimension(int x, int y, int width, int height); + wxSizerFlags& TripleBorder(int direction = wxALL); +}; - /** - @overload - */ - void SetDimension(const wxPoint& pos, const wxSize& size); - /** - Set an item's minimum size by window, sizer, or position. - 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. +/** + @class wxFlexGridSizer - @see wxSizerItem::SetMinSize() - */ - bool SetItemMinSize(wxWindow* window, int width, int height); + 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. + + 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. + @library{wxcore} + @category{winlayout} + + @see wxSizer, @ref overview_sizer +*/ +class wxFlexGridSizer : public wxGridSizer +{ +public: + //@{ /** - Set an item's minimum size by window, sizer, or position. + Constructor for a wxFlexGridSizer. - 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. + @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. - @see wxSizerItem::SetMinSize() + @a vgap and @a hgap define extra space between all children. */ - bool SetItemMinSize(wxSizer* sizer, int width, int height); + wxFlexGridSizer(int rows, int cols, int vgap, int hgap); + wxFlexGridSizer(int cols, int vgap = 0, int hgap = 0); + //@} /** - Set an item's minimum size by window, sizer, or position. + Specifies that column @a idx (starting from zero) should be grown if + there is extra space available to the sizer. - 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 @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). - @see wxSizerItem::SetMinSize() + 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. */ - bool SetItemMinSize(size_t index, int width, int height); + void AddGrowableCol(size_t idx, int proportion = 0); /** - Call this to give the sizer a minimal size. + Specifies that row idx (starting from zero) should be grown if there + is extra space available to the sizer. - 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. + This is identical to AddGrowableCol() except that it works with rows + and not columns. */ - void SetMinSize(const wxSize& size); - - /** - @overload - */ - void SetMinSize(int width, int height); + void AddGrowableRow(size_t idx, int proportion = 0); /** - This method first calls Fit() and then wxTopLevelWindow::SetSizeHints() - on the @a window passed to it. + Returns a wxOrientation value that specifies whether the sizer flexibly + resizes its columns, rows, or both (default). - 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. + @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). - 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. + @see SetFlexibleDirection() */ - void SetSizeHints(wxWindow* window); + int GetFlexibleDirection() const; /** - 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 the value that specifies how the sizer grows in the "non-flexible" + direction if there is one. - @deprecated @todo provide deprecation description + 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 wxScrolled::SetScrollbars() + @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. + + @see SetFlexibleDirection(), SetNonFlexibleGrowMode() */ - void SetVirtualSizeHints(wxWindow* window); + wxFlexSizerGrowMode GetNonFlexibleGrowMode() const; /** - Shows or hides the @a window. - To make a sizer item disappear or reappear, use Show() followed by Layout(). + Returns @true if column @a idx is growable. - Use parameter @a recursive to show or hide elements found in subsizers. + @since 2.9.0 + */ + bool IsColGrowable(size_t idx); - Returns @true if the child item was found, @false otherwise. + /** + Returns @true if row @a idx is growable. - @see Hide(), IsShown() + @since 2.9.0 */ - bool Show(wxWindow* window, bool show = true, - bool recursive = false); + bool IsRowGrowable(size_t idx); /** - Shows or hides @a sizer. - To make a sizer item disappear or reappear, use Show() followed by Layout(). + Specifies that column idx is no longer growable. + */ + void RemoveGrowableCol(size_t idx); - Use parameter @a recursive to show or hide elements found in subsizers. + /** + Specifies that row idx is no longer growable. + */ + void RemoveGrowableRow(size_t idx); - Returns @true if the child item was found, @false otherwise. + /** + Specifies whether the sizer should flexibly resize its columns, rows, or both. - @see Hide(), IsShown() + Argument @a direction can be @c wxVERTICAL, @c wxHORIZONTAL or @c wxBOTH + (which is the default value). Any other value is ignored. + 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