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