docs/latex/wx/sizeevt.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        sizeevt.tex
   3 %% Purpose:     wxSizeEvent documentation
   4 %% Author:      wxWindows team
   5 %% Modified by:
   6 %% Created:
   7 %% RCS-ID:      $Id$
   8 %% Copyright:   (c) wxWindows team
   9 %% License:     wxWindows license
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 \section{\class{wxSizeEvent}}\label{wxsizeevent}
  13
  14 A size event holds information about size change events.
  15
  16 The EVT\_SIZE handler function will be called when the window has been resized.
  17
  18 You may wish to use this for frames to resize their child windows as appropriate.
  19
  20 Note that the size passed is of
  21 the whole window: call \helpref{wxWindow::GetClientSize}{wxwindowgetclientsize} for the area which may be
  22 used by the application.
  23
  24 When a window is resized, usually only a small part of the window is damaged and you
  25 may only need to repaint that area. However, if your drawing depends on the size of the window,
  26 you may need to clear the DC explicitly and repaint the whole window. In which case, you
  27 may need to call \helpref{wxWindow::Refresh}{wxwindowrefresh} to invalidate the entire window.
  28
  29 \wxheading{Derived from}
  30
  31 \helpref{wxEvent}{wxevent}\\
  32 \helpref{wxObject}{wxobject}
  33
  34 \wxheading{Include files}
  35
  36 <wx/event.h>
  37
  38 \wxheading{Event table macros}
  39
  40 To process a size event, use this event handler macro to direct input to a member
  41 function that takes a wxSizeEvent argument.
  42
  43 \twocolwidtha{7cm}
  44 \begin{twocollist}\itemsep=0pt
  45 \twocolitem{{\bf EVT\_SIZE(func)}}{Process a wxEVT\_SIZE event.}
  46 \end{twocollist}%
  47
  48 \wxheading{See also}
  49
  50 \helpref{wxSize}{wxsize},\rtfsp
  51 \helpref{Event handling overview}{eventhandlingoverview}
  52
  53 \latexignore{\rtfignore{\wxheading{Members}}}
  54
  55 \membersection{wxSizeEvent::wxSizeEvent}
  56
  57 \func{}{wxSizeEvent}{\param{const wxSize\& }{sz}, \param{int }{id = 0}}
  58
  59 Constructor.
  60
  61 \membersection{wxSizeEvent::GetSize}\label{wxsizeeventgetsize}
  62
  63 \constfunc{wxSize}{GetSize}{\void}
  64
  65 Returns the entire size of the window generating the size change event.
  66