X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/98ccd5452290db2280d7b23698d66584c3e66732..b72ed64277a2b16c6c8681995e5f3f304a8fe38d:/interface/wx/sizer.h?ds=sidebyside
diff --git a/interface/wx/sizer.h b/interface/wx/sizer.h
index 355305d996..ec02ec9e3c 100644
--- a/interface/wx/sizer.h
+++ b/interface/wx/sizer.h
@@ -3,1588 +3,1686 @@
// Purpose: interface of wxStdDialogButtonSizer
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
+
/**
- @class wxStdDialogButtonSizer
+ @class wxSizer
- 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.
+ 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.
- When there aren't interface guidelines defined for a particular platform or
- toolkit, wxStdDialogButtonSizer reverts
- to the Windows implementation.
+ 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.
- To use this class, first add buttons to the sizer by calling AddButton (or
- SetAffirmativeButton, SetNegativeButton,
- or SetCancelButton) and then call Realize in order to create the actual button
- layout used. Other than these special
- operations, this sizer works like any other sizer.
+ 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.
- 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.
+ 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
+
+ @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 behaviour 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 "Sizer Overview",
- 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. This allows you to use identifiers
- other than the standard identifiers outlined above.
- */
- void SetAffirmativeButton(wxButton* button);
+ wxSizer itself is an abstract class, but the parameters are equivalent
+ in the derived classes that you will instantiate to use it so they are
+ described here:
- /**
- Sets the cancel button for the sizer. 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 SetCancelButton(wxButton* button);
+ wxSizerItem* Add(wxWindow* window, const wxSizerFlags& flags);
/**
- Sets the negative button for the sizer. This allows you to use identifiers
- other than the standard identifiers outlined above.
- */
- void SetNegativeButton(wxButton* button);
-};
+ 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 behaviour. 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);
-/**
- @class wxSizerItem
+ /**
+ Appends a child to the sizer.
- 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.
+ 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:
- @library{wxcore}
- @category{winlayout}
-*/
-class wxSizerItem : public wxObject
-{
-public:
- //@{
- /**
- 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(int width, int height, int proportion, int flag,
- int border, wxObject* userData);
- wxSizerItem(wxWindow* window, const wxSizerFlags& flags);
- wxSizerItem(wxWindow* window, int proportion, int flag,
- int border,
- wxObject* userData);
- wxSizerItem(wxSizer* window, const wxSizerFlags& flags);
- wxSizerItem(wxSizer* sizer, int proportion, int flag,
- int border,
- wxObject* userData);
- //@}
+ wxSizerItem* Add(wxSizer* sizer, const wxSizerFlags& flags);
/**
- Deletes the user data and subsizer, if any.
- */
- ~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 behaviour. 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 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 behaviour. 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.
+ This base function adds non-stretchable space to both the horizontal
+ and vertical orientation of the sizer.
+ More readable way of calling:
+ @code
+ wxSizer::Add(size, size, 0).
+ @endcode
+ @see wxBoxSizer::AddSpacer()
*/
- int GetBorder() const;
+ virtual 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()
*/
- wxRect GetRect();
+ wxSize ComputeFittingWindowSize(wxWindow* window);
/**
- Get the current size of the item, as set in the last Layout.
- */
- 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.
+ Returns @true if the child item was found and detached, @false otherwise.
+
+ @see Remove()
*/
- const wxSize GetSpacer() const;
+ virtual bool Detach(wxWindow* window);
/**
- Get the userData item attribute.
- */
- wxObject* GetUserData() const;
+ Detach the child @a sizer from the sizer without destroying it.
+
+ This method does not cause any layout or resizing to take place, call Layout()
+ to update the layout "on screen" after detaching a child from the sizer.
+
+ Returns @true if the child item was found and detached, @false otherwise.
- /**
- If this item is tracking a window then return it. @NULL 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?
- */
- bool IsSizer() const;
+ Tell the sizer to resize the @a window so that its client area matches the
+ sizer's minimal size (ComputeFittingClientSize() is called to determine it).
+ This is commonly done in the constructor of the window itself, see sample
+ in the description of wxBoxSizer.
- /**
- Is this item a spacer?
+ @return The new window size.
+
+ @see ComputeFittingClientSize(), ComputeFittingWindowSize()
*/
- bool IsSpacer() const;
+ wxSize Fit(wxWindow* window);
/**
- Is this item a window?
+ 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 IsWindow() const;
+ void FitInside(wxWindow* window);
+ //@{
/**
- Set the border item attribute.
+ Returns the list of the items in this sizer.
+
+ The elements of type-safe wxList @c wxSizerItemList are pointers to
+ objects of type wxSizerItem.
*/
- void SetBorder(int border);
+ wxSizerItemList& GetChildren();
+ const wxSizerItemList& GetChildren() 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 window this sizer is used in or @NULL if none.
*/
- void SetDimension(const wxPoint& pos, const wxSize& size);
+ wxWindow* GetContainingWindow() const;
/**
- Set the flag item attribute.
+ Returns the number of items in the sizer.
+
+ If you just need to test whether the sizer is empty or not you can also
+ use IsEmpty() function.
*/
- void SetFlag(int flag);
+ size_t GetItemCount() const;
/**
- Sets the numeric id of the wxSizerItem to @e id.
+ Finds wxSizerItem which holds the given @a window.
+ Use parameter @a recursive to search in subsizers too.
+ Returns pointer to item or @NULL.
*/
- void SetId(int id);
+ wxSizerItem* GetItem(wxWindow* window, bool recursive = false);
/**
-
+ Finds wxSizerItem which holds the given @a sizer.
+ Use parameter @a recursive to search in subsizers too.
+ Returns pointer to item or @NULL.
*/
- void SetInitSize(int x, int y);
+
+ wxSizerItem* GetItem(wxSizer* sizer, bool recursive = false);
/**
- Set the proportion item attribute.
+ 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 SetProportion(int proportion);
+ wxSizerItem* GetItem(size_t index);
- //@{
/**
- Set the ratio 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 SetRatio(int width, int height);
- void SetRatio(wxSize size);
- void SetRatio(float ratio);
- //@}
+ wxSizerItem* GetItemById(int id, bool recursive = false);
/**
- Set the sizer tracked by this item.
+ Returns the minimal size of the sizer.
+
+ This is either the combined minimal size of all the children and their
+ borders or the minimal size set by SetMinSize(), depending on which is bigger.
+ Note that the returned value is client size, not window size.
+ In particular, if you use the value to set toplevel window's minimal or
+ actual size, use wxWindow::SetMinClientSize() or wxWindow::SetClientSize(),
+ not wxWindow::SetMinSize() or wxWindow::SetSize().
*/
- void SetSizer(wxSizer* sizer);
+ wxSize GetMinSize();
/**
- Set the size of the spacer tracked by this item.
+ Returns the current position of the sizer.
*/
- void SetSpacer(const wxSize& size);
+ wxPoint GetPosition() const;
/**
- Set the window to be tracked by this item.
+ 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);
-};
+ Hides the child @a window.
+ To make a sizer item disappear, use Hide() followed by Layout().
+ Use parameter @a recursive to hide elements found in subsizers.
+ Returns @true if the child item was found, @false otherwise.
-/**
- @class wxSizerFlags
+ @see IsShown(), Show()
+ */
+ bool Hide(wxWindow* window, bool recursive = false);
- Container for sizer items flags providing readable names for them.
+ /**
+ Hides the child @a sizer.
- 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
+ To make a sizer item disappear, use Hide() followed by Layout().
- @code
- sizer->Add(ctrl, 0, wxEXPAND | wxALL, 10);
- @endcode
+ Use parameter @a recursive to hide elements found in subsizers.
+ Returns @true if the child item was found, @false otherwise.
- you can now write
+ @see IsShown(), Show()
+ */
+ bool Hide(wxSizer* sizer, bool recursive = false);
- @code
- sizer->Add(ctrl, wxSizerFlags().Expand().Border(wxALL, 10));
- @endcode
+ /**
+ Hides the item at position @a index.
- This is more readable and also allows you to create wxSizerFlags objects which
- can be reused for several sizer items.
+ To make a sizer item disappear, use Hide() followed by Layout().
- @code
- wxSizerFlags flagsExpand(1);
- flagsExpand.Expand().Border(wxALL, 10);
+ Use parameter @a recursive to hide elements found in subsizers.
+ Returns @true if the child item was found, @false otherwise.
- sizer->Add(ctrl1, flagsExpand);
- sizer->Add(ctrl2, flagsExpand);
- @endcode
+ @see IsShown(), Show()
+ */
+ bool Hide(size_t index);
- Note that by specification, all methods of wxSizerFlags return the wxSizerFlags
- object itself to allowing chaining multiple methods calls like in the examples
- above.
+ /**
+ Insert a child into the sizer before any existing item at @a index.
- @library{wxcore}
- @category{winlayout}
+ See Add() for the meaning of the other parameters.
+ */
+ wxSizerItem* Insert(size_t index, wxWindow* window,
+ const wxSizerFlags& flags);
- @see wxSizer
-*/
-class wxSizerFlags
-{
-public:
/**
- Creates the wxSizer with the proportion specified by @e proportion.
+ Insert a child into the sizer before any existing item at @a index.
+
+ See Add() for the meaning of the other parameters.
*/
- wxSizerFlags(int proportion = 0);
+ wxSizerItem* Insert(size_t index, wxWindow* window,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
/**
- Sets the alignment of this wxSizerFlags to @e align.
+ Insert a child into the sizer before any existing item at @a index.
- This method replaces the previously set alignment with the specified
- one.
+ See Add() for the meaning of the other parameters.
+ */
+ wxSizerItem* Insert(size_t index, wxSizer* sizer,
+ const wxSizerFlags& flags);
- @see Top(), Left(), Right(), Bottom(), Centre()
+ /**
+ Insert a child into the sizer before any existing item at @a index.
- @param align Combination of @c wxALIGN_XXX bit masks.
+ See Add() for the meaning of the other parameters.
*/
- wxSizerFlags& Align(int align = 0);
+ wxSizerItem* Insert(size_t index, wxSizer* sizer,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
/**
- Sets the wxSizerFlags to have a border of a number of pixels specified
- by @a borderinpixels with the directions specified by @e direction.
+ Insert a child into the sizer before any existing item at @a index.
+
+ See Add() for the meaning of the other parameters.
*/
- wxSizerFlags& Border(int direction, int borderinpixels);
+ wxSizerItem* Insert(size_t index, int width, int height,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
/**
- Sets the wxSizerFlags to have a border with size as returned by
- GetDefaultBorder().
+ Inserts non-stretchable space to the sizer.
+ More readable way of calling wxSizer::Insert(index, size, size).
+ */
+ wxSizerItem* InsertSpacer(size_t index, int size);
- @param direction Direction(s) to apply the border in.
+ /**
+ Inserts stretchable space to the sizer.
+ More readable way of calling wxSizer::Insert(0, 0, prop).
*/
- wxSizerFlags& Border(int direction = wxALL);
+ wxSizerItem* InsertStretchSpacer(size_t index, int prop = 1);
/**
- Aligns the object to the bottom, similar for @c Align(wxALIGN_BOTTOM).
+ Return @true if the sizer has no elements.
- Unlike Align(), this method doesn't change the horizontal alignment of
- the item.
- */
- wxSizerFlags& Bottom();
+ @see GetItemCount()
+ */
+ bool IsEmpty() const;
/**
- Sets the object of the wxSizerFlags to center itself in the area it is
- given.
+ Returns @true if the @a window is shown.
+
+ @see Hide(), Show(), wxSizerItem::IsShown()
*/
- wxSizerFlags& Center();
+ bool IsShown(wxWindow* window) const;
/**
- Center() for people with the other dialect of English.
+ Returns @true if the @a sizer is shown.
+
+ @see Hide(), Show(), wxSizerItem::IsShown()
*/
- wxSizerFlags& Centre();
+ bool IsShown(wxSizer* sizer) const;
/**
- Sets the border in the given @a direction having twice the default
- border size.
+ Returns @true if the item at @a index is shown.
+
+ @see Hide(), Show(), wxSizerItem::IsShown()
*/
- wxSizerFlags& DoubleBorder(int direction = wxALL);
+ bool IsShown(size_t index) const;
/**
- Sets the border in left and right directions having twice the default
- border size.
+ 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& DoubleHorzBorder();
+ virtual void Layout();
/**
- Sets the object of the wxSizerFlags to expand to fill as much area as
- it can.
+ Same as Add(), but prepends the items to the beginning of the
+ list of items (windows, subsizers or spaces) owned by this sizer.
*/
- wxSizerFlags& Expand();
+ wxSizerItem* Prepend(wxWindow* window, const wxSizerFlags& flags);
/**
- Set the @c wxFIXED_MINSIZE flag which indicates that the initial size
- of the window should be also set as its minimal 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& FixedMinSize();
+ wxSizerItem* Prepend(wxWindow* window, int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
/**
- Set the @c wxRESERVE_SPACE_EVEN_IF_HIDDEN flag. Normally wxSizers
- don't allocate space for hidden windows or other items. This flag
- overrides this behavior so that sufficient space is allocated for the
- window even if it isn't visible. This makes it possible to dynamically
- show and hide controls without resizing parent dialog, for example.
-
- @since 2.8.8
+ Same as Add(), but prepends the items to the beginning of the
+ list of items (windows, subsizers or spaces) owned by this sizer.
*/
- wxSizerFlags& ReserveSpaceEvenIfHidden();
+ wxSizerItem* Prepend(wxSizer* sizer,
+ const wxSizerFlags& flags);
/**
- Returns the border used by default in Border() method.
+ Same as Add(), but prepends the items to the beginning of the
+ list of items (windows, subsizers or spaces) owned by this sizer.
*/
- static int GetDefaultBorder();
+ wxSizerItem* Prepend(wxSizer* sizer, int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
/**
- Aligns the object to the left, similar for @c Align(wxALIGN_LEFT).
-
- Unlike Align(), this method doesn't change the vertical alignment of
- the item.
+ Same as Add(), but prepends the items to the beginning of the
+ list of items (windows, subsizers or spaces) owned by this sizer.
*/
- wxSizerFlags& Left();
+ wxSizerItem* Prepend(int width, int height,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
/**
- Sets the proportion of this wxSizerFlags to @e proportion
+ Prepends non-stretchable space to the sizer.
+ More readable way of calling wxSizer::Prepend(size, size, 0).
*/
- wxSizerFlags& Proportion(int proportion = 0);
+ wxSizerItem* PrependSpacer(int size);
/**
- 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.
+ Prepends stretchable space to the sizer.
+ More readable way of calling wxSizer::Prepend(0, 0, prop).
*/
- wxSizerFlags& Right();
+ wxSizerItem* PrependStretchSpacer(int prop = 1);
/**
- 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.
+ This method is abstract and has to be overwritten by any derived class.
+ Here, the sizer will do the actual calculation of its children's
+ positions and sizes.
*/
- wxSizerFlags& Shaped();
+ virtual void RecalcSizes() = 0;
/**
- Aligns the object to the top, similar for @c Align(wxALIGN_TOP).
+ Removes a child window from the sizer, but does @b not destroy it
+ (because windows are owned by their parent window, not the sizer).
- Unlike Align(), this method doesn't change the horizontal alignment of
- the item.
+ @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.
*/
- wxSizerFlags& Top();
+ virtual bool Remove(wxWindow* window);
/**
- Sets the border in the given @a direction having thrice the default
- border size.
- */
- wxSizerFlags& TripleBorder(int direction = wxALL);
-};
+ Removes a sizer child from the sizer and destroys it.
+ @note This method does not cause any layout or resizing to take
+ place, call Layout() to update the layout "on screen" after
+ removing a child from the sizer.
+ @param sizer The wxSizer to be removed.
-/**
- @class wxNotebookSizer
+ @return @true if the child item was found and removed, @false otherwise.
+ */
+ virtual bool Remove(wxSizer* sizer);
- @deprecated
- This class is deprecated and should not be used in new code! It is no
- longer needed, wxNotebook control can be inserted
- into any sizer class and its minimal size will be determined correctly.
+ /**
+ Removes a 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).
- wxNotebookSizer is a specialized sizer to make sizers work in connection
- with using notebooks. This sizer is different from any other sizer as you
- must not add any children to it - instead, it queries the notebook class
- itself. The only thing this sizer does is to determine the size of the
- biggest page of the notebook and report an adjusted minimal size to a more
- toplevel sizer.
+ @note This method does not cause any layout or resizing to take
+ place, call Layout() to update the layout "on screen" after
+ removing a child from the sizer.
- @library{wxbase}
- @category{winlayout}
+ @param index
+ The position of the child in the sizer, e.g. 0 for the first item.
- @see wxSizer, wxNotebook,
- @ref overview_sizer "Sizers overview"
-*/
-class wxNotebookSizer : public wxSizer
-{
-public:
- /**
- Constructor. It takes an associated notebook as its only parameter.
+ @return @true if the child item was found and removed, @false otherwise.
*/
- wxNotebookSizer(wxNotebook* notebook);
+ virtual bool Remove(int index);
/**
- Returns the notebook associated with the sizer.
- */
- wxNotebook* GetNotebook();
-};
+ 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.
+ 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.
-/**
- @class wxFlexGridSizer
+ Returns @true if the child item was found and removed, @false otherwise.
+ */
+ virtual bool Replace(wxWindow* oldwin, wxWindow* newwin,
+ bool recursive = false);
- A flex grid sizer is a sizer which lays out its children in a two-dimensional
- table with all table fields in one row having the same
- height and all fields in one column having the same width, but all
- rows or all columns are not necessarily the same height or width as in
- the wxGridSizer.
+ /**
+ Detaches the given @a oldsz from the sizer and replaces it with the
+ given @a newsz. The detached child sizer is deleted.
- Since wxWidgets 2.5.0, wxFlexGridSizer can also size items equally in one
- direction but unequally ("flexibly") in the other. If the sizer is only
- flexible in one direction (this can be changed using
- wxFlexGridSizer::SetFlexibleDirection),
- it needs to be decided how the sizer should grow in the other ("non-flexible")
- direction in order to fill the available space. The
- wxFlexGridSizer::SetNonFlexibleGrowMode method
- serves this purpose.
+ Use parameter @a recursive to search the given element recursively in subsizers.
- @library{wxcore}
- @category{winlayout}
+ This method does not cause any layout or resizing to take place,
+ call Layout() to update the layout "on screen" after replacing a
+ child from the sizer.
- @see wxSizer, @ref overview_sizer "Sizer Overview"
-*/
-class wxFlexGridSizer : public wxGridSizer
-{
-public:
- //@{
- /**
- Constructor for a wxGridSizer. @a rows and @a cols determine the number of
- columns and rows in the sizer - if either of the parameters is zero, it will be
- calculated to form the total number of children in the sizer, thus making the
- sizer grow dynamically. @a vgap and @a hgap define extra space between
- all children.
+ Returns @true if the child item was found and removed, @false otherwise.
*/
- wxFlexGridSizer(int rows, int cols, int vgap, int hgap);
- wxFlexGridSizer(int cols, int vgap = 0, int hgap = 0);
- //@}
+ virtual bool Replace(wxSizer* oldsz, wxSizer* newsz,
+ bool recursive = false);
/**
- Specifies that column @a idx (starting from zero) should be grown if
- there is extra space available to the sizer.
+ Detaches the given item at position @a index from the sizer and
+ replaces it with the given wxSizerItem @a newitem.
- 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).
+ 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).
- Notice that the row must not be already growable, if you need to change
- the proportion you must call RemoveGrowableCol() first and then make it
- growable (with a different proportion) again. You can use IsColGrowable()
- to check whether a column is already growable.
+ This method does not cause any layout or resizing to take place,
+ call Layout() to update the layout "on screen" after replacing a
+ child from the sizer.
+
+ Returns @true if the child item was found and removed, @false otherwise.
*/
- void AddGrowableCol(size_t idx, int proportion = 0);
+ virtual bool Replace(size_t index, wxSizerItem* newitem);
/**
- Specifies that row idx (starting from zero) should be grown if there
- is extra space available to the sizer.
-
- This is identical to AddGrowableCol() except that it works with rows
- and not columns.
+ Call this to force the sizer to take the given dimension and thus force
+ the items owned by the sizer to resize themselves according to the
+ rules defined by the parameter in the Add() and Prepend() methods.
*/
- void AddGrowableRow(size_t idx, int proportion = 0);
+ void SetDimension(int x, int y, int width, int height);
/**
- Returns a wxOrientation value that specifies whether the sizer flexibly
- resizes its columns, rows, or both (default).
+ @overload
+ */
+ void SetDimension(const wxPoint& pos, const wxSize& size);
- @return One of the following values:
+ /**
+ Set an item's minimum size by window, sizer, or position.
- @see SetFlexibleDirection()
- */
- int GetFlexibleDirection() const;
+ This function enables an application to set the size of an item after
+ initial creation.
- /**
- Returns the value that specifies how the sizer grows in the "non-flexible"
- direction if there is one.
+ The @a window or @a sizer will be found recursively in the sizer's
+ descendants.
- @return One of the following values:
+ @see wxSizerItem::SetMinSize()
- @see SetFlexibleDirection(),
- SetNonFlexibleGrowMode()
+ @return
+ @true if the minimal size was successfully set or @false if the
+ item was not found.
*/
- int GetNonFlexibleGrowMode() const;
+ //@{
+ bool SetItemMinSize(wxWindow* window, int width, int height);
+ bool SetItemMinSize(wxWindow* window, const wxSize& size);
- /**
- Returns @true if column @a idx is growable.
+ bool SetItemMinSize(wxSizer* sizer, int width, int height);
+ bool SetItemMinSize(wxSizer* sizer, const wxSize& size);
- @since 2.9.0
- */
- bool IsColGrowable(size_t idx);
+ bool SetItemMinSize(size_t index, int width, int height);
+ bool SetItemMinSize(size_t index, const wxSize& size);
+ //@}
/**
- Returns @true if row @a idx is growable.
+ Call this to give the sizer a minimal size.
- @since 2.9.0
+ 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.
*/
- bool IsRowGrowable(size_t idx);
+ void SetMinSize(const wxSize& size);
/**
- Specifies that column idx is no longer growable.
- */
- void RemoveGrowableCol(size_t idx);
+ @overload
+ */
+ void SetMinSize(int width, int height);
/**
- Specifies that row idx is no longer growable.
+ 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 RemoveGrowableRow(size_t idx);
+ void SetSizeHints(wxWindow* window);
/**
- Specifies whether the sizer should flexibly resize its columns, rows, or
- both. Argument @c direction can be @c wxVERTICAL, @c wxHORIZONTAL
- or @c wxBOTH (which is the default value). Any other value is ignored. See
- @ref GetFlexibleDirection() GetFlexibleDirection for the
- explanation of these values.
- Note that this method does not trigger relayout.
+ Tell the sizer to set the minimal size of the @a window virtual area to match
+ the sizer's minimal size. For windows with managed scrollbars this will set them
+ appropriately.
+
+ @deprecated This is exactly the same as FitInside() in wxWidgets 2.9
+ and later, please replace calls to it with FitInside().
+
+ @see wxScrolled::SetScrollbars()
*/
- void SetFlexibleDirection(int direction);
+ void SetVirtualSizeHints(wxWindow* window);
/**
- Specifies how the sizer should grow in the non-flexible direction if
- there is one (so
- SetFlexibleDirection() must have
- been called previously). Argument @a mode can be one of those documented in
- GetNonFlexibleGrowMode(), please
- see there for their explanation.
- Note that this method does not trigger relayout.
- */
- void SetNonFlexibleGrowMode(wxFlexSizerGrowMode mode);
-};
+ Shows or hides the @a window.
+ To make a sizer item disappear or reappear, use Show() followed by Layout().
+ Use parameter @a recursive to show or hide elements found in subsizers.
+ Returns @true if the child item was found, @false otherwise.
-/**
- @class wxSizer
+ @see Hide(), IsShown()
+ */
+ bool Show(wxWindow* window, bool show = true,
+ bool recursive = false);
- 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.
+ /**
+ Shows or hides @a sizer.
+ To make a sizer item disappear or reappear, use Show() followed by Layout().
- 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.
+ Use parameter @a recursive to show or hide elements found in subsizers.
- 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.
+ Returns @true if the child item was found, @false otherwise.
- Sizers may also be used to control the layout of custom drawn items on the
- window. The Add(), Insert(), and Prepend() functions return a pointer to
- the newly added wxSizerItem. Just add empty space of the desired size and
- attributes, and then use the wxSizerItem::GetRect() method to determine
- where the drawing operations should take place.
+ @see Hide(), IsShown()
+ */
+ bool Show(wxSizer* sizer, bool show = true,
+ bool recursive = false);
- 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.
+ /**
+ Shows the item at @a index.
+ To make a sizer item disappear or reappear, use Show() followed by Layout().
- @b wxPython note: If you wish to create a sizer class in wxPython you should
- derive the class from @c wxPySizer in order to get Python-aware
- capabilities for the various virtual methods.
+ Returns @true if the child item was found, @false otherwise.
- @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
+ @see Hide(), IsShown()
+ */
+ bool Show(size_t index, bool show = true);
+};
+
+
+/**
+ @class wxStdDialogButtonSizer
+ This class creates button layouts which conform to the standard button spacing
+ and ordering defined by the platform or toolkit's user interface guidelines
+ (if such things exist). By using this class, you can ensure that all your
+ standard dialogs look correct on all major platforms. Currently it conforms to
+ the Windows, GTK+ and Mac OS X human interface guidelines.
+
+ When there aren't interface guidelines defined for a particular platform or
+ toolkit, wxStdDialogButtonSizer reverts to the Windows implementation.
+
+ To use this class, first add buttons to the sizer by calling
+ wxStdDialogButtonSizer::AddButton (or wxStdDialogButtonSizer::SetAffirmativeButton,
+ wxStdDialogButtonSizer::SetNegativeButton or wxStdDialogButtonSizer::SetCancelButton)
+ and then call Realize in order to create the actual button layout used.
+ Other than these special operations, this sizer works like any other sizer.
+
+ If you add a button with wxID_SAVE, on Mac OS X the button will be renamed to
+ "Save" and the wxID_NO button will be renamed to "Don't Save" in accordance
+ with the Mac OS X Human Interface Guidelines.
@library{wxcore}
@category{winlayout}
- @see @ref overview_sizer "Sizer Overview"
+ @see wxSizer, @ref overview_sizer, wxDialog::CreateButtonSizer
*/
-class wxSizer : public wxObject
+class wxStdDialogButtonSizer : public wxBoxSizer
{
public:
/**
- The constructor. Note that wxSizer is an abstract base class and may not
- be instantiated.
+ Constructor for a wxStdDialogButtonSizer.
*/
- wxSizer();
+ wxStdDialogButtonSizer();
/**
- The destructor.
+ Adds a button to the wxStdDialogButtonSizer. The @a button must have
+ one of the following identifiers:
+ - wxID_OK
+ - wxID_YES
+ - wxID_SAVE
+ - wxID_APPLY
+ - wxID_CLOSE
+ - wxID_NO
+ - wxID_CANCEL
+ - wxID_HELP
+ - wxID_CONTEXT_HELP
*/
- ~wxSizer();
+ void AddButton(wxButton* button);
/**
- Appends a child to the sizer.
-
- 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 flags
- A wxSizerFlags object that enables you to specify most of the above
- parameters more conveniently.
+ Rearranges the buttons and applies proper spacing between buttons to make
+ them match the platform or toolkit's interface guidelines.
*/
- wxSizerItem* Add(wxWindow* window, const wxSizerFlags& flags);
+ void Realize();
/**
- 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:
+ Sets the affirmative button for the sizer.
- @param window
- The window to be added to the sizer. Its initial size (either set
- explicitly by the user or calculated internally when using
- wxDefaultSize) is interpreted as the minimal and in many cases also
- the initial size.
- @param 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.
+ This allows you to use identifiers other than the standard identifiers
+ outlined above.
*/
- wxSizerItem* Add(wxWindow* window, int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = NULL);
+ void SetAffirmativeButton(wxButton* button);
/**
- 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:
+ Sets the cancel button for the sizer.
- @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.
+ This allows you to use identifiers other than the standard identifiers
+ outlined above.
*/
- wxSizerItem* Add(wxSizer* sizer, const wxSizerFlags& flags);
+ void SetCancelButton(wxButton* button);
/**
- 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:
+ Sets the negative button for the sizer.
- @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.
+ This allows you to use identifiers other than the standard identifiers
+ outlined above.
*/
- wxSizerItem* Add(wxSizer* sizer, int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = NULL);
+ void SetNegativeButton(wxButton* button);
+};
- /**
- 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.
+/**
+ @class wxSizerItem
- @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);
+ The wxSizerItem class is used to track the position, size and other
+ attributes of each item managed by a wxSizer.
+ It is not usually necessary to use this class because the sizer elements can
+ also be identified by their positions or window or sizer pointers but sometimes
+ it may be more convenient to use it directly.
+
+ @library{wxcore}
+ @category{winlayout}
+*/
+class wxSizerItem : public wxObject
+{
+public:
/**
- Adds non-stretchable space to the sizer. More readable way of calling
- wxSizer::Add(size, size, 0).
+ Construct a sizer item for tracking a spacer.
*/
- wxSizerItem* AddSpacer(int size);
+ wxSizerItem(int width, int height, int proportion, int flag,
+ int border, wxObject* userData);
+ //@{
/**
- Adds stretchable space to the sizer. More readable way of calling
- wxSizer::Add(0, 0, prop).
+ Construct a sizer item for tracking a window.
*/
- wxSizerItem* AddStretchSpacer(int prop = 1);
+ wxSizerItem(wxWindow* window, const wxSizerFlags& flags);
+ wxSizerItem(wxWindow* window, int proportion, int flag,
+ int border,
+ wxObject* userData);
+ //@}
+ //@{
/**
- 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.
+ Construct a sizer item for tracking a subsizer.
*/
- virtual wxSize CalcMin();
+ wxSizerItem(wxSizer* window, const wxSizerFlags& flags);
+ wxSizerItem(wxSizer* sizer, int proportion, int flag,
+ int border,
+ wxObject* userData);
+ //@}
/**
- Detaches all children from the sizer. If @a delete_windows is @true then
- child windows will also be deleted.
+ Deletes the user data and subsizer, if any.
*/
- void Clear(bool delete_windows = false);
+ virtual ~wxSizerItem();
/**
- 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
+ Set the window to be tracked by this item.
- @see ComputeFittingWindowSize(), Fit()
+ The old window isn't deleted as it is now owned by the sizer item.
*/
- wxSize ComputeFittingClientSize(wxWindow* window);
+ void AssignWindow(wxWindow *window);
/**
- 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
+ Set the sizer tracked by this item.
- @see ComputeFittingClientSize(), Fit()
+ Old sizer, if any, is deleted.
*/
- wxSize ComputeFittingWindowSize(wxWindow* window);
+ void AssignSizer(wxSizer *sizer);
+ //@{
/**
- Detach the child @a window from the sizer without destroying it.
-
- This method does not cause any layout or resizing to take place, call Layout()
- to update the layout "on screen" after detaching a child from the sizer.
-
- Returns @true if the child item was found and detached, @false otherwise.
+ Set the size of the spacer tracked by this item.
- @see Remove()
+ Old spacer, if any, is deleted.
*/
- bool Detach(wxWindow* window);
+ void AssignSpacer(const wxSize& size);
+ void AssignSpacer(int w, int h) { AssignSpacer(wxSize(w, h)); }
+ //@}
/**
- Detach the child @a sizer from the sizer without destroying it.
+ Calculates the minimum desired size for the item, including any space
+ needed by borders.
+ */
+ virtual wxSize CalcMin();
- 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.
+ /**
+ Destroy the window or the windows in a subsizer, depending on the type
+ of item.
+ */
+ virtual void DeleteWindows();
- Returns @true if the child item was found and detached, @false otherwise.
+ /**
+ Enable deleting the SizerItem without destroying the contained sizer.
+ */
+ void DetachSizer();
- @see Remove()
+ /**
+ Return the border attribute.
*/
- bool Detach(wxSizer* sizer);
+ int GetBorder() const;
/**
- Detach a item at position @a index from the sizer without destroying it.
+ Return the flags attribute.
- 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 @ref wxsizer_flags "wxSizer flags list" for details.
+ */
+ int GetFlag() const;
- @see Remove()
+ /**
+ Return the numeric id of wxSizerItem, or @c wxID_NONE if the id has
+ not been set.
*/
- bool Detach(size_t index);
+ int GetId() const;
/**
- Tell the sizer to resize the @a window so that its client area matches the
- sizer's minimal size
- (ComputeFittingClientSize() is called
- to determine it).
- This is commonly done in the constructor of the window
- itself, see sample in the description
- of wxBoxSizer. Returns the new window size.
-
- @see ComputeFittingClientSize(), ComputeFittingWindowSize()
+ Get the minimum size needed for the item.
*/
- wxSize Fit(wxWindow* window);
+ wxSize GetMinSize() const;
/**
- Tell the sizer to resize the virtual size of the @a window to match the sizer's
- minimal size. This will not alter the on screen size of the window, but may
- cause the addition/removal/alteration of scrollbars required to view the virtual
- area in windows which manage it.
+ Sets the minimum size to be allocated for this item.
- @see wxScrolled::SetScrollbars(), SetVirtualSizeHints()
- */
- void FitInside(wxWindow* window);
+ If this item is a window, the @a size is also passed to
+ wxWindow::SetMinSize().
+ */
+ void SetMinSize(const wxSize& size);
/**
- Returns the list of the items in this sizer. The elements of type-safe
- wxList @a wxSizerItemList are pointers to objects of type
- @ref wxSizerItem "wxSizerItem".
- */
- wxSizerItemList& GetChildren();
+ @overload
+ */
+ void SetMinSize(int x, int y);
/**
- Returns the list of the items in this sizer. The elements of type-safe
- wxList @a wxSizerItemList are pointers to objects of type
- @ref wxSizerItem "wxSizerItem".
+ What is the current position of the item, as set in the last Layout.
*/
- const wxSizerItemList& GetChildren() const;
+ wxPoint GetPosition() const;
/**
- Returns the window this sizer is used in or @NULL if none.
+ Get the proportion item attribute.
*/
- wxWindow* GetContainingWindow() const;
+ int GetProportion() const;
/**
- Finds wxSizerItem which holds the given @a window
- Use parameter @a recursive to search in subsizers too.
- Returns pointer to item or @NULL.
+ Get the ration item attribute.
*/
- wxSizerItem* GetItem(wxWindow* window, bool recursive = false);
+ float GetRatio() const;
/**
- Finds wxSizerItem which holds the given @a sizer
- Use parameter @a recursive to search in subsizers too.
- Returns pointer to item or @NULL.
+ Get the rectangle of the item on the parent window, excluding borders.
*/
+ virtual wxRect GetRect();
- wxSizerItem* GetItem(wxSizer* sizer, bool recursive = false);
/**
- Finds wxSizerItem which is located in the sizer at position
- @a index.
- Use parameter @a recursive to search in subsizers too.
- Returns pointer to item or @NULL.
+ Get the current size of the item, as set in the last Layout.
*/
- wxSizerItem* GetItem(size_t index);
+ virtual wxSize GetSize() const;
/**
- 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.
+ If this item is tracking a sizer, return it. @NULL otherwise.
*/
- wxSizerItem* GetItemById(int id, bool recursive = false);
+ wxSizer* GetSizer() const;
/**
- Returns the minimal size of the sizer. This is either the combined minimal
- size of all the children and their borders or the minimal size set by
- SetMinSize(), depending on which is bigger.
- Note that the returned value is client size, not window size.
- In particular, if you use the value to set toplevel window's minimal or
- actual size, use wxWindow::SetMinClientSize
- or wxWindow::SetClientSize, not
- wxWindow::SetMinSize
- or wxWindow::SetSize.
+ If this item is tracking a spacer, return its size.
*/
- wxSize GetMinSize();
+ wxSize GetSpacer() const;
/**
- Returns the current position of the sizer.
+ Get the userData item attribute.
*/
- wxPoint GetPosition();
+ wxObject* GetUserData() const;
/**
- Returns the current size of the sizer.
+ If this item is tracking a window then return it. @NULL otherwise.
*/
- wxSize GetSize();
+ wxWindow* GetWindow() const;
/**
- Hides the child @a window.
-
- To make a sizer item disappear, use Hide() followed by Layout().
+ 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.
- Use parameter @a recursive to hide elements found in subsizers.
- Returns @true if the child item was found, @false otherwise.
+ In other words, for sizer items, all of the child elements must be
+ hidden for the sizer itself to be considered hidden.
- @see IsShown(), Show()
+ As an exception, if the @c wxRESERVE_SPACE_EVEN_IF_HIDDEN flag was
+ used for this sizer item, then IsShown() always returns @true for it
+ (see wxSizerFlags::ReserveSpaceEvenIfHidden()).
*/
- bool Hide(wxWindow* window, bool recursive = false);
+ bool IsShown() 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()
+ Is this item a sizer?
*/
- bool Hide(wxSizer* sizer, bool recursive = false);
+ bool IsSizer() const;
/**
- Hides the item at position @a index.
-
- To make a sizer item disappear, use Hide() followed by Layout().
+ Is this item a spacer?
+ */
+ bool IsSpacer() const;
- Use parameter @a recursive to hide elements found in subsizers.
- Returns @true if the child item was found, @false otherwise.
+ /**
+ Is this item a window?
+ */
+ bool IsWindow() const;
- @see IsShown(), Show()
+ /**
+ Set the border item attribute.
*/
- bool Hide(size_t index);
+ void SetBorder(int border);
/**
- Insert a child into the sizer before any existing item at @a index.
+ 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.
+ */
+ virtual void SetDimension(const wxPoint& pos, const wxSize& size);
- See Add() for the meaning of the other parameters.
+ /**
+ Set the flag item attribute.
*/
- wxSizerItem* Insert(size_t index, wxWindow* window,
- const wxSizerFlags& flags);
+ void SetFlag(int flag);
/**
- Insert a child into the sizer before any existing item at @a index.
+ Sets the numeric id of the wxSizerItem to @e id.
+ */
+ void SetId(int id);
- See Add() for the meaning of the other parameters.
+ /**
+ @todo docme.
*/
- wxSizerItem* Insert(size_t index, wxWindow* window,
- int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = NULL);
+ void SetInitSize(int x, int y);
/**
- Insert a child into the sizer before any existing item at @a index.
+ Set the proportion item attribute.
+ */
+ void SetProportion(int proportion);
- See Add() for the meaning of the other parameters.
+ //@{
+ /**
+ Set the ratio item attribute.
*/
- wxSizerItem* Insert(size_t index, wxSizer* sizer,
- const wxSizerFlags& flags);
+ void SetRatio(int width, int height);
+ void SetRatio(wxSize size);
+ void SetRatio(float ratio);
+ //@}
/**
- Insert a child into the sizer before any existing item at @a index.
+ Set the sizer tracked by this item.
- See Add() for the meaning of the other parameters.
+ @deprecated This function does not free the old sizer which may result
+ in memory leaks, use AssignSizer() which does free it instead.
*/
- wxSizerItem* Insert(size_t index, wxSizer* sizer,
- int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = NULL);
+ void SetSizer(wxSizer* sizer);
/**
- Insert a child into the sizer before any existing item at @a index.
+ Set the size of the spacer tracked by this item.
- See Add() for the meaning of the other parameters.
+ @deprecated This function does not free the old spacer which may result
+ in memory leaks, use AssignSpacer() which does free it instead.
*/
- wxSizerItem* Insert(size_t index, int width, int height,
- int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = NULL);
+ void SetSpacer(const wxSize& size);
/**
- Inserts non-stretchable space to the sizer. More readable way of calling
- wxSizer::Insert(size, size, 0).
+ Set the window to be tracked by this item.
+ @deprecated @todo provide deprecation description
*/
- wxSizerItem* InsertSpacer(size_t index, int size);
+ void SetWindow(wxWindow* window);
/**
- Inserts stretchable space to the sizer. More readable way of calling
- wxSizer::Insert(0, 0, prop).
+ 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* InsertStretchSpacer(size_t index, int prop = 1);
+ void Show(bool show);
+};
- /**
- Returns @true if the @e window is shown.
- @see Hide(), Show(), wxSizerItem::IsShown()
- */
- bool IsShown(wxWindow* window) const;
- /**
- Returns @true if the @e sizer is shown.
+/**
+ @class wxSizerFlags
- @see Hide(), Show(), wxSizerItem::IsShown()
+ 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:
+ /**
+ Creates the wxSizer with the proportion specified by @a proportion.
*/
- bool IsShown(wxSizer* sizer) const;
+ wxSizerFlags(int proportion = 0);
/**
- Returns @true if the item at @a index is shown.
+ Sets the alignment of this wxSizerFlags to @a align.
- @see Hide(), Show(), wxSizerItem::IsShown()
+ 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()
*/
- bool IsShown(size_t index) const;
+ wxSizerFlags& Align(int alignment);
/**
- 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.
+ Sets the wxSizerFlags to have a border of a number of pixels specified
+ by @a borderinpixels with the directions specified by @a direction.
*/
- void Layout();
+ wxSizerFlags& Border(int direction, int borderinpixels);
/**
- Same as Add(), but prepends the items to the beginning of the
- list of items (windows, subsizers or spaces) owned by this sizer.
+ Sets the wxSizerFlags to have a border with size as returned by
+ GetDefaultBorder().
+
+ @param direction
+ Direction(s) to apply the border in.
*/
- wxSizerItem* Prepend(wxWindow* window, const wxSizerFlags& flags);
+ wxSizerFlags& Border(int direction = wxALL);
/**
- Same as Add(), but prepends the items to the beginning of the
- list of items (windows, subsizers or spaces) owned by this sizer.
+ Aligns the object to the bottom, similar for @c Align(wxALIGN_BOTTOM).
+
+ Unlike Align(), this method doesn't change the horizontal alignment of
+ the item.
*/
- wxSizerItem* Prepend(wxWindow* window, int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = NULL);
+ wxSizerFlags& Bottom();
/**
- Same as Add(), but prepends the items to the beginning of the
- list of items (windows, subsizers or spaces) owned by this sizer.
+ Sets the object of the wxSizerFlags to center itself in the area it is
+ given.
*/
- wxSizerItem* Prepend(wxSizer* sizer,
- const wxSizerFlags& flags);
+ wxSizerFlags& Center();
/**
- Same as Add(), but prepends the items to the beginning of the
- list of items (windows, subsizers or spaces) owned by this sizer.
+ Center() for people with the other dialect of English.
*/
- wxSizerItem* Prepend(wxSizer* sizer, int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = NULL);
+ wxSizerFlags& Centre();
/**
- Same as Add(), but prepends the items to the beginning of the
- list of items (windows, subsizers or spaces) owned by this sizer.
+ Sets the border in the given @a direction having twice the default
+ border size.
*/
- wxSizerItem* Prepend(int width, int height,
- int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = NULL);
+ wxSizerFlags& DoubleBorder(int direction = wxALL);
/**
- Prepends non-stretchable space to the sizer. More readable way of
- calling wxSizer::Prepend(size, size, 0).
+ Sets the border in left and right directions having twice the default
+ border size.
*/
- wxSizerItem* PrependSpacer(int size);
+ wxSizerFlags& DoubleHorzBorder();
/**
- Prepends stretchable space to the sizer. More readable way of calling
- wxSizer::Prepend(0, 0, prop).
+ Sets the object of the wxSizerFlags to expand to fill as much area as
+ it can.
*/
- wxSizerItem* PrependStretchSpacer(int prop = 1);
+ wxSizerFlags& Expand();
/**
- 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.
+ Set the @c wxFIXED_MINSIZE flag which indicates that the initial size
+ of the window should be also set as its minimal size.
*/
- virtual void RecalcSizes();
+ wxSizerFlags& FixedMinSize();
/**
- Removes a child window from the sizer, but does @b not destroy it
- (because windows are owned by their parent window, not the sizer).
-
- @deprecated
- The overload of this method taking a wxWindow* parameter
- is deprecated as it does not destroy the window as would usually be
- expected from Remove(). You should use Detach() in new code instead.
- There is currently no wxSizer method that will both detach and destroy
- a wxWindow item.
-
- @note This method does not cause any layout or resizing to take
- place, call Layout() to update the layout "on screen" after
- removing a child from the sizer.
+ 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 behaviour 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
*/
- bool Remove(wxWindow* window);
+ wxSizerFlags& ReserveSpaceEvenIfHidden();
/**
- Removes a sizer child from the sizer and destroys it.
-
- @note This method does not cause any layout or resizing to take
- place, call Layout() to update the layout "on screen" after
- removing a child from the sizer.
+ Returns the border used by default in Border() method.
+ */
+ static int GetDefaultBorder();
- @param sizer The wxSizer to be removed.
+ /**
+ Aligns the object to the left, similar for @c Align(wxALIGN_LEFT).
- @return @true if the child item was found and removed, @false otherwise.
+ Unlike Align(), this method doesn't change the vertical alignment of
+ the item.
*/
- bool Remove(wxSizer* sizer);
+ wxSizerFlags& Left();
/**
- Removes a child from the sizer and destroys it if it is a sizer or a
- spacer, but not if it is a window (because windows are owned by their
- parent window, not the sizer).
-
- @note This method does not cause any layout or resizing to take
- place, call Layout() to update the layout "on screen" after
- removing a child from the sizer.
+ Sets the proportion of this wxSizerFlags to @e proportion
+ */
+ wxSizerFlags& Proportion(int proportion);
- @param index The position of the child in the sizer, e.g. 0 for the
- first item.
+ /**
+ Aligns the object to the right, similar for @c Align(wxALIGN_RIGHT).
- @return @true if the child item was found and removed, @false otherwise.
+ Unlike Align(), this method doesn't change the vertical alignment of
+ the item.
*/
- bool Remove(size_t index);
+ wxSizerFlags& Right();
/**
- 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.
+ 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.
*/
- bool Replace(wxWindow* oldwin, wxWindow* newwin,
- bool recursive = false);
+ wxSizerFlags& Top();
/**
- Detaches the given @a oldsz from the sizer and
- replaces it with the given @a newsz. The detached
- child sizer is deleted.
+ Sets the border in the given @a direction having thrice the default
+ border size.
+ */
+ wxSizerFlags& TripleBorder(int direction = wxALL);
+};
- Use parameter @a recursive to search the given element recursively in subsizers.
- This method does not cause any layout or resizing to take place,
- call Layout() to update the layout "on screen" after replacing a
- child from the sizer.
+/**
+ Values which define the behaviour for resizing wxFlexGridSizer cells in the
+ "non-flexible" direction.
+*/
+enum wxFlexSizerGrowMode
+{
+ /// Don't resize the cells in non-flexible direction at all.
+ wxFLEX_GROWMODE_NONE,
- Returns @true if the child item was found and removed, @false otherwise.
- */
- bool Replace(wxSizer* oldsz, wxSizer* newsz,
- bool recursive = false);
+ /// Uniformly resize only the specified ones (default).
+ wxFLEX_GROWMODE_SPECIFIED,
- /**
- Detaches the given item at position @a index from the sizer and
- replaces it with the given wxSizerItem @a newitem.
+ /// Uniformly resize all cells.
+ wxFLEX_GROWMODE_ALL
+};
- 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).
+/**
+ @class wxFlexGridSizer
- This method does not cause any layout or resizing to take place,
- call Layout() to update the layout "on screen" after replacing a
- child from the sizer.
+ A flex grid sizer is a sizer which lays out its children in a two-dimensional
+ table with all table fields in one row having the same height and all fields
+ in one column having the same width, but all rows or all columns are not
+ necessarily the same height or width as in the wxGridSizer.
- Returns @true if the child item was found and removed, @false otherwise.
- */
- bool Replace(size_t index, wxSizerItem* newitem);
+ 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:
+ //@{
/**
- 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.
+ wxFlexGridSizer constructors.
+
+ Please see wxGridSizer::wxGridSizer documentation.
+
+ @since 2.9.1 (except for the four argument overload)
*/
- void SetDimension(int x, int y, int width, int height);
+ wxFlexGridSizer( int cols, int vgap, int hgap );
+ wxFlexGridSizer( int cols, const wxSize& gap = wxSize(0, 0) );
- /**
- @overload
- */
- void SetDimension(const wxPoint& pos, const wxSize& size);
+ wxFlexGridSizer( int rows, int cols, int vgap, int hgap );
+ wxFlexGridSizer( int rows, int cols, const wxSize& gap );
+ //@}
/**
- 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 (see wxBoxSizer) 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 column must not be already growable, if you need to change
+ the proportion you must call RemoveGrowableCol() first and then make it
+ growable (with a different proportion) again. You can use IsColGrowable()
+ to check whether a column is already growable.
*/
- void SetItemMinSize(wxWindow* window, int width, int height);
+ void AddGrowableCol(size_t idx, int proportion = 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.
+ Specifies that row idx (starting from zero) should be grown if there
+ is extra space available to the sizer.
- @see wxSizerItem::SetMinSize()
+ This is identical to AddGrowableCol() except that it works with rows
+ and not columns.
*/
- void SetItemMinSize(wxSizer* sizer, int width, int height);
+ void AddGrowableRow(size_t idx, int proportion = 0);
/**
- Set an item's minimum size by window, sizer, or position.
+ Returns a ::wxOrientation value that specifies whether the sizer flexibly
+ resizes its columns, rows, or both (default).
- The item will be found recursively in the sizer's descendants. This
- function enables an application to set the size of an item after
- initial creation.
+ @return
+ One of the following values:
+ - wxVERTICAL: Rows are flexibly sized.
+ - wxHORIZONTAL: Columns are flexibly sized.
+ - wxBOTH: Both rows and columns are flexibly sized (this is the default value).
- @see wxSizerItem::SetMinSize()
+ @see SetFlexibleDirection()
*/
- void SetItemMinSize(size_t index, int width, int height);
+ int GetFlexibleDirection() const;
/**
- Call this to give the sizer a minimal size. Normally, the sizer will
- calculate its minimal size based purely on how much space its children
- need. After calling this method GetMinSize() will return either the
- minimal size as requested by its children or the minimal size set here,
- depending on which is bigger.
- */
- void SetMinSize(const wxSize& size);
+ Returns the value that specifies how the sizer grows in the "non-flexible"
+ direction if there is one.
- /**
- @overload
- */
- void SetMinSize(int width, int height);
+ 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.
- /**
- This method first calls Fit() and then
- wxTopLevelWindow::SetSizeHints on the @e window
- passed to it. This only makes sense when @a window is actually a
- wxTopLevelWindow such as a wxFrame or a
- wxDialog, since SetSizeHints only has any effect in these classes.
- It does nothing in normal windows or controls.
- This method is implicitly used by wxWindow::SetSizerAndFit
- which is commonly invoked in the constructor of a toplevel window itself (see
- the sample in the description of wxBoxSizer) if the
- toplevel window is resizable.
+ @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 SetSizeHints(wxWindow* window);
+ wxFlexSizerGrowMode GetNonFlexibleGrowMode() 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 @true if column @a idx is growable.
- @see wxScrolled::SetScrollbars()
+ @since 2.9.0
*/
- void SetVirtualSizeHints(wxWindow* window);
+ bool IsColGrowable(size_t idx);
/**
- Shows or hides the @a window.
- To make a sizer item disappear or reappear, use Show() followed by Layout().
-
- Use parameter @a recursive to show or hide elements found in subsizers.
+ Returns @true if row @a idx is growable.
- Returns @true if the child item was found, @false otherwise.
+ @since 2.9.0
+ */
+ bool IsRowGrowable(size_t idx);
- @see Hide(), IsShown()
+ /**
+ Specifies that the @a idx column index is no longer growable.
*/
- bool Show(wxWindow* window, bool show = true,
- bool recursive = false);
+ void RemoveGrowableCol(size_t idx);
/**
- Shows or hides @a sizer.
- To make a sizer item disappear or reappear, use Show() followed by Layout().
+ Specifies that the @a idx row index is no longer growable.
+ */
+ void RemoveGrowableRow(size_t idx);
- Use parameter @a recursive to show or hide elements found in subsizers.
+ /**
+ Specifies whether the sizer should flexibly resize its columns, rows, or both.
- Returns @true if the child item was found, @false otherwise.
+ Argument @a direction can be @c wxVERTICAL, @c wxHORIZONTAL or @c wxBOTH
+ (which is the default value). Any other value is ignored.
- @see Hide(), IsShown()
+ See GetFlexibleDirection() for the explanation of these values.
+ Note that this method does not trigger relayout.
*/
- bool Show(wxSizer* sizer, bool show = true,
- bool recursive = false);
+ void SetFlexibleDirection(int direction);
/**
- Shows the item at @a index.
- To make a sizer item disappear or reappear, use Show() followed by Layout().
-
- Returns @true if the child item was found, @false otherwise.
+ Specifies how the sizer should grow in the non-flexible direction if
+ there is one (so SetFlexibleDirection() must have been called previously).
- @see Hide(), IsShown()
+ Argument @a mode can be one of those documented in GetNonFlexibleGrowMode(),
+ please see there for their explanation.
+ Note that this method does not trigger relayout.
*/
- bool Show(size_t index, bool show = true);
+ void SetNonFlexibleGrowMode(wxFlexSizerGrowMode mode);
};
-
/**
@class wxGridSizer
A grid sizer is a sizer which lays out its children in a two-dimensional
- table with all table fields having the same size,
- i.e. the width of each field is the width of the widest child,
- the height of each field is the height of the tallest child.
+ table with all table fields having the same size, i.e. the width of each
+ field is the width of the widest child, the height of each field is the
+ height of the tallest child.
@library{wxcore}
@category{winlayout}
- @see wxSizer, @ref overview_sizer "Sizer Overview"
+ @see wxSizer, @ref overview_sizer
*/
class wxGridSizer : public wxSizer
{
public:
//@{
/**
- Constructor for a wxGridSizer. @a rows and @a cols determine the number of
- columns and rows in the sizer - if either of the parameters is zero, it will be
- calculated to form the total number of children in the sizer, thus making the
- sizer grow dynamically. @a vgap and @a hgap define extra space between
- all children.
+ wxGridSizer constructors.
+
+ Usually only the number of columns in the flex grid sizer needs to be
+ specified using @a cols argument. The number of rows will be deduced
+ automatically depending on the number of the elements added to the
+ sizer.
+
+ If a constructor form with @a rows parameter is used (and the value of
+ @a rows argument is not zero, meaning "unspecified") the sizer will
+ check that no more than @c cols*rows elements are added to it, i.e.
+ that no more than the given number of @a rows is used. Adding less than
+ maximally allowed number of items is not an error however.
+
+ Finally, it is also possible to specify the number of rows and use 0
+ for @a cols. In this case, the sizer will use the given fixed number of
+ rows and as many columns as necessary.
+
+ The @a gap (or @a vgap and @a hgap, which correspond to the height and
+ width of the wxSize object) argument defines the size of the padding
+ between the rows (its vertical component, or @a vgap) and columns
+ (its horizontal component, or @a hgap), in pixels.
+
+
+ @since 2.9.1 (except for the four argument overload)
*/
- wxGridSizer(int rows, int cols, int vgap, int hgap);
- wxGridSizer(int cols, int vgap = 0, int hgap = 0);
+ wxGridSizer( int cols, int vgap, int hgap );
+ wxGridSizer( int cols, const wxSize& gap = wxSize(0, 0) );
+
+ wxGridSizer( int rows, int cols, int vgap, int hgap );
+ wxGridSizer( int rows, int cols, const wxSize& gap );
//@}
/**
- Returns the number of columns in the sizer.
+ Returns the number of columns that has been specified for the
+ sizer.
+
+ Returns zero if the sizer is automatically adjusting the number of
+ columns depending on number of its children. To get the effective
+ number of columns or rows being currently used, see GetEffectiveColsCount()
+ */
+ int GetCols() const;
+
+ /**
+ Returns the number of rows that has been specified for the
+ sizer.
+
+ Returns zero if the sizer is automatically adjusting the number of
+ rows depending on number of its children. To get the effective
+ number of columns or rows being currently used, see GetEffectiveRowsCount().
*/
- int GetCols();
+ int GetRows() const;
/**
- Returns the horizontal gap (in pixels) between cells in the sizer.
+ Returns the number of columns currently used by the sizer.
+
+ This will depend on the number of children the sizer has if
+ the sizer is automatically adjusting the number of columns/rows.
+
+ @since 2.9.1
+ */
+ int GetEffectiveColsCount() const;
+
+ /**
+ Returns the number of rows currently used by the sizer.
+
+ This will depend on the number of children the sizer has if
+ the sizer is automatically adjusting the number of columns/rows.
+
+ @since 2.9.1
*/
- int GetHGap();
+ int GetEffectiveRowsCount() const;
/**
- Returns the number of rows in the sizer.
+ Returns the horizontal gap (in pixels) between cells in the sizer.
*/
- int GetRows();
+ int GetHGap() const;
/**
Returns the vertical gap (in pixels) between the cells in the sizer.
*/
- int GetVGap();
+ int GetVGap() const;
/**
Sets the number of columns in the sizer.
@@ -1612,37 +1710,59 @@ public:
/**
@class wxStaticBoxSizer
- wxStaticBoxSizer is a sizer derived from wxBoxSizer but adds a static
- box around the sizer. This static box may be either created independently or
- the sizer may create it itself as a convenience. In any case, the sizer owns
- the wxStaticBox control and will delete it if it is
- deleted.
+ wxStaticBoxSizer is a sizer derived from wxBoxSizer but adds a static box around
+ the sizer.
+
+ The static box may be either created independently or the sizer may create it
+ itself as a convenience. In any case, the sizer owns the wxStaticBox control
+ and will delete it in the wxStaticBoxSizer destructor.
+
+ Note that since wxWidgets 2.9.1 you are encouraged to create the windows
+ which are added to wxStaticBoxSizer as children of wxStaticBox itself, see
+ this class documentation for more details.
+
+ Example of use of this class:
+ @code
+ void MyFrame::CreateControls()
+ {
+ wxPanel *panel = new wxPanel(this);
+ ...
+ wxStaticBoxSizer *sz = new wxStaticBoxSizer(wxVERTICAL, panel, "Box");
+ sz->Add(new wxStaticText(sz->GetStaticBox(), wxID_ANY,
+ "This window is a child of the staticbox"));
+ ...
+ }
+ @endcode
@library{wxcore}
@category{winlayout}
@see wxSizer, wxStaticBox, wxBoxSizer, @ref overview_sizer
- "Sizer Overview"
*/
class wxStaticBoxSizer : public wxBoxSizer
{
public:
- //@{
/**
- The first constructor uses an already existing static box. It takes the
- associated static box and the orientation @e orient, which can be either
- @c wxVERTICAL or @c wxHORIZONTAL as parameters.
- The second one creates a new static box with the given label and parent window.
+ This constructor uses an already existing static box.
+
+ @param box
+ The static box to associate with the sizer (which will take its
+ ownership).
+ @param orient
+ Can be either @c wxVERTICAL or @c wxHORIZONTAL.
*/
wxStaticBoxSizer(wxStaticBox* box, int orient);
- wxStaticBoxSizer(int orient, wxWindow parent,
+
+ /**
+ This constructor creates a new static box with the given label and parent window.
+ */
+ wxStaticBoxSizer(int orient, wxWindow *parent,
const wxString& label = wxEmptyString);
- //@}
/**
Returns the static box associated with the sizer.
*/
- wxStaticBox* GetStaticBox();
+ wxStaticBox* GetStaticBox() const;
};
@@ -1651,17 +1771,15 @@ public:
@class wxBoxSizer
The basic idea behind a box sizer is that windows will most often be laid out
- in rather
- simple basic geometry, typically in a row or a column or several hierarchies of
- either.
+ in rather simple basic geometry, typically in a row or a column or several
+ hierarchies of either.
- For more information, please see @ref overview_sizer_box
- "Programming with wxBoxSizer".
+ For more information, please see @ref overview_sizer_box.
@library{wxcore}
@category{winlayout}
- @see wxSizer, @ref overview_sizer "Sizers Overview"
+ @see wxSizer, @ref overview_sizer
*/
class wxBoxSizer : public wxSizer
{
@@ -1673,8 +1791,26 @@ public:
wxBoxSizer(int orient);
/**
- Implements the calculation of a box sizer's minimal. It is used internally
- only and must not be called by the user. Documented for information.
+ Adds non-stretchable space to the main orientation of the sizer only.
+ More readable way of calling:
+ @code
+ if ( wxBoxSizer::IsVertical() )
+ {
+ wxBoxSizer::Add(0, size, 0).
+ }
+ else
+ {
+ wxBoxSizer::Add(size, 0, 0).
+ }
+ @endcode
+ */
+ virtual wxSizerItem *AddSpacer(int size);
+
+ /**
+ Implements the calculation of a box sizer's minimal.
+
+ It is used internally only and must not be called by the user.
+ Documented for information.
*/
virtual wxSize CalcMin();
@@ -1686,9 +1822,10 @@ public:
/**
Implements the calculation of a box sizer's dimensions and then sets
- the size of its children (calling wxWindow::SetSize
- if the child is a window). It is used internally only and must not be called
- by the user (call Layout() if you want to resize). Documented for information.
+ the size of its children (calling wxWindow::SetSize if the child is a window).
+
+ It is used internally only and must not be called by the user
+ (call Layout() if you want to resize). Documented for information.
*/
void RecalcSizes();
};