.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxTimer 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxTimer \- 
  Timer class
 
.SH DESCRIPTION

  


   The wxTimer 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 two different ways to use this class:
  
  


   
    You may derive a new class from wxTimer and override the
     Notify
     member to perform the required action.
     
    Or you may redirect the notifications to any
     wxEvtHandler
     derived object by using the non default constructor or
     SetOwner
     . Then use the
     EVT_TIMER
     macro to connect it to the event handler which will receive
     wxTimerEvent
     notifications.
     
    Or 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 wxEvtHandler.
   
  
  


   In any case, you must start the timer with
   Start
   after constructing it before it actually starts sending notifications. It can
   be stopped later with
   Stop
   .
  
  


   
    NB:
   
   note that timer can only be used from the main thread currently.
  
 
.SH "PARENTS"

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

  
.SS  wxTimer ()

     


      Default constructor. If you use it to construct the object and don't call
      SetOwner
      later, you must override
      Notify
      method to process the notifications.
     
    
.SS  wxTimer (wxEvtHandler *ownerint id = -1)

     


      Creates a timer and associates it with
      
       owner
      
      . Please see
      SetOwner
      for the description of parameters.
     
    
   
  
.SS  ~wxTimer ()

     


      Destructor. Stops the timer if it is running.
     
    
   
  
.SS int GetInterval ()

     


      Returns the current interval for the timer (in milliseconds).
     
    
   
  
.SS bool IsOneShot ()

     


      Returns
      true
      if the timer is one shot, i.e. if it will stop after firing the first
      notification automatically.
     
    
   
  
.SS bool IsRunning ()

     


      Returns
      true
      if the timer is running,
      false
      if it is stopped.
     
    
   
  
.SS void Notify ()

     


      This member should be overridden by the user if the default constructor
      was used and
      SetOwner
      wasn't called.
     
     


      Perform whatever action which is to be taken periodically here.
     
    
   
  
.SS void SetOwner (wxEvtHandler *ownerint id = -1)

     


      Associates the timer with the given
      
       owner
      
      \/ object. When the timer is running, the owner will receive
      timer events
      with id equal to
      
       id
      
      \/ specified here.
     
    
   
  
.SS bool Start (int milliseconds = -1bool oneShot = false)

     


      (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
      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:
     
     
      
       
        wxTIMER_CONTINUOUS
       
       
        Start a normal, continuously running, timer
       
      

       
      
       
        wxTIMER_ONE_SHOT
       
       
        Start a one shot timer
       
      

     
     


      If the timer was already running, it will be stopped by this method before
      restarting it.
     
    
   
  
.SS void Stop ()

     


      Stops the timer.
     
    
 
.SH "SEE ALSO"

  wxEvtHandler
 
  ::wxStartTimer
  ::wxGetElapsedTime
  wxStopWatch
 
.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.