docs/latex/wx/eraseevt.tex

   1 \section{\class{wxEraseEvent}}\label{wxeraseevent}
   2
   3 An erase event is sent when a window's background needs to be repainted.
   4
   5 \wxheading{Derived from}
   6
   7 \helpref{wxEvent}{wxevent}\\
   8 \helpref{wxObject}{wxobject}
   9
  10 \wxheading{Include files}
  11
  12 <wx/event.h>
  13
  14 \wxheading{Event table macros}
  15
  16 To process an erase event, use this event handler macro to direct input to a member
  17 function that takes a wxEraseEvent argument.
  18
  19 \twocolwidtha{7cm}
  20 \begin{twocollist}\itemsep=0pt
  21 \twocolitem{{\bf EVT\_ERASE\_BACKGROUND(func)}}{Process a wxEVT\_ERASE\_BACKGROUND event.}
  22 \end{twocollist}%
  23
  24 \wxheading{Remarks}
  25
  26 If the {\bf m\_DC} member is non-NULL, draw into this device context.
  27
  28 \wxheading{See also}
  29
  30 \helpref{wxWindow::OnEraseBackground}{wxwindowonerasebackground}, \helpref{Event handling overview}{eventhandlingoverview}
  31
  32 \latexignore{\rtfignore{\wxheading{Members}}}
  33
  34 \membersection{wxEraseEvent::wxEraseEvent}
  35
  36 \func{}{wxEraseEvent}{\param{int }{id = 0}, \param{wxDC* }{dc = NULL}}
  37
  38 Constructor.
  39
  40 \membersection{wxEraseEvent::m\_dc}
  41
  42 \member{wxDC*}{m\_dc}
  43
  44 The device context associated with the erase event (may be NULL).
  45
  46 \membersection{wxEraseEvent::GetDC}\label{wxeraseeventgetdc}
  47
  48 \constfunc{wxDC*}{GetDC}{\void}
  49
  50 Returns the device context to draw into. If this is non-NULL, you should draw
  51 into it to perform the erase operation.
  52