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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
|
.. 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.Timer:
==========================================================================================================================================
|phoenix_title| **wx.Timer**
==========================================================================================================================================
The :ref:`wx.Timer` class allows you to execute code at specified intervals.
Its precision is platform-dependent, but in general will not be better than ``1ms`` nor worse than ``1s`` .
There are three different ways to use this class:
- You may derive a new class from :ref:`wx.Timer` and override the :meth:`wx.Timer.Notify` member to perform the required action.
- You may redirect the notifications to any :ref:`wx.EvtHandler` derived object by using the non-default constructor or :meth:`wx.Timer.SetOwner` . Then use the ``EVT_TIMER`` macro to connect it to the event handler which will receive :ref:`wx.TimerEvent` notifications.
- You may use a derived class and the ``EVT_TIMER`` macro to connect it to an event handler defined in the derived class. If the default constructor is used, the timer object will be its own owner object, since it is derived from :ref:`wx.EvtHandler`.
In any case, you must start the timer with :meth:`wx.Timer.Start` after constructing it before it actually starts sending notifications. It can be stopped later with :meth:`wx.Timer.Stop` .
.. note::
A timer can only be used from the main thread.
.. seealso:: :ref:`wx.StopWatch`
|
|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>Timer</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.Timer_inheritance.png" alt="Inheritance diagram of Timer" 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="5,5,87,35"/> <area shape="rect" id="node3" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="48,83,159,112"/> <area shape="rect" id="node2" href="wx.Timer.html" title="wx.Timer" alt="" coords="65,160,143,189"/> <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.Timer.__init__` Default constructor.
:meth:`~wx.Timer.GetId` Returns the ``ID`` of the events generated by this timer.
:meth:`~wx.Timer.GetInterval` Returns the current interval for the timer (in milliseconds).
:meth:`~wx.Timer.GetOwner` Returns the current `owner` of the timer.
:meth:`~wx.Timer.IsOneShot` Returns ``True`` if the timer is one shot, i.e. if it will stop after firing the first notification automatically.
:meth:`~wx.Timer.IsRunning` Returns ``True`` if the timer is running, ``False`` if it is stopped.
:meth:`~wx.Timer.Notify` This member should be overridden by the user if the default constructor was used and :meth:`~Timer.SetOwner` wasn't called.
:meth:`~wx.Timer.SetOwner` Associates the timer with the given `owner` object.
:meth:`~wx.Timer.Start` (Re)starts the timer.
:meth:`~wx.Timer.StartOnce` Starts the timer for a once-only notification.
:meth:`~wx.Timer.Stop` Stops the timer.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.Timer.Id` See :meth:`~wx.Timer.GetId`
:attr:`~wx.Timer.Interval` See :meth:`~wx.Timer.GetInterval`
:attr:`~wx.Timer.Owner` See :meth:`~wx.Timer.GetOwner` and :meth:`~wx.Timer.SetOwner`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.Timer(EvtHandler)
**Possible constructors**::
Timer()
Timer(owner, id=-1)
The Timer class allows you to execute code at specified intervals.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Default constructor.
If you use it to construct the object and don't call :meth:`SetOwner` later, you must override :meth:`Notify` method to process the notifications.
**~~~**
**__init__** `(self, owner, id=-1)`
Creates a timer and associates it with `owner`.
Please see :meth:`SetOwner` for the description of parameters.
:param `owner`:
:type `owner`: wx.EvtHandler
:param `id`:
:type `id`: int
**~~~**
.. method:: GetId(self)
Returns the ``ID`` of the events generated by this timer.
:rtype: `int`
.. method:: GetInterval(self)
Returns the current interval for the timer (in milliseconds).
:rtype: `int`
.. method:: GetOwner(self)
Returns the current `owner` of the timer.
If non-NULL this is the event handler which will receive the timer events (see :ref:`wx.TimerEvent`) when the timer is running.
:rtype: :ref:`wx.EvtHandler`
.. method:: IsOneShot(self)
Returns ``True`` if the timer is one shot, i.e. if it will stop after firing the first notification automatically.
:rtype: `bool`
.. method:: IsRunning(self)
Returns ``True`` if the timer is running, ``False`` if it is stopped.
:rtype: `bool`
.. method:: Notify(self)
This member should be overridden by the user if the default constructor was used and :meth:`SetOwner` wasn't called.
Perform whatever action which is to be taken periodically here.
Notice that throwing exceptions from this method is currently not supported, use event-based timer handling approach if an exception can be thrown while handling timer notifications.
.. method:: SetOwner(self, owner, id=-1)
Associates the timer with the given `owner` object.
When the timer is running, the owner will receive timer events (see :ref:`wx.TimerEvent`) with `id` equal to `id` specified here.
:param `owner`:
:type `owner`: wx.EvtHandler
:param `id`:
:type `id`: int
.. method:: Start(self, milliseconds=-1, oneShot=TIMER_CONTINUOUS)
(Re)starts the timer.
If `milliseconds` parameter is -1 (value by default), the previous value is used. Returns ``False`` if the timer could not be started, ``True`` otherwise (in MS Windows timers are a limited resource).
If `oneShot` is ``False`` (the default), the :meth:`Notify` function will be called repeatedly until the timer is stopped. If ``True``, it will be called only once and the timer will stop automatically.
To make your code more readable you may also use the following symbolic constants:
- ``wx.TIMER_CONTINUOUS``: Start a normal, continuously running, timer
- ``wx.TIMER_ONE_SHOT``: Start a one shot timer Alternatively, use :meth:`StartOnce` .
If the timer was already running, it will be stopped by this method before restarting it.
:param `milliseconds`:
:type `milliseconds`: int
:param `oneShot`:
:type `oneShot`: bool
:rtype: `bool`
.. method:: StartOnce(self, milliseconds=-1)
Starts the timer for a once-only notification.
This is a simple wrapper for :meth:`Start` with ``TIMER_ONE_SHOT`` parameter.
:param `milliseconds`:
:type `milliseconds`: int
:rtype: `bool`
.. versionadded:: 2.9.5
.. method:: Stop(self)
Stops the timer.
.. attribute:: Id
See :meth:`~wx.Timer.GetId`
.. attribute:: Interval
See :meth:`~wx.Timer.GetInterval`
.. attribute:: Owner
See :meth:`~wx.Timer.GetOwner` and :meth:`~wx.Timer.SetOwner`
|
