From 8258c3ddbdd9dcfa2c8ea05c8dee702a096ff7e3 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Mon, 17 Apr 2006 17:01:16 +0000 Subject: [PATCH] document that Remove(index) doesn't delete the window neither (replaces patch 1470834) git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@38782 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/sizer.tex | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/latex/wx/sizer.tex b/docs/latex/wx/sizer.tex index 3c249db4e2..95ea5614f1 100644 --- a/docs/latex/wx/sizer.tex +++ b/docs/latex/wx/sizer.tex @@ -400,16 +400,18 @@ 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.