docs/latex/wx/stopwtch.tex

   1 \section{\class{wxStopWatch}}\label{wxstopwatch}
   2
   3 The wxStopWatch class allow you to measure time intervals.
   4
   5 \wxheading{Include files}
   6
   7 <wx/timer.h>
   8
   9 \wxheading{See also}
  10
  11 \helpref{::wxStartTimer}{wxstarttimer}, \helpref{::wxGetElapsedTime}{wxgetelapsedtime}, \helpref{wxTimer}{wxtimer}
  12
  13 \latexignore{\rtfignore{\wxheading{Members}}}
  14
  15 \membersection{wxStopWatch::wxStopWatch}
  16
  17 \func{}{wxStopWatch}{\void}
  18
  19 Constructor. This starts the stop watch.
  20
  21 \membersection{wxStopWatch::Pause}\label{wxstopwatchpause}
  22
  23 \func{void}{Pause}{\void}
  24
  25 Pauses the stop watch. Call \helpref{wxStopWatch::Resume}{wxstopwatchresume} to resume
  26 time measuring again.
  27
  28 \membersection{wxStopWatch::Start}
  29
  30 \func{void}{Start}{\param{long}{ milliseconds = 0}}
  31
  32 (Re)starts the stop watch with a given initial value.
  33
  34 \membersection{wxStopWatch::Resume}\label{wxstopwatchresume}
  35
  36 \func{void}{Resume}{\void}
  37
  38 Resumes the stop watch after having been paused with \helpref{wxStopWatch::Pause}{wxstopwatchpause}.
  39
  40 \membersection{wxStopWatch::Time}
  41
  42 \func{long}{Time}{\void}\label{wxstopwatchtime}
  43
  44 Returns the time in milliseconds since the start (or restart) or the last call of
  45 \helpref{wxStopWatch::Pause}{wxstopwatchpause}.
  46