/////////////////////////////////////////////////////////////////////////////
// Name: sizer.h
-// Purpose: documentation for wxStdDialogButtonSizer class
+// Purpose: interface of wxStdDialogButtonSizer
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxcore}
@category{FIXME}
- @seealso
- wxSizer, @ref overview_sizeroverview "Sizer overview",
+ @see wxSizer, @ref overview_sizeroverview "Sizer overview",
wxDialog::CreateButtonSizer
*/
class wxStdDialogButtonSizer : public wxBoxSizer
};
+
/**
@class wxSizerItem
@wxheader{sizer.h}
void SetId(int id);
/**
-
+
*/
void SetInitSize(int x, int y);
};
+
/**
@class wxSizerFlags
@wxheader{sizer.h}
@library{wxcore}
@category{FIXME}
- @seealso
- wxSizer
+ @see wxSizer
*/
class wxSizerFlags
{
Sets the alignment of this wxSizerFlags to @e align.
Note that if this method is not called, the wxSizerFlags has no specified
alignment.
-
+
@see Top(), Left(), Right(),
Bottom(), Centre()
*/
/**
Aligns the object to the bottom, shortcut for @c Align(wxALIGN_BOTTOM)
-
+
@see Align()
*/
wxSizerFlags Bottom();
/**
Aligns the object to the left, shortcut for @c Align(wxALIGN_LEFT)
-
+
@see Align()
*/
wxSizerFlags Left();
/**
Aligns the object to the right, shortcut for @c Align(wxALIGN_RIGHT)
-
+
@see Align()
*/
wxSizerFlags Right();
/**
Aligns the object to the top, shortcut for @c Align(wxALIGN_TOP)
-
+
@see Align()
*/
wxSizerFlags Top();
};
+
/**
@class wxNotebookSizer
@wxheader{sizer.h}
@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}
@library{wxcore}
@category{winlayout}
- @seealso
- wxSizer, @ref overview_sizeroverview "Sizer overview"
+ @see wxSizer, @ref overview_sizeroverview "Sizer overview"
*/
class wxFlexGridSizer : public wxGridSizer
{
Specifies that column @a idx (starting from zero) should be grown if
there is extra space available to the sizer.
The @a proportion parameter has the same meaning as the stretch factor for
- the sizers except that if all proportions are 0,
+ 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);
/**
Returns a wxOrientation value that specifies whether the sizer flexibly
resizes its columns, rows, or both (default).
-
+
@returns One of the following values:
-
+
@see SetFlexibleDirection()
*/
int GetFlexibleDirection() const;
/**
Returns the value that specifies how the sizer grows in the "non-flexible"
direction if there is one.
-
+
@returns One of the following values:
-
+
@see SetFlexibleDirection(),
SetNonFlexibleGrowMode()
*/
};
+
/**
@class wxSizer
@wxheader{sizer.h}
@library{wxcore}
@category{winlayout}
- @seealso
- @ref overview_sizeroverview "Sizer overview"
+ @see @ref overview_sizeroverview "Sizer overview"
*/
class wxSizer : public wxObject
{
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
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.
-
-
-
-
-
+
+
+
+
+
wxEXPAND
-
-
-
-
+
+
+
+
The item will be expanded to fill
the space assigned to the item.
-
-
-
-
-
+
+
+
+
+
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
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.
-
-
-
-
-
+
+
+
+
+
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.
void Clear(bool delete_windows = false);
/**
- 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.
-
+ 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.
-
+ 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);
cause any layout or resizing to take place, call Layout()
to update the layout "on screen" after detaching a child from the sizer.
Returns @true if the child item was found and detached, @false otherwise.
-
+
@see Remove()
*/
bool Detach(wxWindow* window);
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()
*/
wxSize Fit(wxWindow* window);
the addition/removal/alteration of scrollbars required to view the virtual area
in
windows which manage it.
-
+
@see wxScrolledWindow::SetScrollbars, SetVirtualSizeHints()
*/
void FitInside(wxWindow* window);
To make a sizer item disappear, use Hide() followed by Layout().
Use parameter @a recursive to hide elements found in subsizers.
Returns @true if the child item was found, @false otherwise.
-
+
@see IsShown(), Show()
*/
bool Hide(wxWindow* window, bool recursive = false);
//@{
/**
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.
*/
//@{
/**
Returns @true if the @e window, @e sizer, or item at @a index is shown.
-
+
@see Hide(), Show()
*/
bool IsShown(wxWindow* window) const;
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.
-
+
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.
the sizer's
minimal size. For windows with managed scrollbars this will set them
appropriately.
-
+
@see wxScrolledWindow::SetScrollbars
*/
void SetVirtualSizeHints(wxWindow* window);
To make a sizer item disappear or reappear, use Show() followed by Layout().
Use parameter @a recursive to show or hide elements found in subsizers.
Returns @true if the child item was found, @false otherwise.
-
+
@see Hide(), IsShown()
*/
bool Show(wxWindow* window, bool show = true,
};
+
/**
@class wxGridSizer
@wxheader{sizer.h}
@library{wxcore}
@category{winlayout}
- @seealso
- wxSizer, @ref overview_sizeroverview "Sizer overview"
+ @see wxSizer, @ref overview_sizeroverview "Sizer overview"
*/
class wxGridSizer : public wxSizer
{
};
+
/**
@class wxStaticBoxSizer
@wxheader{sizer.h}
@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
{
};
+
/**
@class wxBoxSizer
@wxheader{sizer.h}
@library{wxcore}
@category{winlayout}
- @seealso
- wxSizer, @ref overview_sizeroverview "Sizer overview"
+ @see wxSizer, @ref overview_sizeroverview "Sizer overview"
*/
class wxBoxSizer : public wxSizer
{
*/
void RecalcSizes();
};
+
projects / wxWidgets.git / blobdiff