docs/latex/wx/paintdc.tex

   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. If you have an OnPaint handler, you {\it must} create a wxPaintDC
   7 object within it even if you don't actually use it.
   8
   9 Using wxPaintDC within OnPaint is important because it automatically
  10 sets the clipping area to the damaged area of the window. Attempts to draw
  11 outside this area do not appear.
  12
  13 To draw on a window from outside {\bf OnPaint}, construct a \helpref{wxClientDC}{wxclientdc} object.
  14
  15 To draw on the whole window including decorations, construct a \helpref{wxWindowDC}{wxwindowdc} object
  16 (Windows only).
  17
  18 \wxheading{Derived from}
  19
  20 \helpref{wxWindowDC}{wxwindowdc}\\
  21 \helpref{wxDC}{wxdc}\\
  22 \helpref{wxObject}{wxobject}
  23
  24 \wxheading{Include files}
  25
  26 <wx/dcclient.h>
  27
  28 \wxheading{Library}
  29
  30 \helpref{wxCore}{librarieslist}
  31
  32 \wxheading{See also}
  33
  34 \helpref{wxDC}{wxdc}, \helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxPaintDC}{wxpaintdc},\rtfsp
  35 \helpref{wxWindowDC}{wxwindowdc}, \helpref{wxScreenDC}{wxscreendc}
  36
  37 \latexignore{\rtfignore{\wxheading{Members}}}
  38
  39 \membersection{wxPaintDC::wxPaintDC}\label{wxpaintdcctor}
  40
  41 \func{}{wxPaintDC}{\param{wxWindow*}{ window}}
  42
  43 Constructor. Pass a pointer to the window on which you wish to paint.
  44
  45
  46