]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/paintdc.tex
correction for Mac OS compilation
[wxWidgets.git] / docs / latex / wx / paintdc.tex
CommitLineData
a660d684
KB
1\section{\class{wxPaintDC}}\label{wxpaintdc}
2
3A wxPaintDC must be constructed if an application wishes to paint on the
4client area of a window from within an {\bf OnPaint} event.
5This should normally be constructed as a temporary stack object; don't store
f60d0f94
JS
6a wxPaintDC object. If you have an OnPaint handler, you {\it must} create a wxPaintDC
7object within it even if you don't actually use it.
a660d684 8
884360bc
JS
9Using wxPaintDC within OnPaint is important because it automatically
10sets the clipping area to the damaged area of the window. Attempts to draw
11outside this area do not appear.
12
a660d684
KB
13To draw on a window from outside {\bf OnPaint}, construct a \helpref{wxClientDC}{wxclientdc} object.
14
15To draw on the whole window including decorations, construct a \helpref{wxWindowDC}{wxwindowdc} object
16(Windows only).
17
18\wxheading{Derived from}
19
f53561f1 20\helpref{wxWindowDC}{wxwindowdc}\\
a660d684
KB
21\helpref{wxDC}{wxdc}
22
954b8ae6
JS
23\wxheading{Include files}
24
25<wx/dcclient.h>
26
a660d684
KB
27\wxheading{See also}
28
29\helpref{wxDC}{wxdc}, \helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxPaintDC}{wxpaintdc},\rtfsp
30\helpref{wxWindowDC}{wxwindowdc}, \helpref{wxScreenDC}{wxscreendc}
31
32\latexignore{\rtfignore{\wxheading{Members}}}
33
34\membersection{wxPaintDC::wxPaintDC}
35
36\func{}{wxPaintDC}{\param{wxWindow*}{ window}}
37
38Constructor. Pass a pointer to the window on which you wish to paint.
39
40
41