docs/latex/wx/screendc.tex

   1 \section{\class{wxScreenDC}}\label{wxscreendc}
   2
   3 A wxScreenDC can be used to paint on the screen.
   4 This should normally be constructed as a temporary stack object; don't store
   5 a wxScreenDC object.
   6
   7 \wxheading{Derived from}
   8
   9 \helpref{wxDC}{wxdc}
  10
  11 \wxheading{Include files}
  12
  13 <wx/dcscreen.h>
  14
  15 \wxheading{See also}
  16
  17 \helpref{wxDC}{wxdc}, \helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxPaintDC}{wxpaintdc},\rtfsp
  18 \helpref{wxClientDC}{wxclientdc}, \helpref{wxWindowDC}{wxwindowdc}
  19
  20 \latexignore{\rtfignore{\wxheading{Members}}}
  21
  22 \membersection{wxScreenDC::wxScreenDC}\label{wxscreendcctor}
  23
  24 \func{}{wxScreenDC}{\void}
  25
  26 Constructor.
  27
  28 \membersection{wxScreenDC::StartDrawingOnTop}\label{wxscreendcstartdrawingontop}
  29
  30 \func{bool}{StartDrawingOnTop}{\param{wxWindow*}{ window}}
  31
  32 \func{bool}{StartDrawingOnTop}{\param{wxRect*}{ rect = NULL}}
  33
  34 Use this in conjunction with \helpref{EndDrawingOnTop}{wxscreendcenddrawingontop} to
  35 ensure that drawing to the screen occurs on top of existing windows. Without this,
  36 some window systems (such as X) only allow drawing to take place underneath
  37 other windows.
  38
  39 By using the first form of this function, an application is specifying that
  40 the area that will be drawn on coincides with the given window.
  41
  42 By using the second form, an application can specify an area of the screen
  43 which is to be drawn on. If NULL is passed, the whole screen is available.
  44
  45 It is recommended that an area of the screen is specified because with large regions,
  46 flickering effects are noticeable when destroying the temporary transparent window used
  47 to implement this feature.
  48
  49 You might use this pair of functions when implementing a drag feature, for example
  50 as in the \helpref{wxSplitterWindow}{wxsplitterwindow} implementation.
  51
  52 \wxheading{Remarks}
  53
  54 This function is probably obsolete since the X implementations
  55 allow drawing directly on the screen now. However, the fact that this
  56 function allows the screen to be refreshed afterwards, may be useful to
  57 some applications.
  58
  59 \membersection{wxScreenDC::EndDrawingOnTop}\label{wxscreendcenddrawingontop}
  60
  61 \func{bool}{EndDrawingOnTop}{\void}
  62
  63 Use this in conjunction with \helpref{StartDrawingOnTop}{wxscreendcstartdrawingontop}.
  64
  65 This function destroys the temporary window created to implement on-top drawing (X only).
  66