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

\section{\class{wxPaintDC}}\label{wxpaintdc}

A wxPaintDC must be constructed if an application wishes to paint on the
client area of a window from within an {\bf OnPaint} event.
This should normally be constructed as a temporary stack object; don't store
a wxPaintDC object.

Using wxPaintDC within OnPaint is important because it automatically
sets the clipping area to the damaged area of the window. Attempts to draw
outside this area do not appear.

To draw on a window from outside {\bf OnPaint}, construct a \helpref{wxClientDC}{wxclientdc} object.

To draw on the whole window including decorations, construct a \helpref{wxWindowDC}{wxwindowdc} object
(Windows only).

\wxheading{Derived from}

\helpref{wxDC}{wxdc}

\wxheading{See also}

\helpref{wxDC}{wxdc}, \helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxPaintDC}{wxpaintdc},\rtfsp
\helpref{wxWindowDC}{wxwindowdc}, \helpref{wxScreenDC}{wxscreendc}

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

\membersection{wxPaintDC::wxPaintDC}

\func{}{wxPaintDC}{\param{wxWindow*}{ window}}

Constructor. Pass a pointer to the window on which you wish to paint.
Commit	Line	Data
a660d684 KB	1	\section{\class{wxPaintDC}}\label{wxpaintdc}
	2
	3	A wxPaintDC must be constructed if an application wishes to paint on the
	4	client area of a window from within an {\bf OnPaint} event.
	5	This should normally be constructed as a temporary stack object; don't store
	6	a wxPaintDC object.
	7
884360bc JS	8	Using wxPaintDC within OnPaint is important because it automatically
	9	sets the clipping area to the damaged area of the window. Attempts to draw
	10	outside this area do not appear.
	11
a660d684 KB	12	To draw on a window from outside {\bf OnPaint}, construct a \helpref{wxClientDC}{wxclientdc} object.
	13
	14	To draw on the whole window including decorations, construct a \helpref{wxWindowDC}{wxwindowdc} object
	15	(Windows only).
	16
	17	\wxheading{Derived from}
	18
	19	\helpref{wxDC}{wxdc}
	20
	21	\wxheading{See also}
	22
	23	\helpref{wxDC}{wxdc}, \helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxPaintDC}{wxpaintdc},\rtfsp
	24	\helpref{wxWindowDC}{wxwindowdc}, \helpref{wxScreenDC}{wxscreendc}
	25
	26	\latexignore{\rtfignore{\wxheading{Members}}}
	27
	28	\membersection{wxPaintDC::wxPaintDC}
	29
	30	\func{}{wxPaintDC}{\param{wxWindow*}{ window}}
	31
	32	Constructor. Pass a pointer to the window on which you wish to paint.
	33
	34
	35