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

  


   The wxStopWatch class allow you to measure time intervals. For example, you
   may use it to measure the time elapsed by some function:
  
  


  
    wxStopWatch sw;
    CallLongRunningFunction();
    wxLogMessage("The long running function took 
                 sw.Time());
    sw.Pause();
    ... stopwatch is stopped now ...
    sw.Resume();
    CallLongRunningFunction();
    wxLogMessage("And calling it twice took ldms in all", sw.Time());

  


 
.SH "PARENTS"

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

  
.SS  wxStopWatch ()

     


      Constructor. This starts the stop watch.
     
    
   
  
.SS void Pause ()

     


      Pauses the stop watch. Call
      wxStopWatch::Resume
      to resume time measuring again.
     
     


      If this method is called several times,
      Resume()
      must be called the same number of times to really resume the stop watch.
      You may, however, call
      Start
      to resume it unconditionally.
     
    
   
  
.SS void Resume ()

     


      Resumes the stop watch which had been paused with
      wxStopWatch::Pause
      .
     
    
   
  
.SS void Start (long milliseconds = 0)

     


      (Re)starts the stop watch with a given initial value.
     
    
   
  
.SS long Time ()

     


      
     
     


      Returns the time in milliseconds since the start (or restart) or the last
      call of
      wxStopWatch::Pause
      .
     
    
 
.SH "SEE ALSO"

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