Make wxSizeEvent::GetSize() description more precise.

Mention that it returns the new total (and not client) size of the window.

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

diff --git a/interface/wx/event.h b/interface/wx/event.h
index cc24d5bcb4502644092c2f5968d5f0725ac51076..3365304b3fc2893d4fb0a4ed3aa8e65ec4a9aef3 100644 (file)
--- a/interface/wx/event.h
+++ b/interface/wx/event.h
@@ -3660,7 +3660,7 @@ public:
 
     You may wish to use this for frames to resize their child windows as appropriate.
 
 
     You may wish to use this for frames to resize their child windows as appropriate.
 

-    Note that the size passed is of the whole window: call wxWindow::GetClientSize
+    Note that the size passed is of the whole window: call wxWindow::GetClientSize()

     for the area which may be used by the application.
 
     When a window is resized, usually only a small part of the window is damaged
     for the area which may be used by the application.
 
     When a window is resized, usually only a small part of the window is damaged


@@ -3688,6 +3688,11 @@ public:
 
     /**
         Returns the entire size of the window generating the size change event.
 
     /**
         Returns the entire size of the window generating the size change event.

+
+        This is the new total size of the window, i.e. the same size as would
+        be returned by wxWindow::GetSize() if it were called now. Use
+        wxWindow::GetClientSize() if you catch this event in a top level window
+        such as wxFrame to find the size available for the window contents.

     */
     wxSize GetSize() const;
 };
     */
     wxSize GetSize() const;
 };