File: wx.DCOverlay.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (152 lines) | stat: -rw-r--r-- 3,717 bytes parent folder | download
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
.. 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.DCOverlay:

==========================================================================================================================================
|phoenix_title|  **wx.DCOverlay**
==========================================================================================================================================

Connects an overlay with a drawing DC.          





         



.. seealso:: :ref:`wx.Overlay`, :ref:`wx.DC`    







|

|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>DCOverlay</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.DCOverlay_inheritance.png" alt="Inheritance diagram of DCOverlay" 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.DCOverlay.html" title="wx.DCOverlay" alt="" coords="5,5,115,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.DCOverlay.__init__`                                                   Connects this overlay to the corresponding drawing dc, if the overlay is not initialized yet this call will do so.
:meth:`~wx.DCOverlay.Clear`                                                      Clears the layer, restoring the state at the last init.
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.DCOverlay(object)

   **Possible constructors**::

       DCOverlay(overlay, dc, x, y, width, height)
       
       DCOverlay(overlay, dc)
       
   
   Connects an overlay with a drawing DC.



   .. method:: __init__(self, *args, **kw)



      |overload| Overloaded Implementations:

      **~~~**

      
      **__init__** `(self, overlay, dc, x, y, width, height)`
      
      Connects this overlay to the corresponding drawing dc, if the overlay is not initialized yet this call will do so.                  
      
      
      :param `overlay`: 
      :type `overlay`: wx.Overlay
      :param `dc`: 
      :type `dc`: wx.DC
      :param `x`: 
      :type `x`: int
      :param `y`: 
      :type `y`: int
      :param `width`: 
      :type `width`: int
      :param `height`: 
      :type `height`: int
      
      
      
      
      
      
      **~~~**

      
      **__init__** `(self, overlay, dc)`
      
      Convenience wrapper that behaves the same using the entire area of the dc.                  
      
      
      :param `overlay`: 
      :type `overlay`: wx.Overlay
      :param `dc`: 
      :type `dc`: wx.DC
      
      
      
      
      
      
      **~~~**






   .. method:: Clear(self)

      Clears the layer, restoring the state at the last init.