Doc tweaks

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

diff --git a/docs/latex/wx/sizeevt.tex b/docs/latex/wx/sizeevt.tex
index 361b9ac49f99730fc6ce34293a15f38b4dc3d4b8..3a54aba90c2f78869a46d8a852c204d8767c32b1 100644 (file)
--- a/docs/latex/wx/sizeevt.tex
+++ b/docs/latex/wx/sizeevt.tex
@@ -1,18 +1,31 @@
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %% Name:        sizeevt.tex
 %% Purpose:     wxSizeEvent documentation
-%% Author:      wxWindows team
+%% Author:      wxWidgets team
 %% Modified by:
 %% Created:
 %% RCS-ID:      $Id$
-%% Copyright:   (c) wxWindows team
-%% License:     wxWindows license
+%% Copyright:   (c) wxWidgets team
+%% License:     wxWidgets license
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxSizeEvent}}\label{wxsizeevent}
 
 A size event holds information about size change events.
 
+The EVT\_SIZE handler function will be called when the window has been resized.
+
+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 \helpref{wxWindow::GetClientSize}{wxwindowgetclientsize} 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 and you
+may only need to repaint that area. However, if your drawing depends on the size of the window,
+you may need to clear the DC explicitly and repaint the whole window. In which case, you
+may need to call \helpref{wxWindow::Refresh}{wxwindowrefresh} to invalidate the entire window.
+
 \wxheading{Derived from}
 
 \helpref{wxEvent}{wxevent}\\
@@ -39,7 +52,7 @@ function that takes a wxSizeEvent argument.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxSizeEvent::wxSizeEvent}
+\membersection{wxSizeEvent::wxSizeEvent}\label{wxsizeeventctor}
 
 \func{}{wxSizeEvent}{\param{const wxSize\& }{sz}, \param{int }{id = 0}}