X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/799ea01170e831c212320b0cb3038a91785e4789..7e2b786046f1efbae3778cf64c2fa18d8d553686:/include/wx/timer.h diff --git a/include/wx/timer.h b/include/wx/timer.h index b5ce8d830c..8955051268 100644 --- a/include/wx/timer.h +++ b/include/wx/timer.h @@ -1,35 +1,38 @@ ///////////////////////////////////////////////////////////////////////////// // Name: wx/timer.h // Purpose: wxTimer, wxStopWatch and global time-related functions -// Author: Julian Smart (wxTimer), Sylvain Bougnoux (wxStopWatch) +// Author: Julian Smart // Modified by: Vadim Zeitlin (wxTimerBase) // Guillermo Rodriguez (global clean up) // Created: 04/01/98 // RCS-ID: $Id$ -// Copyright: (c) wxWindows team -// Licence: wxWindows license +// Copyright: (c) Julian Smart +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_TIMER_H_BASE_ #define _WX_TIMER_H_BASE_ -#ifdef __GNUG__ - #pragma interface "timerbase.h" -#endif +#include "wx/defs.h" + +#if wxUSE_GUI && wxUSE_TIMER -#include "wx/setup.h" #include "wx/object.h" #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 +40,19 @@ 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 = 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(); @@ -59,7 +64,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; @@ -71,30 +76,29 @@ 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 + // return the timer ID + int GetId() const { return m_idTimer; } + + // get the (last) timer interval in 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 - protected: // common part of all ctors - void Init() { m_oneShot = FALSE; m_milli = 0; } + void Init() + { m_owner = NULL; m_idTimer = wxID_ANY; m_milli = 0; m_oneShot = false; } 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) }; // ---------------------------------------------------------------------------- @@ -105,16 +109,18 @@ protected: #include "wx/msw/timer.h" #elif defined(__WXMOTIF__) #include "wx/motif/timer.h" -#elif defined(__WXGTK__) +#elif defined(__WXGTK20__) #include "wx/gtk/timer.h" -#elif defined(__WXMGL__) - #include "wx/mgl/timer.h" +#elif defined(__WXGTK__) + #include "wx/gtk1/timer.h" +#elif defined(__WXX11__) || defined(__WXMGL__) + #include "wx/generic/timer.h" +#elif defined (__WXCOCOA__) + #include "wx/cocoa/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 // ---------------------------------------------------------------------------- @@ -125,13 +131,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); } @@ -146,6 +152,8 @@ public: private: wxTimer& m_timer; + + DECLARE_NO_COPY_CLASS(wxTimerRunner) }; // ---------------------------------------------------------------------------- @@ -155,7 +163,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 +179,18 @@ 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), - -#endif // wxUSE_GUI && wxUSE_TIMER +#define wxTimerEventHandler(func) \ + (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxTimerEventFunction, &func) -// ---------------------------------------------------------------------------- -// wxStopWatch: measure time intervals with up to 1ms resolution -// ---------------------------------------------------------------------------- +#define EVT_TIMER(timerid, func) \ + wx__DECLARE_EVT1(wxEVT_TIMER, timerid, wxTimerEventHandler(func)) -#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 // wxUSE_GUI && wxUSE_TIMER #endif // _WX_TIMER_H_BASE_