.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxTimerEvent 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxTimerEvent \- 
  A timer expiration event
 
.SH DESCRIPTION

  


   wxTimerEvent object is passed to the event handler of timer events.
  
  


   For example:
  
  


  
class MyFrame : public wxFrame
{
public:
    ...
    void OnTimer(wxTimerEvent& event);

private:
    wxTimer m_timer;
};

BEGIN_EVENT_TABLE(MyFrame, wxFrame)
    EVT_TIMER(TIMER_ID, MyFrame::OnTimer)
END_EVENT_TABLE()

MyFrame::MyFrame()
       : m_timer(this, TIMER_ID)
{
    m_timer.Start(1000);    // 1 second interval
}

void MyFrame::OnTimer(wxTimerEvent& event)
{
    // do whatever you want to do every second here
}


  


 
.SH "PARENTS"

.SH "INCLUDE FILES"
wx/timer.h
.SH MEMBERS

  
.SS int GetInterval ()

     


      Returns the interval of the timer which generated this event.
     
    
 
.SH "SEE ALSO"

  wxTimer
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.