wxStaticBitmapBase::DoGetBestSize

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

diff --git a/include/wx/timer.h b/include/wx/timer.h
index 8cf9cbd4821b97d1554b79580e40051a57dba25b..9e9ed4e5233018db1b0cbb4a3e1b4e4d84ce9c00 100644 (file)
--- a/include/wx/timer.h
+++ b/include/wx/timer.h
@@ -7,13 +7,13 @@
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) wxWindows team
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_TIMER_H_BASE_
 #define _WX_TIMER_H_BASE_
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
     #pragma interface "timerbase.h"
 #endif
 
@@ -22,14 +22,24 @@
 #include "wx/longlong.h"
 #include "wx/event.h"
 
+#include "wx/stopwatch.h" // for backwards compatibility
+
 #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
+class WXDLLEXPORT wxTimerBase : public wxEvtHandler
 {
 public:
     // ctors and initializers
@@ -37,17 +47,17 @@ public:
 
     // 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); }
+    wxTimerBase() { Init(); SetOwner(this); }
 
     // 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 = -1)
+        { 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 = -1)
+        { m_owner = owner; m_idTimer = timerid; }
 
     virtual ~wxTimerBase();
 
@@ -80,11 +90,9 @@ public:
     // 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
@@ -95,6 +103,8 @@ protected:
 
     int     m_milli;        // the timer interval
     bool    m_oneShot;      // TRUE if one shot
+
+    DECLARE_NO_COPY_CLASS(wxTimerBase)
 };
 
 // ----------------------------------------------------------------------------
@@ -107,14 +117,12 @@ protected:
     #include "wx/motif/timer.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk/timer.h"
-#elif defined(__WXX11__) || defined(__WXMGL__)
+#elif defined(__WXX11__) || defined(__WXMGL__) || defined(__WXCOCOA__)
     #include "wx/generic/timer.h"
 #elif defined(__WXMAC__)
     #include "wx/mac/timer.h"
 #elif defined(__WXPM__)
     #include "wx/os2/timer.h"
-#elif defined(__WXSTUBS__)
-    #include "wx/stubs/timer.h"
 #endif
 
 // ----------------------------------------------------------------------------
@@ -146,6 +154,8 @@ public:
 
 private:
     wxTimer& m_timer;
+
+    DECLARE_NO_COPY_CLASS(wxTimerRunner)
 };
 
 // ----------------------------------------------------------------------------
@@ -155,7 +165,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;
 
@@ -171,73 +181,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, -1, (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()        { Start(); }
-    void Start(long t = 0);
-    void Pause()  { m_pause = GetElapsedTime(); }
-    void Resume() { Start(m_pause); }
-
-    // get elapsed time since the last Start() or Pause() in milliseconds
-    long Time() 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
-};
-
-#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_