]> git.saurik.com Git - wxWidgets.git/blob - src/msw/timer.cpp
Updated documentation according to recent array changes.
[wxWidgets.git] / src / msw / timer.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: timer.cpp
3 // Purpose: wxTimer implementation
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 04/01/98
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart and Markus Holzem
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifdef __GNUG__
13 #pragma implementation "timer.h"
14 #endif
15
16 // For compilers that support precompilation, includes "wx.h".
17 #include "wx/wxprec.h"
18
19 #ifdef __BORLANDC__
20 #pragma hdrstop
21 #endif
22
23 #if wxUSE_TIMER
24
25 #ifndef WX_PRECOMP
26 #include "wx/setup.h"
27 #include "wx/window.h"
28 #include "wx/list.h"
29 #include "wx/event.h"
30 #include "wx/app.h"
31 #include "wx/intl.h"
32 #include "wx/log.h"
33 #endif
34
35 #include "wx/timer.h"
36
37 #include "wx/msw/private.h"
38
39 // ----------------------------------------------------------------------------
40 // private functions
41 // ----------------------------------------------------------------------------
42
43 wxList wxTimerList(wxKEY_INTEGER);
44 UINT WINAPI _EXPORT wxTimerProc(HWND hwnd, WORD, int idTimer, DWORD);
45
46 // ----------------------------------------------------------------------------
47 // macros
48 // ----------------------------------------------------------------------------
49
50 #ifdef __WIN32__
51 #define _EXPORT
52 #else
53 #define _EXPORT _export
54 #endif
55
56 IMPLEMENT_ABSTRACT_CLASS(wxTimer, wxObject)
57
58 // ============================================================================
59 // implementation
60 // ============================================================================
61
62 // ----------------------------------------------------------------------------
63 // wxTimer class
64 // ----------------------------------------------------------------------------
65
66 void wxTimer::Init()
67 {
68 m_id = 0;
69 }
70
71 wxTimer::~wxTimer()
72 {
73 wxTimer::Stop();
74
75 wxTimerList.DeleteObject(this);
76 }
77
78 bool wxTimer::Start(int milliseconds, bool oneShot)
79 {
80 (void)wxTimerBase::Start(milliseconds, oneShot);
81
82 wxCHECK_MSG( m_milli > 0, FALSE, wxT("invalid value for timer timeour") );
83
84 wxTimerList.DeleteObject(this);
85
86 #ifdef __WXMICROWIN__
87 m_id = SetTimer(NULL, (UINT)(m_id ? m_id : 1),
88 (UINT)milliseconds, (TIMERPROC) wxTimerProc);
89 #else
90 TIMERPROC wxTimerProcInst = (TIMERPROC)
91 MakeProcInstance((FARPROC)wxTimerProc, wxGetInstance());
92
93 m_id = SetTimer(NULL, (UINT)(m_id ? m_id : 1),
94 (UINT)milliseconds, wxTimerProcInst);
95 #endif
96
97 if ( m_id > 0 )
98 {
99 wxTimerList.Append(m_id, this);
100
101 return TRUE;
102 }
103 else
104 {
105 wxLogSysError(_("Couldn't create a timer"));
106
107 return FALSE;
108 }
109 }
110
111 void wxTimer::Stop()
112 {
113 if ( m_id )
114 {
115 KillTimer(NULL, (UINT)m_id);
116 wxTimerList.DeleteObject(this);
117 }
118
119 m_id = 0;
120 }
121
122 // ----------------------------------------------------------------------------
123 // private functions
124 // ----------------------------------------------------------------------------
125
126 void wxProcessTimer(wxTimer& timer)
127 {
128 // Avoid to process spurious timer events
129 if ( timer.m_id == 0)
130 return;
131
132 if ( timer.IsOneShot() )
133 timer.Stop();
134
135 timer.Notify();
136 }
137
138 UINT WINAPI _EXPORT wxTimerProc(HWND WXUNUSED(hwnd), WORD, int idTimer, DWORD)
139 {
140 wxNode *node = wxTimerList.Find((long)idTimer);
141
142 wxCHECK_MSG( node, 0, wxT("bogus timer id in wxTimerProc") );
143
144 wxProcessTimer(*(wxTimer *)node->Data());
145
146 return 0;
147 }
148
149 #endif // wxUSE_TIMER