From: Francesco Montorsi <f18m_cpp217828@yahoo.it>
Date: Sat, 22 Nov 2008 12:29:09 +0000 (+0000)
Subject: fix docs for wxWindow::Layout (fixes #4297)
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/dcc5fcbf1fb4ac4622497d407402c04ed8c99a44

fix docs for wxWindow::Layout (fixes #4297)

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

diff --git a/interface/wx/panel.h b/interface/wx/panel.h
index 59acc6534a..f836f6c6a1 100644
--- a/interface/wx/panel.h
+++ b/interface/wx/panel.h
@@ -96,6 +96,12 @@ public:
     */
     virtual void InitDialog();
 
+    /**
+        See wxWindow::SetAutoLayout(): when auto layout is on, this function gets
+        called automatically when the window is resized.
+    */
+    virtual bool Layout();
+
     /**
         The default handler for wxEVT_SYS_COLOUR_CHANGED.
 
diff --git a/interface/wx/toplevel.h b/interface/wx/toplevel.h
index 2c30dada11..0806c2f21f 100644
--- a/interface/wx/toplevel.h
+++ b/interface/wx/toplevel.h
@@ -176,6 +176,12 @@ public:
     */
     bool IsUsingNativeDecorations() const;
 
+    /**
+        See wxWindow::SetAutoLayout(): when auto layout is on, this function gets
+        called automatically when the window is resized.
+    */
+    virtual bool Layout();
+
     /**
         Maximizes or restores the window.
 
diff --git a/interface/wx/window.h b/interface/wx/window.h
index 566bd781b2..b20b43dcde 100644
--- a/interface/wx/window.h
+++ b/interface/wx/window.h
@@ -1503,8 +1503,10 @@ public:
         Invokes the constraint-based layout algorithm or the sizer-based algorithm
         for this window.
 
-        See SetAutoLayout(): when auto layout is on, this function gets called automatically
-        when the window is resized.
+        This function does not get called automatically when the window is resized
+        because lots of windows deriving from wxWindow does not need this functionality.
+        If you want to have Layout() called automatically, you should derive
+        from wxPanel (see wxPanel::Layout).
 
         @see @ref overview_windowsizing
     */
@@ -1981,8 +1983,9 @@ public:
         updated when its size changes.
 
         @param autoLayout
-            Set this to @true if you wish the Layout function to be
-            called automatically when the window is resized.
+            Set this to @true if you wish the Layout() function to be
+            called automatically when the window is resized
+            (really happens only if you derive from wxPanel or wxTopLevelWindow).
 
         @see SetConstraints()
     */