]> git.saurik.com Git - wxWidgets.git/blame - include/wx/event.h
remove file containing many obsolete defines, if anyone wants to revive MicroWindows...
[wxWidgets.git] / include / wx / event.h
CommitLineData
c801d85f 1/////////////////////////////////////////////////////////////////////////////
bd83cb56 2// Name: wx/event.h
c801d85f
KB
3// Purpose: Event classes
4// Author: Julian Smart
5// Modified by:
6// Created: 01/02/97
7// RCS-ID: $Id$
77ffb593 8// Copyright: (c) wxWidgets team
65571936 9// Licence: wxWindows licence
c801d85f
KB
10/////////////////////////////////////////////////////////////////////////////
11
1648d51b
VZ
12#ifndef _WX_EVENT_H__
13#define _WX_EVENT_H__
c801d85f 14
c801d85f 15#include "wx/defs.h"
bde626ce 16#include "wx/cpp.h"
c801d85f 17#include "wx/object.h"
341050e2 18#include "wx/clntdata.h"
e90c1d2a
VZ
19
20#if wxUSE_GUI
21 #include "wx/gdicmn.h"
43b5058d 22 #include "wx/cursor.h"
e90c1d2a 23#endif
42e69d6b 24
72cdf4c9 25#include "wx/thread.h"
c801d85f 26
b5a98acd
VZ
27#include "wx/dynarray.h"
28
e90c1d2a
VZ
29// ----------------------------------------------------------------------------
30// forward declarations
31// ----------------------------------------------------------------------------
32
b5dbe15d 33class WXDLLIMPEXP_FWD_BASE wxList;
e90c1d2a
VZ
34
35#if wxUSE_GUI
b5dbe15d
VS
36 class WXDLLIMPEXP_FWD_CORE wxDC;
37 class WXDLLIMPEXP_FWD_CORE wxMenu;
38 class WXDLLIMPEXP_FWD_CORE wxWindow;
39 class WXDLLIMPEXP_FWD_CORE wxWindowBase;
e90c1d2a
VZ
40#endif // wxUSE_GUI
41
b5dbe15d 42class WXDLLIMPEXP_FWD_BASE wxEvtHandler;
432968bf 43
e90c1d2a
VZ
44// ----------------------------------------------------------------------------
45// Event types
46// ----------------------------------------------------------------------------
64693098 47
cbee8f8d
VZ
48typedef int wxEventType;
49
c4fa5aa7
VZ
50#define wxEVT_ANY ((wxEventType)-1)
51
3a818b15
VZ
52// this is used to make the event table entry type safe, so that for an event
53// handler only a function with proper parameter list can be given.
f29fe169 54#define wxStaticCastEvent(type, val) wx_static_cast(type, val)
3a818b15 55
77ffb593 56// in previous versions of wxWidgets the event types used to be constants
cbee8f8d
VZ
57// which created difficulties with custom/user event types definition
58//
77ffb593 59// starting from wxWidgets 2.4 the event types are now dynamically assigned
cbee8f8d
VZ
60// using wxNewEventType() which solves this problem, however at price of
61// several incompatibilities:
62//
63// a) event table macros declaration changed, it now uses wxEventTableEntry
64// ctor instead of initialisation from an agregate - the macro
65// DECLARE_EVENT_TABLE_ENTRY may be used to write code which can compile
77ffb593 66// with all versions of wxWidgets
cbee8f8d
VZ
67//
68// b) event types can't be used as switch() cases as they're not really
69// constant any more - there is no magic solution here, you just have to
70// change the switch()es to if()s
71//
72// if these are real problems for you, define WXWIN_COMPATIBILITY_EVENT_TYPES
494c7caa
VZ
73// as 1 to get 100% old behaviour, however you won't be able to use the
74// libraries using the new dynamic event type allocation in such case, so avoid
75// it if possible.
76#ifndef WXWIN_COMPATIBILITY_EVENT_TYPES
77 #define WXWIN_COMPATIBILITY_EVENT_TYPES 0
78#endif
cbee8f8d
VZ
79
80#if WXWIN_COMPATIBILITY_EVENT_TYPES
81
d9e2e4c2
DE
82#define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
83 { type, winid, idLast, fn, obj }
cbee8f8d 84
2e4df4bf
VZ
85#define BEGIN_DECLARE_EVENT_TYPES() enum {
86#define END_DECLARE_EVENT_TYPES() };
cbee8f8d 87#define DECLARE_EVENT_TYPE(name, value) name = wxEVT_FIRST + value,
fdb59905 88#define DECLARE_LOCAL_EVENT_TYPE(name, value) name = wxEVT_USER_FIRST + value,
886dd7d2
VZ
89#define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \
90 DECLARE_LOCAL_EVENT_TYPE(name, value)
2e4df4bf 91#define DEFINE_EVENT_TYPE(name)
1a40c31e 92#define DEFINE_LOCAL_EVENT_TYPE(name)
cbee8f8d 93
5527476f 94
cbee8f8d
VZ
95#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
96
d9e2e4c2
DE
97#define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
98 wxEventTableEntry(type, winid, idLast, fn, obj)
cbee8f8d 99
2e4df4bf
VZ
100#define BEGIN_DECLARE_EVENT_TYPES()
101#define END_DECLARE_EVENT_TYPES()
886dd7d2
VZ
102#define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \
103 extern expdecl const wxEventType name;
85664da6 104#define DECLARE_EVENT_TYPE(name, value) \
bddd7a8d 105 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_CORE, name, value)
886dd7d2 106#define DECLARE_LOCAL_EVENT_TYPE(name, value) \
bde626ce 107 DECLARE_EXPORTED_EVENT_TYPE(wxEMPTY_PARAMETER_VALUE, name, value)
71499aaf 108#define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
886dd7d2 109#define DEFINE_LOCAL_EVENT_TYPE(name) DEFINE_EVENT_TYPE(name)
cbee8f8d
VZ
110
111// generate a new unique event type
bddd7a8d 112extern WXDLLIMPEXP_BASE wxEventType wxNewEventType();
cbee8f8d
VZ
113
114#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
115
2e4df4bf
VZ
116BEGIN_DECLARE_EVENT_TYPES()
117
cbee8f8d 118#if WXWIN_COMPATIBILITY_EVENT_TYPES
cbee8f8d
VZ
119 wxEVT_NULL = 0,
120 wxEVT_FIRST = 10000,
2e4df4bf 121 wxEVT_USER_FIRST = wxEVT_FIRST + 2000,
cbee8f8d 122#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
6164f93c
VZ
123 // it is important to still have these as constants to avoid
124 // initialization order related problems
bddd7a8d
VZ
125 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_NULL, 0)
126 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_FIRST, 10000)
127 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_USER_FIRST, wxEVT_FIRST + 2000)
cbee8f8d
VZ
128#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
129
2e4df4bf
VZ
130 DECLARE_EVENT_TYPE(wxEVT_COMMAND_BUTTON_CLICKED, 1)
131 DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHECKBOX_CLICKED, 2)
132 DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHOICE_SELECTED, 3)
133 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_SELECTED, 4)
134 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 5)
135 DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 6)
ad0bae85
VZ
136 // now they are in wx/textctrl.h
137#if WXWIN_COMPATIBILITY_EVENT_TYPES
2e4df4bf
VZ
138 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED, 7)
139 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER, 8)
ad0bae85 140 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL, 13)
d7eee191 141 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN, 14)
ad0bae85 142#endif // WXWIN_COMPATIBILITY_EVENT_TYPES
2e4df4bf
VZ
143 DECLARE_EVENT_TYPE(wxEVT_COMMAND_MENU_SELECTED, 9)
144 DECLARE_EVENT_TYPE(wxEVT_COMMAND_SLIDER_UPDATED, 10)
145 DECLARE_EVENT_TYPE(wxEVT_COMMAND_RADIOBOX_SELECTED, 11)
146 DECLARE_EVENT_TYPE(wxEVT_COMMAND_RADIOBUTTON_SELECTED, 12)
147
148 // wxEVT_COMMAND_SCROLLBAR_UPDATED is now obsolete since we use
149 // wxEVT_SCROLL... events
150
151 DECLARE_EVENT_TYPE(wxEVT_COMMAND_SCROLLBAR_UPDATED, 13)
152 DECLARE_EVENT_TYPE(wxEVT_COMMAND_VLBOX_SELECTED, 14)
153 DECLARE_EVENT_TYPE(wxEVT_COMMAND_COMBOBOX_SELECTED, 15)
154 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED, 16)
155 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER, 17)
156 DECLARE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED, 18)
157
a9a0ceca
VZ
158 // Toolbar dropdown arrows
159 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, 19)
160
2e4df4bf 161 // Sockets and timers send events, too
bddd7a8d 162 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_SOCKET, 50)
c2ca375c 163 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_TIMER , 80)
2e4df4bf
VZ
164
165 // Mouse event types
166 DECLARE_EVENT_TYPE(wxEVT_LEFT_DOWN, 100)
167 DECLARE_EVENT_TYPE(wxEVT_LEFT_UP, 101)
168 DECLARE_EVENT_TYPE(wxEVT_MIDDLE_DOWN, 102)
169 DECLARE_EVENT_TYPE(wxEVT_MIDDLE_UP, 103)
170 DECLARE_EVENT_TYPE(wxEVT_RIGHT_DOWN, 104)
171 DECLARE_EVENT_TYPE(wxEVT_RIGHT_UP, 105)
172 DECLARE_EVENT_TYPE(wxEVT_MOTION, 106)
173 DECLARE_EVENT_TYPE(wxEVT_ENTER_WINDOW, 107)
174 DECLARE_EVENT_TYPE(wxEVT_LEAVE_WINDOW, 108)
175 DECLARE_EVENT_TYPE(wxEVT_LEFT_DCLICK, 109)
176 DECLARE_EVENT_TYPE(wxEVT_MIDDLE_DCLICK, 110)
177 DECLARE_EVENT_TYPE(wxEVT_RIGHT_DCLICK, 111)
178 DECLARE_EVENT_TYPE(wxEVT_SET_FOCUS, 112)
179 DECLARE_EVENT_TYPE(wxEVT_KILL_FOCUS, 113)
456bc6d9
VZ
180 DECLARE_EVENT_TYPE(wxEVT_CHILD_FOCUS, 114)
181 DECLARE_EVENT_TYPE(wxEVT_MOUSEWHEEL, 115)
2e4df4bf
VZ
182
183 // Non-client mouse events
184 DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN, 200)
185 DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_UP, 201)
186 DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_DOWN, 202)
187 DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_UP, 203)
188 DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_DOWN, 204)
189 DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_UP, 205)
190 DECLARE_EVENT_TYPE(wxEVT_NC_MOTION, 206)
191 DECLARE_EVENT_TYPE(wxEVT_NC_ENTER_WINDOW, 207)
192 DECLARE_EVENT_TYPE(wxEVT_NC_LEAVE_WINDOW, 208)
193 DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_DCLICK, 209)
194 DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_DCLICK, 210)
195 DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_DCLICK, 211)
196
197 // Character input event type
198 DECLARE_EVENT_TYPE(wxEVT_CHAR, 212)
199 DECLARE_EVENT_TYPE(wxEVT_CHAR_HOOK, 213)
200 DECLARE_EVENT_TYPE(wxEVT_NAVIGATION_KEY, 214)
201 DECLARE_EVENT_TYPE(wxEVT_KEY_DOWN, 215)
202 DECLARE_EVENT_TYPE(wxEVT_KEY_UP, 216)
5048c832
JS
203#if wxUSE_HOTKEY
204 DECLARE_EVENT_TYPE(wxEVT_HOTKEY, 217)
205#endif
2e4df4bf
VZ
206 // Set cursor event
207 DECLARE_EVENT_TYPE(wxEVT_SET_CURSOR, 230)
208
e8b669d3 209 // wxScrollBar and wxSlider event identifiers
2e4df4bf
VZ
210 DECLARE_EVENT_TYPE(wxEVT_SCROLL_TOP, 300)
211 DECLARE_EVENT_TYPE(wxEVT_SCROLL_BOTTOM, 301)
212 DECLARE_EVENT_TYPE(wxEVT_SCROLL_LINEUP, 302)
213 DECLARE_EVENT_TYPE(wxEVT_SCROLL_LINEDOWN, 303)
214 DECLARE_EVENT_TYPE(wxEVT_SCROLL_PAGEUP, 304)
215 DECLARE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN, 305)
216 DECLARE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK, 306)
217 DECLARE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE, 307)
cbc85508 218 DECLARE_EVENT_TYPE(wxEVT_SCROLL_CHANGED, 308)
2e4df4bf
VZ
219
220 // Scroll events from wxWindow
221 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP, 320)
222 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_BOTTOM, 321)
223 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEUP, 322)
224 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEDOWN, 323)
225 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEUP, 324)
226 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEDOWN, 325)
227 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBTRACK, 326)
228 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBRELEASE, 327)
229
230 // System events
231 DECLARE_EVENT_TYPE(wxEVT_SIZE, 400)
232 DECLARE_EVENT_TYPE(wxEVT_MOVE, 401)
233 DECLARE_EVENT_TYPE(wxEVT_CLOSE_WINDOW, 402)
234 DECLARE_EVENT_TYPE(wxEVT_END_SESSION, 403)
235 DECLARE_EVENT_TYPE(wxEVT_QUERY_END_SESSION, 404)
236 DECLARE_EVENT_TYPE(wxEVT_ACTIVATE_APP, 405)
355debca 237 // 406..408 are power events
2e4df4bf
VZ
238 DECLARE_EVENT_TYPE(wxEVT_ACTIVATE, 409)
239 DECLARE_EVENT_TYPE(wxEVT_CREATE, 410)
240 DECLARE_EVENT_TYPE(wxEVT_DESTROY, 411)
241 DECLARE_EVENT_TYPE(wxEVT_SHOW, 412)
242 DECLARE_EVENT_TYPE(wxEVT_ICONIZE, 413)
243 DECLARE_EVENT_TYPE(wxEVT_MAXIMIZE, 414)
244 DECLARE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED, 415)
63e819f2
VS
245 DECLARE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_LOST, 416)
246 DECLARE_EVENT_TYPE(wxEVT_PAINT, 417)
247 DECLARE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND, 418)
248 DECLARE_EVENT_TYPE(wxEVT_NC_PAINT, 419)
249 DECLARE_EVENT_TYPE(wxEVT_PAINT_ICON, 420)
250 DECLARE_EVENT_TYPE(wxEVT_MENU_OPEN, 421)
251 DECLARE_EVENT_TYPE(wxEVT_MENU_CLOSE, 422)
252 DECLARE_EVENT_TYPE(wxEVT_MENU_HIGHLIGHT, 423)
2e4df4bf
VZ
253 DECLARE_EVENT_TYPE(wxEVT_CONTEXT_MENU, 424)
254 DECLARE_EVENT_TYPE(wxEVT_SYS_COLOUR_CHANGED, 425)
574c939e
KB
255 DECLARE_EVENT_TYPE(wxEVT_DISPLAY_CHANGED, 426)
256 DECLARE_EVENT_TYPE(wxEVT_SETTING_CHANGED, 427)
257 DECLARE_EVENT_TYPE(wxEVT_QUERY_NEW_PALETTE, 428)
258 DECLARE_EVENT_TYPE(wxEVT_PALETTE_CHANGED, 429)
259 DECLARE_EVENT_TYPE(wxEVT_JOY_BUTTON_DOWN, 430)
260 DECLARE_EVENT_TYPE(wxEVT_JOY_BUTTON_UP, 431)
261 DECLARE_EVENT_TYPE(wxEVT_JOY_MOVE, 432)
262 DECLARE_EVENT_TYPE(wxEVT_JOY_ZMOVE, 433)
263 DECLARE_EVENT_TYPE(wxEVT_DROP_FILES, 434)
264 DECLARE_EVENT_TYPE(wxEVT_DRAW_ITEM, 435)
265 DECLARE_EVENT_TYPE(wxEVT_MEASURE_ITEM, 436)
266 DECLARE_EVENT_TYPE(wxEVT_COMPARE_ITEM, 437)
267 DECLARE_EVENT_TYPE(wxEVT_INIT_DIALOG, 438)
bddd7a8d 268 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_IDLE, 439)
574c939e 269 DECLARE_EVENT_TYPE(wxEVT_UPDATE_UI, 440)
5706de1c 270 DECLARE_EVENT_TYPE(wxEVT_SIZING, 441)
4d4f4290 271 DECLARE_EVENT_TYPE(wxEVT_MOVING, 442)
afafd942 272 DECLARE_EVENT_TYPE(wxEVT_HIBERNATE, 443)
355debca 273 // more power events follow -- see wx/power.h
2e4df4bf 274
78c91815
VZ
275 // Clipboard events
276 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_COPY, 444)
277 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_CUT, 445)
278 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_PASTE, 446)
279
2e4df4bf
VZ
280 // Generic command events
281 // Note: a click is a higher-level event than button down/up
282 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK, 500)
283 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LEFT_DCLICK, 501)
284 DECLARE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_CLICK, 502)
285 DECLARE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_DCLICK, 503)
286 DECLARE_EVENT_TYPE(wxEVT_COMMAND_SET_FOCUS, 504)
287 DECLARE_EVENT_TYPE(wxEVT_COMMAND_KILL_FOCUS, 505)
288 DECLARE_EVENT_TYPE(wxEVT_COMMAND_ENTER, 506)
289
290 // Help events
291 DECLARE_EVENT_TYPE(wxEVT_HELP, 1050)
292 DECLARE_EVENT_TYPE(wxEVT_DETAILED_HELP, 1051)
293
294END_DECLARE_EVENT_TYPES()
96f6c703 295
cbee8f8d
VZ
296// these 2 events are the same
297#define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
96f6c703 298
ad0bae85 299// ----------------------------------------------------------------------------
77d4384e 300// Compatibility
ad0bae85
VZ
301// ----------------------------------------------------------------------------
302
303// this event is also used by wxComboBox and wxSpinCtrl which don't include
304// wx/textctrl.h in all ports [yet], so declare it here as well
305//
306// still, any new code using it should include wx/textctrl.h explicitly
307#if !WXWIN_COMPATIBILITY_EVENT_TYPES
bddd7a8d 308 extern const wxEventType WXDLLIMPEXP_CORE wxEVT_COMMAND_TEXT_UPDATED;
ad0bae85 309#endif
c801d85f 310
1648d51b
VZ
311// the predefined constants for the number of times we propagate event
312// upwards window child-parent chain
313enum Propagation_state
314{
315 // don't propagate it at all
316 wxEVENT_PROPAGATE_NONE = 0,
317
318 // propagate it until it is processed
319 wxEVENT_PROPAGATE_MAX = INT_MAX
320};
321
c801d85f 322/*
77ffb593 323 * wxWidgets events, covering all interesting things that might happen
c801d85f
KB
324 * (button clicking, resizing, setting text in widgets, etc.).
325 *
326 * For each completely new event type, derive a new event class.
327 * An event CLASS represents a C++ class defining a range of similar event TYPES;
328 * examples are canvas events, panel item command events.
329 * An event TYPE is a unique identifier for a particular system event,
330 * such as a button press or a listbox deselection.
331 *
332 */
333
bddd7a8d 334class WXDLLIMPEXP_BASE wxEvent : public wxObject
c801d85f 335{
e6a6feba
GD
336private:
337 wxEvent& operator=(const wxEvent&);
abcbaea7 338
8e72b8b5
RR
339protected:
340 wxEvent(const wxEvent&); // for implementing Clone()
c801d85f
KB
341
342public:
d9e2e4c2 343 wxEvent(int winid = 0, wxEventType commandType = wxEVT_NULL );
2b854a32
VZ
344
345 void SetEventType(wxEventType typ) { m_eventType = typ; }
346 wxEventType GetEventType() const { return m_eventType; }
347 wxObject *GetEventObject() const { return m_eventObject; }
348 void SetEventObject(wxObject *obj) { m_eventObject = obj; }
349 long GetTimestamp() const { return m_timeStamp; }
350 void SetTimestamp(long ts = 0) { m_timeStamp = ts; }
351 int GetId() const { return m_id; }
352 void SetId(int Id) { m_id = Id; }
353
354 // Can instruct event processor that we wish to ignore this event
355 // (treat as if the event table entry had not been found): this must be done
356 // to allow the event processing by the base classes (calling event.Skip()
a0d9c6cb
WS
357 // is the analog of calling the base class version of a virtual function)
358 void Skip(bool skip = true) { m_skipped = skip; }
47b378bd 359 bool GetSkipped() const { return m_skipped; }
c801d85f 360
acd15a3f
VZ
361 // this function is used to create a copy of the event polymorphically and
362 // all derived classes must implement it because otherwise wxPostEvent()
363 // for them wouldn't work (it needs to do a copy of the event)
364 virtual wxEvent *Clone() const = 0;
a737331d 365
87b6002d 366 // Implementation only: this test is explicitly anti OO and this function
1648d51b
VZ
367 // exists only for optimization purposes.
368 bool IsCommandEvent() const { return m_isCommandEvent; }
369
370 // Determine if this event should be propagating to the parent window.
371 bool ShouldPropagate() const
372 { return m_propagationLevel != wxEVENT_PROPAGATE_NONE; }
373
374 // Stop an event from propagating to its parent window, returns the old
375 // propagation level value
376 int StopPropagation()
377 {
378 int propagationLevel = m_propagationLevel;
379 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
380 return propagationLevel;
381 }
382
383 // Resume the event propagation by restoring the propagation level
384 // (returned by StopPropagation())
385 void ResumePropagation(int propagationLevel)
386 {
387 m_propagationLevel = propagationLevel;
388 }
389
b4b76d61 390protected:
2b854a32 391 wxObject* m_eventObject;
2b854a32
VZ
392 wxEventType m_eventType;
393 long m_timeStamp;
394 int m_id;
b4b76d61
KH
395
396public:
397 // m_callbackUserData is for internal usage only
2b854a32 398 wxObject* m_callbackUserData;
1648d51b
VZ
399
400protected:
401 // the propagation level: while it is positive, we propagate the event to
402 // the parent window (if any)
403 //
404 // this one doesn't have to be public, we don't have to worry about
405 // backwards compatibility as it is new
406 int m_propagationLevel;
407
b4b76d61 408protected:
42e69d6b 409 bool m_skipped;
193bf013 410 bool m_isCommandEvent;
1c624631 411
8e72b8b5 412private:
1648d51b 413 // it needs to access our m_propagationLevel
b5dbe15d 414 friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce;
1648d51b 415
8e72b8b5 416 DECLARE_ABSTRACT_CLASS(wxEvent)
c801d85f
KB
417};
418
1648d51b
VZ
419/*
420 * Helper class to temporarily change an event not to propagate.
421 */
422class WXDLLIMPEXP_BASE wxPropagationDisabler
423{
424public:
425 wxPropagationDisabler(wxEvent& event) : m_event(event)
426 {
427 m_propagationLevelOld = m_event.StopPropagation();
428 }
429
430 ~wxPropagationDisabler()
431 {
432 m_event.ResumePropagation(m_propagationLevelOld);
433 }
434
435private:
436 wxEvent& m_event;
437 int m_propagationLevelOld;
fc7a2a60
VZ
438
439 DECLARE_NO_COPY_CLASS(wxPropagationDisabler)
1648d51b
VZ
440};
441
442/*
443 * Another one to temporarily lower propagation level.
444 */
445class WXDLLIMPEXP_BASE wxPropagateOnce
446{
447public:
448 wxPropagateOnce(wxEvent& event) : m_event(event)
449 {
450 wxASSERT_MSG( m_event.m_propagationLevel > 0,
451 _T("shouldn't be used unless ShouldPropagate()!") );
452
453 m_event.m_propagationLevel--;
454 }
455
456 ~wxPropagateOnce()
457 {
458 m_event.m_propagationLevel++;
459 }
460
461private:
462 wxEvent& m_event;
fc7a2a60
VZ
463
464 DECLARE_NO_COPY_CLASS(wxPropagateOnce)
1648d51b
VZ
465};
466
c4fa5aa7 467
e90c1d2a
VZ
468#if wxUSE_GUI
469
1648d51b 470
c801d85f
KB
471// Item or menu event class
472/*
473 wxEVT_COMMAND_BUTTON_CLICKED
474 wxEVT_COMMAND_CHECKBOX_CLICKED
475 wxEVT_COMMAND_CHOICE_SELECTED
476 wxEVT_COMMAND_LISTBOX_SELECTED
477 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
478 wxEVT_COMMAND_TEXT_UPDATED
479 wxEVT_COMMAND_TEXT_ENTER
480 wxEVT_COMMAND_MENU_SELECTED
481 wxEVT_COMMAND_SLIDER_UPDATED
482 wxEVT_COMMAND_RADIOBOX_SELECTED
483 wxEVT_COMMAND_RADIOBUTTON_SELECTED
484 wxEVT_COMMAND_SCROLLBAR_UPDATED
485 wxEVT_COMMAND_VLBOX_SELECTED
486 wxEVT_COMMAND_COMBOBOX_SELECTED
1db8dc4a 487 wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
c801d85f
KB
488*/
489
bddd7a8d 490class WXDLLIMPEXP_CORE wxCommandEvent : public wxEvent
c801d85f 491{
2b854a32 492public:
d9e2e4c2 493 wxCommandEvent(wxEventType commandType = wxEVT_NULL, int winid = 0);
c801d85f 494
e6a6feba 495 wxCommandEvent(const wxCommandEvent& event)
497dbbd3 496 : wxEvent(event),
b4b76d61 497 m_cmdString(event.m_cmdString),
497dbbd3
VZ
498 m_commandInt(event.m_commandInt),
499 m_extraLong(event.m_extraLong),
500 m_clientData(event.m_clientData),
501 m_clientObject(event.m_clientObject)
e6a6feba
GD
502 { }
503
2b854a32
VZ
504 // Set/Get client data from controls
505 void SetClientData(void* clientData) { m_clientData = clientData; }
506 void *GetClientData() const { return m_clientData; }
c801d85f 507
2b854a32
VZ
508 // Set/Get client object from controls
509 void SetClientObject(wxClientData* clientObject) { m_clientObject = clientObject; }
88eadcf2 510 wxClientData *GetClientObject() const { return m_clientObject; }
f5e27805 511
2b854a32
VZ
512 // Get listbox selection if single-choice
513 int GetSelection() const { return m_commandInt; }
c801d85f 514
2b854a32 515 // Set/Get listbox/choice selection string
b4b76d61
KH
516 void SetString(const wxString& s) { m_cmdString = s; }
517 wxString GetString() const;
c801d85f 518
2b854a32 519 // Get checkbox value
3ca6a5f0 520 bool IsChecked() const { return m_commandInt != 0; }
c801d85f 521
a0d9c6cb 522 // true if the listbox event was a selection.
2b854a32 523 bool IsSelection() const { return (m_extraLong != 0); }
c801d85f 524
2b854a32 525 void SetExtraLong(long extraLong) { m_extraLong = extraLong; }
a7bc03c9 526 long GetExtraLong() const { return m_extraLong; }
c801d85f 527
2b854a32 528 void SetInt(int i) { m_commandInt = i; }
fd587c7a 529 int GetInt() const { return m_commandInt; }
c801d85f 530
8e72b8b5 531 virtual wxEvent *Clone() const { return new wxCommandEvent(*this); }
aadbdf11 532
b4b76d61 533protected:
b4b76d61 534 wxString m_cmdString; // String event argument
2b854a32
VZ
535 int m_commandInt;
536 long m_extraLong; // Additional information (e.g. select/deselect)
537 void* m_clientData; // Arbitrary client data
538 wxClientData* m_clientObject; // Arbitrary client object
f97500b8 539
8e72b8b5 540private:
fc7a2a60 541 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent)
c801d85f
KB
542};
543
fd3f686c
VZ
544// this class adds a possibility to react (from the user) code to a control
545// notification: allow or veto the operation being reported.
bddd7a8d 546class WXDLLIMPEXP_CORE wxNotifyEvent : public wxCommandEvent
fd3f686c
VZ
547{
548public:
d9e2e4c2
DE
549 wxNotifyEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
550 : wxCommandEvent(commandType, winid)
a0d9c6cb 551 { m_bAllow = true; }
e6a6feba
GD
552
553 wxNotifyEvent(const wxNotifyEvent& event)
554 : wxCommandEvent(event)
497dbbd3 555 { m_bAllow = event.m_bAllow; }
fd3f686c 556
23f681ec 557 // veto the operation (usually it's allowed by default)
a0d9c6cb 558 void Veto() { m_bAllow = false; }
fd3f686c 559
23f681ec 560 // allow the operation if it was disabled by default
a0d9c6cb 561 void Allow() { m_bAllow = true; }
23f681ec 562
fd3f686c
VZ
563 // for implementation code only: is the operation allowed?
564 bool IsAllowed() const { return m_bAllow; }
565
8e72b8b5 566 virtual wxEvent *Clone() const { return new wxNotifyEvent(*this); }
924ef850 567
fd3f686c
VZ
568private:
569 bool m_bAllow;
570
8e72b8b5 571private:
fc7a2a60 572 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent)
fd3f686c
VZ
573};
574
d1367c3d 575// Scroll event class, derived form wxCommandEvent. wxScrollEvents are
e8b669d3 576// sent by wxSlider and wxScrollBar.
c801d85f
KB
577/*
578 wxEVT_SCROLL_TOP
579 wxEVT_SCROLL_BOTTOM
580 wxEVT_SCROLL_LINEUP
581 wxEVT_SCROLL_LINEDOWN
582 wxEVT_SCROLL_PAGEUP
583 wxEVT_SCROLL_PAGEDOWN
584 wxEVT_SCROLL_THUMBTRACK
7d56fb8f 585 wxEVT_SCROLL_THUMBRELEASE
cbc85508 586 wxEVT_SCROLL_CHANGED
c801d85f
KB
587*/
588
bddd7a8d 589class WXDLLIMPEXP_CORE wxScrollEvent : public wxCommandEvent
c801d85f 590{
2b854a32
VZ
591public:
592 wxScrollEvent(wxEventType commandType = wxEVT_NULL,
d9e2e4c2 593 int winid = 0, int pos = 0, int orient = 0);
2b854a32 594
a7bc03c9
VZ
595 int GetOrientation() const { return (int) m_extraLong; }
596 int GetPosition() const { return m_commandInt; }
2b854a32
VZ
597 void SetOrientation(int orient) { m_extraLong = (long) orient; }
598 void SetPosition(int pos) { m_commandInt = pos; }
f97500b8 599
8e72b8b5 600 virtual wxEvent *Clone() const { return new wxScrollEvent(*this); }
f97500b8 601
8e72b8b5 602private:
fc7a2a60 603 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent)
c801d85f
KB
604};
605
d1367c3d
RR
606// ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
607// are sent by wxWindow.
608/*
609 wxEVT_SCROLLWIN_TOP
610 wxEVT_SCROLLWIN_BOTTOM
611 wxEVT_SCROLLWIN_LINEUP
612 wxEVT_SCROLLWIN_LINEDOWN
613 wxEVT_SCROLLWIN_PAGEUP
614 wxEVT_SCROLLWIN_PAGEDOWN
615 wxEVT_SCROLLWIN_THUMBTRACK
7d56fb8f 616 wxEVT_SCROLLWIN_THUMBRELEASE
d1367c3d
RR
617*/
618
bddd7a8d 619class WXDLLIMPEXP_CORE wxScrollWinEvent : public wxEvent
d1367c3d 620{
d1367c3d
RR
621public:
622 wxScrollWinEvent(wxEventType commandType = wxEVT_NULL,
623 int pos = 0, int orient = 0);
b2697d42
VZ
624 wxScrollWinEvent(const wxScrollWinEvent & event) : wxEvent(event)
625 { m_commandInt = event.m_commandInt;
626 m_extraLong = event.m_extraLong; }
d1367c3d 627
a7bc03c9
VZ
628 int GetOrientation() const { return (int) m_extraLong; }
629 int GetPosition() const { return m_commandInt; }
d1367c3d
RR
630 void SetOrientation(int orient) { m_extraLong = (long) orient; }
631 void SetPosition(int pos) { m_commandInt = pos; }
632
8e72b8b5 633 virtual wxEvent *Clone() const { return new wxScrollWinEvent(*this); }
1e6feb95 634
b4b76d61 635protected:
8e72b8b5 636 int m_commandInt;
20947e08 637 long m_extraLong;
1e6feb95 638
8e72b8b5 639private:
fc7a2a60 640 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent)
d1367c3d
RR
641};
642
c801d85f
KB
643// Mouse event class
644
645/*
646 wxEVT_LEFT_DOWN
647 wxEVT_LEFT_UP
648 wxEVT_MIDDLE_DOWN
649 wxEVT_MIDDLE_UP
650 wxEVT_RIGHT_DOWN
651 wxEVT_RIGHT_UP
652 wxEVT_MOTION
653 wxEVT_ENTER_WINDOW
654 wxEVT_LEAVE_WINDOW
655 wxEVT_LEFT_DCLICK
656 wxEVT_MIDDLE_DCLICK
657 wxEVT_RIGHT_DCLICK
658 wxEVT_NC_LEFT_DOWN
659 wxEVT_NC_LEFT_UP,
660 wxEVT_NC_MIDDLE_DOWN,
661 wxEVT_NC_MIDDLE_UP,
662 wxEVT_NC_RIGHT_DOWN,
663 wxEVT_NC_RIGHT_UP,
664 wxEVT_NC_MOTION,
665 wxEVT_NC_ENTER_WINDOW,
666 wxEVT_NC_LEAVE_WINDOW,
667 wxEVT_NC_LEFT_DCLICK,
668 wxEVT_NC_MIDDLE_DCLICK,
669 wxEVT_NC_RIGHT_DCLICK,
670*/
671
497dbbd3
VZ
672// the symbolic names for the mouse buttons
673enum
674{
675 wxMOUSE_BTN_ANY = -1,
3e89999c
VZ
676 wxMOUSE_BTN_NONE = 0,
677 wxMOUSE_BTN_LEFT = 1,
678 wxMOUSE_BTN_MIDDLE = 2,
679 wxMOUSE_BTN_RIGHT = 3
497dbbd3
VZ
680};
681
bddd7a8d 682class WXDLLIMPEXP_CORE wxMouseEvent : public wxEvent
c801d85f 683{
2b854a32
VZ
684public:
685 wxMouseEvent(wxEventType mouseType = wxEVT_NULL);
b2697d42
VZ
686 wxMouseEvent(const wxMouseEvent& event) : wxEvent(event)
687 { Assign(event); }
c801d85f 688
2b854a32 689 // Was it a button event? (*doesn't* mean: is any button *down*?)
497dbbd3 690 bool IsButton() const { return Button(wxMOUSE_BTN_ANY); }
c801d85f 691
3e89999c 692 // Was it a down event from this (or any) button?
497dbbd3 693 bool ButtonDown(int but = wxMOUSE_BTN_ANY) const;
c801d85f 694
3e89999c 695 // Was it a dclick event from this (or any) button?
497dbbd3 696 bool ButtonDClick(int but = wxMOUSE_BTN_ANY) const;
c801d85f 697
3e89999c 698 // Was it a up event from this (or any) button?
497dbbd3 699 bool ButtonUp(int but = wxMOUSE_BTN_ANY) const;
c801d85f 700
3e89999c 701 // Was the given button?
2b854a32 702 bool Button(int but) const;
c801d85f 703
3e89999c 704 // Was the given button in Down state?
2b854a32 705 bool ButtonIsDown(int but) const;
c801d85f 706
497dbbd3 707 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
1e6feb95
VZ
708 int GetButton() const;
709
2b854a32
VZ
710 // Find state of shift/control keys
711 bool ControlDown() const { return m_controlDown; }
712 bool MetaDown() const { return m_metaDown; }
713 bool AltDown() const { return m_altDown; }
714 bool ShiftDown() const { return m_shiftDown; }
a2bd1520
VZ
715 bool CmdDown() const
716 {
717#if defined(__WXMAC__) || defined(__WXCOCOA__)
718 return MetaDown();
719#else
720 return ControlDown();
721#endif
722 }
c801d85f 723
2b854a32
VZ
724 // Find which event was just generated
725 bool LeftDown() const { return (m_eventType == wxEVT_LEFT_DOWN); }
726 bool MiddleDown() const { return (m_eventType == wxEVT_MIDDLE_DOWN); }
727 bool RightDown() const { return (m_eventType == wxEVT_RIGHT_DOWN); }
c801d85f 728
2b854a32
VZ
729 bool LeftUp() const { return (m_eventType == wxEVT_LEFT_UP); }
730 bool MiddleUp() const { return (m_eventType == wxEVT_MIDDLE_UP); }
731 bool RightUp() const { return (m_eventType == wxEVT_RIGHT_UP); }
c801d85f 732
2b854a32
VZ
733 bool LeftDClick() const { return (m_eventType == wxEVT_LEFT_DCLICK); }
734 bool MiddleDClick() const { return (m_eventType == wxEVT_MIDDLE_DCLICK); }
735 bool RightDClick() const { return (m_eventType == wxEVT_RIGHT_DCLICK); }
c801d85f 736
2b854a32
VZ
737 // Find the current state of the mouse buttons (regardless
738 // of current event type)
739 bool LeftIsDown() const { return m_leftDown; }
740 bool MiddleIsDown() const { return m_middleDown; }
741 bool RightIsDown() const { return m_rightDown; }
c801d85f 742
2b854a32
VZ
743 // True if a button is down and the mouse is moving
744 bool Dragging() const
745 {
5b66d31a 746 return (m_eventType == wxEVT_MOTION) && ButtonIsDown(wxMOUSE_BTN_ANY);
2b854a32 747 }
c801d85f 748
2b854a32 749 // True if the mouse is moving, and no button is down
6f63704f
VZ
750 bool Moving() const
751 {
5b66d31a 752 return (m_eventType == wxEVT_MOTION) && !ButtonIsDown(wxMOUSE_BTN_ANY);
6f63704f 753 }
c801d85f 754
2b854a32
VZ
755 // True if the mouse is just entering the window
756 bool Entering() const { return (m_eventType == wxEVT_ENTER_WINDOW); }
c801d85f 757
2b854a32
VZ
758 // True if the mouse is just leaving the window
759 bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); }
c801d85f 760
2b854a32 761 // Find the position of the event
20947e08 762 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
b02da6b1
VZ
763 {
764 if (xpos)
20947e08 765 *xpos = m_x;
b02da6b1
VZ
766 if (ypos)
767 *ypos = m_y;
768 }
769
bf57d1ad 770 void GetPosition(long *xpos, long *ypos) const
b02da6b1
VZ
771 {
772 if (xpos)
20947e08 773 *xpos = (long)m_x;
b02da6b1 774 if (ypos)
bf57d1ad 775 *ypos = (long)m_y;
b02da6b1 776 }
c801d85f 777
2b854a32
VZ
778 // Find the position of the event
779 wxPoint GetPosition() const { return wxPoint(m_x, m_y); }
c801d85f 780
2b854a32 781 // Find the logical position of the event given the DC
a7bc03c9 782 wxPoint GetLogicalPosition(const wxDC& dc) const;
c801d85f 783
2b854a32 784 // Get X position
6cedba09 785 wxCoord GetX() const { return m_x; }
c801d85f 786
2b854a32 787 // Get Y position
6cedba09 788 wxCoord GetY() const { return m_y; }
c801d85f 789
d2c52078
RD
790 // Get wheel rotation, positive or negative indicates direction of
791 // rotation. Current devices all send an event when rotation is equal to
792 // +/-WheelDelta, but this allows for finer resolution devices to be
793 // created in the future. Because of this you shouldn't assume that one
794 // event is equal to 1 line or whatever, but you should be able to either
795 // do partial line scrolling or wait until +/-WheelDelta rotation values
796 // have been accumulated before scrolling.
797 int GetWheelRotation() const { return m_wheelRotation; }
798
799 // Get wheel delta, normally 120. This is the threshold for action to be
800 // taken, and one such action (for example, scrolling one increment)
801 // should occur for each delta.
802 int GetWheelDelta() const { return m_wheelDelta; }
803
aea37008
SC
804 // Gets the axis the wheel operation concerns, 0 being the y axis as on
805 // most mouse wheels, 1 is the x axis for things like MightyMouse scrolls
806 // or horizontal trackpad scrolling
807 int GetWheelAxis() const { return m_wheelAxis; }
808
d2c52078
RD
809 // Returns the configured number of lines (or whatever) to be scrolled per
810 // wheel action. Defaults to one.
811 int GetLinesPerAction() const { return m_linesPerAction; }
aea37008 812
9b9337da 813 // Is the system set to do page scrolling?
c2bbeff0 814 bool IsPageScroll() const { return ((unsigned int)m_linesPerAction == UINT_MAX); }
9b9337da 815
8e72b8b5 816 virtual wxEvent *Clone() const { return new wxMouseEvent(*this); }
aadbdf11 817
55f9eba3 818 wxMouseEvent& operator=(const wxMouseEvent& event) { Assign(event); return *this; }
c7d176e2 819
c801d85f 820public:
b02da6b1
VZ
821 wxCoord m_x, m_y;
822
2b854a32
VZ
823 bool m_leftDown;
824 bool m_middleDown;
825 bool m_rightDown;
826
827 bool m_controlDown;
828 bool m_shiftDown;
829 bool m_altDown;
830 bool m_metaDown;
aea37008
SC
831
832 int m_wheelAxis;
d2c52078
RD
833 int m_wheelRotation;
834 int m_wheelDelta;
835 int m_linesPerAction;
1e6feb95 836
abcbaea7
VZ
837protected:
838 void Assign(const wxMouseEvent& evt);
839
1e6feb95
VZ
840private:
841 DECLARE_DYNAMIC_CLASS(wxMouseEvent)
c801d85f
KB
842};
843
43b5058d
VZ
844// Cursor set event
845
846/*
847 wxEVT_SET_CURSOR
848 */
849
bddd7a8d 850class WXDLLIMPEXP_CORE wxSetCursorEvent : public wxEvent
43b5058d
VZ
851{
852public:
8e72b8b5 853 wxSetCursorEvent(wxCoord x = 0, wxCoord y = 0)
497dbbd3
VZ
854 : wxEvent(0, wxEVT_SET_CURSOR),
855 m_x(x), m_y(y), m_cursor()
e6a6feba 856 { }
43b5058d 857
b2697d42
VZ
858 wxSetCursorEvent(const wxSetCursorEvent & event)
859 : wxEvent(event),
860 m_x(event.m_x),
861 m_y(event.m_y),
862 m_cursor(event.m_cursor)
863 { }
1d2eddff 864
43b5058d
VZ
865 wxCoord GetX() const { return m_x; }
866 wxCoord GetY() const { return m_y; }
867
868 void SetCursor(const wxCursor& cursor) { m_cursor = cursor; }
869 const wxCursor& GetCursor() const { return m_cursor; }
870 bool HasCursor() const { return m_cursor.Ok(); }
871
8e72b8b5 872 virtual wxEvent *Clone() const { return new wxSetCursorEvent(*this); }
f97500b8 873
43b5058d
VZ
874private:
875 wxCoord m_x, m_y;
876 wxCursor m_cursor;
f97500b8 877
8e72b8b5 878private:
fc7a2a60 879 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent)
43b5058d
VZ
880};
881
c801d85f
KB
882// Keyboard input event class
883
884/*
885 wxEVT_CHAR
886 wxEVT_CHAR_HOOK
4ce81a75 887 wxEVT_KEY_DOWN
c801d85f 888 wxEVT_KEY_UP
5048c832 889 wxEVT_HOTKEY
c801d85f
KB
890 */
891
bddd7a8d 892class WXDLLIMPEXP_CORE wxKeyEvent : public wxEvent
c801d85f 893{
c801d85f 894public:
2b854a32 895 wxKeyEvent(wxEventType keyType = wxEVT_NULL);
b2697d42 896 wxKeyEvent(const wxKeyEvent& evt);
c801d85f 897
e7102772
VZ
898 // can be used check if the key event has exactly the given modifiers:
899 // "GetModifiers() = wxMOD_CONTROL" is easier to write than "ControlDown()
900 // && !MetaDown() && !AltDown() && !ShiftDown()"
901 int GetModifiers() const
902 {
903 return (m_controlDown ? wxMOD_CONTROL : 0) |
904 (m_shiftDown ? wxMOD_SHIFT : 0) |
905 (m_metaDown ? wxMOD_META : 0) |
906 (m_altDown ? wxMOD_ALT : 0);
907 }
908
2b854a32
VZ
909 // Find state of shift/control keys
910 bool ControlDown() const { return m_controlDown; }
e7102772 911 bool ShiftDown() const { return m_shiftDown; }
2b854a32
VZ
912 bool MetaDown() const { return m_metaDown; }
913 bool AltDown() const { return m_altDown; }
f6bcfd97 914
a2bd1520
VZ
915 // "Cmd" is a pseudo key which is Control for PC and Unix platforms but
916 // Apple ("Command") key under Macs: it makes often sense to use it instead
917 // of, say, ControlDown() because Cmd key is used for the same thing under
918 // Mac as Ctrl elsewhere (but Ctrl still exists, just not used for this
919 // purpose under Mac)
920 bool CmdDown() const
921 {
922#if defined(__WXMAC__) || defined(__WXCOCOA__)
923 return MetaDown();
924#else
925 return ControlDown();
926#endif
927 }
928
d11710cb
VZ
929 // exclude MetaDown() from HasModifiers() because NumLock under X is often
930 // configured as mod2 modifier, yet the key events even when it is pressed
931 // should be processed normally, not like Ctrl- or Alt-key
932 bool HasModifiers() const { return ControlDown() || AltDown(); }
f6bcfd97
BP
933
934 // get the key code: an ASCII7 char or an element of wxKeyCode enum
935 int GetKeyCode() const { return (int)m_keyCode; }
c801d85f 936
a3db5254
VZ
937#if wxUSE_UNICODE
938 // get the Unicode character corresponding to this key
939 wxChar GetUnicodeKey() const { return m_uniChar; }
940#endif // wxUSE_UNICODE
941
9c7df356
VZ
942 // get the raw key code (platform-dependent)
943 wxUint32 GetRawKeyCode() const { return m_rawCode; }
944
945 // get the raw key flags (platform-dependent)
946 wxUint32 GetRawKeyFlags() const { return m_rawFlags; }
947
2b854a32 948 // Find the position of the event
b02da6b1
VZ
949 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
950 {
20947e08 951 if (xpos) *xpos = m_x;
b02da6b1
VZ
952 if (ypos) *ypos = m_y;
953 }
954
bf57d1ad 955 void GetPosition(long *xpos, long *ypos) const
b02da6b1 956 {
20947e08 957 if (xpos) *xpos = (long)m_x;
bf57d1ad 958 if (ypos) *ypos = (long)m_y;
b02da6b1 959 }
803ef874
JS
960
961 wxPoint GetPosition() const
962 { return wxPoint(m_x, m_y); }
c801d85f 963
2b854a32 964 // Get X position
b02da6b1 965 wxCoord GetX() const { return m_x; }
c801d85f 966
2b854a32 967 // Get Y position
b02da6b1 968 wxCoord GetY() const { return m_y; }
c801d85f 969
ca3e85cf 970#if WXWIN_COMPATIBILITY_2_6
12a3f227
RL
971 // deprecated, Use GetKeyCode instead.
972 wxDEPRECATED( long KeyCode() const );
ca3e85cf 973#endif // WXWIN_COMPATIBILITY_2_6
f6bcfd97 974
8e72b8b5 975 virtual wxEvent *Clone() const { return new wxKeyEvent(*this); }
f97500b8
VZ
976
977 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
978 // example)
979 wxKeyEvent& operator=(const wxKeyEvent& evt)
980 {
981 m_x = evt.m_x;
982 m_y = evt.m_y;
983
984 m_keyCode = evt.m_keyCode;
985
986 m_controlDown = evt.m_controlDown;
987 m_shiftDown = evt.m_shiftDown;
988 m_altDown = evt.m_altDown;
989 m_metaDown = evt.m_metaDown;
990 m_scanCode = evt.m_scanCode;
9c7df356
VZ
991 m_rawCode = evt.m_rawCode;
992 m_rawFlags = evt.m_rawFlags;
cedea72f
VS
993#if wxUSE_UNICODE
994 m_uniChar = evt.m_uniChar;
995#endif
f97500b8
VZ
996
997 return *this;
998 }
999
2b854a32 1000public:
b02da6b1
VZ
1001 wxCoord m_x, m_y;
1002
2b854a32 1003 long m_keyCode;
b02da6b1 1004
e7102772 1005 // TODO: replace those with a single m_modifiers bitmask of wxMOD_XXX?
2b854a32
VZ
1006 bool m_controlDown;
1007 bool m_shiftDown;
1008 bool m_altDown;
1009 bool m_metaDown;
e7102772
VZ
1010
1011 // FIXME: what is this for? relation to m_rawXXX?
b0e813a0 1012 bool m_scanCode;
f97500b8 1013
2b5f62a0
VZ
1014#if wxUSE_UNICODE
1015 // This contains the full Unicode character
1016 // in a character events in Unicode mode
1017 wxChar m_uniChar;
1018#endif
1019
1020 // these fields contain the platform-specific information about
1021 // key that was pressed
9c7df356
VZ
1022 wxUint32 m_rawCode;
1023 wxUint32 m_rawFlags;
1024
8e72b8b5
RR
1025private:
1026 DECLARE_DYNAMIC_CLASS(wxKeyEvent)
c801d85f
KB
1027};
1028
1029// Size event class
1030/*
1031 wxEVT_SIZE
1032 */
1033
bddd7a8d 1034class WXDLLIMPEXP_CORE wxSizeEvent : public wxEvent
c801d85f 1035{
2b854a32 1036public:
497dbbd3 1037 wxSizeEvent() : wxEvent(0, wxEVT_SIZE)
e6a6feba 1038 { }
d9e2e4c2
DE
1039 wxSizeEvent(const wxSize& sz, int winid = 0)
1040 : wxEvent(winid, wxEVT_SIZE),
497dbbd3 1041 m_size(sz)
e6a6feba 1042 { }
1d2eddff 1043 wxSizeEvent(const wxSizeEvent & event)
b2697d42 1044 : wxEvent(event),
5706de1c 1045 m_size(event.m_size), m_rect(event.m_rect)
b2697d42 1046 { }
5706de1c 1047 wxSizeEvent(const wxRect& rect, int id = 0)
e00865fa 1048 : m_size(rect.GetSize()), m_rect(rect)
5706de1c 1049 { m_eventType = wxEVT_SIZING; m_id = id; }
c2bbeff0 1050
2b854a32 1051 wxSize GetSize() const { return m_size; }
5706de1c 1052 wxRect GetRect() const { return m_rect; }
fbfb8bcc 1053 void SetRect(const wxRect& rect) { m_rect = rect; }
aadbdf11 1054
8e72b8b5
RR
1055 virtual wxEvent *Clone() const { return new wxSizeEvent(*this); }
1056
1057public:
b4b76d61 1058 // For internal usage only. Will be converted to protected members.
8e72b8b5 1059 wxSize m_size;
5706de1c 1060 wxRect m_rect; // Used for wxEVT_SIZING
8e72b8b5 1061
f97500b8 1062private:
fc7a2a60 1063 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent)
c801d85f
KB
1064};
1065
1066// Move event class
1067
1068/*
1069 wxEVT_MOVE
1070 */
1071
bddd7a8d 1072class WXDLLIMPEXP_CORE wxMoveEvent : public wxEvent
c801d85f 1073{
2b854a32 1074public:
e6a6feba
GD
1075 wxMoveEvent()
1076 : wxEvent(0, wxEVT_MOVE)
e6a6feba 1077 { }
d9e2e4c2
DE
1078 wxMoveEvent(const wxPoint& pos, int winid = 0)
1079 : wxEvent(winid, wxEVT_MOVE),
497dbbd3 1080 m_pos(pos)
e6a6feba 1081 { }
1d2eddff
JS
1082 wxMoveEvent(const wxMoveEvent& event)
1083 : wxEvent(event),
b2697d42
VZ
1084 m_pos(event.m_pos)
1085 { }
5706de1c
JS
1086 wxMoveEvent(const wxRect& rect, int id = 0)
1087 : m_pos(rect.GetPosition()), m_rect(rect)
1088 { m_eventType = wxEVT_MOVING; m_id = id; }
c2bbeff0 1089
2b854a32 1090 wxPoint GetPosition() const { return m_pos; }
d7f03cae 1091 void SetPosition(const wxPoint& pos) { m_pos = pos; }
5706de1c 1092 wxRect GetRect() const { return m_rect; }
fbfb8bcc 1093 void SetRect(const wxRect& rect) { m_rect = rect; }
aadbdf11 1094
8e72b8b5 1095 virtual wxEvent *Clone() const { return new wxMoveEvent(*this); }
f97500b8 1096
b4b76d61 1097protected:
8e72b8b5 1098 wxPoint m_pos;
5706de1c 1099 wxRect m_rect;
f97500b8 1100
8e72b8b5 1101private:
fc7a2a60 1102 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent)
c801d85f
KB
1103};
1104
1105// Paint event class
1106/*
1107 wxEVT_PAINT
1108 wxEVT_NC_PAINT
1109 wxEVT_PAINT_ICON
1110 */
1111
b078fa02
JS
1112#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1113 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
bddd7a8d 1114 extern WXDLLIMPEXP_CORE int g_isPainting;
edccf428
VZ
1115#endif // debug
1116
bddd7a8d 1117class WXDLLIMPEXP_CORE wxPaintEvent : public wxEvent
c801d85f 1118{
2b854a32 1119public:
edccf428 1120 wxPaintEvent(int Id = 0)
e6a6feba 1121 : wxEvent(Id, wxEVT_PAINT)
edccf428 1122 {
b078fa02 1123#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
edccf428
VZ
1124 // set the internal flag for the duration of processing of WM_PAINT
1125 g_isPainting++;
1126#endif // debug
1127 }
1128
4e689ecd
VZ
1129 // default copy ctor and dtor are normally fine, we only need them to keep
1130 // g_isPainting updated in debug build
b078fa02 1131#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
4e689ecd
VZ
1132 wxPaintEvent(const wxPaintEvent& event)
1133 : wxEvent(event)
1134 {
1135 g_isPainting++;
1136 }
1137
d3c7fc99 1138 virtual ~wxPaintEvent()
edccf428
VZ
1139 {
1140 g_isPainting--;
1141 }
1142#endif // debug
8e72b8b5
RR
1143
1144 virtual wxEvent *Clone() const { return new wxPaintEvent(*this); }
f97500b8 1145
8e72b8b5 1146private:
fc7a2a60 1147 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent)
c801d85f
KB
1148};
1149
bddd7a8d 1150class WXDLLIMPEXP_CORE wxNcPaintEvent : public wxEvent
1e6feb95
VZ
1151{
1152public:
d9e2e4c2
DE
1153 wxNcPaintEvent(int winid = 0)
1154 : wxEvent(winid, wxEVT_NC_PAINT)
e6a6feba 1155 { }
f97500b8 1156
8e72b8b5 1157 virtual wxEvent *Clone() const { return new wxNcPaintEvent(*this); }
1e6feb95
VZ
1158
1159private:
fc7a2a60 1160 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent)
1e6feb95
VZ
1161};
1162
c801d85f
KB
1163// Erase background event class
1164/*
1165 wxEVT_ERASE_BACKGROUND
1166 */
1167
bddd7a8d 1168class WXDLLIMPEXP_CORE wxEraseEvent : public wxEvent
c801d85f 1169{
2b854a32 1170public:
2b854a32 1171 wxEraseEvent(int Id = 0, wxDC *dc = (wxDC *) NULL)
497dbbd3
VZ
1172 : wxEvent(Id, wxEVT_ERASE_BACKGROUND),
1173 m_dc(dc)
e6a6feba
GD
1174 { }
1175
1176 wxEraseEvent(const wxEraseEvent& event)
497dbbd3
VZ
1177 : wxEvent(event),
1178 m_dc(event.m_dc)
e6a6feba 1179 { }
f97500b8 1180
2b854a32 1181 wxDC *GetDC() const { return m_dc; }
aadbdf11 1182
8e72b8b5 1183 virtual wxEvent *Clone() const { return new wxEraseEvent(*this); }
f97500b8 1184
b4b76d61 1185protected:
8e72b8b5
RR
1186 wxDC *m_dc;
1187
1188private:
fc7a2a60 1189 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent)
c801d85f
KB
1190};
1191
1192// Focus event class
1193/*
1194 wxEVT_SET_FOCUS
1195 wxEVT_KILL_FOCUS
1196 */
1197
bddd7a8d 1198class WXDLLIMPEXP_CORE wxFocusEvent : public wxEvent
c801d85f 1199{
2b854a32 1200public:
d9e2e4c2
DE
1201 wxFocusEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1202 : wxEvent(winid, type)
497dbbd3 1203 { m_win = NULL; }
e6a6feba
GD
1204
1205 wxFocusEvent(const wxFocusEvent& event)
1206 : wxEvent(event)
497dbbd3 1207 { m_win = event.m_win; }
1e6feb95 1208
8e72b8b5 1209 // The window associated with this event is the window which had focus
1e6feb95 1210 // before for SET event and the window which will have focus for the KILL
8e72b8b5 1211 // one. NB: it may be NULL in both cases!
1e6feb95
VZ
1212 wxWindow *GetWindow() const { return m_win; }
1213 void SetWindow(wxWindow *win) { m_win = win; }
1214
8e72b8b5 1215 virtual wxEvent *Clone() const { return new wxFocusEvent(*this); }
f97500b8 1216
1e6feb95
VZ
1217private:
1218 wxWindow *m_win;
1219
8e72b8b5 1220private:
fc7a2a60 1221 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent)
c801d85f
KB
1222};
1223
456bc6d9 1224// wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1648d51b 1225// wxFocusEvent it is propagated upwards the window chain
bddd7a8d 1226class WXDLLIMPEXP_CORE wxChildFocusEvent : public wxCommandEvent
456bc6d9
VZ
1227{
1228public:
1229 wxChildFocusEvent(wxWindow *win = NULL);
1230
1231 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1232
8e72b8b5 1233 virtual wxEvent *Clone() const { return new wxChildFocusEvent(*this); }
f97500b8 1234
8e72b8b5 1235private:
fc7a2a60 1236 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent)
456bc6d9
VZ
1237};
1238
c801d85f
KB
1239// Activate event class
1240/*
1241 wxEVT_ACTIVATE
1242 wxEVT_ACTIVATE_APP
afafd942 1243 wxEVT_HIBERNATE
c801d85f
KB
1244 */
1245
bddd7a8d 1246class WXDLLIMPEXP_CORE wxActivateEvent : public wxEvent
c801d85f 1247{
2b854a32 1248public:
a0d9c6cb 1249 wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = true, int Id = 0)
e6a6feba 1250 : wxEvent(Id, type)
497dbbd3 1251 { m_active = active; }
1d2eddff
JS
1252 wxActivateEvent(const wxActivateEvent& event)
1253 : wxEvent(event)
b2697d42 1254 { m_active = event.m_active; }
c2bbeff0 1255
2b854a32 1256 bool GetActive() const { return m_active; }
c801d85f 1257
8e72b8b5 1258 virtual wxEvent *Clone() const { return new wxActivateEvent(*this); }
aadbdf11 1259
2b854a32
VZ
1260private:
1261 bool m_active;
8e72b8b5
RR
1262
1263private:
fc7a2a60 1264 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent)
c801d85f
KB
1265};
1266
1267// InitDialog event class
1268/*
1269 wxEVT_INIT_DIALOG
1270 */
1271
bddd7a8d 1272class WXDLLIMPEXP_CORE wxInitDialogEvent : public wxEvent
c801d85f 1273{
2b854a32
VZ
1274public:
1275 wxInitDialogEvent(int Id = 0)
e6a6feba
GD
1276 : wxEvent(Id, wxEVT_INIT_DIALOG)
1277 { }
8e72b8b5
RR
1278
1279 virtual wxEvent *Clone() const { return new wxInitDialogEvent(*this); }
f97500b8
VZ
1280
1281private:
fc7a2a60 1282 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent)
c801d85f
KB
1283};
1284
1285// Miscellaneous menu event class
1286/*
ccef86c7
VZ
1287 wxEVT_MENU_OPEN,
1288 wxEVT_MENU_CLOSE,
c801d85f 1289 wxEVT_MENU_HIGHLIGHT,
c801d85f
KB
1290*/
1291
bddd7a8d 1292class WXDLLIMPEXP_CORE wxMenuEvent : public wxEvent
c801d85f 1293{
c801d85f 1294public:
92f1a59c 1295 wxMenuEvent(wxEventType type = wxEVT_NULL, int winid = 0, wxMenu* menu = NULL)
d9e2e4c2 1296 : wxEvent(winid, type)
fc7a2a60 1297 { m_menuId = winid; m_menu = menu; }
1d2eddff
JS
1298 wxMenuEvent(const wxMenuEvent & event)
1299 : wxEvent(event)
92f1a59c 1300 { m_menuId = event.m_menuId; m_menu = event.m_menu; }
c2bbeff0 1301
ccef86c7 1302 // only for wxEVT_MENU_HIGHLIGHT
aadbdf11 1303 int GetMenuId() const { return m_menuId; }
c801d85f 1304
ccef86c7 1305 // only for wxEVT_MENU_OPEN/CLOSE
1a18887b 1306 bool IsPopup() const { return m_menuId == wxID_ANY; }
ccef86c7 1307
92f1a59c
JS
1308 // only for wxEVT_MENU_OPEN/CLOSE
1309 wxMenu* GetMenu() const { return m_menu; }
1310
8e72b8b5 1311 virtual wxEvent *Clone() const { return new wxMenuEvent(*this); }
f97500b8 1312
2b854a32 1313private:
92f1a59c
JS
1314 int m_menuId;
1315 wxMenu* m_menu;
f97500b8 1316
fc7a2a60 1317 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent)
c801d85f
KB
1318};
1319
1320// Window close or session close event class
1321/*
1322 wxEVT_CLOSE_WINDOW,
1323 wxEVT_END_SESSION,
1324 wxEVT_QUERY_END_SESSION
1325 */
1326
bddd7a8d 1327class WXDLLIMPEXP_CORE wxCloseEvent : public wxEvent
c801d85f 1328{
c801d85f 1329public:
d9e2e4c2
DE
1330 wxCloseEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1331 : wxEvent(winid, type),
a0d9c6cb
WS
1332 m_loggingOff(true),
1333 m_veto(false), // should be false by default
1334 m_canVeto(true) {}
a3bf7524 1335
1d2eddff
JS
1336 wxCloseEvent(const wxCloseEvent & event)
1337 : wxEvent(event),
b2697d42
VZ
1338 m_loggingOff(event.m_loggingOff),
1339 m_veto(event.m_veto),
a3bf7524 1340 m_canVeto(event.m_canVeto) {}
c2bbeff0 1341
2b854a32 1342 void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
4bcfcdef
VZ
1343 bool GetLoggingOff() const
1344 {
1345 // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
1346 // doesn't make sense for wxEVT_CLOSE_WINDOW
1347 wxASSERT_MSG( m_eventType != wxEVT_CLOSE_WINDOW,
1348 _T("this flag is for end session events only") );
1349
1350 return m_loggingOff;
1351 }
2b854a32 1352
a0d9c6cb 1353 void Veto(bool veto = true)
fe4e9e6c 1354 {
a0d9c6cb 1355 // GetVeto() will return false anyhow...
fe4e9e6c 1356 wxCHECK_RET( m_canVeto,
223d09f6 1357 wxT("call to Veto() ignored (can't veto this event)") );
fe4e9e6c
VZ
1358
1359 m_veto = veto;
1360 }
2b854a32
VZ
1361 void SetCanVeto(bool canVeto) { m_canVeto = canVeto; }
1362 bool CanVeto() const { return m_canVeto; }
fe4e9e6c 1363 bool GetVeto() const { return m_canVeto && m_veto; }
c801d85f 1364
8e72b8b5 1365 virtual wxEvent *Clone() const { return new wxCloseEvent(*this); }
aadbdf11 1366
2b854a32 1367protected:
4bcfcdef
VZ
1368 bool m_loggingOff,
1369 m_veto,
1370 m_canVeto;
2b854a32 1371
8e72b8b5 1372private:
fc7a2a60 1373 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent)
c801d85f
KB
1374};
1375
1376/*
1377 wxEVT_SHOW
1378 */
1379
bddd7a8d 1380class WXDLLIMPEXP_CORE wxShowEvent : public wxEvent
c801d85f 1381{
c801d85f 1382public:
a0d9c6cb 1383 wxShowEvent(int winid = 0, bool show = false)
d9e2e4c2 1384 : wxEvent(winid, wxEVT_SHOW)
497dbbd3 1385 { m_show = show; }
1d2eddff
JS
1386 wxShowEvent(const wxShowEvent & event)
1387 : wxEvent(event)
b2697d42 1388 { m_show = event.m_show; }
c2bbeff0 1389
2b854a32
VZ
1390 void SetShow(bool show) { m_show = show; }
1391 bool GetShow() const { return m_show; }
c801d85f 1392
8e72b8b5 1393 virtual wxEvent *Clone() const { return new wxShowEvent(*this); }
aadbdf11 1394
c801d85f 1395protected:
2b854a32 1396 bool m_show;
3dd9b88a 1397
8e72b8b5 1398private:
fc7a2a60 1399 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent)
c801d85f
KB
1400};
1401
1402/*
1403 wxEVT_ICONIZE
1404 */
1405
bddd7a8d 1406class WXDLLIMPEXP_CORE wxIconizeEvent : public wxEvent
c801d85f 1407{
2b854a32 1408public:
a0d9c6cb 1409 wxIconizeEvent(int winid = 0, bool iconized = true)
d9e2e4c2 1410 : wxEvent(winid, wxEVT_ICONIZE)
497dbbd3 1411 { m_iconized = iconized; }
1d2eddff
JS
1412 wxIconizeEvent(const wxIconizeEvent & event)
1413 : wxEvent(event)
b2697d42 1414 { m_iconized = event.m_iconized; }
c2bbeff0 1415
3dd9b88a
VZ
1416 // return true if the frame was iconized, false if restored
1417 bool Iconized() const { return m_iconized; }
1418
8e72b8b5 1419 virtual wxEvent *Clone() const { return new wxIconizeEvent(*this); }
f97500b8 1420
3dd9b88a
VZ
1421protected:
1422 bool m_iconized;
1423
8e72b8b5 1424private:
fc7a2a60 1425 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent)
c801d85f 1426};
c801d85f
KB
1427/*
1428 wxEVT_MAXIMIZE
1429 */
1430
bddd7a8d 1431class WXDLLIMPEXP_CORE wxMaximizeEvent : public wxEvent
c801d85f 1432{
2b854a32 1433public:
d9e2e4c2
DE
1434 wxMaximizeEvent(int winid = 0)
1435 : wxEvent(winid, wxEVT_MAXIMIZE)
e6a6feba 1436 { }
3dd9b88a 1437
8e72b8b5 1438 virtual wxEvent *Clone() const { return new wxMaximizeEvent(*this); }
f97500b8 1439
8e72b8b5 1440private:
fc7a2a60 1441 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent)
c801d85f
KB
1442};
1443
1444// Joystick event class
1445/*
1446 wxEVT_JOY_BUTTON_DOWN,
1447 wxEVT_JOY_BUTTON_UP,
1448 wxEVT_JOY_MOVE,
1449 wxEVT_JOY_ZMOVE
1450*/
1451
1452// Which joystick? Same as Windows ids so no conversion necessary.
497dbbd3
VZ
1453enum
1454{
1455 wxJOYSTICK1,
1456 wxJOYSTICK2
1457};
c801d85f
KB
1458
1459// Which button is down?
497dbbd3
VZ
1460enum
1461{
1462 wxJOY_BUTTON_ANY = -1,
1463 wxJOY_BUTTON1 = 1,
1464 wxJOY_BUTTON2 = 2,
1465 wxJOY_BUTTON3 = 4,
1466 wxJOY_BUTTON4 = 8
1467};
c801d85f 1468
bddd7a8d 1469class WXDLLIMPEXP_CORE wxJoystickEvent : public wxEvent
c801d85f 1470{
b4b76d61 1471protected:
2b854a32
VZ
1472 wxPoint m_pos;
1473 int m_zPosition;
497dbbd3
VZ
1474 int m_buttonChange; // Which button changed?
1475 int m_buttonState; // Which buttons are down?
1476 int m_joyStick; // Which joystick?
2b854a32 1477
b4b76d61 1478public:
2b854a32
VZ
1479 wxJoystickEvent(wxEventType type = wxEVT_NULL,
1480 int state = 0,
1481 int joystick = wxJOYSTICK1,
1482 int change = 0)
497dbbd3 1483 : wxEvent(0, type),
8b5d5223 1484 m_pos(),
497dbbd3
VZ
1485 m_zPosition(0),
1486 m_buttonChange(change),
1487 m_buttonState(state),
1488 m_joyStick(joystick)
2b854a32 1489 {
2b854a32 1490 }
1d2eddff 1491 wxJoystickEvent(const wxJoystickEvent & event)
b2697d42
VZ
1492 : wxEvent(event),
1493 m_pos(event.m_pos),
1494 m_zPosition(event.m_zPosition),
1495 m_buttonChange(event.m_buttonChange),
1496 m_buttonState(event.m_buttonState),
1497 m_joyStick(event.m_joyStick)
1d2eddff 1498 { }
c2bbeff0 1499
2b854a32
VZ
1500 wxPoint GetPosition() const { return m_pos; }
1501 int GetZPosition() const { return m_zPosition; }
1502 int GetButtonState() const { return m_buttonState; }
1503 int GetButtonChange() const { return m_buttonChange; }
1504 int GetJoystick() const { return m_joyStick; }
1505
1506 void SetJoystick(int stick) { m_joyStick = stick; }
1507 void SetButtonState(int state) { m_buttonState = state; }
1508 void SetButtonChange(int change) { m_buttonChange = change; }
1509 void SetPosition(const wxPoint& pos) { m_pos = pos; }
1510 void SetZPosition(int zPos) { m_zPosition = zPos; }
1511
1512 // Was it a button event? (*doesn't* mean: is any button *down*?)
1513 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) ||
b70ababc 1514 (GetEventType() == wxEVT_JOY_BUTTON_UP)); }
2b854a32
VZ
1515
1516 // Was it a move event?
a7bc03c9 1517 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE); }
2b854a32
VZ
1518
1519 // Was it a zmove event?
a7bc03c9 1520 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE); }
2b854a32
VZ
1521
1522 // Was it a down event from button 1, 2, 3, 4 or any?
1523 bool ButtonDown(int but = wxJOY_BUTTON_ANY) const
c801d85f 1524 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) &&
2b854a32 1525 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
c801d85f 1526
2b854a32
VZ
1527 // Was it a up event from button 1, 2, 3 or any?
1528 bool ButtonUp(int but = wxJOY_BUTTON_ANY) const
c801d85f 1529 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP) &&
2b854a32 1530 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
c801d85f 1531
2b854a32
VZ
1532 // Was the given button 1,2,3,4 or any in Down state?
1533 bool ButtonIsDown(int but = wxJOY_BUTTON_ANY) const
c801d85f 1534 { return (((but == wxJOY_BUTTON_ANY) && (m_buttonState != 0)) ||
2b854a32 1535 ((m_buttonState & but) == but)); }
f305c661 1536
8e72b8b5 1537 virtual wxEvent *Clone() const { return new wxJoystickEvent(*this); }
f97500b8 1538
8e72b8b5 1539private:
fc7a2a60 1540 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent)
c801d85f
KB
1541};
1542
1543// Drop files event class
1544/*
1545 wxEVT_DROP_FILES
1546 */
1547
bddd7a8d 1548class WXDLLIMPEXP_CORE wxDropFilesEvent : public wxEvent
c801d85f 1549{
2b854a32
VZ
1550public:
1551 int m_noFiles;
1552 wxPoint m_pos;
c3c39620 1553 wxString* m_files;
2b854a32
VZ
1554
1555 wxDropFilesEvent(wxEventType type = wxEVT_NULL,
1556 int noFiles = 0,
1557 wxString *files = (wxString *) NULL)
497dbbd3
VZ
1558 : wxEvent(0, type),
1559 m_noFiles(noFiles),
1560 m_pos(),
1561 m_files(files)
e6a6feba 1562 { }
2b854a32 1563
c3c39620
VZ
1564 // we need a copy ctor to avoid deleting m_files pointer twice
1565 wxDropFilesEvent(const wxDropFilesEvent& other)
497dbbd3
VZ
1566 : wxEvent(other),
1567 m_noFiles(other.m_noFiles),
1568 m_pos(other.m_pos),
1569 m_files(NULL)
c3c39620 1570 {
c3c39620
VZ
1571 m_files = new wxString[m_noFiles];
1572 for ( int n = 0; n < m_noFiles; n++ )
1573 {
1574 m_files[n] = other.m_files[n];
1575 }
1576 }
1577
1578 virtual ~wxDropFilesEvent()
1579 {
1580 delete [] m_files;
1581 }
1582
2b854a32
VZ
1583 wxPoint GetPosition() const { return m_pos; }
1584 int GetNumberOfFiles() const { return m_noFiles; }
1585 wxString *GetFiles() const { return m_files; }
f305c661 1586
c3c39620 1587 virtual wxEvent *Clone() const { return new wxDropFilesEvent(*this); }
f97500b8 1588
8e72b8b5 1589private:
fc7a2a60 1590 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent)
c801d85f
KB
1591};
1592
c801d85f
KB
1593// Update UI event
1594/*
1595 wxEVT_UPDATE_UI
1596 */
1597
e39af974
JS
1598// Whether to always send update events to windows, or
1599// to only send update events to those with the
1600// wxWS_EX_PROCESS_UI_UPDATES style.
1601
1602enum wxUpdateUIMode
1603{
1604 // Send UI update events to all windows
1605 wxUPDATE_UI_PROCESS_ALL,
1606
1607 // Send UI update events to windows that have
1608 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
1609 wxUPDATE_UI_PROCESS_SPECIFIED
1610};
1611
bddd7a8d 1612class WXDLLIMPEXP_CORE wxUpdateUIEvent : public wxCommandEvent
c801d85f 1613{
2b854a32
VZ
1614public:
1615 wxUpdateUIEvent(wxWindowID commandId = 0)
e6a6feba 1616 : wxCommandEvent(wxEVT_UPDATE_UI, commandId)
497dbbd3
VZ
1617 {
1618 m_checked =
1619 m_enabled =
a3a4105d 1620 m_shown =
497dbbd3 1621 m_setEnabled =
a3a4105d 1622 m_setShown =
9b9337da 1623 m_setText =
a0d9c6cb 1624 m_setChecked = false;
497dbbd3 1625 }
1d2eddff
JS
1626 wxUpdateUIEvent(const wxUpdateUIEvent & event)
1627 : wxCommandEvent(event),
b2697d42
VZ
1628 m_checked(event.m_checked),
1629 m_enabled(event.m_enabled),
a3a4105d 1630 m_shown(event.m_shown),
b2697d42 1631 m_setEnabled(event.m_setEnabled),
a3a4105d 1632 m_setShown(event.m_setShown),
b2697d42
VZ
1633 m_setText(event.m_setText),
1634 m_setChecked(event.m_setChecked),
1635 m_text(event.m_text)
1636 { }
c2bbeff0 1637
2b854a32
VZ
1638 bool GetChecked() const { return m_checked; }
1639 bool GetEnabled() const { return m_enabled; }
a3a4105d 1640 bool GetShown() const { return m_shown; }
2b854a32
VZ
1641 wxString GetText() const { return m_text; }
1642 bool GetSetText() const { return m_setText; }
1643 bool GetSetChecked() const { return m_setChecked; }
1644 bool GetSetEnabled() const { return m_setEnabled; }
a3a4105d 1645 bool GetSetShown() const { return m_setShown; }
2b854a32 1646
a0d9c6cb
WS
1647 void Check(bool check) { m_checked = check; m_setChecked = true; }
1648 void Enable(bool enable) { m_enabled = enable; m_setEnabled = true; }
a3a4105d 1649 void Show(bool show) { m_shown = show; m_setShown = true; }
a0d9c6cb 1650 void SetText(const wxString& text) { m_text = text; m_setText = true; }
c801d85f 1651
0b30bb0b
JS
1652 // Sets the interval between updates in milliseconds.
1653 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
e39af974 1654 static void SetUpdateInterval(long updateInterval) { sm_updateInterval = updateInterval; }
0b30bb0b
JS
1655
1656 // Returns the current interval between updates in milliseconds
a7bc03c9 1657 static long GetUpdateInterval() { return sm_updateInterval; }
0b30bb0b 1658
e39af974 1659 // Can we update this window?
a7bc03c9 1660 static bool CanUpdate(wxWindowBase *win);
0b30bb0b
JS
1661
1662 // Reset the update time to provide a delay until the next
1663 // time we should update
a7bc03c9 1664 static void ResetUpdateTime();
0b30bb0b 1665
77ffb593 1666 // Specify how wxWidgets will send update events: to
e39af974
JS
1667 // all windows, or only to those which specify that they
1668 // will process the events.
1669 static void SetMode(wxUpdateUIMode mode) { sm_updateMode = mode; }
1670
1671 // Returns the UI update mode
a7bc03c9 1672 static wxUpdateUIMode GetMode() { return sm_updateMode; }
e39af974 1673
8e72b8b5 1674 virtual wxEvent *Clone() const { return new wxUpdateUIEvent(*this); }
f305c661 1675
2b854a32
VZ
1676protected:
1677 bool m_checked;
1678 bool m_enabled;
a3a4105d 1679 bool m_shown;
2b854a32 1680 bool m_setEnabled;
a3a4105d 1681 bool m_setShown;
2b854a32
VZ
1682 bool m_setText;
1683 bool m_setChecked;
1684 wxString m_text;
0b30bb0b 1685#if wxUSE_LONGLONG
e39af974 1686 static wxLongLong sm_lastUpdate;
0b30bb0b 1687#endif
e39af974
JS
1688 static long sm_updateInterval;
1689 static wxUpdateUIMode sm_updateMode;
f97500b8 1690
8e72b8b5 1691private:
fc7a2a60 1692 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent)
c801d85f
KB
1693};
1694
1695/*
1696 wxEVT_SYS_COLOUR_CHANGED
1697 */
1698
1699// TODO: shouldn't all events record the window ID?
bddd7a8d 1700class WXDLLIMPEXP_CORE wxSysColourChangedEvent : public wxEvent
c801d85f 1701{
2b854a32
VZ
1702public:
1703 wxSysColourChangedEvent()
e6a6feba
GD
1704 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED)
1705 { }
f97500b8 1706
8e72b8b5 1707 virtual wxEvent *Clone() const { return new wxSysColourChangedEvent(*this); }
f97500b8 1708
8e72b8b5 1709private:
fc7a2a60 1710 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent)
c801d85f
KB
1711};
1712
a5e84126
JS
1713/*
1714 wxEVT_MOUSE_CAPTURE_CHANGED
1715 The window losing the capture receives this message
1716 (even if it released the capture itself).
1717 */
1718
bddd7a8d 1719class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent : public wxEvent
a5e84126
JS
1720{
1721public:
d9e2e4c2
DE
1722 wxMouseCaptureChangedEvent(wxWindowID winid = 0, wxWindow* gainedCapture = NULL)
1723 : wxEvent(winid, wxEVT_MOUSE_CAPTURE_CHANGED),
497dbbd3 1724 m_gainedCapture(gainedCapture)
e6a6feba
GD
1725 { }
1726
1727 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent& event)
497dbbd3
VZ
1728 : wxEvent(event),
1729 m_gainedCapture(event.m_gainedCapture)
e6a6feba 1730 { }
a5e84126
JS
1731
1732 virtual wxEvent *Clone() const { return new wxMouseCaptureChangedEvent(*this); }
1733
47b378bd 1734 wxWindow* GetCapturedWindow() const { return m_gainedCapture; }
a5e84126
JS
1735
1736private:
1737 wxWindow* m_gainedCapture;
fc7a2a60
VZ
1738
1739 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent)
a5e84126
JS
1740};
1741
63e819f2
VS
1742/*
1743 wxEVT_MOUSE_CAPTURE_LOST
1744 The window losing the capture receives this message, unless it released it
1745 it itself or unless wxWindow::CaptureMouse was called on another window
1746 (and so capture will be restored when the new capturer releases it).
1747 */
1748
1749class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent : public wxEvent
1750{
1751public:
1752 wxMouseCaptureLostEvent(wxWindowID winid = 0)
1753 : wxEvent(winid, wxEVT_MOUSE_CAPTURE_LOST)
1754 {}
1755
1756 wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent& event)
1757 : wxEvent(event)
1758 {}
1759
1760 virtual wxEvent *Clone() const { return new wxMouseCaptureLostEvent(*this); }
1761
1762 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent)
1763};
1764
574c939e
KB
1765/*
1766 wxEVT_DISPLAY_CHANGED
1767 */
bddd7a8d 1768class WXDLLIMPEXP_CORE wxDisplayChangedEvent : public wxEvent
574c939e
KB
1769{
1770private:
fc7a2a60 1771 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent)
574c939e
KB
1772
1773public:
1774 wxDisplayChangedEvent()
e6a6feba
GD
1775 : wxEvent(0, wxEVT_DISPLAY_CHANGED)
1776 { }
574c939e
KB
1777
1778 virtual wxEvent *Clone() const { return new wxDisplayChangedEvent(*this); }
1779};
1780
f7bd2698
JS
1781/*
1782 wxEVT_PALETTE_CHANGED
1783 */
1784
bddd7a8d 1785class WXDLLIMPEXP_CORE wxPaletteChangedEvent : public wxEvent
f7bd2698 1786{
f7bd2698 1787public:
d9e2e4c2
DE
1788 wxPaletteChangedEvent(wxWindowID winid = 0)
1789 : wxEvent(winid, wxEVT_PALETTE_CHANGED),
497dbbd3
VZ
1790 m_changedWindow((wxWindow *) NULL)
1791 { }
e6a6feba
GD
1792
1793 wxPaletteChangedEvent(const wxPaletteChangedEvent& event)
497dbbd3
VZ
1794 : wxEvent(event),
1795 m_changedWindow(event.m_changedWindow)
e6a6feba 1796 { }
f7bd2698 1797
2b854a32
VZ
1798 void SetChangedWindow(wxWindow* win) { m_changedWindow = win; }
1799 wxWindow* GetChangedWindow() const { return m_changedWindow; }
f7bd2698 1800
8e72b8b5 1801 virtual wxEvent *Clone() const { return new wxPaletteChangedEvent(*this); }
f305c661 1802
f7bd2698 1803protected:
2b854a32 1804 wxWindow* m_changedWindow;
8e72b8b5
RR
1805
1806private:
fc7a2a60 1807 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent)
f7bd2698
JS
1808};
1809
1810/*
1811 wxEVT_QUERY_NEW_PALETTE
1812 Indicates the window is getting keyboard focus and should re-do its palette.
1813 */
1814
bddd7a8d 1815class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent : public wxEvent
f7bd2698 1816{
f7bd2698 1817public:
d9e2e4c2
DE
1818 wxQueryNewPaletteEvent(wxWindowID winid = 0)
1819 : wxEvent(winid, wxEVT_QUERY_NEW_PALETTE),
a0d9c6cb 1820 m_paletteRealized(false)
e6a6feba 1821 { }
1d2eddff
JS
1822 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent & event)
1823 : wxEvent(event),
b2697d42
VZ
1824 m_paletteRealized(event.m_paletteRealized)
1825 { }
c2bbeff0 1826
2b854a32
VZ
1827 // App sets this if it changes the palette.
1828 void SetPaletteRealized(bool realized) { m_paletteRealized = realized; }
1829 bool GetPaletteRealized() const { return m_paletteRealized; }
f7bd2698 1830
8e72b8b5 1831 virtual wxEvent *Clone() const { return new wxQueryNewPaletteEvent(*this); }
f305c661 1832
f7bd2698 1833protected:
2b854a32 1834 bool m_paletteRealized;
f97500b8 1835
8e72b8b5 1836private:
fc7a2a60 1837 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent)
f7bd2698
JS
1838};
1839
7fdefd57
VZ
1840/*
1841 Event generated by dialog navigation keys
1842 wxEVT_NAVIGATION_KEY
1843 */
d9506e77 1844// NB: don't derive from command event to avoid being propagated to the parent
bddd7a8d 1845class WXDLLIMPEXP_CORE wxNavigationKeyEvent : public wxEvent
7fdefd57 1846{
7fdefd57 1847public:
d9506e77 1848 wxNavigationKeyEvent()
497dbbd3 1849 : wxEvent(0, wxEVT_NAVIGATION_KEY),
298ca00c 1850 m_flags(IsForward | FromTab), // defaults are for TAB
497dbbd3 1851 m_focus((wxWindow *)NULL)
aef35d0e
VZ
1852 {
1853 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
1854 }
d9506e77 1855
e6a6feba 1856 wxNavigationKeyEvent(const wxNavigationKeyEvent& event)
497dbbd3
VZ
1857 : wxEvent(event),
1858 m_flags(event.m_flags),
1859 m_focus(event.m_focus)
e6a6feba 1860 { }
7fdefd57 1861
2b854a32 1862 // direction: forward (true) or backward (false)
d9506e77
VZ
1863 bool GetDirection() const
1864 { return (m_flags & IsForward) != 0; }
1865 void SetDirection(bool bForward)
1866 { if ( bForward ) m_flags |= IsForward; else m_flags &= ~IsForward; }
7fdefd57 1867
2b854a32
VZ
1868 // it may be a window change event (MDI, notebook pages...) or a control
1869 // change event
d9506e77
VZ
1870 bool IsWindowChange() const
1871 { return (m_flags & WinChange) != 0; }
1872 void SetWindowChange(bool bIs)
1873 { if ( bIs ) m_flags |= WinChange; else m_flags &= ~WinChange; }
1874
298ca00c
VZ
1875 // Set to true under MSW if the event was generated using the tab key.
1876 // This is required for proper navogation over radio buttons
1877 bool IsFromTab() const
1878 { return (m_flags & FromTab) != 0; }
1879 void SetFromTab(bool bIs)
1880 { if ( bIs ) m_flags |= FromTab; else m_flags &= ~FromTab; }
1881
2b854a32
VZ
1882 // the child which has the focus currently (may be NULL - use
1883 // wxWindow::FindFocus then)
d9506e77
VZ
1884 wxWindow* GetCurrentFocus() const { return m_focus; }
1885 void SetCurrentFocus(wxWindow *win) { m_focus = win; }
1886
54a69edf
JS
1887 // Set flags
1888 void SetFlags(long flags) { m_flags = flags; }
1889
8e72b8b5
RR
1890 virtual wxEvent *Clone() const { return new wxNavigationKeyEvent(*this); }
1891
d9506e77
VZ
1892 enum
1893 {
f2de9fee 1894 IsBackward = 0x0000,
d9506e77 1895 IsForward = 0x0001,
298ca00c
VZ
1896 WinChange = 0x0002,
1897 FromTab = 0x0004
d9506e77
VZ
1898 };
1899
1900 long m_flags;
1901 wxWindow *m_focus;
1902
8e72b8b5 1903private:
fc7a2a60 1904 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent)
7fdefd57
VZ
1905};
1906
42e69d6b
VZ
1907// Window creation/destruction events: the first is sent as soon as window is
1908// created (i.e. the underlying GUI object exists), but when the C++ object is
1909// fully initialized (so virtual functions may be called). The second,
1910// wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
1911// still safe to call virtual functions at this moment
1912/*
1913 wxEVT_CREATE
1914 wxEVT_DESTROY
1915 */
1916
bddd7a8d 1917class WXDLLIMPEXP_CORE wxWindowCreateEvent : public wxCommandEvent
42e69d6b 1918{
42e69d6b
VZ
1919public:
1920 wxWindowCreateEvent(wxWindow *win = NULL);
1921
1922 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
f97500b8 1923
8e72b8b5 1924 virtual wxEvent *Clone() const { return new wxWindowCreateEvent(*this); }
f97500b8 1925
8e72b8b5 1926private:
fc7a2a60 1927 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent)
42e69d6b
VZ
1928};
1929
bddd7a8d 1930class WXDLLIMPEXP_CORE wxWindowDestroyEvent : public wxCommandEvent
42e69d6b 1931{
42e69d6b
VZ
1932public:
1933 wxWindowDestroyEvent(wxWindow *win = NULL);
1934
1935 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
f97500b8 1936
8e72b8b5
RR
1937 virtual wxEvent *Clone() const { return new wxWindowDestroyEvent(*this); }
1938
1939private:
fc7a2a60 1940 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent)
42e69d6b
VZ
1941};
1942
bd83cb56 1943// A help event is sent when the user clicks on a window in context-help mode.
b96340e6 1944/*
bd83cb56
VZ
1945 wxEVT_HELP
1946 wxEVT_DETAILED_HELP
1947*/
b96340e6 1948
bddd7a8d 1949class WXDLLIMPEXP_CORE wxHelpEvent : public wxCommandEvent
b96340e6 1950{
b96340e6 1951public:
b107e8d5
VZ
1952 // how was this help event generated?
1953 enum Origin
1954 {
1955 Origin_Unknown, // unrecognized event source
1956 Origin_Keyboard, // event generated from F1 key press
1957 Origin_HelpButton // event from [?] button on the title bar (Windows)
1958 };
1959
bd83cb56 1960 wxHelpEvent(wxEventType type = wxEVT_NULL,
d9e2e4c2 1961 wxWindowID winid = 0,
b107e8d5
VZ
1962 const wxPoint& pt = wxDefaultPosition,
1963 Origin origin = Origin_Unknown)
d9e2e4c2 1964 : wxCommandEvent(type, winid),
b107e8d5
VZ
1965 m_pos(pt),
1966 m_origin(GuessOrigin(origin))
e6a6feba 1967 { }
1d2eddff
JS
1968 wxHelpEvent(const wxHelpEvent & event)
1969 : wxCommandEvent(event),
b2697d42
VZ
1970 m_pos(event.m_pos),
1971 m_target(event.m_target),
b107e8d5
VZ
1972 m_link(event.m_link),
1973 m_origin(event.m_origin)
1d2eddff 1974 { }
c2bbeff0 1975
bd83cb56
VZ
1976 // Position of event (in screen coordinates)
1977 const wxPoint& GetPosition() const { return m_pos; }
1978 void SetPosition(const wxPoint& pos) { m_pos = pos; }
b96340e6 1979
bd83cb56
VZ
1980 // Optional link to further help
1981 const wxString& GetLink() const { return m_link; }
1982 void SetLink(const wxString& link) { m_link = link; }
fb6261e9 1983
bd83cb56
VZ
1984 // Optional target to display help in. E.g. a window specification
1985 const wxString& GetTarget() const { return m_target; }
1986 void SetTarget(const wxString& target) { m_target = target; }
fb6261e9 1987
8e72b8b5 1988 virtual wxEvent *Clone() const { return new wxHelpEvent(*this); }
f97500b8 1989
b107e8d5
VZ
1990 // optional indication of the event source
1991 Origin GetOrigin() const { return m_origin; }
1992 void SetOrigin(Origin origin) { m_origin = origin; }
1993
bd83cb56
VZ
1994protected:
1995 wxPoint m_pos;
1996 wxString m_target;
1997 wxString m_link;
b107e8d5
VZ
1998 Origin m_origin;
1999
2000 // we can try to guess the event origin ourselves, even if none is
2001 // specified in the ctor
2002 static Origin GuessOrigin(Origin origin);
bd83cb56
VZ
2003
2004private:
fc7a2a60 2005 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent)
b96340e6
JS
2006};
2007
78c91815
VZ
2008// A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2009// message, i.e. the user has cut/copied/pasted data from/into a text control
2010// via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2011// NOTE : under windows these events are *NOT* generated automatically
2012// for a Rich Edit text control.
2013/*
2014wxEVT_COMMAND_TEXT_COPY
2015wxEVT_COMMAND_TEXT_CUT
2016wxEVT_COMMAND_TEXT_PASTE
2017*/
2018
2019class WXDLLIMPEXP_CORE wxClipboardTextEvent : public wxCommandEvent
2020{
2021public:
2022 wxClipboardTextEvent(wxEventType type = wxEVT_NULL,
2023 wxWindowID winid = 0)
2024 : wxCommandEvent(type, winid)
2025 { }
2026 wxClipboardTextEvent(const wxClipboardTextEvent & event)
2027 : wxCommandEvent(event)
2028 { }
2029
2030 virtual wxEvent *Clone() const { return new wxClipboardTextEvent(*this); }
2031
2032private:
2033 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent)
2034};
2035
69231000
JS
2036// A Context event is sent when the user right clicks on a window or
2037// presses Shift-F10
2038// NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2039// Under other systems it may have to be generated from a right click event
2040/*
2041 wxEVT_CONTEXT_MENU
2042*/
2043
bddd7a8d 2044class WXDLLIMPEXP_CORE wxContextMenuEvent : public wxCommandEvent
69231000
JS
2045{
2046public:
2047 wxContextMenuEvent(wxEventType type = wxEVT_NULL,
d9e2e4c2 2048 wxWindowID winid = 0,
e6a6feba 2049 const wxPoint& pt = wxDefaultPosition)
d9e2e4c2 2050 : wxCommandEvent(type, winid),
497dbbd3 2051 m_pos(pt)
e6a6feba 2052 { }
1d2eddff
JS
2053 wxContextMenuEvent(const wxContextMenuEvent & event)
2054 : wxCommandEvent(event),
b2697d42 2055 m_pos(event.m_pos)
1d2eddff 2056 { }
c2bbeff0 2057
69231000
JS
2058 // Position of event (in screen coordinates)
2059 const wxPoint& GetPosition() const { return m_pos; }
2060 void SetPosition(const wxPoint& pos) { m_pos = pos; }
2061
8e72b8b5 2062 virtual wxEvent *Clone() const { return new wxContextMenuEvent(*this); }
f97500b8 2063
69231000
JS
2064protected:
2065 wxPoint m_pos;
2066
2067private:
fc7a2a60 2068 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent)
69231000
JS
2069};
2070
b46b1d59
VZ
2071#endif // wxUSE_GUI
2072
e90c1d2a
VZ
2073// Idle event
2074/*
2075 wxEVT_IDLE
2076 */
2077
e39af974
JS
2078// Whether to always send idle events to windows, or
2079// to only send update events to those with the
2080// wxWS_EX_PROCESS_IDLE style.
2081
2082enum wxIdleMode
2083{
2084 // Send idle events to all windows
2085 wxIDLE_PROCESS_ALL,
2086
2087 // Send idle events to windows that have
2088 // the wxWS_EX_PROCESS_IDLE flag specified
2089 wxIDLE_PROCESS_SPECIFIED
2090};
2091
b46b1d59 2092class WXDLLIMPEXP_BASE wxIdleEvent : public wxEvent
e90c1d2a 2093{
e90c1d2a
VZ
2094public:
2095 wxIdleEvent()
497dbbd3 2096 : wxEvent(0, wxEVT_IDLE),
a0d9c6cb 2097 m_requestMore(false)
e6a6feba 2098 { }
1d2eddff
JS
2099 wxIdleEvent(const wxIdleEvent & event)
2100 : wxEvent(event),
b2697d42
VZ
2101 m_requestMore(event.m_requestMore)
2102 { }
c2bbeff0 2103
a0d9c6cb 2104 void RequestMore(bool needMore = true) { m_requestMore = needMore; }
e90c1d2a
VZ
2105 bool MoreRequested() const { return m_requestMore; }
2106
8e72b8b5 2107 virtual wxEvent *Clone() const { return new wxIdleEvent(*this); }
e90c1d2a 2108
77ffb593 2109 // Specify how wxWidgets will send idle events: to
e39af974
JS
2110 // all windows, or only to those which specify that they
2111 // will process the events.
2112 static void SetMode(wxIdleMode mode) { sm_idleMode = mode; }
2113
2114 // Returns the idle event mode
a7bc03c9 2115 static wxIdleMode GetMode() { return sm_idleMode; }
e39af974 2116
e90c1d2a
VZ
2117protected:
2118 bool m_requestMore;
e39af974 2119 static wxIdleMode sm_idleMode;
f97500b8 2120
8e72b8b5 2121private:
fc7a2a60 2122 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent)
e90c1d2a
VZ
2123};
2124
e5fb7191 2125/* TODO
c801d85f
KB
2126 wxEVT_MOUSE_CAPTURE_CHANGED,
2127 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
c801d85f
KB
2128// wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2129 // wxEVT_FONT_CHANGED to all other windows (maybe).
2130 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2131 wxEVT_MEASURE_ITEM,
2132 wxEVT_COMPARE_ITEM
2133*/
2134
88a9f974 2135
8e193f38
VZ
2136// ============================================================================
2137// event handler and related classes
2138// ============================================================================
2139
d5d51013
VZ
2140// for backwards compatibility and to prevent eVC 4 for ARM from crashing with
2141// internal compiler error when compiling wx, we define wxObjectEventFunction
2142// as a wxObject method even though it can only be a wxEvtHandler one
2143typedef void (wxObject::*wxObjectEventFunction)(wxEvent&);
c801d85f 2144
2e4df4bf
VZ
2145// we can't have ctors nor base struct in backwards compatibility mode or
2146// otherwise we won't be able to initialize the objects with an agregate, so
2147// we have to keep both versions
2148#if WXWIN_COMPATIBILITY_EVENT_TYPES
2149
bddd7a8d 2150struct WXDLLIMPEXP_BASE wxEventTableEntry
2e4df4bf
VZ
2151{
2152 // For some reason, this can't be wxEventType, or VC++ complains.
2153 int m_eventType; // main event type
2154 int m_id; // control/menu/toolbar id
2155 int m_lastId; // used for ranges of ids
2156 wxObjectEventFunction m_fn; // function to call: not wxEventFunction,
2157 // because of dependency problems
2158
2159 wxObject* m_callbackUserData;
2160};
2161
2162#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
2163
6164f93c
VZ
2164// struct containing the members common to static and dynamic event tables
2165// entries
bddd7a8d 2166struct WXDLLIMPEXP_BASE wxEventTableEntryBase
77d4384e 2167{
e6a6feba
GD
2168private:
2169 wxEventTableEntryBase& operator=(const wxEventTableEntryBase& event);
abcbaea7 2170
e6a6feba 2171public:
d9e2e4c2 2172 wxEventTableEntryBase(int winid, int idLast,
6164f93c 2173 wxObjectEventFunction fn, wxObject *data)
d9e2e4c2 2174 : m_id(winid),
497dbbd3
VZ
2175 m_lastId(idLast),
2176 m_fn(fn),
2177 m_callbackUserData(data)
e6a6feba
GD
2178 { }
2179
2180 wxEventTableEntryBase(const wxEventTableEntryBase& event)
497dbbd3
VZ
2181 : m_id(event.m_id),
2182 m_lastId(event.m_lastId),
2183 m_fn(event.m_fn),
2184 m_callbackUserData(event.m_callbackUserData)
abcbaea7 2185 { }
6164f93c 2186
497dbbd3
VZ
2187 // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2188 // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2189 int m_id,
2190 m_lastId;
82a5f02c 2191
6164f93c
VZ
2192 // function to call: not wxEventFunction, because of dependency problems
2193 wxObjectEventFunction m_fn;
77d4384e 2194
6164f93c 2195 // arbitrary user data asosciated with the callback
77d4384e
RR
2196 wxObject* m_callbackUserData;
2197};
2198
6164f93c 2199// an entry from a static event table
bddd7a8d 2200struct WXDLLIMPEXP_BASE wxEventTableEntry : public wxEventTableEntryBase
c801d85f 2201{
d9e2e4c2 2202 wxEventTableEntry(const int& evType, int winid, int idLast,
6164f93c 2203 wxObjectEventFunction fn, wxObject *data)
d9e2e4c2 2204 : wxEventTableEntryBase(winid, idLast, fn, data),
e6a6feba
GD
2205 m_eventType(evType)
2206 { }
6164f93c
VZ
2207
2208 // the reference to event type: this allows us to not care about the
2209 // (undefined) order in which the event table entries and the event types
2210 // are initialized: initially the value of this reference might be
2211 // invalid, but by the time it is used for the first time, all global
2212 // objects will have been initialized (including the event type constants)
2213 // and so it will have the correct value when it is needed
2214 const int& m_eventType;
fc7a2a60
VZ
2215
2216private:
2217 wxEventTableEntry& operator=(const wxEventTableEntry&);
6164f93c
VZ
2218};
2219
2220// an entry used in dynamic event table managed by wxEvtHandler::Connect()
bddd7a8d 2221struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry : public wxEventTableEntryBase
6164f93c 2222{
d9e2e4c2 2223 wxDynamicEventTableEntry(int evType, int winid, int idLast,
65b17727 2224 wxObjectEventFunction fn, wxObject *data, wxEvtHandler* eventSink)
d9e2e4c2 2225 : wxEventTableEntryBase(winid, idLast, fn, data),
65b17727
JS
2226 m_eventType(evType),
2227 m_eventSink(eventSink)
e6a6feba 2228 { }
6164f93c
VZ
2229
2230 // not a reference here as we can't keep a reference to a temporary int
2231 // created to wrap the constant value typically passed to Connect() - nor
2232 // do we need it
2233 int m_eventType;
65b17727
JS
2234
2235 // Pointer to object whose function is fn - so we don't assume the
1c624631 2236 // EventFunction is always a member of the EventHandler receiving the
65b17727
JS
2237 // message
2238 wxEvtHandler* m_eventSink;
fc7a2a60
VZ
2239
2240 DECLARE_NO_COPY_CLASS(wxDynamicEventTableEntry)
c801d85f
KB
2241};
2242
2e4df4bf
VZ
2243#endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
2244
2245// ----------------------------------------------------------------------------
2246// wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2247// ----------------------------------------------------------------------------
886dd7d2 2248
bddd7a8d 2249struct WXDLLIMPEXP_BASE wxEventTable
c801d85f 2250{
0b5eceb6
VZ
2251 const wxEventTable *baseTable; // base event table (next in chain)
2252 const wxEventTableEntry *entries; // bottom of entry array
c801d85f
KB
2253};
2254
b5a98acd
VZ
2255// ----------------------------------------------------------------------------
2256// wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2257// ----------------------------------------------------------------------------
2258
d5d29b8a 2259WX_DEFINE_ARRAY_PTR(const wxEventTableEntry*, wxEventTableEntryPointerArray);
b5a98acd
VZ
2260
2261class WXDLLIMPEXP_BASE wxEventHashTable
2262{
2263private:
2264 // Internal data structs
2265 struct EventTypeTable
2266 {
2267 wxEventType eventType;
2268 wxEventTableEntryPointerArray eventEntryTable;
2269 };
2270 typedef EventTypeTable* EventTypeTablePointer;
2271
2272public:
2273 // Constructor, needs the event table it needs to hash later on.
1c624631
VZ
2274 // Note: hashing of the event table is not done in the constructor as it
2275 // can be that the event table is not yet full initialize, the hash
b5a98acd
VZ
2276 // will gets initialized when handling the first event look-up request.
2277 wxEventHashTable(const wxEventTable &table);
2278 // Destructor.
2279 ~wxEventHashTable();
2280
1c624631 2281 // Handle the given event, in other words search the event table hash
b5a98acd
VZ
2282 // and call self->ProcessEvent() if a match was found.
2283 bool HandleEvent(wxEvent &event, wxEvtHandler *self);
2284
afa039f9
JS
2285 // Clear table
2286 void Clear();
2287
a0826b11 2288#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
afa039f9
JS
2289 // Clear all tables
2290 static void ClearAll();
a0826b11 2291#endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
afa039f9 2292
b5a98acd
VZ
2293protected:
2294 // Init the hash table with the entries of the static event table.
2295 void InitHashTable();
2296 // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2297 void AddEntry(const wxEventTableEntry &entry);
2298 // Allocate and init with null pointers the base hash table.
2299 void AllocEventTypeTable(size_t size);
1c624631 2300 // Grow the hash table in size and transfer all items currently
b5a98acd
VZ
2301 // in the table to the correct location in the new table.
2302 void GrowEventTypeTable();
2303
2304protected:
2305 const wxEventTable &m_table;
2306 bool m_rebuildHash;
2307
2308 size_t m_size;
2309 EventTypeTablePointer *m_eventTypeTable;
fc7a2a60 2310
afa039f9
JS
2311 static wxEventHashTable* sm_first;
2312 wxEventHashTable* m_previous;
2313 wxEventHashTable* m_next;
2314
fc7a2a60 2315 DECLARE_NO_COPY_CLASS(wxEventHashTable)
b5a98acd
VZ
2316};
2317
6164f93c 2318// ----------------------------------------------------------------------------
77ffb593 2319// wxEvtHandler: the base class for all objects handling wxWidgets events
6164f93c
VZ
2320// ----------------------------------------------------------------------------
2321
bddd7a8d 2322class WXDLLIMPEXP_BASE wxEvtHandler : public wxObject
c801d85f 2323{
2b854a32
VZ
2324public:
2325 wxEvtHandler();
6164f93c 2326 virtual ~wxEvtHandler();
2b854a32
VZ
2327
2328 wxEvtHandler *GetNextHandler() const { return m_nextHandler; }
2329 wxEvtHandler *GetPreviousHandler() const { return m_previousHandler; }
2330 void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
2331 void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
2332
8e193f38 2333 void SetEvtHandlerEnabled(bool enabled) { m_enabled = enabled; }
2b854a32
VZ
2334 bool GetEvtHandlerEnabled() const { return m_enabled; }
2335
8e193f38
VZ
2336 // process an event right now
2337 virtual bool ProcessEvent(wxEvent& event);
2b854a32 2338
8e193f38 2339 // add an event to be processed later
76bfdc9a 2340 virtual void AddPendingEvent(const wxEvent& event);
2b854a32 2341
8e193f38 2342 void ProcessPendingEvents();
2b854a32 2343
7214297d 2344#if wxUSE_THREADS
76bfdc9a 2345 bool ProcessThreadEvent(const wxEvent& event);
7214297d 2346#endif
2b854a32
VZ
2347
2348 // Dynamic association of a member function handler with the event handler,
d9e2e4c2 2349 // winid and event type
7fa03f04
VZ
2350 void Connect(int winid,
2351 int lastId,
2352 int eventType,
2353 wxObjectEventFunction func,
2354 wxObject *userData = (wxObject *) NULL,
2355 wxEvtHandler *eventSink = (wxEvtHandler *) NULL);
2b854a32
VZ
2356
2357 // Convenience function: take just one id
7fa03f04
VZ
2358 void Connect(int winid,
2359 int eventType,
2360 wxObjectEventFunction func,
2361 wxObject *userData = (wxObject *) NULL,
2362 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
65b17727 2363 { Connect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2b854a32 2364
7fa03f04
VZ
2365 // Even more convenient: without id (same as using id of wxID_ANY)
2366 void Connect(int eventType,
2367 wxObjectEventFunction func,
2368 wxObject *userData = (wxObject *) NULL,
2369 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2370 { Connect(wxID_ANY, wxID_ANY, eventType, func, userData, eventSink); }
2371
2372 bool Disconnect(int winid,
2373 int lastId,
2374 wxEventType eventType,
2375 wxObjectEventFunction func = NULL,
2376 wxObject *userData = (wxObject *) NULL,
2377 wxEvtHandler *eventSink = (wxEvtHandler *) NULL);
2378
e554d626 2379 bool Disconnect(int winid = wxID_ANY,
7fa03f04
VZ
2380 wxEventType eventType = wxEVT_NULL,
2381 wxObjectEventFunction func = NULL,
2382 wxObject *userData = (wxObject *) NULL,
2383 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
65b17727 2384 { return Disconnect(winid, wxID_ANY, eventType, func, userData, eventSink); }
98243fed 2385
bdbe28fa 2386 bool Disconnect(wxEventType eventType,
e0685bb0 2387 wxObjectEventFunction func,
bdbe28fa
VZ
2388 wxObject *userData = (wxObject *) NULL,
2389 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2390 { return Disconnect(wxID_ANY, eventType, func, userData, eventSink); }
7fa03f04 2391
10da6a8f 2392 wxList* GetDynamicEventTable() const { return m_dynamicEvents ; }
b88c44e7
RD
2393
2394 // User data can be associated with each wxEvtHandler
2395 void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
2396 wxClientData *GetClientObject() const { return DoGetClientObject(); }
2397
2398 void SetClientData( void *data ) { DoSetClientData(data); }
2399 void *GetClientData() const { return DoGetClientData(); }
2400
1c624631
VZ
2401 // check if the given event table entry matches this event and call the
2402 // handler if it does
2403 //
2404 // return true if the event was processed, false otherwise (no match or the
2405 // handler decided to skip the event)
2406 static bool ProcessEventIfMatches(const wxEventTableEntryBase& tableEntry,
2407 wxEvtHandler *handler,
2408 wxEvent& event);
b88c44e7 2409
8e193f38
VZ
2410 // implementation from now on
2411 virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
2b854a32 2412 bool SearchDynamicEventTable( wxEvent& event );
c801d85f 2413
63863e09 2414#if wxUSE_THREADS
1c624631
VZ
2415 void ClearEventLocker();
2416#endif // wxUSE_THREADS
63863e09 2417
afa039f9
JS
2418 // Avoid problems at exit by cleaning up static hash table gracefully
2419 void ClearEventHashTable() { GetEventHashTable().Clear(); }
2420
c801d85f 2421private:
8e193f38 2422 static const wxEventTableEntry sm_eventTableEntries[];
2b854a32 2423
c801d85f 2424protected:
4caf847c
VZ
2425 // hooks for wxWindow used by ProcessEvent()
2426 // -----------------------------------------
2427
6eabf58c
VS
2428 // This one is called before trying our own event table to allow plugging
2429 // in the validators.
1c624631 2430 //
6eabf58c
VS
2431 // NB: This method is intentionally *not* inside wxUSE_VALIDATORS!
2432 // It is part of wxBase which doesn't use validators and the code
2433 // is compiled out when building wxBase w/o GUI classes, which affects
3103e8a9 2434 // binary compatibility and wxBase library can't be used by GUI
6eabf58c 2435 // ports.
4caf847c 2436 virtual bool TryValidator(wxEvent& WXUNUSED(event)) { return false; }
4caf847c
VZ
2437
2438 // this one is called after failing to find the event handle in our own
2439 // table to give a chance to the other windows to process it
2440 //
2441 // base class implementation passes the event to wxTheApp
2442 virtual bool TryParent(wxEvent& event);
2443
2444
1c624631 2445 static const wxEventTable sm_eventTable;
193bf013
VZ
2446 virtual const wxEventTable *GetEventTable() const;
2447
b5a98acd
VZ
2448 static wxEventHashTable sm_eventHashTable;
2449 virtual wxEventHashTable& GetEventHashTable() const;
2450
63863e09
JS
2451 wxEvtHandler* m_nextHandler;
2452 wxEvtHandler* m_previousHandler;
63863e09 2453 wxList* m_dynamicEvents;
42e69d6b 2454 wxList* m_pendingEvents;
6164f93c 2455
7214297d 2456#if wxUSE_THREADS
20947e08 2457#if defined (__VISAGECPP__)
cd30330f
VZ
2458 const wxCriticalSection& Lock() const { return m_eventsLocker; }
2459 wxCriticalSection& Lock() { return m_eventsLocker; }
2460
20947e08
DW
2461 wxCriticalSection m_eventsLocker;
2462# else
cd30330f
VZ
2463 const wxCriticalSection& Lock() const { return *m_eventsLocker; }
2464 wxCriticalSection& Lock() { return *m_eventsLocker; }
2465
63863e09 2466 wxCriticalSection* m_eventsLocker;
20947e08 2467# endif
7214297d 2468#endif
193bf013 2469
8e193f38
VZ
2470 // Is event handler enabled?
2471 bool m_enabled;
6164f93c 2472
b88c44e7
RD
2473
2474 // The user data: either an object which will be deleted by the container
2475 // when it's deleted or some raw pointer which we do nothing with - only
2476 // one type of data can be used with the given window (i.e. you cannot set
2477 // the void data and then associate the container with wxClientData or vice
2478 // versa)
2479 union
2480 {
2481 wxClientData *m_clientObject;
2482 void *m_clientData;
2483 };
2484
2485 // what kind of data do we have?
2486 wxClientDataType m_clientDataType;
2487
2488 // client data accessors
2489 virtual void DoSetClientObject( wxClientData *data );
2490 virtual wxClientData *DoGetClientObject() const;
2491
2492 virtual void DoSetClientData( void *data );
2493 virtual void *DoGetClientData() const;
2494
6164f93c 2495private:
fc7a2a60 2496 DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler)
c801d85f
KB
2497};
2498
e2478fde
VZ
2499// Post a message to the given eventhandler which will be processed during the
2500// next event loop iteration
76bfdc9a 2501inline void wxPostEvent(wxEvtHandler *dest, const wxEvent& event)
e2478fde
VZ
2502{
2503 wxCHECK_RET( dest, wxT("need an object to post event to in wxPostEvent") );
2504
2505 dest->AddPendingEvent(event);
2506}
2507
96d38c7e
VS
2508typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
2509
7fa03f04
VZ
2510#define wxEventHandler(func) \
2511 (wxObjectEventFunction)wxStaticCastEvent(wxEventFunction, &func)
2512
e90c1d2a 2513#if wxUSE_GUI
7fa03f04 2514
c4fa5aa7
VZ
2515// ----------------------------------------------------------------------------
2516// wxEventBlocker: helper class to temporarily disable event handling for a window
2517// ----------------------------------------------------------------------------
2518
b483f5fe 2519class WXDLLIMPEXP_CORE wxEventBlocker : public wxEvtHandler
c4fa5aa7
VZ
2520{
2521public:
2522 wxEventBlocker(wxWindow *win, wxEventType type = wxEVT_ANY);
2523 virtual ~wxEventBlocker();
2524
2525 void Block(wxEventType type)
2526 {
2527 m_eventsToBlock.push_back(type);
2528 }
2529
2530 virtual bool ProcessEvent(wxEvent& event);
2531
2532protected:
2533 wxArrayInt m_eventsToBlock;
2534 wxWindow *m_window;
2535
2536 DECLARE_NO_COPY_CLASS(wxEventBlocker)
2537};
2538
c801d85f
KB
2539typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&);
2540typedef void (wxEvtHandler::*wxScrollEventFunction)(wxScrollEvent&);
c5b42c87 2541typedef void (wxEvtHandler::*wxScrollWinEventFunction)(wxScrollWinEvent&);
c801d85f
KB
2542typedef void (wxEvtHandler::*wxSizeEventFunction)(wxSizeEvent&);
2543typedef void (wxEvtHandler::*wxMoveEventFunction)(wxMoveEvent&);
2544typedef void (wxEvtHandler::*wxPaintEventFunction)(wxPaintEvent&);
7309deea 2545typedef void (wxEvtHandler::*wxNcPaintEventFunction)(wxNcPaintEvent&);
c801d85f
KB
2546typedef void (wxEvtHandler::*wxEraseEventFunction)(wxEraseEvent&);
2547typedef void (wxEvtHandler::*wxMouseEventFunction)(wxMouseEvent&);
2548typedef void (wxEvtHandler::*wxCharEventFunction)(wxKeyEvent&);
2549typedef void (wxEvtHandler::*wxFocusEventFunction)(wxFocusEvent&);
456bc6d9 2550typedef void (wxEvtHandler::*wxChildFocusEventFunction)(wxChildFocusEvent&);
c801d85f
KB
2551typedef void (wxEvtHandler::*wxActivateEventFunction)(wxActivateEvent&);
2552typedef void (wxEvtHandler::*wxMenuEventFunction)(wxMenuEvent&);
2553typedef void (wxEvtHandler::*wxJoystickEventFunction)(wxJoystickEvent&);
2554typedef void (wxEvtHandler::*wxDropFilesEventFunction)(wxDropFilesEvent&);
2555typedef void (wxEvtHandler::*wxInitDialogEventFunction)(wxInitDialogEvent&);
7fa03f04
VZ
2556typedef void (wxEvtHandler::*wxSysColourChangedEventFunction)(wxSysColourChangedEvent&);
2557typedef void (wxEvtHandler::*wxDisplayChangedEventFunction)(wxDisplayChangedEvent&);
c801d85f
KB
2558typedef void (wxEvtHandler::*wxUpdateUIEventFunction)(wxUpdateUIEvent&);
2559typedef void (wxEvtHandler::*wxIdleEventFunction)(wxIdleEvent&);
2560typedef void (wxEvtHandler::*wxCloseEventFunction)(wxCloseEvent&);
2561typedef void (wxEvtHandler::*wxShowEventFunction)(wxShowEvent&);
9bc13858 2562typedef void (wxEvtHandler::*wxIconizeEventFunction)(wxIconizeEvent&);
98e78a5e 2563typedef void (wxEvtHandler::*wxMaximizeEventFunction)(wxMaximizeEvent&);
81d66cf3 2564typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&);
f7bd2698
JS
2565typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&);
2566typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&);
43b5058d
VZ
2567typedef void (wxEvtHandler::*wxWindowCreateEventFunction)(wxWindowCreateEvent&);
2568typedef void (wxEvtHandler::*wxWindowDestroyEventFunction)(wxWindowDestroyEvent&);
2569typedef void (wxEvtHandler::*wxSetCursorEventFunction)(wxSetCursorEvent&);
669f7a11 2570typedef void (wxEvtHandler::*wxNotifyEventFunction)(wxNotifyEvent&);
b96340e6 2571typedef void (wxEvtHandler::*wxHelpEventFunction)(wxHelpEvent&);
69231000 2572typedef void (wxEvtHandler::*wxContextMenuEventFunction)(wxContextMenuEvent&);
a5e84126 2573typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction)(wxMouseCaptureChangedEvent&);
63e819f2 2574typedef void (wxEvtHandler::*wxMouseCaptureLostEventFunction)(wxMouseCaptureLostEvent&);
78c91815 2575typedef void (wxEvtHandler::*wxClipboardTextEventFunction)(wxClipboardTextEvent&);
7fa03f04 2576
7fa03f04
VZ
2577
2578#define wxCommandEventHandler(func) \
8bc3ec1f 2579 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCommandEventFunction, &func)
7fa03f04 2580#define wxScrollEventHandler(func) \
8bc3ec1f 2581 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxScrollEventFunction, &func)
7fa03f04 2582#define wxScrollWinEventHandler(func) \
8bc3ec1f 2583 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxScrollWinEventFunction, &func)
7fa03f04 2584#define wxSizeEventHandler(func) \
8bc3ec1f 2585 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSizeEventFunction, &func)
7fa03f04 2586#define wxMoveEventHandler(func) \
8bc3ec1f 2587 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMoveEventFunction, &func)
7fa03f04 2588#define wxPaintEventHandler(func) \
8bc3ec1f 2589 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxPaintEventFunction, &func)
7fa03f04 2590#define wxNcPaintEventHandler(func) \
8bc3ec1f 2591 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNcPaintEventFunction, &func)
7fa03f04 2592#define wxEraseEventHandler(func) \
8bc3ec1f 2593 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxEraseEventFunction, &func)
7fa03f04 2594#define wxMouseEventHandler(func) \
8bc3ec1f 2595 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseEventFunction, &func)
7fa03f04 2596#define wxCharEventHandler(func) \
8bc3ec1f 2597 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCharEventFunction, &func)
7fa03f04
VZ
2598#define wxKeyEventHandler(func) wxCharEventHandler(func)
2599#define wxFocusEventHandler(func) \
8bc3ec1f 2600 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxFocusEventFunction, &func)
7fa03f04 2601#define wxChildFocusEventHandler(func) \
8bc3ec1f 2602 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxChildFocusEventFunction, &func)
7fa03f04 2603#define wxActivateEventHandler(func) \
8bc3ec1f 2604 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxActivateEventFunction, &func)
7fa03f04 2605#define wxMenuEventHandler(func) \
8bc3ec1f 2606 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMenuEventFunction, &func)
7fa03f04 2607#define wxJoystickEventHandler(func) \
8bc3ec1f 2608 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxJoystickEventFunction, &func)
7fa03f04 2609#define wxDropFilesEventHandler(func) \
8bc3ec1f 2610 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDropFilesEventFunction, &func)
7fa03f04 2611#define wxInitDialogEventHandler(func) \
8bc3ec1f 2612 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxInitDialogEventFunction, &func)
7fa03f04 2613#define wxSysColourChangedEventHandler(func) \
8bc3ec1f 2614 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSysColourChangedEventFunction, &func)
7fa03f04 2615#define wxDisplayChangedEventHandler(func) \
8bc3ec1f 2616 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDisplayChangedEventFunction, &func)
7fa03f04 2617#define wxUpdateUIEventHandler(func) \
8bc3ec1f 2618 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxUpdateUIEventFunction, &func)
7fa03f04 2619#define wxIdleEventHandler(func) \
8bc3ec1f 2620 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxIdleEventFunction, &func)
7fa03f04 2621#define wxCloseEventHandler(func) \
8bc3ec1f 2622 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCloseEventFunction, &func)
7fa03f04 2623#define wxShowEventHandler(func) \
8bc3ec1f 2624 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxShowEventFunction, &func)
7fa03f04 2625#define wxIconizeEventHandler(func) \
8bc3ec1f 2626 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxIconizeEventFunction, &func)
7fa03f04 2627#define wxMaximizeEventHandler(func) \
8bc3ec1f 2628 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMaximizeEventFunction, &func)
7fa03f04 2629#define wxNavigationKeyEventHandler(func) \
8bc3ec1f 2630 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNavigationKeyEventFunction, &func)
7fa03f04 2631#define wxPaletteChangedEventHandler(func) \
8bc3ec1f 2632 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxPaletteChangedEventFunction, &func)
7fa03f04 2633#define wxQueryNewPaletteEventHandler(func) \
8bc3ec1f 2634 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxQueryNewPaletteEventFunction, &func)
7fa03f04 2635#define wxWindowCreateEventHandler(func) \
8bc3ec1f 2636 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxWindowCreateEventFunction, &func)
7fa03f04 2637#define wxWindowDestroyEventHandler(func) \
8bc3ec1f 2638 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxWindowDestroyEventFunction, &func)
7fa03f04 2639#define wxSetCursorEventHandler(func) \
8bc3ec1f 2640 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSetCursorEventFunction, &func)
7fa03f04 2641#define wxNotifyEventHandler(func) \
8bc3ec1f 2642 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNotifyEventFunction, &func)
7fa03f04 2643#define wxHelpEventHandler(func) \
8bc3ec1f 2644 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxHelpEventFunction, &func)
7fa03f04 2645#define wxContextMenuEventHandler(func) \
8bc3ec1f 2646 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxContextMenuEventFunction, &func)
7fa03f04 2647#define wxMouseCaptureChangedEventHandler(func) \
8bc3ec1f 2648 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseCaptureChangedEventFunction, &func)
63e819f2
VS
2649#define wxMouseCaptureLostEventHandler(func) \
2650 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseCaptureLostEventFunction, &func)
78c91815
VZ
2651#define wxClipboardTextEventHandler(func) \
2652 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxClipboardTextEventFunction, &func)
7fa03f04 2653
e90c1d2a 2654#endif // wxUSE_GUI
c801d85f
KB
2655
2656// N.B. In GNU-WIN32, you *have* to take the address of a member function
2657// (use &) or the compiler crashes...
2658
2659#define DECLARE_EVENT_TABLE() \
2e4df4bf
VZ
2660 private: \
2661 static const wxEventTableEntry sm_eventTableEntries[]; \
2662 protected: \
2663 static const wxEventTable sm_eventTable; \
b5a98acd
VZ
2664 virtual const wxEventTable* GetEventTable() const; \
2665 static wxEventHashTable sm_eventHashTable; \
2666 virtual wxEventHashTable& GetEventHashTable() const;
c801d85f 2667
48276300
VZ
2668// N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
2669// sm_eventTable before using it in GetEventTable() or the compiler gives
2670// E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
b5a98acd 2671
c801d85f 2672#define BEGIN_EVENT_TABLE(theClass, baseClass) \
2e4df4bf
VZ
2673 const wxEventTable theClass::sm_eventTable = \
2674 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
48276300
VZ
2675 const wxEventTable *theClass::GetEventTable() const \
2676 { return &theClass::sm_eventTable; } \
b5a98acd
VZ
2677 wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
2678 wxEventHashTable &theClass::GetEventHashTable() const \
2679 { return theClass::sm_eventHashTable; } \
2e4df4bf 2680 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
c801d85f 2681
f96a9d34
JS
2682#define BEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
2683 template<typename T1> \
2684 const wxEventTable theClass<T1>::sm_eventTable = \
2685 { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
2686 template<typename T1> \
2687 const wxEventTable *theClass<T1>::GetEventTable() const \
2688 { return &theClass<T1>::sm_eventTable; } \
2689 template<typename T1> \
2690 wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
2691 template<typename T1> \
2692 wxEventHashTable &theClass<T1>::GetEventHashTable() const \
2693 { return theClass<T1>::sm_eventHashTable; } \
2694 template<typename T1> \
2695 const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
2696
2697#define BEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
2698 template<typename T1, typename T2> \
2699 const wxEventTable theClass<T1, T2>::sm_eventTable = \
2700 { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
2701 template<typename T1, typename T2> \
2702 const wxEventTable *theClass<T1, T2>::GetEventTable() const \
2703 { return &theClass<T1, T2>::sm_eventTable; } \
2704 template<typename T1, typename T2> \
2705 wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
2706 template<typename T1, typename T2> \
2707 wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
2708 { return theClass<T1, T2>::sm_eventHashTable; } \
2709 template<typename T1, typename T2> \
2710 const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
2711
2712#define BEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
2713 template<typename T1, typename T2, typename T3> \
2714 const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
2715 { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
2716 template<typename T1, typename T2, typename T3> \
2717 const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
2718 { return &theClass<T1, T2, T3>::sm_eventTable; } \
2719 template<typename T1, typename T2, typename T3> \
2720 wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
2721 template<typename T1, typename T2, typename T3> \
2722 wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
2723 { return theClass<T1, T2, T3>::sm_eventHashTable; } \
2724 template<typename T1, typename T2, typename T3> \
2725 const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
2726
2727#define BEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
2728 template<typename T1, typename T2, typename T3, typename T4> \
2729 const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
2730 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
2731 template<typename T1, typename T2, typename T3, typename T4> \
2732 const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
2733 { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
2734 template<typename T1, typename T2, typename T3, typename T4> \
2735 wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
2736 template<typename T1, typename T2, typename T3, typename T4> \
2737 wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
2738 { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
2739 template<typename T1, typename T2, typename T3, typename T4> \
2740 const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
2741
2742#define BEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
2743 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2744 const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
2745 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
2746 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2747 const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
2748 { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
2749 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2750 wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
2751 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2752 wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
2753 { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
2754 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2755 const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
2756
2757#define BEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
2758 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2759 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable = \
2760 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
2761 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2762 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
2763 { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
2764 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2765 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
2766 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2767 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
2768 { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
2769 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2770 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
2771
2772#define BEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
2773 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2774 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable = \
2775 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
2776 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2777 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
2778 { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
2779 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2780 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
2781 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2782 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
2783 { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
2784 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2785 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
2786
33e29419 2787#define END_EVENT_TABLE() DECLARE_EVENT_TABLE_ENTRY( wxEVT_NULL, 0, 0, 0, 0 ) };
2b854a32 2788
c801d85f
KB
2789/*
2790 * Event table macros
2791 */
2792
7fa03f04
VZ
2793// helpers for writing shorter code below: declare an event macro taking 2, 1
2794// or none ids (the missing ids default to wxID_ANY)
2795//
2796// macro arguments:
2797// - evt one of wxEVT_XXX constants
2798// - id1, id2 ids of the first/last id
2799// - fn the function (should be cast to the right type)
2800#define wx__DECLARE_EVT2(evt, id1, id2, fn) \
2801 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
2802#define wx__DECLARE_EVT1(evt, id, fn) \
2803 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
2804#define wx__DECLARE_EVT0(evt, fn) \
2805 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
2806
2807
c801d85f 2808// Generic events
7fa03f04
VZ
2809#define EVT_CUSTOM(event, winid, func) \
2810 wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
2811#define EVT_CUSTOM_RANGE(event, id1, id2, func) \
2812 wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
c801d85f 2813
265accbe 2814// EVT_COMMAND
96eb51bb 2815#define EVT_COMMAND(winid, event, func) \
7fa03f04 2816 wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
96eb51bb 2817#define EVT_COMMAND_RANGE(id1, id2, event, func) \
7fa03f04 2818 wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
265accbe 2819
7fa03f04
VZ
2820#define EVT_NOTIFY(event, winid, func) \
2821 wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
2822#define EVT_NOTIFY_RANGE(event, id1, id2, func) \
2823 wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
265accbe 2824
c801d85f 2825// Miscellaneous
7fa03f04
VZ
2826#define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
2827#define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
2828#define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
2829#define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
2830#define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
2831#define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
2832#define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
2833#define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
2834#define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
2835#define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
2836#define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
2837#define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
2838#define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
5048c832 2839#if wxUSE_HOTKEY
7fa03f04 2840#define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
5048c832 2841#endif
7fa03f04
VZ
2842#define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
2843#define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
2844#define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
2845#define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
2846#define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
2847#define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
2848#define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
2849#define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
2850#define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
2851#define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
afafd942 2852#define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
7fa03f04
VZ
2853#define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
2854#define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
2855#define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
2856#define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
2857#define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
2858#define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
2859#define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
2860#define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
2861#define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
2862#define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
2863#define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
2864#define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
2865#define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
2866#define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
2867#define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
2868#define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
63e819f2 2869#define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
c801d85f
KB
2870
2871// Mouse events
7fa03f04
VZ
2872#define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
2873#define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
2874#define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
2875#define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
2876#define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
2877#define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
2878#define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
2879#define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
2880#define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
2881#define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
2882#define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
2883#define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
2884#define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
c801d85f
KB
2885
2886// All mouse events
2887#define EVT_MOUSE_EVENTS(func) \
7fa03f04
VZ
2888 EVT_LEFT_DOWN(func) \
2889 EVT_LEFT_UP(func) \
2890 EVT_MIDDLE_DOWN(func) \
2891 EVT_MIDDLE_UP(func) \
2892 EVT_RIGHT_DOWN(func) \
2893 EVT_RIGHT_UP(func) \
2894 EVT_MOTION(func) \
2895 EVT_LEFT_DCLICK(func) \
2896 EVT_MIDDLE_DCLICK(func) \
2897 EVT_RIGHT_DCLICK(func) \
2898 EVT_LEAVE_WINDOW(func) \
2899 EVT_ENTER_WINDOW(func) \
2900 EVT_MOUSEWHEEL(func)
c801d85f 2901
c5b42c87 2902// Scrolling from wxWindow (sent to wxScrolledWindow)
7fa03f04
VZ
2903#define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
2904#define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
2905#define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
2906#define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
2907#define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
2908#define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
2909#define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
2910#define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
2911
c5b42c87 2912#define EVT_SCROLLWIN(func) \
7fa03f04
VZ
2913 EVT_SCROLLWIN_TOP(func) \
2914 EVT_SCROLLWIN_BOTTOM(func) \
2915 EVT_SCROLLWIN_LINEUP(func) \
2916 EVT_SCROLLWIN_LINEDOWN(func) \
2917 EVT_SCROLLWIN_PAGEUP(func) \
2918 EVT_SCROLLWIN_PAGEDOWN(func) \
2919 EVT_SCROLLWIN_THUMBTRACK(func) \
2920 EVT_SCROLLWIN_THUMBRELEASE(func)
c5b42c87
RR
2921
2922// Scrolling from wxSlider and wxScrollBar
7fa03f04
VZ
2923#define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
2924#define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
2925#define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
2926#define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
2927#define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
2928#define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
2929#define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
2930#define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
cbc85508 2931#define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
7fa03f04 2932
c801d85f 2933#define EVT_SCROLL(func) \
7fa03f04
VZ
2934 EVT_SCROLL_TOP(func) \
2935 EVT_SCROLL_BOTTOM(func) \
2936 EVT_SCROLL_LINEUP(func) \
2937 EVT_SCROLL_LINEDOWN(func) \
2938 EVT_SCROLL_PAGEUP(func) \
2939 EVT_SCROLL_PAGEDOWN(func) \
2940 EVT_SCROLL_THUMBTRACK(func) \
e8739575 2941 EVT_SCROLL_THUMBRELEASE(func) \
84006e65 2942 EVT_SCROLL_CHANGED(func)
c801d85f 2943
c5b42c87 2944// Scrolling from wxSlider and wxScrollBar, with an id
7fa03f04
VZ
2945#define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
2946#define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
2947#define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
2948#define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
2949#define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
2950#define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
2951#define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
2952#define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
cbc85508 2953#define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
7fa03f04 2954
d9e2e4c2 2955#define EVT_COMMAND_SCROLL(winid, func) \
7fa03f04
VZ
2956 EVT_COMMAND_SCROLL_TOP(winid, func) \
2957 EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
2958 EVT_COMMAND_SCROLL_LINEUP(winid, func) \
2959 EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
2960 EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
2961 EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
2962 EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
e8739575 2963 EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
84006e65 2964 EVT_COMMAND_SCROLL_CHANGED(winid, func)
cbc85508 2965
ca3e85cf
WS
2966#if WXWIN_COMPATIBILITY_2_6
2967 // compatibility macros for the old name, deprecated in 2.8
2968 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
2969 #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
2970 #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
2971#endif // WXWIN_COMPATIBILITY_2_6
c801d85f
KB
2972
2973// Convenience macros for commonly-used commands
7fa03f04
VZ
2974#define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
2975#define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
2976#define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
2977#define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
2978#define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
2979#define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
119727ad 2980#if defined(__SMARTPHONE__)
7fa03f04 2981# define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
119727ad 2982#else
7fa03f04 2983# define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
119727ad 2984#endif
7fa03f04
VZ
2985#define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
2986#define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
2987#define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
c801d85f 2988// EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
7fa03f04
VZ
2989#define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
2990#define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
2991#define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
2992#define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
a9a0ceca 2993#define EVT_TOOL_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, winid, wxCommandEventHandler(func))
7fa03f04
VZ
2994#define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
2995#define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
2996#define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
2997#define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
2998#define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
c801d85f
KB
2999
3000// Generic command events
7fa03f04
VZ
3001#define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3002#define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3003#define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3004#define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3005#define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3006#define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3007#define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
c801d85f
KB
3008
3009// Joystick events
1241ab8b 3010
7fa03f04
VZ
3011#define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
3012#define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
3013#define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
3014#define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
c801d85f
KB
3015
3016// All joystick events
3017#define EVT_JOYSTICK_EVENTS(func) \
7fa03f04
VZ
3018 EVT_JOY_BUTTON_DOWN(func) \
3019 EVT_JOY_BUTTON_UP(func) \
3020 EVT_JOY_MOVE(func) \
3021 EVT_JOY_ZMOVE(func)
c801d85f
KB
3022
3023// Idle event
7fa03f04 3024#define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
c801d85f
KB
3025
3026// Update UI event
7fa03f04
VZ
3027#define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
3028#define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
c801d85f 3029
b96340e6 3030// Help events
7fa03f04
VZ
3031#define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
3032#define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
3033#define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
3034#define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
fb6261e9 3035
69231000 3036// Context Menu Events
7fa03f04 3037#define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
5cd2a6ae 3038#define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
69231000 3039
78c91815
VZ
3040// Clipboard text Events
3041#define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
3042#define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
3043#define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
3044
8e193f38
VZ
3045// ----------------------------------------------------------------------------
3046// Global data
3047// ----------------------------------------------------------------------------
3048
3049// for pending event processing - notice that there is intentionally no
3050// WXDLLEXPORT here
bddd7a8d 3051extern WXDLLIMPEXP_BASE wxList *wxPendingEvents;
8e193f38 3052#if wxUSE_THREADS
bddd7a8d 3053 extern WXDLLIMPEXP_BASE wxCriticalSection *wxPendingEventsLocker;
8e193f38
VZ
3054#endif
3055
e90c1d2a
VZ
3056// ----------------------------------------------------------------------------
3057// Helper functions
3058// ----------------------------------------------------------------------------
3059
3060#if wxUSE_GUI
e702ff0f
JS
3061
3062// Find a window with the focus, that is also a descendant of the given window.
3063// This is used to determine the window to initially send commands to.
9f8b9d9c 3064WXDLLIMPEXP_CORE wxWindow* wxFindFocusDescendant(wxWindow* ancestor);
e702ff0f 3065
e90c1d2a
VZ
3066#endif // wxUSE_GUI
3067
1648d51b 3068#endif // _WX_EVENT_H__