fixed the last of the off-by-one errors (some are refixed, again...)

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

diff --git a/include/wx/timer.h b/include/wx/timer.h
index d33638a8c81331b958152637d063aa71d9c4d10a..ae1da9917b6309c49679436a61e0959ce49732c0 100644 (file)
--- a/include/wx/timer.h
+++ b/include/wx/timer.h
@@ -1,12 +1,13 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/timer.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/timer.h

-// Purpose:     wxTimer class and global time-related functions
-// Author:      Julian Smart
-// Modified by:
+// Purpose:     wxTimer, wxStopWatch and global time-related functions
+// Author:      Julian Smart (wxTimer), Sylvain Bougnoux (wxStopWatch)
+// Modified by: Vadim Zeitlin (wxTimerBase)
+//              Guillermo Rodriguez (global clean up)

 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Created:     04/01/98
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:    wxWindows license
+// Copyright:   (c) wxWindows team
+// Licence:     wxWindows license

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_TIMER_H_BASE_
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_TIMER_H_BASE_


@@ -19,6 +20,9 @@
 #include "wx/setup.h"
 #include "wx/object.h"
 #include "wx/longlong.h"
 #include "wx/setup.h"
 #include "wx/object.h"
 #include "wx/longlong.h"

+#include "wx/event.h"
+
+#if wxUSE_GUI && wxUSE_TIMER

 
 // ----------------------------------------------------------------------------
 // wxTimer
 
 // ----------------------------------------------------------------------------
 // wxTimer


@@ -28,31 +32,43 @@
 class WXDLLEXPORT wxTimerBase : public wxObject
 {
 public:
 class WXDLLEXPORT wxTimerBase : public wxObject
 {
 public:

-    wxTimerBase() { m_oneShot = FALSE; m_milli = 0; }
+    // ctors and initializers
+    // ----------------------
+
+    // default: if you don't call SetOwner(), your only chance to get timer
+    // notifications is to override Notify() in the derived class
+    wxTimerBase() { Init(); SetOwner(NULL); }
+
+    // ctor which allows to avoid having to override Notify() in the derived
+    // class: the owner will get timer notifications which can be handled with
+    // EVT_TIMER
+    wxTimerBase(wxEvtHandler *owner, int id = -1)
+        { Init(); SetOwner(owner, id); }
+
+    // same as ctor above
+    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()
 
     // 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;
 
 
     // stop the timer
     virtual void Stop() = 0;
 

-    // override this in your wxTimer-derived class
-    virtual void Notify() = 0;
+    // override this in your wxTimer-derived class if you want to process timer
+    // messages in it, use non default ctor or SetOwner() otherwise
+    virtual void Notify();

 
     // getting info
     // ------------
 
     // getting info
     // ------------


@@ -73,16 +89,28 @@ public:
 #endif // WXWIN_COMPATIBILITY_2
 
 protected:
 #endif // WXWIN_COMPATIBILITY_2
 
 protected:

+    // common part of all ctors
+    void Init() { m_oneShot = FALSE; m_milli = 0; }
+
+    wxEvtHandler *m_owner;
+    int     m_idTimer;
+

     int     m_milli;        // the timer interval
     bool    m_oneShot;      // TRUE if one shot
 };
 
     int     m_milli;        // the timer interval
     bool    m_oneShot;      // TRUE if one shot
 };
 

+// ----------------------------------------------------------------------------
+// wxTimer itself
+// ----------------------------------------------------------------------------
+

 #if defined(__WXMSW__)
     #include "wx/msw/timer.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/timer.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk/timer.h"
 #if defined(__WXMSW__)
     #include "wx/msw/timer.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/timer.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk/timer.h"

+#elif defined(__WXMGL__)
+    #include "wx/mgl/timer.h"

 #elif defined(__WXQT__)
     #include "wx/qt/timer.h"
 #elif defined(__WXMAC__)
 #elif defined(__WXQT__)
     #include "wx/qt/timer.h"
 #elif defined(__WXMAC__)


@@ -94,17 +122,80 @@ protected:
 #endif
 
 // ----------------------------------------------------------------------------
 #endif
 
 // ----------------------------------------------------------------------------

-// wxStopWatch
+// 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
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxTimerEvent : public wxEvent
+{
+public:
+    wxTimerEvent(int id = 0, int interval = 0) : wxEvent(id)
+    {
+        m_eventType = wxEVT_TIMER;
+
+        m_interval = interval;
+    }
+
+    // accessors
+    int GetInterval() const { return m_interval; }
+
+private:
+    int m_interval;
+
+    DECLARE_DYNAMIC_CLASS(wxTimerEvent)
+};
+
+typedef void (wxEvtHandler::*wxTimerEventFunction)(wxTimerEvent&);
+
+#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
 {
 class WXDLLEXPORT wxStopWatch
 {

-public: 
+public:

     // ctor starts the stop watch
     wxStopWatch()        { Start(); }
     void Start(long t = 0);
     // ctor starts the stop watch
     wxStopWatch()        { Start(); }
     void Start(long t = 0);

-    inline void Pause()  { m_pause = GetElapsedTime(); }
-    inline void Resume() { Start(m_pause); }
+    void Pause()  { m_pause = GetElapsedTime(); }
+    void Resume() { Start(m_pause); }

 
     // get elapsed time since the last Start() or Pause() in milliseconds
     long Time() const;
 
     // get elapsed time since the last Start() or Pause() in milliseconds
     long Time() const;


@@ -112,14 +203,17 @@ public:
 protected:
     // returns the elapsed time since t0
     long GetElapsedTime() const;
 protected:
     // returns the elapsed time since t0
     long GetElapsedTime() const;

-    
+

 private:
     wxLongLong m_t0;      // the time of the last Start()
     long m_pause;         // the time of the last Pause() or 0
 };
 
 private:
     wxLongLong m_t0;      // the time of the last Start()
     long m_pause;         // the time of the last Pause() or 0
 };
 

+#endif // wxUSE_STOPWATCH
+
+#if wxUSE_LONGLONG

 
 

-// Starts a global timer 
+// Starts a global timer

 // -- DEPRECATED: use wxStopWatch instead
 void WXDLLEXPORT wxStartTimer();
 
 // -- DEPRECATED: use wxStopWatch instead
 void WXDLLEXPORT wxStartTimer();
 


@@ -127,18 +221,24 @@ void WXDLLEXPORT wxStartTimer();
 // -- DEPRECATED: use wxStopWatch instead
 long WXDLLEXPORT wxGetElapsedTime(bool resetTimer = TRUE);
 
 // -- 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.
 
 // ----------------------------------------------------------------------------
 // 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.
 
 // 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()

 
 #endif
     // _WX_TIMER_H_BASE_
 
 #endif
     // _WX_TIMER_H_BASE_