.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 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

Inheritance diagram for class
TimerEvent:
|
|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(timer : Timer) -> None
TimerEvent object is passed to the event handler of timer events
(see `Timer.SetOwner).`
.. method:: __init__(self, timer : Timer)
:param `timer`:
:type `timer`: wx.Timer
:rtype: `None`
.. 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`