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