]> git.saurik.com Git - wxWidgets.git/blame - include/wx/timer.h
DoPrepareDC needs the dc.
[wxWidgets.git] / include / wx / timer.h
CommitLineData
0470b1e6
VZ
1/////////////////////////////////////////////////////////////////////////////
2// Name: wx/timer.h
ed791986
VZ
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)
0470b1e6
VZ
7// Created: 04/01/98
8// RCS-ID: $Id$
77ffb593 9// Copyright: (c) wxWidgets team
65571936 10// Licence: wxWindows licence
0470b1e6
VZ
11/////////////////////////////////////////////////////////////////////////////
12
34138703
JS
13#ifndef _WX_TIMER_H_BASE_
14#define _WX_TIMER_H_BASE_
c801d85f 15
12028905 16#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
0470b1e6
VZ
17 #pragma interface "timerbase.h"
18#endif
19
d895ad7c 20#include "wx/setup.h"
0470b1e6 21#include "wx/object.h"
d895ad7c 22#include "wx/longlong.h"
ed791986 23#include "wx/event.h"
0470b1e6 24
5fb98c22
VZ
25#include "wx/stopwatch.h" // for backwards compatibility
26
1e6feb95 27#if wxUSE_GUI && wxUSE_TIMER
52a07708 28
0470b1e6
VZ
29// ----------------------------------------------------------------------------
30// wxTimer
31// ----------------------------------------------------------------------------
32
b0a2d8a8
VZ
33// more readable flags for Start():
34
35// generate notifications periodically until the timer is stopped (default)
36#define wxTIMER_CONTINUOUS FALSE
37
38// only send the notification once and then stop the timer
39#define wxTIMER_ONE_SHOT TRUE
40
0470b1e6 41// the interface of wxTimer class
01ebf752 42class WXDLLEXPORT wxTimerBase : public wxEvtHandler
0470b1e6
VZ
43{
44public:
ed791986
VZ
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
01ebf752 50 wxTimerBase() { Init(); SetOwner(this); }
ed791986
VZ
51
52 // ctor which allows to avoid having to override Notify() in the derived
53 // class: the owner will get timer notifications which can be handled with
54 // EVT_TIMER
c5c5dad5
DE
55 wxTimerBase(wxEvtHandler *owner, int timerid = -1)
56 { Init(); SetOwner(owner, timerid); }
ed791986
VZ
57
58 // same as ctor above
c5c5dad5
DE
59 void SetOwner(wxEvtHandler *owner, int timerid = -1)
60 { m_owner = owner; m_idTimer = timerid; }
313feadc 61 wxEvtHandler* GetOwner() const { return m_owner; }
0470b1e6 62
799ea011 63 virtual ~wxTimerBase();
03e11df5 64
0470b1e6
VZ
65 // working with the timer
66 // ----------------------
67
68 // start the timer: if milliseconds == -1, use the same value as for the
69 // last Start()
99646f7e
VZ
70 //
71 // it is now valid to call Start() multiple times: this just restarts the
72 // timer if it is already running
73 virtual bool Start(int milliseconds = -1, bool oneShot = FALSE);
0470b1e6
VZ
74
75 // stop the timer
76 virtual void Stop() = 0;
77
ed791986
VZ
78 // override this in your wxTimer-derived class if you want to process timer
79 // messages in it, use non default ctor or SetOwner() otherwise
80 virtual void Notify();
0470b1e6
VZ
81
82 // getting info
83 // ------------
84
85 // return TRUE if the timer is running
86 virtual bool IsRunning() const = 0;
87
88 // get the (last) timer interval in the milliseconds
89 int GetInterval() const { return m_milli; }
90
91 // return TRUE if the timer is one shot
92 bool IsOneShot() const { return m_oneShot; }
93
0bdc5dd6
RD
94 // return the timer ID
95 int GetId() const { return m_idTimer; }
96
97
0470b1e6 98protected:
ed791986
VZ
99 // common part of all ctors
100 void Init() { m_oneShot = FALSE; m_milli = 0; }
101
102 wxEvtHandler *m_owner;
103 int m_idTimer;
104
0470b1e6
VZ
105 int m_milli; // the timer interval
106 bool m_oneShot; // TRUE if one shot
22f3361e
VZ
107
108 DECLARE_NO_COPY_CLASS(wxTimerBase)
0470b1e6
VZ
109};
110
ed791986
VZ
111// ----------------------------------------------------------------------------
112// wxTimer itself
113// ----------------------------------------------------------------------------
114
2049ba38 115#if defined(__WXMSW__)
0470b1e6 116 #include "wx/msw/timer.h"
2049ba38 117#elif defined(__WXMOTIF__)
0470b1e6 118 #include "wx/motif/timer.h"
2049ba38 119#elif defined(__WXGTK__)
0470b1e6 120 #include "wx/gtk/timer.h"
51a8edc7 121#elif defined(__WXX11__) || defined(__WXMGL__) || defined(__WXCOCOA__)
c331ac2e 122 #include "wx/generic/timer.h"
34138703 123#elif defined(__WXMAC__)
0470b1e6 124 #include "wx/mac/timer.h"
1777b9bb 125#elif defined(__WXPM__)
0470b1e6 126 #include "wx/os2/timer.h"
c801d85f
KB
127#endif
128
52a07708
VZ
129// ----------------------------------------------------------------------------
130// wxTimerRunner: starts the timer in its ctor, stops in the dtor
131// ----------------------------------------------------------------------------
132
133class WXDLLEXPORT wxTimerRunner
134{
135public:
136 wxTimerRunner(wxTimer& timer) : m_timer(timer) { }
137 wxTimerRunner(wxTimer& timer, int milli, bool oneShot = FALSE)
138 : m_timer(timer)
139 {
140 m_timer.Start(milli, oneShot);
141 }
142
143 void Start(int milli, bool oneShot = FALSE)
144 {
145 m_timer.Start(milli, oneShot);
146 }
147
148 ~wxTimerRunner()
149 {
150 if ( m_timer.IsRunning() )
151 {
152 m_timer.Stop();
153 }
154 }
155
156private:
157 wxTimer& m_timer;
fc7a2a60
VZ
158
159 DECLARE_NO_COPY_CLASS(wxTimerRunner)
52a07708
VZ
160};
161
0470b1e6 162// ----------------------------------------------------------------------------
ed791986
VZ
163// wxTimerEvent
164// ----------------------------------------------------------------------------
165
166class WXDLLEXPORT wxTimerEvent : public wxEvent
167{
168public:
c5c5dad5 169 wxTimerEvent(int timerid = 0, int interval = 0) : wxEvent(timerid)
ed791986
VZ
170 {
171 m_eventType = wxEVT_TIMER;
172
173 m_interval = interval;
174 }
175
176 // accessors
177 int GetInterval() const { return m_interval; }
178
acd15a3f
VZ
179 // implement the base class pure virtual
180 virtual wxEvent *Clone() const { return new wxTimerEvent(*this); }
181
ed791986
VZ
182private:
183 int m_interval;
184
fc7a2a60 185 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxTimerEvent)
ed791986
VZ
186};
187
188typedef void (wxEvtHandler::*wxTimerEventFunction)(wxTimerEvent&);
189
c5c5dad5 190#define EVT_TIMER(timerid, func) \
3a818b15 191 DECLARE_EVENT_TABLE_ENTRY( wxEVT_TIMER, timerid, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxTimerEventFunction, & func ), NULL),
ed791986 192
1e6feb95 193#endif // wxUSE_GUI && wxUSE_TIMER
52a07708 194
c801d85f 195#endif
34138703 196 // _WX_TIMER_H_BASE_