\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxSizer::wxSizer}\label{wxsizerwxsizer}
\func{}{wxSizer}{\void}
The constructor. Note that wxSizer is an abstract base class and may not
be instantiated.
+
\membersection{wxSizer::\destruct{wxSizer}}\label{wxsizerdtor}
\func{}{\destruct{wxSizer}}{\void}
The destructor.
+
\membersection{wxSizer::Add}\label{wxsizeradd}
\func{void}{Add}{\param{wxWindow* }{window}, \param{int }{proportion = 0},\param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
\func{void}{Add}{\param{int }{width}, \param{int }{height}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
-Adds the {\it window} to the sizer. As wxSizer itself is an abstract class, the parameters
-have no meaning in the wxSizer class itself, but as there currently is only one class
-deriving directly from wxSizer and this class does not override these methods, the meaning
-of the parameters is described here:
+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:
\docparam{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
their obvious meaning). With proportional resize, a child may also be centered
in the main orientation using wxALIGN\_CENTER\_VERTICAL (same as
wxALIGN\_CENTRE\_VERTICAL) and wxALIGN\_CENTER\_HORIZONTAL (same as
-wxALIGN\_CENTRE\_HORIZONTAL) flags. Finally, you can also specify
-wxADJUST\_MINSIZE flag to make the minimal size of the control dynamically adjust
-to the value returned by its \helpref{GetAdjustedBestSize()}{wxwindowgetadjustedbestsize}
-method - this allows, for example, for correct relayouting of a static text
-control even if its text is changed during run-time.}
+wxALIGN\_CENTRE\_HORIZONTAL) flags.}
\docparam{border}{Determines the border width, if the {\it flag} parameter is set to any border.}
item, for use in derived classes when sizing information is more
complex than the {\it proportion} and {\it flag} will allow for.}
+
\membersection{wxSizer::CalcMin}\label{wxsizercalcmin}
\func{wxSize}{CalcMin}{\void}
This method is abstract and has to be overwritten by any derived class.
Here, the sizer will do the actual calculation of its children minimal sizes.
+
+\membersection{wxSizer::Detach}\label{wxsizerdetach}
+
+\func{bool}{Detach}{\param{wxWindow* }{window}}
+
+\func{bool}{Detach}{\param{wxSizer* }{sizer}}
+
+\func{bool}{Detach}{\param{size\_t }{index}}
+
+Detach a child from the sizer without destroying it. {\it window} is the window to be
+detached, {\it sizer} is the equivalent sizer and {\it 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 \helpref{wxSizer::Layout}{wxsizerlayout}
+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.
+
+\wxheading{See also}
+
+\helpref{wxSizer::Remove}{wxsizerremove}
+
+
\membersection{wxSizer::Fit}\label{wxsizerfit}
\func{wxSize}{Fit}{\param{wxWindow* }{window}}
is commonly done in the constructor of the window itself, see sample in the description
of \helpref{wxBoxSizer}{wxboxsizer}. Returns the new size.
+For a top level window this is the total window size, not client size.
+
+
\membersection{wxSizer::FitInside}\label{wxsizerfitinside}
\func{void}{FitInside}{\param{wxWindow* }{window}}
\helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars},\rtfsp
\helpref{wxSizer::SetVirtualSizeHints}{wxsizersetvirtualsizehints}
+
\membersection{wxSizer::GetSize}\label{wxsizergetsize}
\func{wxSize}{GetSize}{\void}
Returns the current size of the sizer.
+
\membersection{wxSizer::GetPosition}\label{wxsizergetposition}
\func{wxPoint}{GetPosition}{\void}
Returns the current position of the sizer.
+
\membersection{wxSizer::GetMinSize}\label{wxsizergetminsize}
\func{wxSize}{GetMinSize}{\void}
size of all the children and their borders or the minimal size set by
\helpref{SetMinSize}{wxsizersetminsize}, depending on which is bigger.
+
+\membersection{wxSizer::Insert}\label{wxsizerinsert}
+
+\func{void}{Insert}{\param{size\_t }{index}, \param{wxWindow* }{window}, \param{int }{proportion = 0},\param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
+
+\func{void}{Insert}{\param{size\_t }{index}, \param{wxSizer* }{sizer}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
+
+\func{void}{Insert}{\param{size\_t }{index}, \param{int }{width}, \param{int }{height}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
+
+Insert a child into the sizer before any existing item at {\it index}.
+
+\docparam{index}{The position this child should assume in the sizer.}
+
+See \helpref{wxSizer::Add}{wxsizeradd} for the meaning of the other parameters.
+
+
\membersection{wxSizer::Layout}\label{wxsizerlayout}
\func{void}{Layout}{\void}
to or removed a child (window, other sizer or space) from the sizer while keeping
the current dimension.
+
\membersection{wxSizer::Prepend}\label{wxsizerprepend}
\func{void}{Prepend}{\param{wxWindow* }{window}, \param{int }{proportion = 0}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
Same as \helpref{wxSizer::Add}{wxsizeradd}, but prepends the items to the beginning of the
list of items (windows, subsizers or spaces) owned by this sizer.
+
\membersection{wxSizer::RecalcSizes}\label{wxsizerrecalcsizes}
\func{void}{RecalcSizes}{\void}
Here, the sizer will do the actual calculation of its children's positions
and sizes.
+
\membersection{wxSizer::Remove}\label{wxsizerremove}
\func{bool}{Remove}{\param{wxWindow* }{window}}
\func{bool}{Remove}{\param{wxSizer* }{sizer}}
-\func{bool}{Remove}{\param{int }{nth}}
+\func{bool}{Remove}{\param{size\_t }{index}}
+
+Removes a child from the sizer and destroys it. {\it sizer} is the wxSizer to be removed,
+{\it 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
+\helpref{wxSizer::Layout}{wxsizerlayout} to update the layout "on screen" after removing a
+child from the sizer.
+
+{\bf NB:} The method taking a wxWindow* parameter is deprecated. For historical reasons
+it does not destroy the window as would usually be expected from Remove. You should use
+\helpref{wxSizer::Detach}{wxsizerdetach} in new code instead. There is currently no wxSizer
+method that will both detach and destroy a wxWindow item.
-Removes a child from the sizer. {\it window} is the window to be removed, {\it sizer} is the
-equivalent sizer and {\it nth} 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 and does
-not delete the window itself. Call \helpref{wxSizer::Layout}{wxsizerlayout} to update
-the layout "on screen" after removing a child from the sizer.
+Returns true if the child item was found and removed, false otherwise.
-Returns TRUE if the child item was found and removed, FALSE otherwise.
\membersection{wxSizer::SetDimension}\label{wxsizersetdimension}
by the sizer to resize themselves according to the rules defined by the parameter in the
\helpref{Add}{wxsizeradd} and \helpref{Prepend}{wxsizerprepend} methods.
+
\membersection{wxSizer::SetMinSize}\label{wxsizersetminsize}
\func{void}{SetMinSize}{\param{int }{width}, \param{int }{height}}
as requested by its children or the minimal size set here, depending on which is
bigger.
+
\membersection{wxSizer::SetItemMinSize}\label{wxsizersetitemminsize}
\func{void}{SetItemMinSize}{\param{wxWindow* }{window}, \param{int}{ width}, \param{int}{ height}}
\func{void}{SetItemMinSize}{\param{wxSizer* }{sizer}, \param{int}{ width}, \param{int}{ height}}
-\func{void}{SetItemMinSize}{\param{int}{ pos}, \param{int}{ width}, \param{int}{ height}}
+\func{void}{SetItemMinSize}{\param{size\_t }{index}, \param{int}{ width}, \param{int}{ height}}
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.
+
\membersection{wxSizer::SetSizeHints}\label{wxsizersetsizehints}
\func{void}{SetSizeHints}{\param{wxWindow* }{window}}
see sample in the description of \helpref{wxBoxSizer}{wxboxsizer} if the window is resizable
(as are many dialogs under Unix and frames on probably all platforms).
+
\membersection{wxSizer::SetVirtualSizeHints}\label{wxsizersetvirtualsizehints}
\func{void}{SetVirtualSizeHints}{\param{wxWindow* }{window}}
\helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars}
+
\membersection{wxSizer::Show}\label{wxsizershow}
-\func{void}{Show}{\param{wxWindow* }{window}, \param{bool }{show = TRUE}}
+\func{void}{Show}{\param{wxWindow* }{window}, \param{bool }{show = true}}
+
+\func{void}{Show}{\param{wxSizer* }{sizer}, \param{bool }{show = true}}
+
+\func{void}{Show}{\param{size\_t }{index}, \param{bool }{show = true}}
-\func{void}{Show}{\param{wxSizer* }{sizer}, \param{bool }{show = TRUE}}
+Shows or hides the {\it window}, {\it sizer}, or item at {\it index}.
+To make a sizer item disappear or reappear, use Show() followed by Layout().
-Shows or hides a window or sizer. To make a sizer item disappear or
-reappear, use Show() followed by Layout().
+Note that this only works with wxBoxSizer and wxFlexGridSizer, since they
+are the only two sizer classes that can size rows/columns independently.
projects / wxWidgets.git / blobdiff