/////////////////////////////////////////////////////////////////////////////
// Name: timer.h
-// Purpose: documentation for wxTimer class
+// Purpose: interface of wxTimer
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
after constructing it before it actually starts sending notifications. It can
be stopped later with wxTimer::Stop.
- @b Note: A timer can only be used from the main thread.
+ @note A timer can only be used from the main thread.
@library{wxbase}
@category{misc}
- @seealso
- wxStopWatch
+ @see wxStopWatch
*/
class wxTimer : public wxEvtHandler
{
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.
*/
};
+
/**
@class wxTimerEvent
@wxheader{timer.h}
@library{wxbase}
@category{events}
- @seealso
- wxTimer
+ @see wxTimer
*/
class wxTimerEvent : public wxEvent
{
*/
wxTimer GetTimer() const;
};
+