]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/screendc.tex
silence gcc warnings about values not handled in switch
[wxWidgets.git] / docs / latex / wx / screendc.tex
... / ...
CommitLineData
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{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
26Constructor.
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
34Use this in conjunction with \helpref{EndDrawingOnTop}{wxscreendcenddrawingontop} to
35ensure that drawing to the screen occurs on top of existing windows. Without this,
36some window systems (such as X) only allow drawing to take place underneath
37other windows.
38
39By using the first form of this function, an application is specifying that
40the area that will be drawn on coincides with the given window.
41
42By using the second form, an application can specify an area of the screen
43which is to be drawn on. If NULL is passed, the whole screen is available.
44
45It is recommended that an area of the screen is specified because with large regions,
46flickering effects are noticeable when destroying the temporary transparent window used
47to implement this feature.
48
49You might use this pair of functions when implementing a drag feature, for example
50as in the \helpref{wxSplitterWindow}{wxsplitterwindow} implementation.
51
52\wxheading{Remarks}
53
54This function is probably obsolete since the X implementations
55allow drawing directly on the screen now. However, the fact that this
56function allows the screen to be refreshed afterwards, may be useful to
57some applications.
58
59\membersection{wxScreenDC::EndDrawingOnTop}\label{wxscreendcenddrawingontop}
60
61\func{bool}{EndDrawingOnTop}{\void}
62
63Use this in conjunction with \helpref{StartDrawingOnTop}{wxscreendcstartdrawingontop}.
64
65This function destroys the temporary window created to implement on-top drawing (X only).
66