X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/01ebf7520366a4cf80975d820794fea394c96d7b..cbeda384e51acb82e13994cb67ac1714669cae10:/include/wx/timer.h diff --git a/include/wx/timer.h b/include/wx/timer.h index 77d2710666..0b9a63b082 100644 --- a/include/wx/timer.h +++ b/include/wx/timer.h @@ -1,43 +1,45 @@ ///////////////////////////////////////////////////////////////////////////// // 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 +// Copyright: (c) Julian Smart // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_TIMER_H_BASE_ #define _WX_TIMER_H_BASE_ -#if defined(__GNUG__) && !defined(__APPLE__) - #pragma interface "timerbase.h" -#endif +#include "wx/defs.h" + +#if 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 +#include "wx/utils.h" -#if wxUSE_GUI && wxUSE_TIMER - -// ---------------------------------------------------------------------------- -// wxTimer -// ---------------------------------------------------------------------------- // 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 + +class WXDLLIMPEXP_FWD_BASE wxTimerImpl; +class WXDLLIMPEXP_FWD_BASE wxTimerEvent; + +// timer event type +wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_BASE, wxEVT_TIMER, wxTimerEvent); // the interface of wxTimer class -class WXDLLEXPORT wxTimerBase : public wxEvtHandler +class WXDLLIMPEXP_BASE wxTimer : public wxEvtHandler { public: // ctors and initializers @@ -45,101 +47,90 @@ 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(this); } + wxTimer() + { + 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); } + wxTimer(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); + + virtual ~wxTimer(); - virtual ~wxTimerBase(); // working with the timer // ---------------------- + // NB: Start() and Stop() are not supposed to be overridden, they are only + // virtual for historical reasons, only Notify() can be overridden + // start the timer: if milliseconds == -1, use the same value as for the // last Start() // // 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; + // stop the timer, does nothing if the timer is not running + virtual void Stop(); // 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 - // ------------ - // return TRUE if the timer is running - virtual bool IsRunning() const = 0; + // accessors + // --------- + + // get the object notified about the timer events + wxEvtHandler *GetOwner() const; + + // return true if the timer is running + bool IsRunning() const; - // get the (last) timer interval in the milliseconds - int GetInterval() const { return m_milli; } + // return the timer ID + int GetId() const; - // return TRUE if the timer is one shot - bool IsOneShot() const { return m_oneShot; } + // get the (last) timer interval in milliseconds + int GetInterval() const; -#if WXWIN_COMPATIBILITY_2 - // deprecated functions - int Interval() const { return GetInterval(); }; - bool OneShot() const { return IsOneShot(); } -#endif // WXWIN_COMPATIBILITY_2 + // return true if the timer is one shot + bool IsOneShot() const; protected: // common part of all ctors - void Init() { m_oneShot = FALSE; m_milli = 0; } + void Init(); - wxEvtHandler *m_owner; - int m_idTimer; + wxTimerImpl *m_impl; - int m_milli; // the timer interval - bool m_oneShot; // TRUE if one shot - - DECLARE_NO_COPY_CLASS(wxTimerBase) + wxDECLARE_NO_COPY_CLASS(wxTimer); }; -// ---------------------------------------------------------------------------- -// 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" -#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" -#endif - // ---------------------------------------------------------------------------- // wxTimerRunner: starts the timer in its ctor, stops in the dtor // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxTimerRunner +class WXDLLIMPEXP_BASE 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,121 +145,49 @@ public: private: wxTimer& m_timer; + + wxDECLARE_NO_COPY_CLASS(wxTimerRunner); }; // ---------------------------------------------------------------------------- // wxTimerEvent // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxTimerEvent : public wxEvent +class WXDLLIMPEXP_BASE wxTimerEvent : public wxEvent { public: - wxTimerEvent(int id = 0, int interval = 0) : wxEvent(id) - { - m_eventType = wxEVT_TIMER; + wxTimerEvent() + : wxEvent(wxID_ANY, wxEVT_TIMER) { m_timer=NULL; } - m_interval = interval; + wxTimerEvent(wxTimer& timer) + : wxEvent(timer.GetId(), wxEVT_TIMER), + m_timer(&timer) + { + SetEventObject(timer.GetOwner()); } // accessors - int GetInterval() const { return m_interval; } + int GetInterval() const { return m_timer->GetInterval(); } + wxTimer& GetTimer() const { return *m_timer; } // implement the base class pure virtual virtual wxEvent *Clone() const { return new wxTimerEvent(*this); } + virtual wxEventCategory GetEventCategory() const { return wxEVT_CATEGORY_TIMER; } private: - int m_interval; + wxTimer* m_timer; - 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 - -// ---------------------------------------------------------------------------- -// 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(); +#define wxTimerEventHandler(func) \ + wxEVENT_HANDLER_CAST(wxTimerEventFunction, func) -#if wxUSE_LONGLONG -// Get number of milliseconds since local time 00:00:00 Jan 1st 1970 -extern wxLongLong WXDLLEXPORT wxGetLocalTimeMillis(); -#endif // wxUSE_LONGLONG +#define EVT_TIMER(timerid, func) \ + wx__DECLARE_EVT1(wxEVT_TIMER, timerid, wxTimerEventHandler(func)) -#define wxGetCurrentTime() wxGetLocalTime() +#endif // wxUSE_TIMER -#endif - // _WX_TIMER_H_BASE_ +#endif // _WX_TIMER_H_BASE_