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
|
.. 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.EventBlocker:
==========================================================================================================================================
|phoenix_title| **wx.EventBlocker**
==========================================================================================================================================
This class is a special event handler which allows to discard any event (or a set of event types) directed to a specific window.
Example:
::
def DoSomething(self):
# block all events directed to this window while
# we do the 1000 FunctionWhichSendsEvents() calls
with wx.EventBlocker(self) as blocker:
for i in xrange(1000):
FunctionWhichSendsEvents(i)
# wx.EventBlocker destructor called on exit from the context
# manager, old event handlers are restored.
# the event generated by this call will be processed:
FunctionWhichSendsEvents(0)
.. seealso:: :ref:`How Events are Processed <how events are processed>`, :ref:`wx.EvtHandler`
|
|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>EventBlocker</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.EventBlocker_inheritance.png" alt="Inheritance diagram of EventBlocker" 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.EventBlocker.html" title="wx.EventBlocker" alt="" coords="41,160,167,189"/> <area shape="rect" id="node2" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="48,83,159,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="5,5,87,35"/> <area shape="rect" id="node4" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.EventBlocker.__init__` Constructs the blocker for the given window and for the given event type.
:meth:`~wx.EventBlocker.Block` Adds to the list of event types which should be blocked the given `eventType`.
:meth:`~wx.EventBlocker.__enter__`
:meth:`~wx.EventBlocker.__exit__`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.EventBlocker(EvtHandler)
**Possible constructors**::
EventBlocker(win, type=-1)
This class is a special event handler which allows to discard any
event (or a set of event types) directed to a specific window.
.. method:: __init__(self, win, type=-1)
Constructs the blocker for the given window and for the given event type.
If `type` is ``wxEVT_ANY`` , then all events for that window are blocked. You can call :meth:`Block` after creation to add other event types to the list of events to block.
Note that the `win` window **must** remain alive until the :ref:`wx.EventBlocker` object destruction.
:param `win`:
:type `win`: wx.Window
:param `type`:
:type `type`: wx.EventType
.. method:: Block(self, eventType)
Adds to the list of event types which should be blocked the given `eventType`.
:param `eventType`:
:type `eventType`: wx.EventType
.. method:: __enter__(self)
.. method:: __exit__(self, exc_type, exc_val, exc_tb)
|
