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