Notebook, Listbox, and Checklst updates

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

diff --git a/include/wx/timer.h b/include/wx/timer.h
index aee24ca764e350f9b132b8d3740996e4b8ea0502..2c030fbd07e640dde65ecd53a1c1cb428ccfff72 100644 (file)
--- a/include/wx/timer.h
+++ b/include/wx/timer.h
@@ -13,7 +13,7 @@
 #ifndef _WX_TIMER_H_BASE_
 #define _WX_TIMER_H_BASE_
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(__APPLE__)
     #pragma interface "timerbase.h"
 #endif
 
@@ -22,10 +22,20 @@
 #include "wx/longlong.h"
 #include "wx/event.h"
 
+#if wxUSE_GUI && wxUSE_TIMER
+
 // ----------------------------------------------------------------------------
 // wxTimer
 // ----------------------------------------------------------------------------
 
+// more readable flags for Start():
+
+// generate notifications periodically until the timer is stopped (default)
+#define wxTIMER_CONTINUOUS FALSE
+
+// only send the notification once and then stop the timer
+#define wxTIMER_ONE_SHOT TRUE
+
 // the interface of wxTimer class
 class WXDLLEXPORT wxTimerBase : public wxObject
 {
@@ -41,29 +51,23 @@ public:
     // class: the owner will get timer notifications which can be handled with
     // EVT_TIMER
     wxTimerBase(wxEvtHandler *owner, int id = -1)
-        { Init(); SetOwner(owner, -1); }
+        { Init(); SetOwner(owner, id); }
 
     // same as ctor above
     void SetOwner(wxEvtHandler *owner, int id = -1)
         { m_owner = owner; m_idTimer = id; }
 
+    virtual ~wxTimerBase();
+
     // 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 +115,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(__WXX11__) || defined(__WXMGL__)
+    #include "wx/generic/timer.h"
 #elif defined(__WXMAC__)
     #include "wx/mac/timer.h"
 #elif defined(__WXPM__)
@@ -121,6 +125,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
 // ----------------------------------------------------------------------------
@@ -138,6 +173,9 @@ public:
     // accessors
     int GetInterval() const { return m_interval; }
 
+    // implement the base class pure virtual
+    virtual wxEvent *Clone() const { return new wxTimerEvent(*this); }
+
 private:
     int m_interval;
 
@@ -146,22 +184,33 @@ 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:
     // ctor starts the stop watch
-    wxStopWatch()        { Start(); }
-    void Start(long t = 0);
-    void Pause()  { m_pause = GetElapsedTime(); }
-    void Resume() { Start(m_pause); }
+    wxStopWatch() { m_pauseCount = 0; Start(); }
+
+    // start the stop watch at the moment t0
+    void Start(long t0 = 0);
+
+    // pause the stop watch
+    void Pause() { if ( !m_pauseCount++) m_pause = GetElapsedTime(); }
+
+    // resume it
+    void Resume() { if ( !--m_pauseCount ) Start(m_pause); }
 
-    // get elapsed time since the last Start() or Pause() in milliseconds
+    // get elapsed time since the last Start() in milliseconds
     long Time() const;
 
 protected:
@@ -169,10 +218,19 @@ protected:
     long GetElapsedTime() const;
 
 private:
-    wxLongLong m_t0;      // the time of the last Start()
-    long m_pause;         // the time of the last Pause() or 0
+    // the time of the last Start()
+    wxLongLong m_t0;
+
+    // the time of the last Pause() (only valid if m_pauseCount > 0)
+    long m_pause;
+
+    // if > 0, the stop watch is paused, otherwise it is running
+    int m_pauseCount;
 };
 
+#endif // wxUSE_STOPWATCH
+
+#if wxUSE_LONGLONG
 
 // Starts a global timer
 // -- DEPRECATED: use wxStopWatch instead
@@ -182,15 +240,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()