X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/52a07708c402e7b60a73abb6bae42838cf92c9f7..1f1c42109dce7d0760966eb57127a0bb668d50f5:/include/wx/timer.h diff --git a/include/wx/timer.h b/include/wx/timer.h index eddeb32d2c..3c0b0b7f37 100644 --- 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(__APPLE__) #pragma interface "timerbase.h" #endif @@ -22,14 +22,24 @@ #include "wx/longlong.h" #include "wx/event.h" -#if wxUSE_GUI +#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,7 +47,7 @@ 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 @@ -49,23 +59,17 @@ public: 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; @@ -101,6 +105,8 @@ protected: int m_milli; // the timer interval bool m_oneShot; // TRUE if one shot + + DECLARE_NO_COPY_CLASS(wxTimerBase) }; // ---------------------------------------------------------------------------- @@ -113,14 +119,12 @@ 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__) || 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 // ---------------------------------------------------------------------------- @@ -171,6 +175,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; @@ -179,55 +186,10 @@ private: typedef void (wxEvtHandler::*wxTimerEventFunction)(wxTimerEvent&); -#define EVT_TIMER(id, func) { wxEVT_TIMER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTimerEventFunction) & func, NULL}, - -#endif // wxUSE_GUI - -// ---------------------------------------------------------------------------- -// wxStopWatch: measure time intervals with up to 1ms resolution -// ---------------------------------------------------------------------------- - -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 -}; - - -// 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); - -// ---------------------------------------------------------------------------- -// global time functions -// ---------------------------------------------------------------------------- - -// Get number of seconds since local time 00:00:00 Jan 1st 1970. -long WXDLLEXPORT wxGetLocalTime(); - -// Get number of seconds since GMT 00:00:00, Jan 1st 1970. -long WXDLLEXPORT wxGetUTCTime(); +#define EVT_TIMER(id, func) \ + DECLARE_EVENT_TABLE_ENTRY( wxEVT_TIMER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTimerEventFunction) & func, NULL), -#define wxGetCurrentTime() wxGetLocalTime() +#endif // wxUSE_GUI && wxUSE_TIMER #endif // _WX_TIMER_H_BASE_