*************
wx.TimerEvent
*************

Inheritance diagram for `wx.TimerEvent`:

|

.. inheritance-diagram:: wx.TimerEvent

|

Description
===========

`wx.TimerEvent` object is passed to the event handler of timer events.

For example::

    class MyFrame(wx.Frame):

        def __init__(self, parent):

            # ... Other initialization code here ...
 
            self._timer = wx.Timer(self, wx.ID_ANY)
     
            # Bind the event to the handler
            self.Bind(wx.EVT_TIMER, self.OnTimer)

            # Start the timer with 1 second interval 
            self._timer.Start(1000)   
     
        
        def OnTimer(self, event):

            # Do whatever you want to do every second here
            DoMyProcess()



.. seealso:: `wx.Timer <../Widgets/wx.Timer.html>`_


Derived From
^^^^^^^^^^^^^

* `wx.Event <wx.Event.html>`_ 


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `GetInterval <#GetInterval>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `Interval <#Interval>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(timerid=0, interval=0)

   Constructor.

   **Parameters:**

   * `timerid` (int)
   * `interval` (int)

   |

   **Returns:**

   `wx.TimerEvent <wx.TimerEvent.html>`_
 

--------

.. method:: GetInterval()

   Returns the interval of the timer which generated this event.

   |  

   **Returns:**

   `int` 

--------

Properties
^^^^^^^^^^


.. attribute:: Interval

   See `GetInterval <#GetInterval>`_