corrected comment

[wxWidgets.git] / include / wx / timer.h

diff --git a/include/wx/timer.h b/include/wx/timer.h
index 30491db2ff37b96b57a7df4a574841d385e79b43..802544a91bbfafece940bd57215624a578c1d6ad 100644 (file)
--- a/include/wx/timer.h
+++ b/include/wx/timer.h
@@ -22,6 +22,8 @@
 #include "wx/longlong.h"
 #include "wx/event.h"
 
+#if wxUSE_GUI
+
 // ----------------------------------------------------------------------------
 // wxTimer
 // ----------------------------------------------------------------------------
@@ -52,18 +54,10 @@ public:
 
     // start the timer: if milliseconds == -1, use the same value as for the
     // last Start()
-    virtual bool Start(int milliseconds = -1, bool oneShot = FALSE)
-    {
-        if ( milliseconds != -1 )
-        {
-            m_milli = milliseconds;
-        }
-
-        m_oneShot = oneShot;
-
-        return TRUE;
-    }
-
+    //
+    // it is now valid to call Start() multiple times: this just restarts the
+    // timer if it is already running
+    virtual bool Start(int milliseconds = -1, bool oneShot = FALSE);
 
     // stop the timer
     virtual void Stop() = 0;
@@ -121,6 +115,37 @@ protected:
     #include "wx/stubs/timer.h"
 #endif
 
+// ----------------------------------------------------------------------------
+// wxTimerRunner: starts the timer in its ctor, stops in the dtor
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxTimerRunner
+{
+public:
+    wxTimerRunner(wxTimer& timer) : m_timer(timer) { }
+    wxTimerRunner(wxTimer& timer, int milli, bool oneShot = FALSE)
+        : m_timer(timer)
+    {
+        m_timer.Start(milli, oneShot);
+    }
+
+    void Start(int milli, bool oneShot = FALSE)
+    {
+        m_timer.Start(milli, oneShot);
+    }
+
+    ~wxTimerRunner()
+    {
+        if ( m_timer.IsRunning() )
+        {
+            m_timer.Stop();
+        }
+    }
+
+private:
+    wxTimer& m_timer;
+};
+
 // ----------------------------------------------------------------------------
 // wxTimerEvent
 // ----------------------------------------------------------------------------
@@ -146,7 +171,10 @@ private:
 
 typedef void (wxEvtHandler::*wxTimerEventFunction)(wxTimerEvent&);
 
-#define EVT_TIMER(id, func) { wxEVT_TIMER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTimerEventFunction) & func, NULL},
+#define EVT_TIMER(id, func) \
+    wxEventTableEntry( wxEVT_TIMER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTimerEventFunction) & func, NULL),
+
+#endif // wxUSE_GUI
 
 // ----------------------------------------------------------------------------
 // wxStopWatch: measure time intervals with up to 1ms resolution
@@ -187,10 +215,13 @@ long WXDLLEXPORT wxGetElapsedTime(bool resetTimer = TRUE);
 // ----------------------------------------------------------------------------
 
 // Get number of seconds since local time 00:00:00 Jan 1st 1970.
-long WXDLLEXPORT wxGetLocalTime();
+extern long WXDLLEXPORT wxGetLocalTime();
 
 // Get number of seconds since GMT 00:00:00, Jan 1st 1970.
-long WXDLLEXPORT wxGetUTCTime();
+extern long WXDLLEXPORT wxGetUTCTime();
+
+// Get number of milliseconds since local time 00:00:00 Jan 1st 1970
+extern wxLongLong WXDLLEXPORT wxGetLocalTimeMillis();
 
 #define wxGetCurrentTime() wxGetLocalTime()