1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.ScreenDC:
==========================================================================================================================================
|phoenix_title| **wx.ScreenDC**
==========================================================================================================================================
A :ref:`wx.ScreenDC` can be used to paint on the screen.
This should normally be constructed as a temporary stack object; don't store a :ref:`wx.ScreenDC` object.
.. seealso:: :ref:`wx.DC`, :ref:`wx.MemoryDC`, :ref:`wx.PaintDC`, :ref:`wx.ClientDC`, :ref:`wx.WindowDC`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>ScreenDC</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.ScreenDC_inheritance.png" alt="Inheritance diagram of ScreenDC" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Object.html" title="wx.Object" alt="" coords="17,5,99,35"/> <area shape="rect" id="node3" href="wx.DC.html" title="wx.DC" alt="" coords="23,83,95,112"/> <area shape="rect" id="node2" href="wx.ScreenDC.html" title="wx.ScreenDC" alt="" coords="5,160,112,189"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.ScreenDC.__init__` Constructor.
:meth:`~wx.ScreenDC.EndDrawingOnTop` Use this in conjunction with :meth:`~ScreenDC.StartDrawingOnTop` .
:meth:`~wx.ScreenDC.StartDrawingOnTop` Use this in conjunction with :meth:`~ScreenDC.EndDrawingOnTop` to ensure that drawing to the screen occurs on top of existing windows.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.ScreenDC(DC)
**Possible constructors**::
ScreenDC()
A ScreenDC can be used to paint on the screen.
.. method:: __init__(self)
Constructor.
.. staticmethod:: EndDrawingOnTop()
Use this in conjunction with :meth:`StartDrawingOnTop` .
This function destroys the temporary window created to implement on-top drawing (X only).
:rtype: `bool`
.. staticmethod:: StartDrawingOnTop(*args, **kw)
|overload| Overloaded Implementations:
**~~~**
**StartDrawingOnTop** `(window)`
Use this in conjunction with :meth:`EndDrawingOnTop` to ensure that drawing to the screen occurs on top of existing windows.
Without this, some window systems (such as X) only allow drawing to take place underneath other windows.
This version of :meth:`StartDrawingOnTop` is used to specify that the area that will be drawn on coincides with the given window. It is recommended that an area of the screen is specified with :meth:`StartDrawingOnTop` because with large regions, flickering effects are noticeable when destroying the temporary transparent window used to implement this feature.
You might use this function when implementing a drag feature, for example as in the :ref:`wx.SplitterWindow` implementation.
:param `window`:
:type `window`: wx.Window
:rtype: `bool`
.. note::
This function is probably obsolete since the X implementations allow drawing directly on the screen now. However, the fact that this function allows the screen to be refreshed afterwards, may be useful to some applications.
**~~~**
**StartDrawingOnTop** `(rect=None)`
Use this in conjunction with :meth:`EndDrawingOnTop` to ensure that drawing to the screen occurs on top of existing windows.
Without this, some window systems (such as X) only allow drawing to take place underneath other windows.
This version of :meth:`StartDrawingOnTop` is used to specify an area of the screen which is to be drawn on. If ``None`` is passed, the whole screen is available. It is recommended that an area of the screen is specified with this function rather than with :meth:`StartDrawingOnTop` , because with large regions, flickering effects are noticeable when destroying the temporary transparent window used to implement this feature.
You might use this function when implementing a drag feature, for example as in the :ref:`wx.SplitterWindow` implementation.
:param `rect`:
:type `rect`: wx.Rect
:rtype: `bool`
.. note::
This function is probably obsolete since the X implementations allow drawing directly on the screen now. However, the fact that this function allows the screen to be refreshed afterwards, may be useful to some applications.
**~~~**
|