Apply patch [ 1554736 ] wxXmlDocument::DetachRoot

[wxWidgets.git] / docs / latex / wx / sizer.tex

diff --git a/docs/latex/wx/sizer.tex b/docs/latex/wx/sizer.tex
index 3c249db4e27e13545294f0cbb12d0f8925d12179..c1961173964c495e6d52732df1bee9cb03f329cf 100644 (file)
--- a/docs/latex/wx/sizer.tex
+++ b/docs/latex/wx/sizer.tex
@@ -133,13 +133,13 @@ use that size to calculate the layout. This allows layouts to
 adjust when an item changes and its \arg{best size} becomes
 different. If you would rather have a window item stay the size it
 started with then use wxFIXED\_MINSIZE.}
-\twocolitem{\windowstyle{wxALIGN\_CENTER}\\
+\twocolitem{\windowstyle{wxALIGN\_CENTER wxALIGN\_CENTRE}\\
 \windowstyle{wxALIGN\_LEFT}\\
 \windowstyle{wxALIGN\_RIGHT}\\
 \windowstyle{wxALIGN\_TOP}\\
 \windowstyle{wxALIGN\_BOTTOM}\\
-\windowstyle{wxALIGN\_CENTER\_VERTICAL}\\
-\windowstyle{wxALIGN\_CENTER\_HORIZONTAL}}{The wxALIGN flags allow you to
+\windowstyle{wxALIGN\_CENTER\_VERTICAL wxALIGN\_CENTRE\_VERTICAL}\\
+\windowstyle{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.}
 \end{twocollist}
@@ -233,6 +233,13 @@ windows which manage it.
 \helpref{wxSizer::SetVirtualSizeHints}{wxsizersetvirtualsizehints}
 
 
+\membersection{wxSizer::GetContainingWindow}\label{wxsizergetcontainingwindow}
+
+\constfunc{wxWindow *}{GetContainingWindow}{\void}
+
+Returns the window this sizer is used in or \NULL if none.
+
+
 \membersection{wxSizer::GetItem}\label{wxsizergetitem}
 
 \func{wxSizerItem *}{GetItem}{\param{wxWindow* }{window}, \param{bool }{recursive = false}}
@@ -400,16 +407,42 @@ and sizes.
 
 \func{bool}{Remove}{\param{size\_t }{index}}
 
-Removes a child from the sizer and destroys it.  \arg{sizer} is the wxSizer to be removed,
-\arg{index} is the position of the child in the sizer, typically 0 for the first item.
+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).  \arg{sizer} is the wxSizer to be removed,
+\arg{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
 \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.
+{\bf 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 
+\helpref{wxSizer::Detach}{wxsizerdetach} 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.
+
+
+\membersection{wxSizer::Replace}\label{wxsizerreplace}
+
+\func{bool}{Replace}{\param{wxWindow* }{oldwin}, \param{wxWindow* }{newwin}, \param{bool }{recursive = false}}
+
+\func{bool}{Replace}{\param{wxSizer* }{oldsz}, \param{wxSizer* }{newsz}, \param{bool }{recursive = false}}
+
+\func{bool}{Remove}{\param{size\_t }{oldindex}, \param{wxSizerItem* }{newitem}}
+
+Detaches the given \arg{oldwin}, \arg{oldsz} child from the sizer and 
+replaces it with the given window, sizer, or wxSizerItem.
+
+The detached child is removed {\bf only} if it is a sizer or a spacer
+(because windows are owned by their parent window, not the sizer).
+
+Use parameter \arg{recursive} to search the given element recursively in subsizers.
+
+
+This method does not cause any layout or resizing to take place, call
+\helpref{wxSizer::Layout}{wxsizerlayout} 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.