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