X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/df0c322667ba2e66751bb7453e4de69afae3f4a0..8d0a7b563acf4bd7e75824ba2076a7ab4d81a650:/include/wx/timer.h diff --git a/include/wx/timer.h b/include/wx/timer.h index b8c8e8dc28..f17a83a091 100644 --- a/include/wx/timer.h +++ b/include/wx/timer.h @@ -1,144 +1,201 @@ ///////////////////////////////////////////////////////////////////////////// // Name: wx/timer.h -// Purpose: wxTimer class and global time-related functions -// Author: Julian Smart -// Modified by: +// Purpose: wxTimer, wxStopWatch and global time-related functions +// Author: Julian Smart (wxTimer), Sylvain Bougnoux (wxStopWatch) +// Modified by: Vadim Zeitlin (wxTimerBase) +// Guillermo Rodriguez (global clean up) // Created: 04/01/98 // RCS-ID: $Id$ -// Copyright: (c) Julian Smart and Markus Holzem -// Licence: wxWindows license +// Copyright: (c) wxWidgets team +// 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 -#include "wx/setup.h" +#include "wx/defs.h" + +#if wxUSE_GUI && wxUSE_TIMER + #include "wx/object.h" #include "wx/longlong.h" +#include "wx/event.h" +#include "wx/stopwatch.h" // for backwards compatibility // ---------------------------------------------------------------------------- // 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: - wxTimerBase() { m_oneShot = FALSE; m_milli = 0; } + // 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 + 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 timerid = wxID_ANY) + { Init(); SetOwner(owner, timerid); } + + // same as ctor above + void SetOwner(wxEvtHandler *owner, int timerid = wxID_ANY) + { m_owner = owner; m_idTimer = timerid; } + wxEvtHandler* GetOwner() const { return m_owner; } + + 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; - // override this in your wxTimer-derived class - virtual void Notify() = 0; + // 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 + // return true if the timer is running virtual bool IsRunning() const = 0; // get the (last) timer interval in the 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 + // return the timer ID + int GetId() const { return m_idTimer; } + protected: + // common part of all ctors + void Init() { m_oneShot = false; m_milli = 0; } + + 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) }; +// ---------------------------------------------------------------------------- +// 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(__WXQT__) - #include "wx/qt/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 // ---------------------------------------------------------------------------- -// wxStopWatch +// wxTimerRunner: starts the timer in its ctor, stops in the dtor // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxStopWatch +class WXDLLEXPORT wxTimerRunner { -public: - // ctor starts the stop watch - wxStopWatch() { Start(); } - void Start(long t = 0); - inline void Pause() { m_pause = GetElapsedTime(); } - inline void Resume() { Start(m_pause); } +public: + wxTimerRunner(wxTimer& timer) : m_timer(timer) { } + wxTimerRunner(wxTimer& timer, int milli, bool oneShot = false) + : m_timer(timer) + { + m_timer.Start(milli, oneShot); + } - // get elapsed time since the last Start() or Pause() in milliseconds - long Time() const; + void Start(int milli, bool oneShot = false) + { + m_timer.Start(milli, oneShot); + } + + ~wxTimerRunner() + { + if ( m_timer.IsRunning() ) + { + m_timer.Stop(); + } + } -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 + wxTimer& m_timer; + + DECLARE_NO_COPY_CLASS(wxTimerRunner) }; +// ---------------------------------------------------------------------------- +// wxTimerEvent +// ---------------------------------------------------------------------------- + +class WXDLLEXPORT wxTimerEvent : public wxEvent +{ +public: + wxTimerEvent(int timerid = 0, int interval = 0) : wxEvent(timerid) + { + m_eventType = wxEVT_TIMER; + + m_interval = interval; + } -// Starts a global timer -// -- DEPRECATED: use wxStopWatch instead -void WXDLLEXPORT wxStartTimer(); + // accessors + int GetInterval() const { return m_interval; } -// Gets elapsed milliseconds since last wxStartTimer or wxGetElapsedTime -// -- DEPRECATED: use wxStopWatch instead -long WXDLLEXPORT wxGetElapsedTime(bool resetTimer = TRUE); + // implement the base class pure virtual + virtual wxEvent *Clone() const { return new wxTimerEvent(*this); } +private: + int m_interval; -// ---------------------------------------------------------------------------- -// global time functions -// ---------------------------------------------------------------------------- + DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxTimerEvent) +}; + +typedef void (wxEvtHandler::*wxTimerEventFunction)(wxTimerEvent&); -// Get number of seconds since local time 00:00:00 Jan 1st 1970. -long WXDLLEXPORT wxGetLocalTime(); +#define wxTimerEventHandler(func) \ + (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxTimerEventFunction, &func) -// Get number of seconds since GMT 00:00:00, Jan 1st 1970. -long WXDLLEXPORT wxGetUTCTime(); +#define EVT_TIMER(timerid, func) \ + wx__DECLARE_EVT1(wxEVT_TIMER, timerid, wxTimerEventHandler(func)) -#define wxGetCurrentTime() wxGetLocalTime() +#endif // wxUSE_GUI && wxUSE_TIMER #endif // _WX_TIMER_H_BASE_