Doc tweaks

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

diff --git a/docs/latex/wx/sizeevt.tex b/docs/latex/wx/sizeevt.tex
index c30c12614cc65533019916ba7d031cbba554e018..3a54aba90c2f78869a46d8a852c204d8767c32b1 100644 (file)
--- a/docs/latex/wx/sizeevt.tex
+++ b/docs/latex/wx/sizeevt.tex
@@ -1,22 +1,31 @@
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %% Name:        sizeevt.tex
-%% Purpose:     wxSizeEvent and related event classes documentation
-%% Author:      wxWindows team
+%% Purpose:     wxSizeEvent documentation
+%% Author:      wxWidgets team
 %% Modified by:
 %% Created:
 %% RCS-ID:      $Id$
-%% Copyright:   (c) wxWindows team
-%% License:     wxWindows license
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% wxSizeEvent
+%% 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}\\
@@ -43,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}}
 
@@ -55,94 +64,3 @@ Constructor.
 
 Returns the entire size of the window generating the size change event.
 
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% wxIconizeEvent
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-\section{\class{wxIconizeEvent}}\label{wxiconizeevent}
-
-An event being sent when the frame is iconized (minimized) or restored.
-
-Currently only wxMSW and wxGTK generate such events.
-
-\wxheading{Derived from}
-
-\helpref{wxEvent}{wxevent}\\
-\helpref{wxObject}{wxobject}
-
-\wxheading{Include files}
-
-<wx/event.h>
-
-\wxheading{Event table macros}
-
-To process an iconize event, use this event handler macro to direct input to a
-member function that takes a wxIconizeEvent argument.
-
-\twocolwidtha{7cm}
-\begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf EVT\_ICONIZE(func)}}{Process a wxEVT\_ICONIZE event.}
-\end{twocollist}%
-
-\wxheading{See also}
-
-\helpref{Event handling overview}{eventhandlingoverview},\rtfsp
-\helpref{wxFrame::Iconize}{wxframeiconize},\rtfsp
-\helpref{wxFrame::IsIconized}{wxframeisiconized}
-
-\latexignore{\rtfignore{\wxheading{Members}}}
-
-\membersection{wxIconizeEvent::wxIconizeEvent}\label{wxiconizeeventctor}
-
-\func{}{wxIconizeEvent}{\param{int }{id = 0}, \param{bool }{iconized = TRUE}}
-
-Constructor.
-
-\membersection{wxIconizeEvent::Iconized}\label{wxiconizeeventiconized}
-
-\constfunc{bool}{Iconized}{\void}
-
-Returns {\tt TRUE} if the frame has been iconized, {\tt FALSE} if it has been
-restored.
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% wxMaximizeEvent
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-\section{\class{wxMaximizeEvent}}\label{wxmaximizeevent}
-
-An event being sent when the frame is maximized (minimized) or restored.
-
-\wxheading{Derived from}
-
-\helpref{wxEvent}{wxevent}\\
-\helpref{wxObject}{wxobject}
-
-\wxheading{Include files}
-
-<wx/event.h>
-
-\wxheading{Event table macros}
-
-To process a maximize event, use this event handler macro to direct input to a
-member function that takes a wxMaximizeEvent argument.
-
-\twocolwidtha{7cm}
-\begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf EVT\_MAXIMIZE(func)}}{Process a wxEVT\_MAXIMIZE event.}
-\end{twocollist}%
-
-\wxheading{See also}
-
-\helpref{Event handling overview}{eventhandlingoverview},\rtfsp
-\helpref{wxFrame::Maximize}{wxframemaximize},\rtfsp
-\helpref{wxFrame::IsMaximized}{wxframeismaximized}
-
-\latexignore{\rtfignore{\wxheading{Members}}}
-
-\membersection{wxMaximizeEvent::wxMaximizeEvent}\label{wxmaximizeeventctor}
-
-\func{}{wxMaximizeEvent}{\param{int }{id = 0}}
-
-Constructor.
-