X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f0599ea91951caa2cda364498ea844be593b8a2a..472eec8a0391538e4dcf7f7c6c4f4d44c8383616:/include/wx/timer.h?ds=sidebyside diff --git a/include/wx/timer.h b/include/wx/timer.h index 93d3f94f7c..8c6e01625b 100644 --- a/include/wx/timer.h +++ b/include/wx/timer.h @@ -1,52 +1,186 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: wx/timer.h +// Purpose: wxTimer, wxStopWatch and global time-related functions +// Author: Julian Smart +// Modified by: Vadim Zeitlin (wxTimerBase) +// Guillermo Rodriguez (global clean up) +// Created: 04/01/98 +// RCS-ID: $Id$ +// Copyright: (c) Julian Smart +// Licence: wxWindows licence +///////////////////////////////////////////////////////////////////////////// + #ifndef _WX_TIMER_H_BASE_ #define _WX_TIMER_H_BASE_ -#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(__WXQT__) -#include "wx/qt/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 - -class wxChrono +#include "wx/defs.h" + +#if wxUSE_TIMER + +#include "wx/object.h" +#include "wx/longlong.h" +#include "wx/event.h" +#include "wx/stopwatch.h" // for backwards compatibility +#include "wx/utils.h" + + +// 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 + +class WXDLLIMPEXP_FWD_BASE wxTimerImpl; + +// the interface of wxTimer class +class WXDLLIMPEXP_BASE wxTimer : public wxEvtHandler { -public: - wxChrono(); - - void Start(long t=0); - void Pause(); - void Resume(); +public: + // ctors and initializers + // ---------------------- + + // default: if you don't call SetOwner(), your only chance to get timer + // notifications is to override Notify() in the derived class + 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 + wxTimer(wxEvtHandler *owner, int timerid = wxID_ANY) + { + Init(); + SetOwner(owner, timerid); + } + + // same as ctor above + void SetOwner(wxEvtHandler *owner, int timerid = wxID_ANY); + + virtual ~wxTimer(); + + + // 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); + + // 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(); + + + // accessors + // --------- + + // get the object notified about the timer events + wxEvtHandler *GetOwner() const; - long Time(); + // return true if the timer is running + bool IsRunning() const; + + // return the timer ID + int GetId() const; + + // get the (last) timer interval in milliseconds + int GetInterval() const; + + // return true if the timer is one shot + bool IsOneShot() const; + +protected: + // common part of all ctors + void Init(); + + wxTimerImpl *m_impl; + + DECLARE_NO_COPY_CLASS(wxTimer) +}; + +// ---------------------------------------------------------------------------- +// wxTimerRunner: starts the timer in its ctor, stops in the dtor +// ---------------------------------------------------------------------------- + +class WXDLLEXPORT wxTimerRunner +{ +public: + wxTimerRunner(wxTimer& timer) : m_timer(timer) { } + wxTimerRunner(wxTimer& timer, int milli, bool oneShot = false) + : m_timer(timer) + { + m_timer.Start(milli, oneShot); + } + + void Start(int milli, bool oneShot = false) + { + m_timer.Start(milli, oneShot); + } + + ~wxTimerRunner() + { + if ( m_timer.IsRunning() ) + { + m_timer.Stop(); + } + } private: - long m_t0; - long m_pause; + wxTimer& m_timer; + + DECLARE_NO_COPY_CLASS(wxTimerRunner) }; -// Timer functions (milliseconds) -void WXDLLEXPORT wxStartTimer(); +// ---------------------------------------------------------------------------- +// wxTimerEvent +// ---------------------------------------------------------------------------- + +class WXDLLIMPEXP_BASE wxTimerEvent : public wxEvent +{ +public: + wxTimerEvent(wxTimer& timer) + : wxEvent(timer.GetId(), wxEVT_TIMER), + m_timer(timer) + { + SetEventObject(timer.GetOwner()); + } + + // accessors + 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); } + +private: + wxTimer& m_timer; + + DECLARE_ABSTRACT_CLASS(wxTimerEvent) + DECLARE_NO_ASSIGN_CLASS(wxTimerEvent) +}; -// Gets time since last wxStartTimer or wxGetElapsedTime -long WXDLLEXPORT wxGetElapsedTime(bool resetTimer = TRUE); +typedef void (wxEvtHandler::*wxTimerEventFunction)(wxTimerEvent&); -// EXPERIMENTAL: comment this out if it doesn't compile. -bool WXDLLEXPORT wxGetLocalTime(long *timeZone, int *dstObserved); +#define wxTimerEventHandler(func) \ + (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxTimerEventFunction, &func) -// Get number of seconds since 00:00:00 GMT, Jan 1st 1970. -long WXDLLEXPORT wxGetCurrentTime(); +#define EVT_TIMER(timerid, func) \ + wx__DECLARE_EVT1(wxEVT_TIMER, timerid, wxTimerEventHandler(func)) -// Get number of milliseconds since 00:00:00 GMT, Jan 1st 1970. -long WXDLLEXPORT wxGetCurrentUTime(); +#endif // wxUSE_TIMER -#endif - // _WX_TIMER_H_BASE_ +#endif // _WX_TIMER_H_BASE_