From: Václav Slavík <vslavik@fastmail.fm>
Date: Sat, 22 Mar 2008 14:43:36 +0000 (+0000)
Subject: documented that Freeze and Thaw are now recursive
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/a7c01bb15548f1701e2b1d401f1db19d9b9a327f

documented that Freeze and Thaw are now recursive

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52694 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/docs/changes.txt b/docs/changes.txt
index eea40fac66..7fd21dcaa6 100644
--- a/docs/changes.txt
+++ b/docs/changes.txt
@@ -281,11 +281,12 @@ All (GUI):
   behaviour of GetNextSibling() consistent between wxMSW and generic versions.
 - Merged wxRichTextAttr and wxTextAttrEx into wxTextAttr, and added a font table
   to wxRichTextBuffer to reduce wxFont consumption and increase performance.
-- Optimize wxGenericTreeCtrl::Collapse/ExpandAllChildren(). (Szczepan Holyszewski)
+- Optimize wxGenericTreeCtrl::Collapse/ExpandAllChildren()
+  (Szczepan Holyszewski).
 - Added <scrollrate> parameter to wxScrolledWindow XRC handler.
-- Added support for automatic dialog scrolling, via the new wxDialogLayoutAdapter
-  class and various new wxDialog functions. See the topic "Automatic Scrolling
-  Dialogs" in the manual for further details.
+- Added support for automatic dialog scrolling, via the new
+  wxDialogLayoutAdapter class and various new wxDialog functions. See the
+  topic "Automatic Scrolling Dialogs" in the manual for further details.
 - Added support for resizing wxWizard bitmaps to the current page height,
   via SetBitmapPlacement, SetBitmapBackgroundColour and SetMinimumBitmapWidth.
   Also made it easier to derive from wxWizard and override behaviour.
@@ -294,7 +295,8 @@ All (GUI):
 - Added wxWindow::HasFocus().
 - Added wxGLCanvas::IsDisplaySupported().
 - Added wxApp::SetNativeTheme() (Stefan H.).
-- Made wxSpinCtrl::Reparent() in MSW and generic versions (Angelo Mottola)
+- Made wxSpinCtrl::Reparent() in MSW and generic versions (Angelo Mottola).
+- Freeze() and Thaw() now recursively freeze/thaw the children too.
 
 wxGTK:
 
diff --git a/interface/window.h b/interface/window.h
index 17d68f60a0..39677f024f 100644
--- a/interface/window.h
+++ b/interface/window.h
@@ -564,18 +564,23 @@ public:
     virtual void FitInside();
 
     /**
-        Freezes the window or, in other words, prevents any updates from taking place
-        on screen, the window is not redrawn at all. Thaw() must
-        be called to reenable window redrawing. Calls to these two functions may be
-        nested but to ensure that the window is properly repainted again, you must thaw
-        it exactly as many times as you froze it.
-        This method is useful for visual appearance optimization (for example, it
-        is a good idea to use it before doing many large text insertions in a row into
-        a wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all
-        controls so it is mostly just a hint to wxWidgets and not a mandatory
-        directive.
-
-        @see wxWindowUpdateLocker
+        Freezes the window or, in other words, prevents any updates from taking
+        place on screen, the window is not redrawn at all.
+
+        Thaw() must be called to reenable window redrawing. Calls to these two
+        functions may be nested but to ensure that the window is properly
+        repainted again, you must thaw it exactly as many times as you froze
+        it.
+
+        If the window has any children, they are recursively frozen too.
+
+        This method is useful for visual appearance optimization (for example,
+        it is a good idea to use it before doing many large text insertions in
+        a row into a wxTextCtrl under wxGTK) but is not implemented on all
+        platforms nor for all controls so it is mostly just a hint to wxWidgets
+        and not a mandatory directive.
+
+        @see wxWindowUpdateLocker, Thaw(), IsFrozen()
     */
     virtual void Freeze();
 
@@ -1315,7 +1320,7 @@ public:
         Returns @true if the window is currently frozen by a call to
         Freeze().
 
-        @see Thaw()
+        @see Freeze(), Thaw()
     */
     virtual bool IsFrozen() const;
 
@@ -2461,11 +2466,14 @@ public:
                                 wxDirection dir = wxBOTTOM);
 
     /**
-        Reenables window updating after a previous call to
-        Freeze(). To really thaw the control, it must be called
-        exactly the same number of times as Freeze().
+        Reenables window updating after a previous call to Freeze().
+
+        To really thaw the control, it must be called exactly the same number
+        of times as Freeze().
+
+        If the window has any children, they are recursively thawn too.
 
-        @see wxWindowUpdateLocker
+        @see wxWindowUpdateLocker, Freeze(), IsFrozen()
     */
     virtual void Thaw();