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