rename UpdatePulse() to Pulse() (forgot to commit with the rest of the changes)

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

diff --git a/docs/latex/wx/sizeevt.tex b/docs/latex/wx/sizeevt.tex
index a06d99fa76112f6eee2d60134ddbfaf68dd4faa9..096ad48e5914d2976163201fe4dd2dc545d8c01f 100644 (file)
--- a/docs/latex/wx/sizeevt.tex
+++ b/docs/latex/wx/sizeevt.tex
@@ -1,12 +1,40 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        sizeevt.tex
+%% Purpose:     wxSizeEvent documentation
+%% Author:      wxWidgets team
+%% Modified by:
+%% Created:
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWidgets team
+%% License:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+

 \section{\class{wxSizeEvent}}\label{wxsizeevent}
 
 A size event holds information about size change events.
 
 \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}\\
 \helpref{wxObject}{wxobject}
 
 \wxheading{Derived from}
 
 \helpref{wxEvent}{wxevent}\\
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/event.h>
+

 \wxheading{Event table macros}
 
 To process a size event, use this event handler macro to direct input to a member
 \wxheading{Event table macros}
 
 To process a size event, use this event handler macro to direct input to a member


@@ -19,11 +47,12 @@ function that takes a wxSizeEvent argument.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxWindow::OnSize}{wxwindowonsize}, \helpref{wxSize}{wxsize}, \helpref{Event handling overview}{eventhandlingoverview}
+\helpref{wxSize}{wxsize},\rtfsp
+\helpref{Event handling overview}{eventhandlingoverview}

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxSizeEvent::wxSizeEvent}
+\membersection{wxSizeEvent::wxSizeEvent}\label{wxsizeeventctor}

 
 \func{}{wxSizeEvent}{\param{const wxSize\& }{sz}, \param{int }{id = 0}}
 
 
 \func{}{wxSizeEvent}{\param{const wxSize\& }{sz}, \param{int }{id = 0}}