1 ///////////////////////////////////////////////////////////////////////////// 2 // Name: wx/timer.h 3 // Purpose: wxTimer, wxStopWatch and global time-related functions 4 // Author: Julian Smart (wxTimer), Sylvain Bougnoux (wxStopWatch) 5 // Modified by: Vadim Zeitlin (wxTimerBase) 6 // Guillermo Rodriguez (global clean up) 7 // Created: 04/01/98 8 // RCS-ID: $Id: timer.h,v 1.1 2006/12/02 15:58:27 scara Exp $ 9 // Copyright: (c) wxWindows team 10 // Licence: wxWindows license 11 ///////////////////////////////////////////////////////////////////////////// 12 13 #ifndef _WX_TIMER_H_BASE_ 14 #define _WX_TIMER_H_BASE_ 15 16 #if defined(__GNUG__) && !defined(__APPLE__) 17 #pragma interface "timerbase.h" 18 #endif 19 20 #include "wx/setup.h" 21 #include "wx/object.h" 22 #include "wx/longlong.h" 23 #include "wx/event.h" 24 25 #if wxUSE_GUI && wxUSE_TIMER 26 27 // ---------------------------------------------------------------------------- 28 // wxTimer 29 // ---------------------------------------------------------------------------- 30 31 // more readable flags for Start(): 32 33 // generate notifications periodically until the timer is stopped (default) 34 #define wxTIMER_CONTINUOUS FALSE 35 36 // only send the notification once and then stop the timer 37 #define wxTIMER_ONE_SHOT TRUE 38 39 // the interface of wxTimer class 40 class WXDLLEXPORT wxTimerBase : public wxObject 41 { 42 public: 43 // ctors and initializers 44 // ---------------------- 45 46 // default: if you don't call SetOwner(), your only chance to get timer 47 // notifications is to override Notify() in the derived class wxTimerBase()48 wxTimerBase() { Init(); SetOwner(NULL); } 49 50 // ctor which allows to avoid having to override Notify() in the derived 51 // class: the owner will get timer notifications which can be handled with 52 // EVT_TIMER 53 wxTimerBase(wxEvtHandler *owner, int id = -1) 54 { Init(); SetOwner(owner, id); } 55 56 // same as ctor above 57 void SetOwner(wxEvtHandler *owner, int id = -1) 58 { m_owner = owner; m_idTimer = id; } 59 60 virtual ~wxTimerBase(); 61 62 // working with the timer 63 // ---------------------- 64 65 // start the timer: if milliseconds == -1, use the same value as for the 66 // last Start() 67 // 68 // it is now valid to call Start() multiple times: this just restarts the 69 // timer if it is already running 70 virtual bool Start(int milliseconds = -1, bool oneShot = FALSE); 71 72 // stop the timer 73 virtual void Stop() = 0; 74 75 // override this in your wxTimer-derived class if you want to process timer 76 // messages in it, use non default ctor or SetOwner() otherwise 77 virtual void Notify(); 78 79 // getting info 80 // ------------ 81 82 // return TRUE if the timer is running 83 virtual bool IsRunning() const = 0; 84 85 // get the (last) timer interval in the milliseconds GetInterval()86 int GetInterval() const { return m_milli; } 87 88 // return TRUE if the timer is one shot IsOneShot()89 bool IsOneShot() const { return m_oneShot; } 90 91 #if WXWIN_COMPATIBILITY_2 92 // deprecated functions Interval()93 int Interval() const { return GetInterval(); }; OneShot()94 bool OneShot() const { return IsOneShot(); } 95 #endif // WXWIN_COMPATIBILITY_2 96 97 protected: 98 // common part of all ctors Init()99 void Init() { m_oneShot = FALSE; m_milli = 0; } 100 101 wxEvtHandler *m_owner; 102 int m_idTimer; 103 104 int m_milli; // the timer interval 105 bool m_oneShot; // TRUE if one shot 106 }; 107 108 // ---------------------------------------------------------------------------- 109 // wxTimer itself 110 // ---------------------------------------------------------------------------- 111 112 #if defined(__WXMSW__) 113 #include "wx/msw/timer.h" 114 #elif defined(__WXMOTIF__) 115 #include "wx/motif/timer.h" 116 #elif defined(__WXGTK__) 117 #include "wx/gtk/timer.h" 118 #elif defined(__WXX11__) || defined(__WXMGL__) 119 #include "wx/generic/timer.h" 120 #elif defined(__WXMAC__) 121 #include "wx/mac/timer.h" 122 #elif defined(__WXPM__) 123 #include "wx/os2/timer.h" 124 #elif defined(__WXSTUBS__) 125 #include "wx/stubs/timer.h" 126 #endif 127 128 // ---------------------------------------------------------------------------- 129 // wxTimerRunner: starts the timer in its ctor, stops in the dtor 130 // ---------------------------------------------------------------------------- 131 132 class WXDLLEXPORT wxTimerRunner 133 { 134 public: wxTimerRunner(wxTimer & timer)135 wxTimerRunner(wxTimer& timer) : m_timer(timer) { } 136 wxTimerRunner(wxTimer& timer, int milli, bool oneShot = FALSE) m_timer(timer)137 : m_timer(timer) 138 { 139 m_timer.Start(milli, oneShot); 140 } 141 142 void Start(int milli, bool oneShot = FALSE) 143 { 144 m_timer.Start(milli, oneShot); 145 } 146 ~wxTimerRunner()147 ~wxTimerRunner() 148 { 149 if ( m_timer.IsRunning() ) 150 { 151 m_timer.Stop(); 152 } 153 } 154 155 private: 156 wxTimer& m_timer; 157 }; 158 159 // ---------------------------------------------------------------------------- 160 // wxTimerEvent 161 // ---------------------------------------------------------------------------- 162 163 class WXDLLEXPORT wxTimerEvent : public wxEvent 164 { 165 public: wxEvent(id)166 wxTimerEvent(int id = 0, int interval = 0) : wxEvent(id) 167 { 168 m_eventType = wxEVT_TIMER; 169 170 m_interval = interval; 171 } 172 173 // accessors GetInterval()174 int GetInterval() const { return m_interval; } 175 176 // implement the base class pure virtual Clone()177 virtual wxEvent *Clone() const { return new wxTimerEvent(*this); } 178 179 private: 180 int m_interval; 181 182 DECLARE_DYNAMIC_CLASS(wxTimerEvent) 183 }; 184 185 typedef void (wxEvtHandler::*wxTimerEventFunction)(wxTimerEvent&); 186 187 #define EVT_TIMER(id, func) \ 188 DECLARE_EVENT_TABLE_ENTRY( wxEVT_TIMER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTimerEventFunction) & func, NULL), 189 190 #endif // wxUSE_GUI && wxUSE_TIMER 191 192 // ---------------------------------------------------------------------------- 193 // wxStopWatch: measure time intervals with up to 1ms resolution 194 // ---------------------------------------------------------------------------- 195 196 #if wxUSE_STOPWATCH 197 198 class WXDLLEXPORT wxStopWatch 199 { 200 public: 201 // ctor starts the stop watch wxStopWatch()202 wxStopWatch() { m_pauseCount = 0; Start(); } 203 204 // start the stop watch at the moment t0 205 void Start(long t0 = 0); 206 207 // pause the stop watch Pause()208 void Pause() { if ( !m_pauseCount++) m_pause = GetElapsedTime(); } 209 210 // resume it Resume()211 void Resume() { if ( !--m_pauseCount ) Start(m_pause); } 212 213 // get elapsed time since the last Start() in milliseconds 214 long Time() const; 215 216 protected: 217 // returns the elapsed time since t0 218 long GetElapsedTime() const; 219 220 private: 221 // the time of the last Start() 222 wxLongLong m_t0; 223 224 // the time of the last Pause() (only valid if m_pauseCount > 0) 225 long m_pause; 226 227 // if > 0, the stop watch is paused, otherwise it is running 228 int m_pauseCount; 229 }; 230 231 #endif // wxUSE_STOPWATCH 232 233 #if wxUSE_LONGLONG 234 235 // Starts a global timer 236 // -- DEPRECATED: use wxStopWatch instead 237 void WXDLLEXPORT wxStartTimer(); 238 239 // Gets elapsed milliseconds since last wxStartTimer or wxGetElapsedTime 240 // -- DEPRECATED: use wxStopWatch instead 241 long WXDLLEXPORT wxGetElapsedTime(bool resetTimer = TRUE); 242 243 #endif // wxUSE_LONGLONG 244 245 // ---------------------------------------------------------------------------- 246 // global time functions 247 // ---------------------------------------------------------------------------- 248 249 // Get number of seconds since local time 00:00:00 Jan 1st 1970. 250 extern long WXDLLEXPORT wxGetLocalTime(); 251 252 // Get number of seconds since GMT 00:00:00, Jan 1st 1970. 253 extern long WXDLLEXPORT wxGetUTCTime(); 254 255 #if wxUSE_LONGLONG 256 // Get number of milliseconds since local time 00:00:00 Jan 1st 1970 257 extern wxLongLong WXDLLEXPORT wxGetLocalTimeMillis(); 258 #endif // wxUSE_LONGLONG 259 260 #define wxGetCurrentTime() wxGetLocalTime() 261 262 #endif 263 // _WX_TIMER_H_BASE_ 264