]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/timer.h
wxURL - doc cleanups, depreciated more methods, more source comments. wxURI - enclos...
[wxWidgets.git] / include / wx / timer.h
index 77d27106661c31660256c77323a8ee85409ffea0..313e0446807de9a71c5dc2c5c05da52f49221cdb 100644 (file)
@@ -6,14 +6,14 @@
 //              Guillermo Rodriguez (global clean up)
 // Created:     04/01/98
 // RCS-ID:      $Id$
-// Copyright:   (c) wxWindows team
+// Copyright:   (c) wxWidgets team
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_TIMER_H_BASE_
 #define _WX_TIMER_H_BASE_
 
-#if defined(__GNUG__) && !defined(__APPLE__)
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
     #pragma interface "timerbase.h"
 #endif
 
@@ -22,6 +22,8 @@
 #include "wx/longlong.h"
 #include "wx/event.h"
 
+#include "wx/stopwatch.h" // for backwards compatibility
+
 #if wxUSE_GUI && wxUSE_TIMER
 
 // ----------------------------------------------------------------------------
 // more readable flags for Start():
 
 // generate notifications periodically until the timer is stopped (default)
-#define wxTIMER_CONTINUOUS FALSE
+#define wxTIMER_CONTINUOUS false
 
 // only send the notification once and then stop the timer
-#define wxTIMER_ONE_SHOT TRUE
+#define wxTIMER_ONE_SHOT true
 
 // the interface of wxTimer class
 class WXDLLEXPORT wxTimerBase : public wxEvtHandler
@@ -50,12 +52,13 @@ public:
     // 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); }
+    wxTimerBase(wxEvtHandler *owner, int timerid = wxID_ANY)
+        { Init(); SetOwner(owner, timerid); }
 
     // same as ctor above
-    void SetOwner(wxEvtHandler *owner, int id = -1)
-        { m_owner = owner; m_idTimer = id; }
+    void SetOwner(wxEvtHandler *owner, int timerid = wxID_ANY)
+        { m_owner = owner; m_idTimer = timerid; }
+    wxEvtHandler* GetOwner() const { return m_owner; }
 
     virtual ~wxTimerBase();
 
@@ -67,7 +70,7 @@ public:
     //
     // 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);
+    virtual bool Start(int milliseconds = -1, bool oneShot = false);
 
     // stop the timer
     virtual void Stop() = 0;
@@ -79,30 +82,28 @@ public:
     // getting info
     // ------------
 
-    // return TRUE if the timer is running
+    // return true if the timer is running
     virtual bool IsRunning() const = 0;
 
     // get the (last) timer interval in the milliseconds
     int GetInterval() const { return m_milli; }
 
-    // return TRUE if the timer is one shot
+    // return true if the timer is one shot
     bool IsOneShot() const { return m_oneShot; }
 
-#if WXWIN_COMPATIBILITY_2
-    // deprecated functions
-    int Interval() const { return GetInterval(); };
-    bool OneShot() const { return IsOneShot(); }
-#endif // WXWIN_COMPATIBILITY_2
+    // return the timer ID
+    int GetId() const { return m_idTimer; }
+
 
 protected:
     // common part of all ctors
-    void Init() { m_oneShot = FALSE; m_milli = 0; }
+    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
+    bool    m_oneShot;      // true if one shot
 
     DECLARE_NO_COPY_CLASS(wxTimerBase)
 };
@@ -133,13 +134,13 @@ class WXDLLEXPORT wxTimerRunner
 {
 public:
     wxTimerRunner(wxTimer& timer) : m_timer(timer) { }
-    wxTimerRunner(wxTimer& timer, int milli, bool oneShot = FALSE)
+    wxTimerRunner(wxTimer& timer, int milli, bool oneShot = false)
         : m_timer(timer)
     {
         m_timer.Start(milli, oneShot);
     }
 
-    void Start(int milli, bool oneShot = FALSE)
+    void Start(int milli, bool oneShot = false)
     {
         m_timer.Start(milli, oneShot);
     }
@@ -154,6 +155,8 @@ public:
 
 private:
     wxTimer& m_timer;
+
+    DECLARE_NO_COPY_CLASS(wxTimerRunner)
 };
 
 // ----------------------------------------------------------------------------
@@ -163,7 +166,7 @@ private:
 class WXDLLEXPORT wxTimerEvent : public wxEvent
 {
 public:
-    wxTimerEvent(int id = 0, int interval = 0) : wxEvent(id)
+    wxTimerEvent(int timerid = 0, int interval = 0) : wxEvent(timerid)
     {
         m_eventType = wxEVT_TIMER;
 
@@ -179,96 +182,15 @@ public:
 private:
     int m_interval;
 
-    DECLARE_DYNAMIC_CLASS(wxTimerEvent)
+    DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxTimerEvent)
 };
 
 typedef void (wxEvtHandler::*wxTimerEventFunction)(wxTimerEvent&);
 
-#define EVT_TIMER(id, func) \
-    DECLARE_EVENT_TABLE_ENTRY( wxEVT_TIMER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTimerEventFunction) & func, NULL),
+#define EVT_TIMER(timerid, func) \
+    DECLARE_EVENT_TABLE_ENTRY( wxEVT_TIMER, timerid, wxID_ANY, (wxObjectEventFunction) (wxEventFunction)  wxStaticCastEvent( 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() { 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()
-    {
-        wxASSERT_MSG( m_pauseCount > 0,
-                      _T("Resuming stop watch which is not paused") );
-
-        if ( !--m_pauseCount )
-            Start(m_pause);
-    }
-
-    // get elapsed time since the last Start() in milliseconds
-    long Time() const;
-
-protected:
-    // returns the elapsed time since t0
-    long GetElapsedTime() const;
-
-private:
-    // 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
-void WXDLLEXPORT wxStartTimer();
-
-// Gets elapsed milliseconds since last wxStartTimer or wxGetElapsedTime
-// -- 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.
-extern long WXDLLEXPORT wxGetLocalTime();
-
-// Get number of seconds since GMT 00:00:00, Jan 1st 1970.
-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_