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