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