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
|
.. 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.TimerEvent:
==========================================================================================================================================
|phoenix_title| **wx.TimerEvent**
==========================================================================================================================================
:ref:`wx.TimerEvent` object is passed to the event handler of timer events (see :meth:`wx.Timer.SetOwner` ).
For example:
::
class MyFrame(wx.Frame):
def __init__(self, parent):
wx.Frame.__init__(self, parent)
self.timer = wx.Timer(self, TIMER_ID)
self.Bind(wx.EVT_TIMER, self.OnTimer)
self.timer.Start(1000) # 1 second interval
def OnTimer(self, event):
# do whatever you want to do every second here
print('Hello')
.. seealso:: :ref:`wx.Timer`
|
|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>TimerEvent</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.TimerEvent_inheritance.png" alt="Inheritance diagram of TimerEvent" 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.TimerEvent.html" title="wx.TimerEvent" alt="" coords="5,160,120,189"/> <area shape="rect" id="node2" href="wx.Event.html" title="wx.Event" alt="" coords="23,83,101,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="21,5,103,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.TimerEvent.__init__`
:meth:`~wx.TimerEvent.GetInterval` Returns the interval of the timer which generated this event.
:meth:`~wx.TimerEvent.GetTimer` Returns the timer object which generated this event.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.TimerEvent.Interval` See :meth:`~wx.TimerEvent.GetInterval`
:attr:`~wx.TimerEvent.Timer` See :meth:`~wx.TimerEvent.GetTimer`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.TimerEvent(Event)
**Possible constructors**::
TimerEvent()
TimerEvent(timer)
TimerEvent object is passed to the event handler of timer events
(see `Timer.SetOwner).`
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
**~~~**
**__init__** `(self, timer)`
:param `timer`:
:type `timer`: wx.Timer
**~~~**
.. method:: GetInterval(self)
Returns the interval of the timer which generated this event.
:rtype: `int`
.. method:: GetTimer(self)
Returns the timer object which generated this event.
:rtype: :ref:`wx.Timer`
.. attribute:: Interval
See :meth:`~wx.TimerEvent.GetInterval`
.. attribute:: Timer
See :meth:`~wx.TimerEvent.GetTimer`
|
