[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{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}

If the {\bf m\_DC} member is non-NULL, draw into this device context.

\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 (may be NULL).

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

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

Returns the device context to draw into. If this is non-NULL, you should draw
into it to perform the erase operation.
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
	10	\wxheading{Event table macros}
	11
	12	To process an erase event, use this event handler macro to direct input to a member
	13	function that takes a wxEraseEvent argument.
	14
	15	\twocolwidtha{7cm}
	16	\begin{twocollist}\itemsep=0pt
884360bc	17	\twocolitem{{\bf EVT\_ERASE\_BACKGROUND(func)}}{Process a wxEVT\_ERASE\_BACKGROUND event.}
a660d684 KB	18	\end{twocollist}%
	19
	20	\wxheading{Remarks}
	21
	22	If the {\bf m\_DC} member is non-NULL, draw into this device context.
	23
	24	\wxheading{See also}
	25
	26	\helpref{wxWindow::OnEraseBackground}{wxwindowonerasebackground}, \helpref{Event handling overview}{eventhandlingoverview}
	27
	28	\latexignore{\rtfignore{\wxheading{Members}}}
	29
	30	\membersection{wxEraseEvent::wxEraseEvent}
	31
	32	\func{}{wxEraseEvent}{\param{int }{id = 0}, \param{wxDC* }{dc = NULL}}
	33
	34	Constructor.
	35
	36	\membersection{wxEraseEvent::m\_dc}
	37
	38	\member{wxDC*}{m\_dc}
	39
	40	The device context associated with the erase event (may be NULL).
	41
	42	\membersection{wxEraseEvent::GetDC}\label{wxeraseeventgetdc}
	43
	44	\constfunc{wxDC*}{GetDC}{\void}
	45
	46	Returns the device context to draw into. If this is non-NULL, you should draw
	47	into it to perform the erase operation.
	48