/////////////////////////////////////////////////////////////////////////////
// Name: stopwatch.h
-// Purpose: documentation for wxStopWatch class
+// Purpose: interface of wxStopWatch
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/**
@class wxStopWatch
@wxheader{stopwatch.h}
-
+
The wxStopWatch class allow you to measure time intervals. For example, you may
use it to measure the time elapsed by some function:
-
+
@code
wxStopWatch sw;
CallLongRunningFunction();
CallLongRunningFunction();
wxLogMessage("And calling it twice took $ldms in all", sw.Time());
@endcode
-
+
@library{wxbase}
@category{misc}
-
- @seealso
- wxTimer
+
+ @see wxTimer
*/
-class wxStopWatch
+class wxStopWatch
{
public:
/**
wxStopWatch();
/**
- Pauses the stop watch. Call Resume() to resume
+ Pauses the stop watch. Call Resume() to resume
time measuring again.
-
If this method is called several times, @c Resume() must be called the same
- number of times to really resume the stop watch. You may, however, call
+ number of times to really resume the stop watch. You may, however, call
Start() to resume it unconditionally.
*/
void Pause();
/**
- Resumes the stop watch which had been paused with
+ Resumes the stop watch which had been paused with
Pause().
*/
void Resume();
/**
Returns the time in milliseconds since the start (or restart) or the last call
- of
+ of
Pause().
*/
- long Time();
+ long Time() const;
};
+
// ============================================================================
// Global functions/macros
// ============================================================================
/**
Returns the number of seconds since local time 00:00:00 Jan 1st 1970.
-
- @sa wxDateTime::Now
+
+ @see wxDateTime::Now
*/
long wxGetLocalTime();
/**
Returns the number of seconds since GMT 00:00:00 Jan 1st 1970.
-
- @sa wxDateTime::Now
+
+ @see wxDateTime::Now
*/
long wxGetUTCTime();
/**
Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
-
- @sa wxDateTime::Now, wxLongLong
+
+ @see wxDateTime::Now, wxLongLong
*/
wxLongLong wxGetLocalTimeMillis();