]>
Commit | Line | Data |
---|---|---|
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$ | |
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 | #ifdef __GNUG__ | |
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 | // the interface of wxTimer class | |
32 | class WXDLLEXPORT wxTimerBase : public wxObject | |
33 | { | |
34 | public: | |
35 | // ctors and initializers | |
36 | // ---------------------- | |
37 | ||
38 | // default: if you don't call SetOwner(), your only chance to get timer | |
39 | // notifications is to override Notify() in the derived class | |
40 | wxTimerBase() { Init(); SetOwner(NULL); } | |
41 | ||
42 | // ctor which allows to avoid having to override Notify() in the derived | |
43 | // class: the owner will get timer notifications which can be handled with | |
44 | // EVT_TIMER | |
45 | wxTimerBase(wxEvtHandler *owner, int id = -1) | |
46 | { Init(); SetOwner(owner, id); } | |
47 | ||
48 | // same as ctor above | |
49 | void SetOwner(wxEvtHandler *owner, int id = -1) | |
50 | { m_owner = owner; m_idTimer = id; } | |
51 | ||
52 | virtual ~wxTimerBase(); | |
53 | ||
54 | // working with the timer | |
55 | // ---------------------- | |
56 | ||
57 | // start the timer: if milliseconds == -1, use the same value as for the | |
58 | // last Start() | |
59 | // | |
60 | // it is now valid to call Start() multiple times: this just restarts the | |
61 | // timer if it is already running | |
62 | virtual bool Start(int milliseconds = -1, bool oneShot = FALSE); | |
63 | ||
64 | // stop the timer | |
65 | virtual void Stop() = 0; | |
66 | ||
67 | // override this in your wxTimer-derived class if you want to process timer | |
68 | // messages in it, use non default ctor or SetOwner() otherwise | |
69 | virtual void Notify(); | |
70 | ||
71 | // getting info | |
72 | // ------------ | |
73 | ||
74 | // return TRUE if the timer is running | |
75 | virtual bool IsRunning() const = 0; | |
76 | ||
77 | // get the (last) timer interval in the milliseconds | |
78 | int GetInterval() const { return m_milli; } | |
79 | ||
80 | // return TRUE if the timer is one shot | |
81 | bool IsOneShot() const { return m_oneShot; } | |
82 | ||
83 | #if WXWIN_COMPATIBILITY_2 | |
84 | // deprecated functions | |
85 | int Interval() const { return GetInterval(); }; | |
86 | bool OneShot() const { return IsOneShot(); } | |
87 | #endif // WXWIN_COMPATIBILITY_2 | |
88 | ||
89 | protected: | |
90 | // common part of all ctors | |
91 | void Init() { m_oneShot = FALSE; m_milli = 0; } | |
92 | ||
93 | wxEvtHandler *m_owner; | |
94 | int m_idTimer; | |
95 | ||
96 | int m_milli; // the timer interval | |
97 | bool m_oneShot; // TRUE if one shot | |
98 | }; | |
99 | ||
100 | // ---------------------------------------------------------------------------- | |
101 | // wxTimer itself | |
102 | // ---------------------------------------------------------------------------- | |
103 | ||
104 | #if defined(__WXMSW__) | |
105 | #include "wx/msw/timer.h" | |
106 | #elif defined(__WXMOTIF__) | |
107 | #include "wx/motif/timer.h" | |
108 | #elif defined(__WXGTK__) | |
109 | #include "wx/gtk/timer.h" | |
110 | #elif defined(__WXMGL__) | |
111 | #include "wx/mgl/timer.h" | |
112 | #elif defined(__WXMAC__) | |
113 | #include "wx/mac/timer.h" | |
114 | #elif defined(__WXPM__) | |
115 | #include "wx/os2/timer.h" | |
116 | #elif defined(__WXSTUBS__) | |
117 | #include "wx/stubs/timer.h" | |
118 | #endif | |
119 | ||
120 | // ---------------------------------------------------------------------------- | |
121 | // wxTimerRunner: starts the timer in its ctor, stops in the dtor | |
122 | // ---------------------------------------------------------------------------- | |
123 | ||
124 | class WXDLLEXPORT wxTimerRunner | |
125 | { | |
126 | public: | |
127 | wxTimerRunner(wxTimer& timer) : m_timer(timer) { } | |
128 | wxTimerRunner(wxTimer& timer, int milli, bool oneShot = FALSE) | |
129 | : m_timer(timer) | |
130 | { | |
131 | m_timer.Start(milli, oneShot); | |
132 | } | |
133 | ||
134 | void Start(int milli, bool oneShot = FALSE) | |
135 | { | |
136 | m_timer.Start(milli, oneShot); | |
137 | } | |
138 | ||
139 | ~wxTimerRunner() | |
140 | { | |
141 | if ( m_timer.IsRunning() ) | |
142 | { | |
143 | m_timer.Stop(); | |
144 | } | |
145 | } | |
146 | ||
147 | private: | |
148 | wxTimer& m_timer; | |
149 | }; | |
150 | ||
151 | // ---------------------------------------------------------------------------- | |
152 | // wxTimerEvent | |
153 | // ---------------------------------------------------------------------------- | |
154 | ||
155 | class WXDLLEXPORT wxTimerEvent : public wxEvent | |
156 | { | |
157 | public: | |
158 | wxTimerEvent(int id = 0, int interval = 0) : wxEvent(id) | |
159 | { | |
160 | m_eventType = wxEVT_TIMER; | |
161 | ||
162 | m_interval = interval; | |
163 | } | |
164 | ||
165 | // accessors | |
166 | int GetInterval() const { return m_interval; } | |
167 | ||
168 | // implement the base class pure virtual | |
169 | virtual wxEvent *Clone() const { return new wxTimerEvent(*this); } | |
170 | ||
171 | private: | |
172 | int m_interval; | |
173 | ||
174 | DECLARE_DYNAMIC_CLASS(wxTimerEvent) | |
175 | }; | |
176 | ||
177 | typedef void (wxEvtHandler::*wxTimerEventFunction)(wxTimerEvent&); | |
178 | ||
179 | #define EVT_TIMER(id, func) \ | |
180 | DECLARE_EVENT_TABLE_ENTRY( wxEVT_TIMER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTimerEventFunction) & func, NULL), | |
181 | ||
182 | #endif // wxUSE_GUI && wxUSE_TIMER | |
183 | ||
184 | // ---------------------------------------------------------------------------- | |
185 | // wxStopWatch: measure time intervals with up to 1ms resolution | |
186 | // ---------------------------------------------------------------------------- | |
187 | ||
188 | #if wxUSE_STOPWATCH | |
189 | ||
190 | class WXDLLEXPORT wxStopWatch | |
191 | { | |
192 | public: | |
193 | // ctor starts the stop watch | |
194 | wxStopWatch() { Start(); } | |
195 | void Start(long t = 0); | |
196 | void Pause() { m_pause = GetElapsedTime(); } | |
197 | void Resume() { Start(m_pause); } | |
198 | ||
199 | // get elapsed time since the last Start() or Pause() in milliseconds | |
200 | long Time() const; | |
201 | ||
202 | protected: | |
203 | // returns the elapsed time since t0 | |
204 | long GetElapsedTime() const; | |
205 | ||
206 | private: | |
207 | wxLongLong m_t0; // the time of the last Start() | |
208 | long m_pause; // the time of the last Pause() or 0 | |
209 | }; | |
210 | ||
211 | #endif // wxUSE_STOPWATCH | |
212 | ||
213 | #if wxUSE_LONGLONG | |
214 | ||
215 | // Starts a global timer | |
216 | // -- DEPRECATED: use wxStopWatch instead | |
217 | void WXDLLEXPORT wxStartTimer(); | |
218 | ||
219 | // Gets elapsed milliseconds since last wxStartTimer or wxGetElapsedTime | |
220 | // -- DEPRECATED: use wxStopWatch instead | |
221 | long WXDLLEXPORT wxGetElapsedTime(bool resetTimer = TRUE); | |
222 | ||
223 | #endif // wxUSE_LONGLONG | |
224 | ||
225 | // ---------------------------------------------------------------------------- | |
226 | // global time functions | |
227 | // ---------------------------------------------------------------------------- | |
228 | ||
229 | // Get number of seconds since local time 00:00:00 Jan 1st 1970. | |
230 | extern long WXDLLEXPORT wxGetLocalTime(); | |
231 | ||
232 | // Get number of seconds since GMT 00:00:00, Jan 1st 1970. | |
233 | extern long WXDLLEXPORT wxGetUTCTime(); | |
234 | ||
235 | #if wxUSE_LONGLONG | |
236 | // Get number of milliseconds since local time 00:00:00 Jan 1st 1970 | |
237 | extern wxLongLong WXDLLEXPORT wxGetLocalTimeMillis(); | |
238 | #endif // wxUSE_LONGLONG | |
239 | ||
240 | #define wxGetCurrentTime() wxGetLocalTime() | |
241 | ||
242 | #endif | |
243 | // _WX_TIMER_H_BASE_ |