formatting changes

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

diff --git a/include/wx/timer.h b/include/wx/timer.h
index 30491db2ff37b96b57a7df4a574841d385e79b43..c7459e915296ed7f6bc2a89d2c831655f2ce2d8d 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 && wxUSE_TIMER
+
 // ----------------------------------------------------------------------------
 // wxTimer
 // ----------------------------------------------------------------------------
@@ -47,23 +49,19 @@ public:
     void SetOwner(wxEvtHandler *owner, int id = -1)
         { m_owner = owner; m_idTimer = id; }
 
+#ifdef __DARWIN__
+    virtual ~wxTimerBase() { }
+#endif
+
     // working with the timer
     // ----------------------
 
     // 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;
@@ -111,8 +109,8 @@ protected:
     #include "wx/motif/timer.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk/timer.h"
-#elif defined(__WXQT__)
-    #include "wx/qt/timer.h"
+#elif defined(__WXMGL__)
+    #include "wx/mgl/timer.h"
 #elif defined(__WXMAC__)
     #include "wx/mac/timer.h"
 #elif defined(__WXPM__)
@@ -121,6 +119,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,12 +175,17 @@ 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) \
+    DECLARE_EVENT_TABLE_ENTRY( wxEVT_TIMER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTimerEventFunction) & func, NULL),
+
+#endif // wxUSE_GUI && wxUSE_TIMER
 
 // ----------------------------------------------------------------------------
 // wxStopWatch: measure time intervals with up to 1ms resolution
 // ----------------------------------------------------------------------------
 
+#if wxUSE_STOPWATCH
+
 class WXDLLEXPORT wxStopWatch
 {
 public:
@@ -173,6 +207,9 @@ private:
     long m_pause;         // the time of the last Pause() or 0
 };
 
+#endif // wxUSE_STOPWATCH
+
+#if wxUSE_LONGLONG
 
 // Starts a global timer
 // -- DEPRECATED: use wxStopWatch instead
@@ -182,15 +219,22 @@ void WXDLLEXPORT wxStartTimer();
 // -- DEPRECATED: use wxStopWatch instead
 long WXDLLEXPORT wxGetElapsedTime(bool resetTimer = TRUE);
 
+#endif // wxUSE_LONGLONG
+
 // ----------------------------------------------------------------------------
 // global time functions
 // ----------------------------------------------------------------------------
 
 // 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();
+
+#if wxUSE_LONGLONG
+// Get number of milliseconds since local time 00:00:00 Jan 1st 1970
+extern wxLongLong WXDLLEXPORT wxGetLocalTimeMillis();
+#endif // wxUSE_LONGLONG
 
 #define wxGetCurrentTime() wxGetLocalTime()