/////////////////////////////////////////////////////////////////////////////
// Name: sizer.h
-// Purpose: documentation for wxStdDialogButtonSizer class
+// Purpose: interface of wxStdDialogButtonSizer
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/**
@class wxStdDialogButtonSizer
@wxheader{sizer.h}
-
+
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
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 the Windows implementation.
+
To use this class, first add buttons to the sizer by calling AddButton (or
SetAffirmativeButton, SetNegativeButton,
or SetCancelButton) and then call Realize in order to create the actual button
layout used. Other than these special
- operations, this sizer works like any other sizer.
-
+ 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{FIXME}
-
- @seealso
- wxSizer, @ref overview_sizeroverview "Sizer overview",
+
+ @see wxSizer, @ref overview_sizeroverview "Sizer overview",
wxDialog::CreateButtonSizer
*/
class wxStdDialogButtonSizer : public wxBoxSizer
/**
Adds a button to the wxStdDialogButtonSizer. The button must have one of the
following identifiers:
-
wxID_OK
wxID_YES
wxID_SAVE
};
+
/**
@class wxSizerItem
@wxheader{sizer.h}
-
+
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{FIXME}
*/
*/
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(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);
//@}
/**
/**
Return the border attribute.
*/
- int GetBorder();
+ int GetBorder() const;
/**
Return the flags attribute.
*/
- int GetFlag();
+ int GetFlag() const;
/**
Return the numeric id of wxSizerItem, or @c wxID_NONE if the id has
not been set.
*/
- int GetId();
+ int GetId() const;
/**
Get the minimum size needed for the item.
*/
- wxSize GetMinSize();
+ wxSize GetMinSize() const;
/**
What is the current position of the item, as set in the last Layout.
*/
- wxPoint GetPosition();
+ wxPoint GetPosition() const;
/**
Get the proportion item attribute.
*/
- int GetProportion();
+ int GetProportion() const;
/**
Get the ration item attribute.
*/
- float GetRatio();
+ float GetRatio() const;
/**
Get the rectangle of the item on the parent window, excluding borders.
/**
Get the current size of the item, as set in the last Layout.
*/
- wxSize GetSize();
+ wxSize GetSize() const;
/**
If this item is tracking a sizer, return it. @NULL otherwise.
*/
- wxSizer* GetSizer();
+ wxSizer* GetSizer() const;
/**
If this item is tracking a spacer, return its size.
*/
- const wxSize GetSpacer();
+ const wxSize GetSpacer() const;
/**
Get the userData item attribute.
*/
- wxObject* GetUserData();
+ wxObject* GetUserData() const;
/**
If this item is tracking a window then return it. @NULL otherwise.
*/
- wxWindow* GetWindow();
+ wxWindow* GetWindow() const;
/**
Returns @true if this item is a window or a spacer and it is shown or if this
items, all of the child elements must be hidden for the sizer itself to be
considered hidden.
*/
- bool IsShown();
+ bool IsShown() const;
/**
Is this item a sizer?
*/
- bool IsSizer();
+ bool IsSizer() const;
/**
Is this item a spacer?
*/
- bool IsSpacer();
+ bool IsSpacer() const;
/**
Is this item a window?
*/
- bool IsWindow();
+ bool IsWindow() const;
/**
Set the border item attribute.
Set the ratio item attribute.
*/
void SetRatio(int width, int height);
- void SetRatio(wxSize size);
- void SetRatio(float ratio);
+ void SetRatio(wxSize size);
+ void SetRatio(float ratio);
//@}
/**
};
+
/**
@class wxSizerFlags
@wxheader{sizer.h}
-
- Normally, when you add an item to a sizer via
+
+ 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(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(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{FIXME}
-
- @seealso
- wxSizer
+
+ @see wxSizer
*/
-class wxSizerFlags
+class wxSizerFlags
{
public:
/**
/**
Sets the alignment of this wxSizerFlags to @e align.
-
Note that if this method is not called, the wxSizerFlags has no specified
alignment.
- @sa Top(), Left(), Right(),
- Bottom(), Centre()
+ @see Top(), Left(), Right(),
+ Bottom(), Centre()
*/
wxSizerFlags Align(int align = 0);
//@{
/**
Sets the wxSizerFlags to have a border of a number of pixels specified by
- @e borderinpixels with the directions specified by @e direction.
-
- In the overloaded version without @e borderinpixels parameter, the border of
+ @a borderinpixels with the directions specified by @e direction.
+ In the overloaded version without @a borderinpixels parameter, the border of
default size, as returned by GetDefaultBorder(),
is used.
*/
wxSizerFlags Border(int direction, int borderinpixels);
- wxSizerFlags Border(int direction = wxALL);
+ wxSizerFlags Border(int direction = wxALL);
//@}
/**
Aligns the object to the bottom, shortcut for @c Align(wxALIGN_BOTTOM)
- @sa Align()
+ @see Align()
*/
wxSizerFlags Bottom();
wxSizerFlags Centre();
/**
- Sets the border in the given @e direction having twice the default border
+ Sets the border in the given @a direction having twice the default border
size.
*/
wxSizerFlags DoubleBorder(int direction = wxALL);
/**
Aligns the object to the left, shortcut for @c Align(wxALIGN_LEFT)
- @sa Align()
+ @see Align()
*/
wxSizerFlags Left();
/**
Aligns the object to the right, shortcut for @c Align(wxALIGN_RIGHT)
- @sa Align()
+ @see Align()
*/
wxSizerFlags Right();
/**
Aligns the object to the top, shortcut for @c Align(wxALIGN_TOP)
- @sa Align()
+ @see Align()
*/
-#define wxSizerFlags Top() /* implementation is private */
+ wxSizerFlags Top();
/**
- Sets the border in the given @e direction having thrice the default border
+ Sets the border in the given @a direction having thrice the default border
size.
*/
wxSizerFlags TripleBorder(int direction = wxALL);
};
+
/**
@class wxNotebookSizer
@wxheader{sizer.h}
-
+
@b 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.
See @ref overview_sizeroverview "wxSizer overview" for more information.
-
+
wxNotebookSizer is a specialized sizer to make sizers work in connection
- with using notebooks. This sizer is different from any other sizer as
+ 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.
-
+
@library{wxbase}
@category{FIXME}
-
- @seealso
- wxSizer, wxNotebook, @ref overview_sizeroverview "Sizer overview"
+
+ @see wxSizer, wxNotebook, @ref overview_sizeroverview "Sizer overview"
*/
class wxNotebookSizer : public wxSizer
{
};
+
/**
@class wxFlexGridSizer
@wxheader{sizer.h}
-
+
A flex grid sizer is a sizer which lays out its children in a two-dimensional
table with all table fields in one row having the same
height and all fields in one column having the same width, but all
rows or all columns are not necessarily the same height or width as in
the wxGridSizer.
-
+
Since wxWidgets 2.5.0, wxFlexGridSizer can also size items equally in one
direction but unequally ("flexibly") in the other. If the sizer is only
flexible in one direction (this can be changed using
direction in order to fill the available space. The
wxFlexGridSizer::SetNonFlexibleGrowMode method
serves this purpose.
-
+
@library{wxcore}
@category{winlayout}
-
- @seealso
- wxSizer, @ref overview_sizeroverview "Sizer overview"
+
+ @see wxSizer, @ref overview_sizeroverview "Sizer overview"
*/
class wxFlexGridSizer : public wxGridSizer
{
public:
//@{
/**
- Constructor for a wxGridSizer. @e rows and @e cols determine the number of
+ 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. @e vgap and @e hgap define extra space between
+ sizer grow dynamically. @a vgap and @a hgap define extra space between
all children.
*/
wxFlexGridSizer(int rows, int cols, int vgap, int hgap);
- wxFlexGridSizer(int cols, int vgap = 0, int hgap = 0);
+ wxFlexGridSizer(int cols, int vgap = 0, int hgap = 0);
//@}
/**
- Specifies that column @e idx (starting from zero) should be grown if
+ Specifies that column @a idx (starting from zero) should be grown if
there is extra space available to the sizer.
-
- The @e proportion parameter has the same meaning as the stretch factor for
- the sizers except that if all proportions are 0,
+ 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).
*/
void AddGrowableCol(size_t idx, int proportion = 0);
/**
Specifies that row idx (starting from zero) should be grown if there
is extra space available to the sizer.
-
See AddGrowableCol() for the description
- of @e proportion parameter.
+ of @a proportion parameter.
*/
void AddGrowableRow(size_t idx, int proportion = 0);
@returns One of the following values:
- @sa SetFlexibleDirection()
+ @see SetFlexibleDirection()
*/
- int GetFlexibleDirection();
+ int GetFlexibleDirection() const;
/**
Returns the value that specifies how the sizer grows in the "non-flexible"
@returns One of the following values:
- @sa SetFlexibleDirection(),
- SetNonFlexibleGrowMode()
+ @see SetFlexibleDirection(),
+ SetNonFlexibleGrowMode()
*/
- int GetNonFlexibleGrowMode();
+ int GetNonFlexibleGrowMode() const;
/**
Specifies that column idx is no longer growable.
or @c wxBOTH (which is the default value). Any other value is ignored. See
@ref getflexibledrection() GetFlexibleDirection for the
explanation of these values.
-
Note that this method does not trigger relayout.
*/
void SetFlexibleDirection(int direction);
Specifies how the sizer should grow in the non-flexible direction if
there is one (so
SetFlexibleDirection() must have
- been called previously). Argument @e mode can be one of those documented in
+ 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);
};
+
/**
@class wxSizer
@wxheader{sizer.h}
-
+
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,
+ classes derived from it. Currently there are wxBoxSizer,
wxStaticBoxSizer,
wxGridSizer,
wxFlexGridSizer,
wxWrapSizer
and wxGridBagSizer.
-
+
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
and thus does not interfere with tab ordering and requires very little
resources compared
to a real window on screen.
-
+
What makes sizers so well fitted for use in wxWidgets is the fact that every
control
reports its own minimal size and the algorithm can handle differences in font
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
Add, Insert, and Prepend functions return a pointer to the newly added
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.
-
+
@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.
-
+
@library{wxcore}
@category{winlayout}
-
- @seealso
- @ref overview_sizeroverview "Sizer overview"
+
+ @see @ref overview_sizeroverview "Sizer overview"
*/
class wxSizer : public wxObject
{
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 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 width and height
- 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
+ @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 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 width and height
+ 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
+ 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 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
+ the dialog.
+ @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
+ 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
+ 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
+ value of 1 each to make them grow and shrink equally with the sizer's
horizontal dimension.
+ @param flag
+ This parameter can be used to set a number of flags
+ which can be combined using the binary OR operator |. 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.
+
+
+
+
+
+
+ wxTOP
+
+ wxBOTTOM
+
+ wxLEFT
+
+ wxRIGHT
+
+ wxALL
+
+
+
+
+ These flags are used to specify which side(s) of
+ the sizer item the border width will apply to.
- @param flag
- This parameter can be used to set a number of flags
- which can be combined using the binary OR operator |. 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.
- wxTOP
- wxBOTTOM
- wxLEFT
- wxRIGHT
+ wxEXPAND
- wxALL
- These flags are used to specify which side(s) of
- the sizer item the border width will apply to.
+ The item will be expanded to fill
+ the space assigned to the item.
- wxEXPAND
- The item will be expanded to fill
- the space assigned to the item.
- wxSHAPED
+ wxSHAPED
- The item will be expanded as much
- as possible while also maintaining its aspect ratio
- 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.
+ The item will be expanded as much
+ as possible while also maintaining its aspect ratio
- wxALIGN_CENTER wxALIGN_CENTRE
- wxALIGN_LEFT
- wxALIGN_RIGHT
- wxALIGN_TOP
- wxALIGN_BOTTOM
+ wxFIXED_MINSIZE
- 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.
+ 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.
- @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.
- @param flags
- A wxSizerFlags object that
- enables you to specify most of the above parameters more conveniently.
+
+
+ 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.
+ @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.
+ @param flags
+ A wxSizerFlags object that
+ enables you to specify most of the above parameters more conveniently.
*/
wxSizerItem* Add(wxWindow* window, const wxSizerFlags& flags);
- wxSizerItem* Add(wxWindow* window, int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = @NULL);
- wxSizerItem* Add(wxSizer* sizer, const wxSizerFlags& flags);
- wxSizerItem* Add(wxSizer* sizer, int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = @NULL);
- wxSizerItem* Add(int width, int height, int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = @NULL);
+ wxSizerItem* Add(wxWindow* window, int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
+ wxSizerItem* Add(wxSizer* sizer, const wxSizerFlags& flags);
+ wxSizerItem* Add(wxSizer* sizer, int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
+ wxSizerItem* Add(int width, int height, int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
//@}
/**
wxSize CalcMin();
/**
- Detaches all children from the sizer. If @e delete_windows is @true then
+ Detaches all children from the sizer. If @a delete_windows is @true then
child windows will also be deleted.
*/
- void Clear(bool delete_windows = @false);
+ void Clear(bool delete_windows = false);
/**
- Computes client area size for @e 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.
-
- @sa ComputeFittingWindowSize(), Fit()
+ Computes client area size for @a window so that it matches the sizer's
+ minimal size. Unlike GetMinSize(), this method accounts for other
+ constraints imposed on @e window, namely display's size (returned size
+ will never be too large for the display) and maximum window size if
+ previously set by wxWindow::SetMaxSize(). The returned value is
+ suitable for passing to wxWindow::SetClientSize() or
+ wxWindow::SetMinClientSize().
+
+ @since 2.8.8
+
+ @see ComputeFittingWindowSize(), Fit()
*/
wxSize ComputeFittingClientSize(wxWindow* window);
/**
- Like ComputeFittingClientSize(),
- but converts the result into window size.
-
- The returned value is suitable for passing to
- wxWindow::SetSize or
- wxWindow::SetMinSize.
-
- @sa ComputeFittingClientSize(), Fit()
+ Like ComputeFittingClientSize(), but converts the result into window
+ size. The returned value is suitable for passing to wxWindow::SetSize()
+ or wxWindow::SetMinSize().
+
+ @since 2.8.8
+
+ @see ComputeFittingClientSize(), Fit()
*/
wxSize ComputeFittingWindowSize(wxWindow* window);
//@{
/**
- Detach a child from the sizer without destroying it. @e window is the window to
+ Detach a child from the sizer without destroying it. @a window is the window to
be
- detached, @e sizer is the equivalent sizer and @e index is the position of
+ detached, @a sizer is the equivalent sizer and @a index is the position of
the child in the sizer, typically 0 for the first item. 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.
- @sa Remove()
+ @see Remove()
*/
bool Detach(wxWindow* window);
- bool Detach(wxSizer* sizer);
- bool Detach(size_t index);
+ bool Detach(wxSizer* sizer);
+ bool Detach(size_t index);
//@}
/**
- Tell the sizer to resize the @e window so that its client area matches the
+ 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).
itself, see sample in the description
of wxBoxSizer. Returns the new window size.
- @sa ComputeFittingClientSize(), ComputeFittingWindowSize()
+ @see ComputeFittingClientSize(), ComputeFittingWindowSize()
*/
-#define wxSize Fit(wxWindow* window) /* implementation is private */
+ wxSize Fit(wxWindow* window);
/**
- Tell the sizer to resize the virtual size of the @e window to match the sizer's
+ 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.
- @sa wxScrolledWindow::SetScrollbars, SetVirtualSizeHints()
+ @see wxScrolledWindow::SetScrollbars, SetVirtualSizeHints()
*/
void FitInside(wxWindow* window);
//@{
/**
- Returns the list of the items in this sizer. The elements of type-safe
- wxList @c wxSizerItemList are objects of type
+ Returns the list of the items in this sizer. The elements of type-safe
+ wxList @c wxSizerItemList are objects of type
@ref overview_wxsizeritem "wxSizerItem *".
*/
const wxSizerItemList GetChildren();
- wxSizerItemList GetChildren();
+ const wxSizerItemList GetChildren();
//@}
/**
Returns the window this sizer is used in or @NULL if none.
*/
- wxWindow * GetContainingWindow();
+ wxWindow* GetContainingWindow() const;
//@{
/**
- Finds item of the sizer which holds given @e window, @e sizer or is located
+ Finds item of the sizer which holds given @e window, @a sizer or is located
in sizer at position @e index.
- Use parameter @e recursive to search in subsizers too.
-
+ Use parameter @a recursive to search in subsizers too.
Returns pointer to item or @NULL.
*/
- wxSizerItem * GetItem(wxWindow* window, bool recursive = @false);
- wxSizerItem * GetItem(wxSizer* sizer, bool recursive = @false);
- wxSizerItem * GetItem(size_t index);
+ wxSizerItem* GetItem(wxWindow* window, bool recursive = false);
+ wxSizerItem* GetItem(wxSizer* sizer, bool recursive = false);
+ wxSizerItem* GetItem(size_t index);
//@}
/**
- Finds item of the sizer which has the given @e id. This @e id is not the
+ 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 @e recursive to search in subsizers too.
-
+ retrieving the sizers created from XRC resources.
+ Use parameter @a recursive to search in subsizers too.
Returns pointer to item or @NULL.
*/
- wxSizerItem * GetItemById(int id, bool recursive = @false);
+ wxSizerItem* GetItemById(int id, bool recursive = false);
/**
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
+ 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
/**
Hides the @e window, @e sizer, or item at @e index.
To make a sizer item disappear, use Hide() followed by Layout().
- Use parameter @e recursive to hide elements found in subsizers.
-
+ Use parameter @a recursive to hide elements found in subsizers.
Returns @true if the child item was found, @false otherwise.
- @sa IsShown(), Show()
+ @see IsShown(), Show()
*/
- bool Hide(wxWindow* window, bool recursive = @false);
- bool Hide(wxSizer* sizer, bool recursive = @false);
- bool Hide(size_t index);
+ bool Hide(wxWindow* window, bool recursive = false);
+ bool Hide(wxSizer* sizer, bool recursive = false);
+ bool Hide(size_t index);
//@}
//@{
/**
- Insert a child into the sizer before any existing item at
+ Insert a child into the sizer before any existing item at
+
See Add() for the meaning of the other parameters.
@param index.
- index
- The position this child should assume in the sizer.
+ index
+ The position this child should assume in the sizer.
*/
wxSizerItem* Insert(size_t index, wxWindow* window,
const wxSizerFlags& flags);
- wxSizerItem* Insert(size_t index, wxWindow* window,
- int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = @NULL);
- wxSizerItem* Insert(size_t index, wxSizer* sizer,
- const wxSizerFlags& flags);
- wxSizerItem* Insert(size_t index, wxSizer* sizer,
- int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = @NULL);
- wxSizerItem* Insert(size_t index, int width, int height,
- int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = @NULL);
+ wxSizerItem* Insert(size_t index, wxWindow* window,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
+ wxSizerItem* Insert(size_t index, wxSizer* sizer,
+ const wxSizerFlags& flags);
+ wxSizerItem* Insert(size_t index, wxSizer* sizer,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
+ wxSizerItem* Insert(size_t index, int width, int height,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
//@}
/**
//@{
/**
- Returns @true if the @e window, @e sizer, or item at @e index is shown.
+ Returns @true if the @e window, @e sizer, or item at @a index is shown.
- @sa Hide(), Show()
+ @see Hide(), Show()
*/
- bool IsShown(wxWindow* window);
- bool IsShown(wxSizer* sizer);
- bool IsShown(size_t index);
+ bool IsShown(wxWindow* window) const;
+ const bool IsShown(wxSizer* sizer) const;
+ const bool IsShown(size_t index) const;
//@}
/**
list of items (windows, subsizers or spaces) owned by this sizer.
*/
wxSizerItem* Prepend(wxWindow* window, const wxSizerFlags& flags);
- wxSizerItem* Prepend(wxWindow* window, int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = @NULL);
- wxSizerItem* Prepend(wxSizer* sizer,
- const wxSizerFlags& flags);
- wxSizerItem* Prepend(wxSizer* sizer, int proportion = 0,
- int flag = 0,
- int border = 0,
- wxObject* userData = @NULL);
- wxSizerItem* Prepend(int width, int height,
- int proportion = 0,
- int flag = 0,
- int border= 0,
- wxObject* userData = @NULL);
+ wxSizerItem* Prepend(wxWindow* window, int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
+ wxSizerItem* Prepend(wxSizer* sizer,
+ const wxSizerFlags& flags);
+ wxSizerItem* Prepend(wxSizer* sizer, int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
+ wxSizerItem* Prepend(int width, int height,
+ int proportion = 0,
+ int flag = 0,
+ int border = 0,
+ wxObject* userData = NULL);
//@}
/**
/**
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). @e sizer is the wxSizer to be removed,
- @e index is the position of the child in the sizer, e.g. 0 for the first item.
+ not the sizer). @a sizer is the wxSizer to be removed,
+ @a index is the position of the child in the sizer, e.g. 0 for the first item.
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.
-
@b NB: The method taking a wxWindow* parameter is deprecated as it does not
- destroy the window as would usually be expected from Remove. You should use
+ 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.
-
Returns @true if the child item was found and removed, @false otherwise.
*/
bool Remove(wxWindow* window);
- bool Remove(wxSizer* sizer);
- bool Remove(size_t index);
+ bool Remove(wxSizer* sizer);
+ bool Remove(size_t index);
//@}
//@{
/**
- Detaches the given @e oldwin, @e oldsz child from the sizer and
+ Detaches the given @e oldwin, @a oldsz child from the sizer and
replaces it with the given window, sizer, or wxSizerItem.
-
The detached child is removed @b only if it is a sizer or a spacer
(because windows are owned by their parent window, not the sizer).
+ Use parameter @a recursive to search the given element recursively in subsizers.
- Use parameter @e recursive to search the given element recursively in subsizers.
This method does not cause any layout or resizing to take place, call
Layout() to update the layout "on screen" after replacing a
child from the sizer.
-
Returns @true if the child item was found and removed, @false otherwise.
*/
bool Replace(wxWindow* oldwin, wxWindow* newwin,
- bool recursive = @false);
- bool Replace(wxSizer* oldsz, wxSizer* newsz,
- bool recursive = @false);
- bool Remove(size_t oldindex, wxSizerItem* newitem);
+ bool recursive = false);
+ bool Replace(wxSizer* oldsz, wxSizer* newsz,
+ bool recursive = false);
+ bool Remove(size_t oldindex, wxSizerItem* newitem);
//@}
/**
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
+ parameter in the
Add() and Prepend() methods.
*/
void SetDimension(int x, int y, int width, int height);
after initial creation.
*/
void SetItemMinSize(wxWindow* window, int width, int height);
- void SetItemMinSize(wxSizer* sizer, int width, int height);
- void SetItemMinSize(size_t index, int width, int height);
+ void SetItemMinSize(wxSizer* sizer, int width, int height);
+ void SetItemMinSize(size_t index, int width, int height);
//@}
//@{
bigger.
*/
void SetMinSize(int width, int height);
- void SetMinSize(const wxSize& size);
+ void SetMinSize(const wxSize& size);
//@}
/**
- This method first calls Fit() and then
+ This method first calls Fit() and then
wxTopLevelWindow::SetSizeHints on the @e window
- passed to it. This only makes sense when @e window is actually a
+ 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.
+ 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
+ This method is implicitly used by wxWindow::SetSizerAndFit
which is commonly invoked in the constructor of a toplevel window itself (see
the sample in the description of wxBoxSizer) if the
toplevel window is resizable.
void SetSizeHints(wxWindow* window);
/**
- Tell the sizer to set the minimal size of the @e window virtual area to match
+ 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.
- @sa wxScrolledWindow::SetScrollbars
+ @see wxScrolledWindow::SetScrollbars
*/
void SetVirtualSizeHints(wxWindow* window);
/**
Shows or hides the @e window, @e sizer, or item at @e index.
To make a sizer item disappear or reappear, use Show() followed by Layout().
- Use parameter @e recursive to show or hide elements found in subsizers.
-
+ Use parameter @a recursive to show or hide elements found in subsizers.
Returns @true if the child item was found, @false otherwise.
- @sa Hide(), IsShown()
+ @see Hide(), IsShown()
*/
- bool Show(wxWindow* window, bool show = @true,
- bool recursive = @false);
- bool Show(wxSizer* sizer, bool show = @true,
- bool recursive = @false);
- bool Show(size_t index, bool show = @true);
+ bool Show(wxWindow* window, bool show = true,
+ bool recursive = false);
+ bool Show(wxSizer* sizer, bool show = true,
+ bool recursive = false);
+ bool Show(size_t index, bool show = true);
//@}
};
+
/**
@class wxGridSizer
@wxheader{sizer.h}
-
+
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.
-
+
@library{wxcore}
@category{winlayout}
-
- @seealso
- wxSizer, @ref overview_sizeroverview "Sizer overview"
+
+ @see wxSizer, @ref overview_sizeroverview "Sizer overview"
*/
class wxGridSizer : public wxSizer
{
public:
//@{
/**
- Constructor for a wxGridSizer. @e rows and @e cols determine the number of
+ 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. @e vgap and @e hgap define extra space between
+ sizer grow dynamically. @a vgap and @a hgap define extra space between
all children.
*/
wxGridSizer(int rows, int cols, int vgap, int hgap);
- wxGridSizer(int cols, int vgap = 0, int hgap = 0);
+ wxGridSizer(int cols, int vgap = 0, int hgap = 0);
//@}
/**
};
+
/**
@class wxStaticBoxSizer
@wxheader{sizer.h}
-
+
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.
-
+
@library{wxcore}
@category{winlayout}
-
- @seealso
- wxSizer, wxStaticBox, wxBoxSizer, @ref overview_sizeroverview "Sizer overview"
+
+ @see wxSizer, wxStaticBox, wxBoxSizer, @ref overview_sizeroverview "Sizer
+ overview"
*/
class wxStaticBoxSizer : public wxBoxSizer
{
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.
*/
wxStaticBoxSizer(wxStaticBox* box, int orient);
- wxStaticBoxSizer(int orient, wxWindow parent,
- const wxString& label = wxEmptyString);
+ wxStaticBoxSizer(int orient, wxWindow parent,
+ const wxString& label = wxEmptyString);
//@}
/**
};
+
/**
@class wxBoxSizer
@wxheader{sizer.h}
-
+
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.
-
+
For more information, please see @ref overview_boxsizerprogramming "Programming
with wxBoxSizer".
-
+
@library{wxcore}
@category{winlayout}
-
- @seealso
- wxSizer, @ref overview_sizeroverview "Sizer overview"
+
+ @see wxSizer, @ref overview_sizeroverview "Sizer overview"
*/
class wxBoxSizer : public wxSizer
{
public:
/**
- Constructor for a wxBoxSizer. @e orient may be either of wxVERTICAL
+ Constructor for a wxBoxSizer. @a orient may be either of wxVERTICAL
or wxHORIZONTAL for creating either a column sizer or a row sizer.
*/
wxBoxSizer(int orient);
/**
Implements the calculation of a box sizer's dimensions and then sets
- the size of its children (calling wxWindow::SetSize
+ 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();
};
+
projects / wxWidgets.git / blobdiff