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