]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/screendc.tex
Documented new menu label functions
[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{Library}
16
17\helpref{wxCore}{librarieslist}
18
19\wxheading{See also}
20
21\helpref{wxDC}{wxdc}, \helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxPaintDC}{wxpaintdc},\rtfsp
22\helpref{wxClientDC}{wxclientdc}, \helpref{wxWindowDC}{wxwindowdc}
23
24\latexignore{\rtfignore{\wxheading{Members}}}
25
26\membersection{wxScreenDC::wxScreenDC}\label{wxscreendcctor}
27
28\func{}{wxScreenDC}{\void}
29
30Constructor.
31
32\membersection{wxScreenDC::StartDrawingOnTop}\label{wxscreendcstartdrawingontop}
33
34\func{bool}{StartDrawingOnTop}{\param{wxWindow*}{ window}}
35
36\func{bool}{StartDrawingOnTop}{\param{wxRect*}{ rect = NULL}}
37
38Use this in conjunction with \helpref{EndDrawingOnTop}{wxscreendcenddrawingontop} to
39ensure that drawing to the screen occurs on top of existing windows. Without this,
40some window systems (such as X) only allow drawing to take place underneath
41other windows.
42
43By using the first form of this function, an application is specifying that
44the area that will be drawn on coincides with the given window.
45
46By using the second form, an application can specify an area of the screen
47which is to be drawn on. If NULL is passed, the whole screen is available.
48
49It is recommended that an area of the screen is specified because with large regions,
50flickering effects are noticeable when destroying the temporary transparent window used
51to implement this feature.
52
53You might use this pair of functions when implementing a drag feature, for example
54as in the \helpref{wxSplitterWindow}{wxsplitterwindow} implementation.
55
56\wxheading{Remarks}
57
58This function is probably obsolete since the X implementations
59allow drawing directly on the screen now. However, the fact that this
60function allows the screen to be refreshed afterwards, may be useful to
61some applications.
62
63\membersection{wxScreenDC::EndDrawingOnTop}\label{wxscreendcenddrawingontop}
64
65\func{bool}{EndDrawingOnTop}{\void}
66
67Use this in conjunction with \helpref{StartDrawingOnTop}{wxscreendcstartdrawingontop}.
68
69This function destroys the temporary window created to implement on-top drawing (X only).
70