.. include:: headings.inc



.. _TimerEvent:

==========================================================================================================================================
|phoenix_title|  **TimerEvent**
==========================================================================================================================================

:ref:`TimerEvent`  object is passed to the event handler of timer events (see :meth:`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:`Timer`    







|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **TimerEvent**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/TimerEvent_inheritance.png" alt="Inheritance diagram of TimerEvent" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="TimerEvent.html" title="TimerEvent  object is passed to the event handler of timer events (see Timer.SetOwner )." alt="" coords="247,5,348,35"/> <area shape="rect" id="node2" href="Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="125,5,197,35"/> <area shape="rect" id="node4" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,77,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~TimerEvent.__init__`                                                     
:meth:`~TimerEvent.GetInterval`                                                  Returns the interval of the timer which generated this event.
:meth:`~TimerEvent.GetTimer`                                                     Returns the timer object which generated this event.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~TimerEvent.Interval`                                                     See :meth:`~TimerEvent.GetInterval`
:attr:`~TimerEvent.Timer`                                                        See :meth:`~TimerEvent.GetTimer`
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: TimerEvent(Event)

   TimerEvent object is passed to the event handler of timer events (see `Timer.SetOwner).`
   
   **Possible constructors**::

       TimerEvent()
       
       TimerEvent(timer)
       



   .. method:: __init__(self, *args, **kw)



      |overload| **Overloaded Implementations**:

      **~~~**

      
      **__init__** `(self)`
      
      
      
      
      
      **~~~**

      
      **__init__** `(self, timer)`
      
      
      
      
      :param `timer`: 
      :type `timer`: 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:`Timer`








   .. attribute:: Interval

      See :meth:`~TimerEvent.GetInterval`


   .. attribute:: Timer

      See :meth:`~TimerEvent.GetTimer`