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