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

\section{\class{wxEraseEvent}}\label{wxeraseevent}

An erase event is sent when a window's background needs to be repainted.

\wxheading{Derived from}

\helpref{wxEvent}{wxevent}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/event.h>

\wxheading{Event table macros}

To process an erase event, use this event handler macro to direct input to a member
function that takes a wxEraseEvent argument.

\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_ERASE\_BACKGROUND(func)}}{Process a wxEVT\_ERASE\_BACKGROUND event.}
\end{twocollist}%

\wxheading{Remarks}

Use the {\bf m\_DC} device context to draw into, don't create wxPaintDC in 
the event handler.

\wxheading{See also}

\helpref{wxWindow::OnEraseBackground}{wxwindowonerasebackground}, \helpref{Event handling overview}{eventhandlingoverview}

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

\membersection{wxEraseEvent::wxEraseEvent}

\func{}{wxEraseEvent}{\param{int }{id = 0}, \param{wxDC* }{dc = NULL}}

Constructor.

\membersection{wxEraseEvent::m\_dc}

\member{wxDC*}{m\_dc}

The device context associated with the erase event.

\membersection{wxEraseEvent::GetDC}\label{wxeraseeventgetdc}

\constfunc{wxDC*}{GetDC}{\void}

Returns the device context to draw into.
Commit	Line	Data
a660d684 KB	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
954b8ae6 JS	10	\wxheading{Include files}
	11
	12	<wx/event.h>
	13
a660d684 KB	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
884360bc	21	\twocolitem{{\bf EVT\_ERASE\_BACKGROUND(func)}}{Process a wxEVT\_ERASE\_BACKGROUND event.}
a660d684 KB	22	\end{twocollist}%
	23
	24	\wxheading{Remarks}
	25
dce5c1db VS	26	Use the {\bf m\_DC} device context to draw into, don't create wxPaintDC in
dce5c1db VS	27	the event handler.
a660d684 KB	28
	29	\wxheading{See also}
	30
	31	\helpref{wxWindow::OnEraseBackground}{wxwindowonerasebackground}, \helpref{Event handling overview}{eventhandlingoverview}
	32
	33	\latexignore{\rtfignore{\wxheading{Members}}}
	34
	35	\membersection{wxEraseEvent::wxEraseEvent}
	36
	37	\func{}{wxEraseEvent}{\param{int }{id = 0}, \param{wxDC* }{dc = NULL}}
	38
	39	Constructor.
	40
	41	\membersection{wxEraseEvent::m\_dc}
	42
	43	\member{wxDC*}{m\_dc}
	44
dce5c1db	45	The device context associated with the erase event.
a660d684 KB	46
	47	\membersection{wxEraseEvent::GetDC}\label{wxeraseeventgetdc}
	48
	49	\constfunc{wxDC*}{GetDC}{\void}
	50
dce5c1db	51	Returns the device context to draw into.
a660d684	52