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