]> git.saurik.com Git - wxWidgets.git/blob - include/wx/timer.h
Define WXBUILDING in Xcode projects.
[wxWidgets.git] / include / wx / timer.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/timer.h
3 // Purpose: wxTimer, wxStopWatch and global time-related functions
4 // Author: Julian Smart
5 // Modified by: Vadim Zeitlin (wxTimerBase)
6 // Guillermo Rodriguez (global clean up)
7 // Created: 04/01/98
8 // RCS-ID: $Id$
9 // Copyright: (c) Julian Smart
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
12
13 #ifndef _WX_TIMER_H_BASE_
14 #define _WX_TIMER_H_BASE_
15
16 #include "wx/defs.h"
17
18 #if wxUSE_TIMER
19
20 #include "wx/object.h"
21 #include "wx/longlong.h"
22 #include "wx/event.h"
23 #include "wx/stopwatch.h" // for backwards compatibility
24 #include "wx/utils.h"
25
26
27 // more readable flags for Start():
28
29 // generate notifications periodically until the timer is stopped (default)
30 #define wxTIMER_CONTINUOUS false
31
32 // only send the notification once and then stop the timer
33 #define wxTIMER_ONE_SHOT true
34
35 class WXDLLIMPEXP_FWD_BASE wxTimerImpl;
36 class WXDLLIMPEXP_FWD_BASE wxTimerEvent;
37
38 // timer event type
39 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_BASE, wxEVT_TIMER, wxTimerEvent);
40
41 // the interface of wxTimer class
42 class WXDLLIMPEXP_BASE wxTimer : public wxEvtHandler
43 {
44 public:
45 // ctors and initializers
46 // ----------------------
47
48 // default: if you don't call SetOwner(), your only chance to get timer
49 // notifications is to override Notify() in the derived class
50 wxTimer()
51 {
52 Init();
53 SetOwner(this);
54 }
55
56 // ctor which allows to avoid having to override Notify() in the derived
57 // class: the owner will get timer notifications which can be handled with
58 // EVT_TIMER
59 wxTimer(wxEvtHandler *owner, int timerid = wxID_ANY)
60 {
61 Init();
62 SetOwner(owner, timerid);
63 }
64
65 // same as ctor above
66 void SetOwner(wxEvtHandler *owner, int timerid = wxID_ANY);
67
68 virtual ~wxTimer();
69
70
71 // working with the timer
72 // ----------------------
73
74 // NB: Start() and Stop() are not supposed to be overridden, they are only
75 // virtual for historical reasons, only Notify() can be overridden
76
77 // start the timer: if milliseconds == -1, use the same value as for the
78 // last Start()
79 //
80 // it is now valid to call Start() multiple times: this just restarts the
81 // timer if it is already running
82 virtual bool Start(int milliseconds = -1, bool oneShot = false);
83
84 // start the timer for one iteration only, this is just a simple wrapper
85 // for Start()
86 bool StartOnce(int milliseconds = -1) { return Start(milliseconds, true); }
87
88 // stop the timer, does nothing if the timer is not running
89 virtual void Stop();
90
91 // override this in your wxTimer-derived class if you want to process timer
92 // messages in it, use non default ctor or SetOwner() otherwise
93 virtual void Notify();
94
95
96 // accessors
97 // ---------
98
99 // get the object notified about the timer events
100 wxEvtHandler *GetOwner() const;
101
102 // return true if the timer is running
103 bool IsRunning() const;
104
105 // return the timer ID
106 int GetId() const;
107
108 // get the (last) timer interval in milliseconds
109 int GetInterval() const;
110
111 // return true if the timer is one shot
112 bool IsOneShot() const;
113
114 protected:
115 // common part of all ctors
116 void Init();
117
118 wxTimerImpl *m_impl;
119
120 wxDECLARE_NO_COPY_CLASS(wxTimer);
121 };
122
123 // ----------------------------------------------------------------------------
124 // wxTimerRunner: starts the timer in its ctor, stops in the dtor
125 // ----------------------------------------------------------------------------
126
127 class WXDLLIMPEXP_BASE wxTimerRunner
128 {
129 public:
130 wxTimerRunner(wxTimer& timer) : m_timer(timer) { }
131 wxTimerRunner(wxTimer& timer, int milli, bool oneShot = false)
132 : m_timer(timer)
133 {
134 m_timer.Start(milli, oneShot);
135 }
136
137 void Start(int milli, bool oneShot = false)
138 {
139 m_timer.Start(milli, oneShot);
140 }
141
142 ~wxTimerRunner()
143 {
144 if ( m_timer.IsRunning() )
145 {
146 m_timer.Stop();
147 }
148 }
149
150 private:
151 wxTimer& m_timer;
152
153 wxDECLARE_NO_COPY_CLASS(wxTimerRunner);
154 };
155
156 // ----------------------------------------------------------------------------
157 // wxTimerEvent
158 // ----------------------------------------------------------------------------
159
160 class WXDLLIMPEXP_BASE wxTimerEvent : public wxEvent
161 {
162 public:
163 wxTimerEvent()
164 : wxEvent(wxID_ANY, wxEVT_TIMER) { m_timer=NULL; }
165
166 wxTimerEvent(wxTimer& timer)
167 : wxEvent(timer.GetId(), wxEVT_TIMER),
168 m_timer(&timer)
169 {
170 SetEventObject(timer.GetOwner());
171 }
172
173 // accessors
174 int GetInterval() const { return m_timer->GetInterval(); }
175 wxTimer& GetTimer() const { return *m_timer; }
176
177 // implement the base class pure virtual
178 virtual wxEvent *Clone() const { return new wxTimerEvent(*this); }
179 virtual wxEventCategory GetEventCategory() const { return wxEVT_CATEGORY_TIMER; }
180
181 private:
182 wxTimer* m_timer;
183
184 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxTimerEvent)
185 };
186
187 typedef void (wxEvtHandler::*wxTimerEventFunction)(wxTimerEvent&);
188
189 #define wxTimerEventHandler(func) \
190 wxEVENT_HANDLER_CAST(wxTimerEventFunction, func)
191
192 #define EVT_TIMER(timerid, func) \
193 wx__DECLARE_EVT1(wxEVT_TIMER, timerid, wxTimerEventHandler(func))
194
195 #endif // wxUSE_TIMER
196
197 #endif // _WX_TIMER_H_BASE_