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