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
207
|
.. 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.DCClipper:
==========================================================================================================================================
|phoenix_title| **wx.DCClipper**
==========================================================================================================================================
:ref:`wx.DCClipper` is a helper class for setting a clipping region on a :ref:`wx.DC` during its lifetime.
An object of :ref:`wx.DCClipper` class is typically created on the stack so that it is automatically destroyed when the object goes out of scope. A typical usage example:
::
def MyFunction(dc):
clip = wx.DCClipper(dc, rect)
# ... drawing functions here are affected by clipping rect ...
def OtherFunction():
dc = wx.DC()
MyFunction(dc)
# ... drawing functions here are not affected by clipping rect ...
.. note::
Unlike other similar classes such as :ref:`wx.DCFontChanger`, :ref:`wx.DCClipper` currently doesn't restore the previously active clipping region when it is destroyed but simply resets clipping on the associated :ref:`wx.DC`. This may be changed in the future wxWidgets versions but has to be taken into account explicitly in the current one.
.. seealso:: :meth:`wx.DC.SetClippingRegion` , :ref:`wx.DCFontChanger`, :ref:`wx.DCTextColourChanger`, :ref:`wx.DCPenChanger`, :ref:`wx.DCBrushChanger`
|
|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>DCClipper</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.DCClipper_inheritance.png" alt="Inheritance diagram of DCClipper" 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.DCClipper.html" title="wx.DCClipper" alt="" coords="5,5,109,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.DCClipper.__init__` Sets the clipping region to the specified region/coordinates.
:meth:`~wx.DCClipper.__enter__`
:meth:`~wx.DCClipper.__exit__`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.DCClipper(object)
**Possible constructors**::
DCClipper(dc, region)
DCClipper(dc, rect)
DCClipper(dc, x, y, w, h)
DCClipper is a helper class for setting a clipping region on a DC
during its lifetime.
.. method:: __init__(self, *args, **kw)
Sets the clipping region to the specified region/coordinates.
The clipping region is automatically unset when this object is destroyed.
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self, dc, region)`
:param `dc`:
:type `dc`: wx.DC
:param `region`:
:type `region`: wx.Region
**~~~**
**__init__** `(self, dc, rect)`
:param `dc`:
:type `dc`: wx.DC
:param `rect`:
:type `rect`: wx.Rect
**~~~**
**__init__** `(self, dc, x, y, w, h)`
:param `dc`:
:type `dc`: wx.DC
:param `x`:
:type `x`: int
:param `y`:
:type `y`: int
:param `w`:
:type `w`: int
:param `h`:
:type `h`: int
**~~~**
.. method:: __enter__(self)
.. method:: __exit__(self, exc_type, exc_val, exc_tb)
|
