]> git.saurik.com Git - wxWidgets.git/blame - include/wx/event.h
another GetInt/GetId bug fix
[wxWidgets.git] / include / wx / event.h
CommitLineData
c801d85f 1/////////////////////////////////////////////////////////////////////////////
bd83cb56 2// Name: wx/event.h
c801d85f
KB
3// Purpose: Event classes
4// Author: Julian Smart
5// Modified by:
6// Created: 01/02/97
7// RCS-ID: $Id$
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
KB
14
15#ifdef __GNUG__
2b854a32 16 #pragma interface "event.h"
c801d85f
KB
17#endif
18
19#include "wx/defs.h"
20#include "wx/object.h"
e90c1d2a
VZ
21
22#if wxUSE_GUI
23 #include "wx/gdicmn.h"
43b5058d 24 #include "wx/cursor.h"
e90c1d2a 25#endif
42e69d6b 26
72cdf4c9 27#include "wx/thread.h"
c801d85f 28
e90c1d2a
VZ
29// ----------------------------------------------------------------------------
30// forward declarations
31// ----------------------------------------------------------------------------
32
33class WXDLLEXPORT wxList;
34
35#if wxUSE_GUI
36 class WXDLLEXPORT wxClientData;
37 class WXDLLEXPORT wxDC;
38 class WXDLLEXPORT wxMenu;
73974df1 39 class WXDLLEXPORT wxWindow;
e90c1d2a
VZ
40#endif // wxUSE_GUI
41
42// ----------------------------------------------------------------------------
43// Event types
44// ----------------------------------------------------------------------------
64693098 45
23f681ec
VZ
46#if defined(__BORLANDC__) && defined(__WIN16__)
47 // For 16-bit BC++, these 2 would be identical otherwise (truncated)
48 #define wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED wxEVT_COMMAND_NB_PAGE_CHANGED
49 #define wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING wxEVT_COMMAND_NB_PAGE_CHANGING
50#endif
51
0757d27c
JS
52typedef int wxEventType;
53
23f681ec
VZ
54// the standard event types
55enum
56{
57 wxEVT_NULL = 0,
58 wxEVT_FIRST = 10000,
59
60 wxEVT_COMMAND_BUTTON_CLICKED = wxEVT_FIRST + 1,
61 wxEVT_COMMAND_CHECKBOX_CLICKED = wxEVT_FIRST + 2,
62 wxEVT_COMMAND_CHOICE_SELECTED = wxEVT_FIRST + 3,
63 wxEVT_COMMAND_LISTBOX_SELECTED = wxEVT_FIRST + 4,
64 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = wxEVT_FIRST + 5,
65 wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = wxEVT_FIRST + 6,
66 wxEVT_COMMAND_TEXT_UPDATED = wxEVT_FIRST + 7,
67 wxEVT_COMMAND_TEXT_ENTER = wxEVT_FIRST + 8,
68 wxEVT_COMMAND_MENU_SELECTED = wxEVT_FIRST + 9,
69 wxEVT_COMMAND_TOOL_CLICKED = wxEVT_COMMAND_MENU_SELECTED,
70 wxEVT_COMMAND_SLIDER_UPDATED = wxEVT_FIRST + 10,
71 wxEVT_COMMAND_RADIOBOX_SELECTED = wxEVT_FIRST + 11,
72 wxEVT_COMMAND_RADIOBUTTON_SELECTED = wxEVT_FIRST + 12,
73 //wxEVT_COMMAND_SCROLLBAR_UPDATED is now obsolete since we use wxEVT_SCROLL... events
74 wxEVT_COMMAND_SCROLLBAR_UPDATED = wxEVT_FIRST + 13,
75 wxEVT_COMMAND_VLBOX_SELECTED = wxEVT_FIRST + 14,
76 wxEVT_COMMAND_COMBOBOX_SELECTED = wxEVT_FIRST + 15,
77 wxEVT_COMMAND_TOOL_RCLICKED = wxEVT_FIRST + 16,
78 wxEVT_COMMAND_TOOL_ENTER = wxEVT_FIRST + 17,
79 wxEVT_COMMAND_SPINCTRL_UPDATED = wxEVT_FIRST + 18,
80
81 /* Sockets and timers send events, too */
82 wxEVT_SOCKET = wxEVT_FIRST + 50,
83 wxEVT_TIMER = wxEVT_FIRST + 80,
84
85 /* Mouse event types */
86 wxEVT_LEFT_DOWN = wxEVT_FIRST + 100,
87 wxEVT_LEFT_UP = wxEVT_FIRST + 101,
88 wxEVT_MIDDLE_DOWN = wxEVT_FIRST + 102,
89 wxEVT_MIDDLE_UP = wxEVT_FIRST + 103,
90 wxEVT_RIGHT_DOWN = wxEVT_FIRST + 104,
91 wxEVT_RIGHT_UP = wxEVT_FIRST + 105,
92 wxEVT_MOTION = wxEVT_FIRST + 106,
93 wxEVT_ENTER_WINDOW = wxEVT_FIRST + 107,
94 wxEVT_LEAVE_WINDOW = wxEVT_FIRST + 108,
95 wxEVT_LEFT_DCLICK = wxEVT_FIRST + 109,
96 wxEVT_MIDDLE_DCLICK = wxEVT_FIRST + 110,
97 wxEVT_RIGHT_DCLICK = wxEVT_FIRST + 111,
98 wxEVT_SET_FOCUS = wxEVT_FIRST + 112,
99 wxEVT_KILL_FOCUS = wxEVT_FIRST + 113,
100
101 /* Non-client mouse events */
102 wxEVT_NC_LEFT_DOWN = wxEVT_FIRST + 200,
103 wxEVT_NC_LEFT_UP = wxEVT_FIRST + 201,
104 wxEVT_NC_MIDDLE_DOWN = wxEVT_FIRST + 202,
105 wxEVT_NC_MIDDLE_UP = wxEVT_FIRST + 203,
106 wxEVT_NC_RIGHT_DOWN = wxEVT_FIRST + 204,
107 wxEVT_NC_RIGHT_UP = wxEVT_FIRST + 205,
108 wxEVT_NC_MOTION = wxEVT_FIRST + 206,
109 wxEVT_NC_ENTER_WINDOW = wxEVT_FIRST + 207,
110 wxEVT_NC_LEAVE_WINDOW = wxEVT_FIRST + 208,
111 wxEVT_NC_LEFT_DCLICK = wxEVT_FIRST + 209,
112 wxEVT_NC_MIDDLE_DCLICK = wxEVT_FIRST + 210,
113 wxEVT_NC_RIGHT_DCLICK = wxEVT_FIRST + 211,
114
115 /* Character input event type */
116 wxEVT_CHAR = wxEVT_FIRST + 212,
117 wxEVT_CHAR_HOOK = wxEVT_FIRST + 213,
118 wxEVT_NAVIGATION_KEY = wxEVT_FIRST + 214,
119 wxEVT_KEY_DOWN = wxEVT_FIRST + 215,
120 wxEVT_KEY_UP = wxEVT_FIRST + 216,
62448488 121
43b5058d
VZ
122 /* Set cursor event */
123 wxEVT_SET_CURSOR = wxEVT_FIRST + 230,
124
23f681ec
VZ
125 /*
126 * wxScrollbar and wxSlider event identifiers
127 */
128 wxEVT_SCROLL_TOP = wxEVT_FIRST + 300,
129 wxEVT_SCROLL_BOTTOM = wxEVT_FIRST + 301,
130 wxEVT_SCROLL_LINEUP = wxEVT_FIRST + 302,
131 wxEVT_SCROLL_LINEDOWN = wxEVT_FIRST + 303,
132 wxEVT_SCROLL_PAGEUP = wxEVT_FIRST + 304,
133 wxEVT_SCROLL_PAGEDOWN = wxEVT_FIRST + 305,
134 wxEVT_SCROLL_THUMBTRACK = wxEVT_FIRST + 306,
7ead72f2 135 wxEVT_SCROLL_THUMBRELEASE = wxEVT_FIRST + 307,
c801d85f 136
23f681ec
VZ
137 /*
138 * Scroll events from wxWindow
139 */
140 wxEVT_SCROLLWIN_TOP = wxEVT_FIRST + 320,
141 wxEVT_SCROLLWIN_BOTTOM = wxEVT_FIRST + 321,
142 wxEVT_SCROLLWIN_LINEUP = wxEVT_FIRST + 322,
143 wxEVT_SCROLLWIN_LINEDOWN = wxEVT_FIRST + 323,
144 wxEVT_SCROLLWIN_PAGEUP = wxEVT_FIRST + 324,
145 wxEVT_SCROLLWIN_PAGEDOWN = wxEVT_FIRST + 325,
146 wxEVT_SCROLLWIN_THUMBTRACK = wxEVT_FIRST + 326,
7ead72f2 147 wxEVT_SCROLLWIN_THUMBRELEASE = wxEVT_FIRST + 327,
23f681ec
VZ
148
149 /*
150 * System events
151 */
152 wxEVT_SIZE = wxEVT_FIRST + 400,
153 wxEVT_MOVE = wxEVT_FIRST + 401,
154 wxEVT_CLOSE_WINDOW = wxEVT_FIRST + 402,
155 wxEVT_END_SESSION = wxEVT_FIRST + 403,
156 wxEVT_QUERY_END_SESSION = wxEVT_FIRST + 404,
157 wxEVT_ACTIVATE_APP = wxEVT_FIRST + 405,
158 wxEVT_POWER = wxEVT_FIRST + 406,
159 wxEVT_ACTIVATE = wxEVT_FIRST + 409,
160 wxEVT_CREATE = wxEVT_FIRST + 410,
161 wxEVT_DESTROY = wxEVT_FIRST + 411,
162 wxEVT_SHOW = wxEVT_FIRST + 412,
163 wxEVT_ICONIZE = wxEVT_FIRST + 413,
164 wxEVT_MAXIMIZE = wxEVT_FIRST + 414,
165 wxEVT_MOUSE_CAPTURE_CHANGED = wxEVT_FIRST + 415,
166 wxEVT_PAINT = wxEVT_FIRST + 416,
167 wxEVT_ERASE_BACKGROUND = wxEVT_FIRST + 417,
168 wxEVT_NC_PAINT = wxEVT_FIRST + 418,
169 wxEVT_PAINT_ICON = wxEVT_FIRST + 419,
170 wxEVT_MENU_CHAR = wxEVT_FIRST + 420,
171 wxEVT_MENU_INIT = wxEVT_FIRST + 421,
172 wxEVT_MENU_HIGHLIGHT = wxEVT_FIRST + 422,
173 wxEVT_POPUP_MENU_INIT = wxEVT_FIRST + 423,
174 wxEVT_CONTEXT_MENU = wxEVT_FIRST + 424,
175 wxEVT_SYS_COLOUR_CHANGED = wxEVT_FIRST + 425,
176 wxEVT_SETTING_CHANGED = wxEVT_FIRST + 426,
177 wxEVT_QUERY_NEW_PALETTE = wxEVT_FIRST + 427,
178 wxEVT_PALETTE_CHANGED = wxEVT_FIRST + 428,
179 wxEVT_JOY_BUTTON_DOWN = wxEVT_FIRST + 429,
180 wxEVT_JOY_BUTTON_UP = wxEVT_FIRST + 430,
181 wxEVT_JOY_MOVE = wxEVT_FIRST + 431,
182 wxEVT_JOY_ZMOVE = wxEVT_FIRST + 432,
183 wxEVT_DROP_FILES = wxEVT_FIRST + 433,
184 wxEVT_DRAW_ITEM = wxEVT_FIRST + 434,
185 wxEVT_MEASURE_ITEM = wxEVT_FIRST + 435,
186 wxEVT_COMPARE_ITEM = wxEVT_FIRST + 436,
187 wxEVT_INIT_DIALOG = wxEVT_FIRST + 437,
188 wxEVT_IDLE = wxEVT_FIRST + 438,
189 wxEVT_UPDATE_UI = wxEVT_FIRST + 439,
190
191 /* System misc. */
192 wxEVT_END_PROCESS = wxEVT_FIRST + 440,
193
194 /* Dial up events */
195 wxEVT_DIALUP_CONNECTED = wxEVT_FIRST + 450,
196 wxEVT_DIALUP_DISCONNECTED = wxEVT_FIRST + 451,
197
198 /* Generic command events */
199 /* Note: a click is a higher-level event than button down/up */
200 wxEVT_COMMAND_LEFT_CLICK = wxEVT_FIRST + 500,
201 wxEVT_COMMAND_LEFT_DCLICK = wxEVT_FIRST + 501,
202 wxEVT_COMMAND_RIGHT_CLICK = wxEVT_FIRST + 502,
203 wxEVT_COMMAND_RIGHT_DCLICK = wxEVT_FIRST + 503,
204 wxEVT_COMMAND_SET_FOCUS = wxEVT_FIRST + 504,
205 wxEVT_COMMAND_KILL_FOCUS = wxEVT_FIRST + 505,
206 wxEVT_COMMAND_ENTER = wxEVT_FIRST + 506,
207
208 /* Tree control event types */
209 wxEVT_COMMAND_TREE_BEGIN_DRAG = wxEVT_FIRST + 600,
210 wxEVT_COMMAND_TREE_BEGIN_RDRAG = wxEVT_FIRST + 601,
211 wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT = wxEVT_FIRST + 602,
212 wxEVT_COMMAND_TREE_END_LABEL_EDIT = wxEVT_FIRST + 603,
213 wxEVT_COMMAND_TREE_DELETE_ITEM = wxEVT_FIRST + 604,
214 wxEVT_COMMAND_TREE_GET_INFO = wxEVT_FIRST + 605,
215 wxEVT_COMMAND_TREE_SET_INFO = wxEVT_FIRST + 606,
216 wxEVT_COMMAND_TREE_ITEM_EXPANDED = wxEVT_FIRST + 607,
217 wxEVT_COMMAND_TREE_ITEM_EXPANDING = wxEVT_FIRST + 608,
218 wxEVT_COMMAND_TREE_ITEM_COLLAPSED = wxEVT_FIRST + 609,
219 wxEVT_COMMAND_TREE_ITEM_COLLAPSING = wxEVT_FIRST + 610,
220 wxEVT_COMMAND_TREE_SEL_CHANGED = wxEVT_FIRST + 611,
221 wxEVT_COMMAND_TREE_SEL_CHANGING = wxEVT_FIRST + 612,
222 wxEVT_COMMAND_TREE_KEY_DOWN = wxEVT_FIRST + 613,
223 wxEVT_COMMAND_TREE_ITEM_ACTIVATED = wxEVT_FIRST + 614,
224 wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK = wxEVT_FIRST + 615,
225 wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK = wxEVT_FIRST + 616,
226 wxEVT_COMMAND_TREE_END_DRAG = wxEVT_FIRST + 617,
227
228 /* List control event types */
229 wxEVT_COMMAND_LIST_BEGIN_DRAG = wxEVT_FIRST + 700,
230 wxEVT_COMMAND_LIST_BEGIN_RDRAG = wxEVT_FIRST + 701,
231 wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT = wxEVT_FIRST + 702,
232 wxEVT_COMMAND_LIST_END_LABEL_EDIT = wxEVT_FIRST + 703,
233 wxEVT_COMMAND_LIST_DELETE_ITEM = wxEVT_FIRST + 704,
234 wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS = wxEVT_FIRST + 705,
235 wxEVT_COMMAND_LIST_GET_INFO = wxEVT_FIRST + 706,
236 wxEVT_COMMAND_LIST_SET_INFO = wxEVT_FIRST + 707,
237 wxEVT_COMMAND_LIST_ITEM_SELECTED = wxEVT_FIRST + 708,
238 wxEVT_COMMAND_LIST_ITEM_DESELECTED = wxEVT_FIRST + 709,
239 wxEVT_COMMAND_LIST_KEY_DOWN = wxEVT_FIRST + 710,
240 wxEVT_COMMAND_LIST_INSERT_ITEM = wxEVT_FIRST + 711,
241 wxEVT_COMMAND_LIST_COL_CLICK = wxEVT_FIRST + 712,
242 wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK = wxEVT_FIRST + 713,
243 wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK = wxEVT_FIRST + 714,
244 wxEVT_COMMAND_LIST_ITEM_ACTIVATED = wxEVT_FIRST + 715,
245
246 /* Tab and notebook control event types */
247 wxEVT_COMMAND_TAB_SEL_CHANGED = wxEVT_FIRST + 800,
248 wxEVT_COMMAND_TAB_SEL_CHANGING = wxEVT_FIRST + 801,
249 wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED = wxEVT_FIRST + 802,
250 wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING = wxEVT_FIRST + 803,
251
252 /* Splitter events */
253 wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED = wxEVT_FIRST + 850,
254 wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING = wxEVT_FIRST + 851,
255 wxEVT_COMMAND_SPLITTER_DOUBLECLICKED = wxEVT_FIRST + 852,
256 wxEVT_COMMAND_SPLITTER_UNSPLIT = wxEVT_FIRST + 853,
257
258 /* Wizard events */
259 wxEVT_WIZARD_PAGE_CHANGED = wxEVT_FIRST + 900,
260 wxEVT_WIZARD_PAGE_CHANGING = wxEVT_FIRST + 901,
261 wxEVT_WIZARD_CANCEL = wxEVT_FIRST + 902,
262
263 /* Calendar events */
264 wxEVT_CALENDAR_SEL_CHANGED = wxEVT_FIRST + 950,
265 wxEVT_CALENDAR_DAY_CHANGED = wxEVT_FIRST + 951,
266 wxEVT_CALENDAR_MONTH_CHANGED = wxEVT_FIRST + 952,
267 wxEVT_CALENDAR_YEAR_CHANGED = wxEVT_FIRST + 953,
268 wxEVT_CALENDAR_DOUBLECLICKED = wxEVT_FIRST + 954,
269 wxEVT_CALENDAR_WEEKDAY_CLICKED = wxEVT_FIRST + 955,
270
19141178
RR
271 /* Plot events */
272 wxEVT_PLOT_SEL_CHANGING = wxEVT_FIRST + 1000,
273 wxEVT_PLOT_SEL_CHANGED = wxEVT_FIRST + 1001,
274 wxEVT_PLOT_CLICKED = wxEVT_FIRST + 1002,
275 wxEVT_PLOT_DOUBLECLICKED = wxEVT_FIRST + 1003,
276 wxEVT_PLOT_ZOOM_IN = wxEVT_FIRST + 1004,
277 wxEVT_PLOT_ZOOM_OUT = wxEVT_FIRST + 1005,
278 wxEVT_PLOT_VALUE_SEL_CREATING = wxEVT_FIRST + 1010,
279 wxEVT_PLOT_VALUE_SEL_CREATED = wxEVT_FIRST + 1011,
280 wxEVT_PLOT_VALUE_SEL_CHANGING = wxEVT_FIRST + 1012,
281 wxEVT_PLOT_VALUE_SEL_CHANGED = wxEVT_FIRST + 1013,
282 wxEVT_PLOT_AREA_SEL_CREATING = wxEVT_FIRST + 1014,
283 wxEVT_PLOT_AREA_SEL_CREATED = wxEVT_FIRST + 1015,
284 wxEVT_PLOT_AREA_SEL_CHANGING = wxEVT_FIRST + 1016,
285 wxEVT_PLOT_AREA_SEL_CHANGED = wxEVT_FIRST + 1017,
98243fed 286 wxEVT_PLOT_BEGIN_X_LABEL_EDIT = wxEVT_FIRST + 1020,
19141178
RR
287 wxEVT_PLOT_END_X_LABEL_EDIT = wxEVT_FIRST + 1021,
288 wxEVT_PLOT_BEGIN_Y_LABEL_EDIT = wxEVT_FIRST + 1022,
289 wxEVT_PLOT_END_Y_LABEL_EDIT = wxEVT_FIRST + 1023,
290 wxEVT_PLOT_BEGIN_TITLE_EDIT = wxEVT_FIRST + 1024,
291 wxEVT_PLOT_END_TITLE_EDIT = wxEVT_FIRST + 1025,
292 wxEVT_PLOT_AREA_CREATE = wxEVT_FIRST + 1026,
293
b96340e6
JS
294 /* Help events */
295 wxEVT_HELP = wxEVT_FIRST + 1050,
fb6261e9 296 wxEVT_DETAILED_HELP,
b96340e6 297
23f681ec
VZ
298 wxEVT_USER_FIRST = wxEVT_FIRST + 2000
299};
66b6b045 300
db131261 301/* Compatibility */
c801d85f
KB
302
303#if WXWIN_COMPATIBILITY
304
305#define wxEVENT_TYPE_BUTTON_COMMAND wxEVT_COMMAND_BUTTON_CLICKED
306#define wxEVENT_TYPE_CHECKBOX_COMMAND wxEVT_COMMAND_CHECKBOX_CLICKED
307#define wxEVENT_TYPE_CHOICE_COMMAND wxEVT_COMMAND_CHOICE_SELECTED
308#define wxEVENT_TYPE_LISTBOX_COMMAND wxEVT_COMMAND_LISTBOX_SELECTED
309#define wxEVENT_TYPE_LISTBOX_DCLICK_COMMAND wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
310#define wxEVENT_TYPE_TEXT_COMMAND wxEVT_COMMAND_TEXT_UPDATED
311#define wxEVENT_TYPE_MULTITEXT_COMMAND wxEVT_COMMAND_TEXT_UPDATED
312#define wxEVENT_TYPE_MENU_COMMAND wxEVT_COMMAND_MENU_SELECTED
313#define wxEVENT_TYPE_SLIDER_COMMAND wxEVT_COMMAND_SLIDER_UPDATED
314#define wxEVENT_TYPE_RADIOBOX_COMMAND wxEVT_COMMAND_RADIOBOX_SELECTED
315#define wxEVENT_TYPE_RADIOBUTTON_COMMAND wxEVT_COMMAND_RADIOBUTTON_SELECTED
316#define wxEVENT_TYPE_TEXT_ENTER_COMMAND wxEVT_COMMAND_TEXT_ENTER
317#define wxEVENT_TYPE_SET_FOCUS wxEVT_SET_FOCUS
318#define wxEVENT_TYPE_KILL_FOCUS wxEVT_KILL_FOCUS
319#define wxEVENT_TYPE_SCROLLBAR_COMMAND wxEVT_COMMAND_SCROLLBAR_UPDATED
320#define wxEVENT_TYPE_VIRT_LISTBOX_COMMAND wxEVT_COMMAND_VLBOX_SELECTED
321#define wxEVENT_TYPE_COMBOBOX_COMMAND wxEVT_COMMAND_COMBOBOX_SELECTED
322
323#define wxEVENT_TYPE_LEFT_DOWN wxEVT_LEFT_DOWN
324#define wxEVENT_TYPE_LEFT_UP wxEVT_LEFT_UP
325#define wxEVENT_TYPE_MIDDLE_DOWN wxEVT_MIDDLE_DOWN
326#define wxEVENT_TYPE_MIDDLE_UP wxEVT_MIDDLE_UP
327#define wxEVENT_TYPE_RIGHT_DOWN wxEVT_RIGHT_DOWN
328#define wxEVENT_TYPE_RIGHT_UP wxEVT_RIGHT_UP
329#define wxEVENT_TYPE_MOTION wxEVT_MOTION
330#define wxEVENT_TYPE_ENTER_WINDOW wxEVT_ENTER_WINDOW
331#define wxEVENT_TYPE_LEAVE_WINDOW wxEVT_LEAVE_WINDOW
332#define wxEVENT_TYPE_LEFT_DCLICK wxEVT_LEFT_DCLICK
333#define wxEVENT_TYPE_MIDDLE_DCLICK wxEVT_MIDDLE_DCLICK
334#define wxEVENT_TYPE_RIGHT_DCLICK wxEVT_RIGHT_DCLICK
335#define wxEVENT_TYPE_CHAR wxEVT_CHAR
336#define wxEVENT_TYPE_SCROLL_TOP wxEVT_SCROLL_TOP
337#define wxEVENT_TYPE_SCROLL_BOTTOM wxEVT_SCROLL_BOTTOM
338#define wxEVENT_TYPE_SCROLL_LINEUP wxEVT_SCROLL_LINEUP
339#define wxEVENT_TYPE_SCROLL_LINEDOWN wxEVT_SCROLL_LINEDOWN
340#define wxEVENT_TYPE_SCROLL_PAGEUP wxEVT_SCROLL_PAGEUP
341#define wxEVENT_TYPE_SCROLL_PAGEDOWN wxEVT_SCROLL_PAGEDOWN
342#define wxEVENT_TYPE_SCROLL_THUMBTRACK wxEVT_SCROLL_THUMBTRACK
343
2b854a32 344#endif // WXWIN_COMPATIBILITY
c801d85f
KB
345
346/*
347 * wxWindows events, covering all interesting things that might happen
348 * (button clicking, resizing, setting text in widgets, etc.).
349 *
350 * For each completely new event type, derive a new event class.
351 * An event CLASS represents a C++ class defining a range of similar event TYPES;
352 * examples are canvas events, panel item command events.
353 * An event TYPE is a unique identifier for a particular system event,
354 * such as a button press or a listbox deselection.
355 *
356 */
357
2b854a32 358class WXDLLEXPORT wxEvent : public wxObject
c801d85f 359{
2b854a32 360 DECLARE_ABSTRACT_CLASS(wxEvent)
c801d85f
KB
361
362public:
2b854a32
VZ
363 wxEvent(int id = 0);
364 ~wxEvent() {}
365
366 void SetEventType(wxEventType typ) { m_eventType = typ; }
367 wxEventType GetEventType() const { return m_eventType; }
368 wxObject *GetEventObject() const { return m_eventObject; }
369 void SetEventObject(wxObject *obj) { m_eventObject = obj; }
370 long GetTimestamp() const { return m_timeStamp; }
371 void SetTimestamp(long ts = 0) { m_timeStamp = ts; }
372 int GetId() const { return m_id; }
373 void SetId(int Id) { m_id = Id; }
374
375 // Can instruct event processor that we wish to ignore this event
376 // (treat as if the event table entry had not been found): this must be done
377 // to allow the event processing by the base classes (calling event.Skip()
378 // is the analog of calling the base class verstion of a virtual function)
379 void Skip(bool skip = TRUE) { m_skipped = skip; }
380 bool GetSkipped() const { return m_skipped; };
c801d85f 381
193bf013
VZ
382 // implementation only: this test is explicitlty anti OO and this functions
383 // exists only for optimization purposes
384 bool IsCommandEvent() const { return m_isCommandEvent; }
385
aadbdf11 386 void CopyObject(wxObject& object_dest) const;
a737331d 387
c801d85f 388public:
2b854a32 389 wxObject* m_eventObject;
2b854a32
VZ
390 wxEventType m_eventType;
391 long m_timeStamp;
392 int m_id;
393 wxObject* m_callbackUserData;
42e69d6b 394 bool m_skipped;
193bf013
VZ
395
396 // optimization: instead of using costly IsKindOf() we keep a flag telling
397 // whether we're a command event (by far the most common case)
398 bool m_isCommandEvent;
c801d85f
KB
399};
400
e90c1d2a
VZ
401#if wxUSE_GUI
402
c801d85f
KB
403// Item or menu event class
404/*
405 wxEVT_COMMAND_BUTTON_CLICKED
406 wxEVT_COMMAND_CHECKBOX_CLICKED
407 wxEVT_COMMAND_CHOICE_SELECTED
408 wxEVT_COMMAND_LISTBOX_SELECTED
409 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
410 wxEVT_COMMAND_TEXT_UPDATED
411 wxEVT_COMMAND_TEXT_ENTER
412 wxEVT_COMMAND_MENU_SELECTED
413 wxEVT_COMMAND_SLIDER_UPDATED
414 wxEVT_COMMAND_RADIOBOX_SELECTED
415 wxEVT_COMMAND_RADIOBUTTON_SELECTED
416 wxEVT_COMMAND_SCROLLBAR_UPDATED
417 wxEVT_COMMAND_VLBOX_SELECTED
418 wxEVT_COMMAND_COMBOBOX_SELECTED
419*/
420
2b854a32 421class WXDLLEXPORT wxCommandEvent : public wxEvent
c801d85f 422{
2b854a32 423 DECLARE_DYNAMIC_CLASS(wxCommandEvent)
c801d85f 424
2b854a32
VZ
425public:
426 wxCommandEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
427 ~wxCommandEvent() {}
c801d85f 428
2b854a32
VZ
429 /*
430 * Accessors dependent on context
431 *
432 */
c801d85f 433
2b854a32
VZ
434 // Set/Get client data from controls
435 void SetClientData(void* clientData) { m_clientData = clientData; }
436 void *GetClientData() const { return m_clientData; }
c801d85f 437
2b854a32
VZ
438 // Set/Get client object from controls
439 void SetClientObject(wxClientData* clientObject) { m_clientObject = clientObject; }
440 void *GetClientObject() const { return m_clientObject; }
f5e27805 441
2b854a32
VZ
442 // Get listbox selection if single-choice
443 int GetSelection() const { return m_commandInt; }
c801d85f 444
2b854a32 445 // Set/Get listbox/choice selection string
29006414 446 void SetString(const wxString& s) { m_commandString = s; }
7214297d 447 wxString GetString() const { return m_commandString; }
c801d85f 448
2b854a32 449 // Get checkbox value
3ca6a5f0 450 bool IsChecked() const { return m_commandInt != 0; }
c801d85f 451
2b854a32
VZ
452 // TRUE if the listbox event was a selection.
453 bool IsSelection() const { return (m_extraLong != 0); }
c801d85f 454
2b854a32
VZ
455 void SetExtraLong(long extraLong) { m_extraLong = extraLong; }
456 long GetExtraLong() const { return m_extraLong ; }
c801d85f 457
2b854a32
VZ
458 void SetInt(int i) { m_commandInt = i; }
459 long GetInt() const { return m_commandInt ; }
c801d85f 460
aadbdf11
GL
461 void CopyObject(wxObject& obj) const;
462
3ca6a5f0
BP
463#ifdef WXWIN_COMPATIBILITY_2
464 bool Checked() const { return IsChecked(); }
465#endif // WXWIN_COMPATIBILITY_2
466
2b854a32 467public:
29006414 468 wxString m_commandString; // String event argument
2b854a32
VZ
469 int m_commandInt;
470 long m_extraLong; // Additional information (e.g. select/deselect)
471 void* m_clientData; // Arbitrary client data
472 wxClientData* m_clientObject; // Arbitrary client object
c801d85f
KB
473};
474
fd3f686c
VZ
475// this class adds a possibility to react (from the user) code to a control
476// notification: allow or veto the operation being reported.
2b854a32 477class WXDLLEXPORT wxNotifyEvent : public wxCommandEvent
fd3f686c
VZ
478{
479public:
480 wxNotifyEvent(wxEventType commandType = wxEVT_NULL, int id = 0)
481 : wxCommandEvent(commandType, id) { m_bAllow = TRUE; }
482
23f681ec 483 // veto the operation (usually it's allowed by default)
fd3f686c
VZ
484 void Veto() { m_bAllow = FALSE; }
485
23f681ec
VZ
486 // allow the operation if it was disabled by default
487 void Allow() { m_bAllow = TRUE; }
488
fd3f686c
VZ
489 // for implementation code only: is the operation allowed?
490 bool IsAllowed() const { return m_bAllow; }
491
924ef850
RR
492 // probably useless: CopyObject() is used for deferred event
493 // handling but wxNotifyEvent must be processed immediately
494 void CopyObject(wxObject& obj) const;
495
fd3f686c
VZ
496private:
497 bool m_bAllow;
498
92976ab6 499 DECLARE_DYNAMIC_CLASS(wxNotifyEvent)
fd3f686c
VZ
500};
501
d1367c3d
RR
502// Scroll event class, derived form wxCommandEvent. wxScrollEvents are
503// sent by wxSlider and wxScrollbar.
c801d85f
KB
504/*
505 wxEVT_SCROLL_TOP
506 wxEVT_SCROLL_BOTTOM
507 wxEVT_SCROLL_LINEUP
508 wxEVT_SCROLL_LINEDOWN
509 wxEVT_SCROLL_PAGEUP
510 wxEVT_SCROLL_PAGEDOWN
511 wxEVT_SCROLL_THUMBTRACK
7d56fb8f 512 wxEVT_SCROLL_THUMBRELEASE
c801d85f
KB
513*/
514
2b854a32 515class WXDLLEXPORT wxScrollEvent : public wxCommandEvent
c801d85f 516{
2b854a32 517 DECLARE_DYNAMIC_CLASS(wxScrollEvent)
c801d85f 518
2b854a32
VZ
519public:
520 wxScrollEvent(wxEventType commandType = wxEVT_NULL,
521 int id = 0, int pos = 0, int orient = 0);
522 ~wxScrollEvent() {}
523
524 /*
525 * Accessors
526 *
527 */
528
529 int GetOrientation() const { return (int) m_extraLong ; }
530 int GetPosition() const { return m_commandInt ; }
531 void SetOrientation(int orient) { m_extraLong = (long) orient; }
532 void SetPosition(int pos) { m_commandInt = pos; }
c801d85f
KB
533};
534
d1367c3d
RR
535// ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
536// are sent by wxWindow.
537/*
538 wxEVT_SCROLLWIN_TOP
539 wxEVT_SCROLLWIN_BOTTOM
540 wxEVT_SCROLLWIN_LINEUP
541 wxEVT_SCROLLWIN_LINEDOWN
542 wxEVT_SCROLLWIN_PAGEUP
543 wxEVT_SCROLLWIN_PAGEDOWN
544 wxEVT_SCROLLWIN_THUMBTRACK
7d56fb8f 545 wxEVT_SCROLLWIN_THUMBRELEASE
d1367c3d
RR
546*/
547
548class WXDLLEXPORT wxScrollWinEvent : public wxEvent
549{
550 DECLARE_DYNAMIC_CLASS(wxScrollWinEvent)
551
552public:
553 wxScrollWinEvent(wxEventType commandType = wxEVT_NULL,
554 int pos = 0, int orient = 0);
555 ~wxScrollWinEvent() {}
556
557 /*
558 * Accessors
559 */
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
3c679789 566 void CopyObject(wxObject& object_dest) const;
d1367c3d
RR
567public:
568 int m_commandInt; // Additional information
20947e08 569 long m_extraLong;
d1367c3d
RR
570};
571
c801d85f
KB
572// Mouse event class
573
574/*
575 wxEVT_LEFT_DOWN
576 wxEVT_LEFT_UP
577 wxEVT_MIDDLE_DOWN
578 wxEVT_MIDDLE_UP
579 wxEVT_RIGHT_DOWN
580 wxEVT_RIGHT_UP
581 wxEVT_MOTION
582 wxEVT_ENTER_WINDOW
583 wxEVT_LEAVE_WINDOW
584 wxEVT_LEFT_DCLICK
585 wxEVT_MIDDLE_DCLICK
586 wxEVT_RIGHT_DCLICK
587 wxEVT_NC_LEFT_DOWN
588 wxEVT_NC_LEFT_UP,
589 wxEVT_NC_MIDDLE_DOWN,
590 wxEVT_NC_MIDDLE_UP,
591 wxEVT_NC_RIGHT_DOWN,
592 wxEVT_NC_RIGHT_UP,
593 wxEVT_NC_MOTION,
594 wxEVT_NC_ENTER_WINDOW,
595 wxEVT_NC_LEAVE_WINDOW,
596 wxEVT_NC_LEFT_DCLICK,
597 wxEVT_NC_MIDDLE_DCLICK,
598 wxEVT_NC_RIGHT_DCLICK,
599*/
600
2b854a32 601class WXDLLEXPORT wxMouseEvent : public wxEvent
c801d85f 602{
2b854a32 603 DECLARE_DYNAMIC_CLASS(wxMouseEvent)
c801d85f 604
2b854a32
VZ
605public:
606 wxMouseEvent(wxEventType mouseType = wxEVT_NULL);
c801d85f 607
2b854a32
VZ
608 // Was it a button event? (*doesn't* mean: is any button *down*?)
609 bool IsButton() const { return Button(-1); }
c801d85f 610
2b854a32
VZ
611 // Was it a down event from button 1, 2 or 3 or any?
612 bool ButtonDown(int but = -1) const;
c801d85f 613
2b854a32
VZ
614 // Was it a dclick event from button 1, 2 or 3 or any?
615 bool ButtonDClick(int but = -1) const;
c801d85f 616
2b854a32
VZ
617 // Was it a up event from button 1, 2 or 3 or any?
618 bool ButtonUp(int but = -1) const;
c801d85f 619
2b854a32
VZ
620 // Was the given button 1,2,3 or any changing state?
621 bool Button(int but) const;
c801d85f 622
2b854a32
VZ
623 // Was the given button 1,2,3 or any in Down state?
624 bool ButtonIsDown(int but) const;
c801d85f 625
2b854a32
VZ
626 // Find state of shift/control keys
627 bool ControlDown() const { return m_controlDown; }
628 bool MetaDown() const { return m_metaDown; }
629 bool AltDown() const { return m_altDown; }
630 bool ShiftDown() const { return m_shiftDown; }
c801d85f 631
2b854a32
VZ
632 // Find which event was just generated
633 bool LeftDown() const { return (m_eventType == wxEVT_LEFT_DOWN); }
634 bool MiddleDown() const { return (m_eventType == wxEVT_MIDDLE_DOWN); }
635 bool RightDown() const { return (m_eventType == wxEVT_RIGHT_DOWN); }
c801d85f 636
2b854a32
VZ
637 bool LeftUp() const { return (m_eventType == wxEVT_LEFT_UP); }
638 bool MiddleUp() const { return (m_eventType == wxEVT_MIDDLE_UP); }
639 bool RightUp() const { return (m_eventType == wxEVT_RIGHT_UP); }
c801d85f 640
2b854a32
VZ
641 bool LeftDClick() const { return (m_eventType == wxEVT_LEFT_DCLICK); }
642 bool MiddleDClick() const { return (m_eventType == wxEVT_MIDDLE_DCLICK); }
643 bool RightDClick() const { return (m_eventType == wxEVT_RIGHT_DCLICK); }
c801d85f 644
2b854a32
VZ
645 // Find the current state of the mouse buttons (regardless
646 // of current event type)
647 bool LeftIsDown() const { return m_leftDown; }
648 bool MiddleIsDown() const { return m_middleDown; }
649 bool RightIsDown() const { return m_rightDown; }
c801d85f 650
2b854a32
VZ
651 // True if a button is down and the mouse is moving
652 bool Dragging() const
653 {
654 return ((m_eventType == wxEVT_MOTION) &&
655 (LeftIsDown() || MiddleIsDown() || RightIsDown()));
656 }
c801d85f 657
2b854a32
VZ
658 // True if the mouse is moving, and no button is down
659 bool Moving() const { return (m_eventType == wxEVT_MOTION); }
c801d85f 660
2b854a32
VZ
661 // True if the mouse is just entering the window
662 bool Entering() const { return (m_eventType == wxEVT_ENTER_WINDOW); }
c801d85f 663
2b854a32
VZ
664 // True if the mouse is just leaving the window
665 bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); }
c801d85f 666
2b854a32 667 // Find the position of the event
20947e08 668 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
b02da6b1
VZ
669 {
670 if (xpos)
20947e08 671 *xpos = m_x;
b02da6b1
VZ
672 if (ypos)
673 *ypos = m_y;
674 }
675
0e528b99 676#ifndef __WIN16__
bf57d1ad 677 void GetPosition(long *xpos, long *ypos) const
b02da6b1
VZ
678 {
679 if (xpos)
20947e08 680 *xpos = (long)m_x;
b02da6b1 681 if (ypos)
bf57d1ad 682 *ypos = (long)m_y;
b02da6b1 683 }
0e528b99 684#endif
c801d85f 685
2b854a32
VZ
686 // Find the position of the event
687 wxPoint GetPosition() const { return wxPoint(m_x, m_y); }
c801d85f 688
2b854a32
VZ
689 // Find the logical position of the event given the DC
690 wxPoint GetLogicalPosition(const wxDC& dc) const ;
c801d85f 691
2b854a32
VZ
692 // Compatibility
693#if WXWIN_COMPATIBILITY
20947e08 694 void Position(long *xpos, long *ypos) const
b02da6b1
VZ
695 {
696 if (xpos)
20947e08 697 *xpos = (long)m_x;
b02da6b1
VZ
698 if (ypos)
699 *ypos = (long)m_y;
700 }
701
2b854a32
VZ
702 void Position(float *xpos, float *ypos) const
703 {
704 *xpos = (float) m_x; *ypos = (float) m_y;
705 }
706#endif // WXWIN_COMPATIBILITY
c801d85f 707
2b854a32 708 // Get X position
6cedba09 709 wxCoord GetX() const { return m_x; }
c801d85f 710
2b854a32 711 // Get Y position
6cedba09 712 wxCoord GetY() const { return m_y; }
c801d85f 713
aadbdf11
GL
714 void CopyObject(wxObject& obj) const;
715
c801d85f 716public:
b02da6b1
VZ
717 wxCoord m_x, m_y;
718
2b854a32
VZ
719 bool m_leftDown;
720 bool m_middleDown;
721 bool m_rightDown;
722
723 bool m_controlDown;
724 bool m_shiftDown;
725 bool m_altDown;
726 bool m_metaDown;
c801d85f
KB
727};
728
43b5058d
VZ
729// Cursor set event
730
731/*
732 wxEVT_SET_CURSOR
733 */
734
735class WXDLLEXPORT wxSetCursorEvent : public wxEvent
736{
737public:
738 wxSetCursorEvent(wxCoord x, wxCoord y)
739 {
740 m_eventType = wxEVT_SET_CURSOR;
741
742 m_x = x;
743 m_y = y;
744 }
745
746 wxCoord GetX() const { return m_x; }
747 wxCoord GetY() const { return m_y; }
748
749 void SetCursor(const wxCursor& cursor) { m_cursor = cursor; }
750 const wxCursor& GetCursor() const { return m_cursor; }
751 bool HasCursor() const { return m_cursor.Ok(); }
752
753private:
754 wxCoord m_x, m_y;
755 wxCursor m_cursor;
756};
757
c801d85f
KB
758// Keyboard input event class
759
760/*
761 wxEVT_CHAR
762 wxEVT_CHAR_HOOK
4ce81a75 763 wxEVT_KEY_DOWN
c801d85f
KB
764 wxEVT_KEY_UP
765 */
766
2b854a32 767class WXDLLEXPORT wxKeyEvent : public wxEvent
c801d85f 768{
2b854a32 769 DECLARE_DYNAMIC_CLASS(wxKeyEvent)
c801d85f
KB
770
771public:
2b854a32 772 wxKeyEvent(wxEventType keyType = wxEVT_NULL);
c801d85f 773
2b854a32
VZ
774 // Find state of shift/control keys
775 bool ControlDown() const { return m_controlDown; }
776 bool MetaDown() const { return m_metaDown; }
777 bool AltDown() const { return m_altDown; }
778 bool ShiftDown() const { return m_shiftDown; }
f6bcfd97
BP
779
780 bool HasModifiers() const { return ControlDown() || AltDown() || MetaDown(); }
781
782 // get the key code: an ASCII7 char or an element of wxKeyCode enum
783 int GetKeyCode() const { return (int)m_keyCode; }
c801d85f 784
2b854a32 785 // Find the position of the event
b02da6b1
VZ
786 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
787 {
20947e08 788 if (xpos) *xpos = m_x;
b02da6b1
VZ
789 if (ypos) *ypos = m_y;
790 }
791
0e528b99 792#ifndef __WIN16__
bf57d1ad 793 void GetPosition(long *xpos, long *ypos) const
b02da6b1 794 {
20947e08 795 if (xpos) *xpos = (long)m_x;
bf57d1ad 796 if (ypos) *ypos = (long)m_y;
b02da6b1 797 }
0e528b99 798#endif
803ef874
JS
799
800 wxPoint GetPosition() const
801 { return wxPoint(m_x, m_y); }
c801d85f 802
2b854a32 803 // Get X position
b02da6b1 804 wxCoord GetX() const { return m_x; }
c801d85f 805
2b854a32 806 // Get Y position
b02da6b1 807 wxCoord GetY() const { return m_y; }
c801d85f 808
aadbdf11
GL
809 void CopyObject(wxObject& obj) const;
810
f6bcfd97
BP
811 // deprecated
812 long KeyCode() const { return m_keyCode; }
813
2b854a32 814public:
b02da6b1
VZ
815 wxCoord m_x, m_y;
816
2b854a32 817 long m_keyCode;
b02da6b1 818
2b854a32
VZ
819 bool m_controlDown;
820 bool m_shiftDown;
821 bool m_altDown;
822 bool m_metaDown;
b0e813a0 823 bool m_scanCode;
c801d85f
KB
824};
825
826// Size event class
827/*
828 wxEVT_SIZE
829 */
830
2b854a32 831class WXDLLEXPORT wxSizeEvent : public wxEvent
c801d85f 832{
2b854a32 833 DECLARE_DYNAMIC_CLASS(wxSizeEvent)
c801d85f 834
2b854a32
VZ
835public:
836 wxSize m_size;
c801d85f 837
2b854a32
VZ
838 wxSizeEvent() { m_eventType = wxEVT_SIZE; }
839 wxSizeEvent(const wxSize& sz, int id = 0)
840 : m_size(sz)
841 { m_eventType = wxEVT_SIZE; m_id = id; }
c801d85f 842
2b854a32 843 wxSize GetSize() const { return m_size; }
aadbdf11
GL
844
845 void CopyObject(wxObject& obj) const;
c801d85f
KB
846};
847
848// Move event class
849
850/*
851 wxEVT_MOVE
852 */
853
2b854a32 854class WXDLLEXPORT wxMoveEvent : public wxEvent
c801d85f 855{
2b854a32 856 DECLARE_DYNAMIC_CLASS(wxMoveEvent)
c801d85f 857
2b854a32
VZ
858public:
859 wxPoint m_pos;
c801d85f 860
2b854a32
VZ
861 wxMoveEvent() { m_eventType = wxEVT_MOVE; }
862 wxMoveEvent(const wxPoint& pos, int id = 0)
863 : m_pos(pos)
864 { m_eventType = wxEVT_MOVE; m_id = id; }
c801d85f 865
2b854a32 866 wxPoint GetPosition() const { return m_pos; }
aadbdf11
GL
867
868 void CopyObject(wxObject& obj) const;
c801d85f
KB
869};
870
871// Paint event class
872/*
873 wxEVT_PAINT
874 wxEVT_NC_PAINT
875 wxEVT_PAINT_ICON
876 */
877
edccf428
VZ
878#if defined(__WXDEBUG__) && defined(__WXMSW__)
879 // see comments in src/msw/dcclient.cpp where g_isPainting is defined
98243fed 880 extern WXDLLEXPORT int g_isPainting;
edccf428
VZ
881#endif // debug
882
2b854a32 883class WXDLLEXPORT wxPaintEvent : public wxEvent
c801d85f 884{
2b854a32 885 DECLARE_DYNAMIC_CLASS(wxPaintEvent)
c801d85f 886
2b854a32 887public:
edccf428
VZ
888 wxPaintEvent(int Id = 0)
889 {
890 m_eventType = wxEVT_PAINT;
891 m_id = Id;
892
893#if defined(__WXDEBUG__) && defined(__WXMSW__)
894 // set the internal flag for the duration of processing of WM_PAINT
895 g_isPainting++;
896#endif // debug
897 }
898
899#if defined(__WXDEBUG__) && defined(__WXMSW__)
900 ~wxPaintEvent()
901 {
902 g_isPainting--;
903 }
904#endif // debug
c801d85f
KB
905};
906
907// Erase background event class
908/*
909 wxEVT_ERASE_BACKGROUND
910 */
911
2b854a32 912class WXDLLEXPORT wxEraseEvent : public wxEvent
c801d85f 913{
2b854a32
VZ
914 DECLARE_DYNAMIC_CLASS(wxEraseEvent)
915
916public:
917 wxDC *m_dc;
918
919 wxEraseEvent(int Id = 0, wxDC *dc = (wxDC *) NULL)
920 { m_eventType = wxEVT_ERASE_BACKGROUND; m_id = Id; m_dc = dc; }
921 wxDC *GetDC() const { return m_dc; }
aadbdf11
GL
922
923 void CopyObject(wxObject& obj) const;
c801d85f
KB
924};
925
926// Focus event class
927/*
928 wxEVT_SET_FOCUS
929 wxEVT_KILL_FOCUS
930 */
931
2b854a32 932class WXDLLEXPORT wxFocusEvent : public wxEvent
c801d85f 933{
2b854a32 934 DECLARE_DYNAMIC_CLASS(wxFocusEvent)
c801d85f 935
2b854a32
VZ
936public:
937 wxFocusEvent(wxEventType type = wxEVT_NULL, int Id = 0)
938 { m_eventType = type; m_id = Id; }
c801d85f
KB
939};
940
941// Activate event class
942/*
943 wxEVT_ACTIVATE
944 wxEVT_ACTIVATE_APP
945 */
946
2b854a32 947class WXDLLEXPORT wxActivateEvent : public wxEvent
c801d85f 948{
2b854a32
VZ
949 DECLARE_DYNAMIC_CLASS(wxActivateEvent)
950
951public:
952 wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = TRUE, int Id = 0)
953 { m_eventType = type; m_active = active; m_id = Id; }
954 bool GetActive() const { return m_active; }
c801d85f 955
aadbdf11
GL
956 void CopyObject(wxObject& obj) const;
957
2b854a32
VZ
958private:
959 bool m_active;
c801d85f
KB
960};
961
962// InitDialog event class
963/*
964 wxEVT_INIT_DIALOG
965 */
966
2b854a32 967class WXDLLEXPORT wxInitDialogEvent : public wxEvent
c801d85f 968{
2b854a32 969 DECLARE_DYNAMIC_CLASS(wxInitDialogEvent)
c801d85f 970
2b854a32
VZ
971public:
972 wxInitDialogEvent(int Id = 0)
973 { m_eventType = wxEVT_INIT_DIALOG; m_id = Id; }
c801d85f
KB
974};
975
976// Miscellaneous menu event class
977/*
978 wxEVT_MENU_CHAR,
979 wxEVT_MENU_INIT,
980 wxEVT_MENU_HIGHLIGHT,
981 wxEVT_POPUP_MENU_INIT,
982 wxEVT_CONTEXT_MENU,
983*/
984
2b854a32 985class WXDLLEXPORT wxMenuEvent : public wxEvent
c801d85f 986{
2b854a32 987 DECLARE_DYNAMIC_CLASS(wxMenuEvent)
c801d85f
KB
988
989public:
aadbdf11
GL
990 wxMenuEvent(wxEventType type = wxEVT_NULL, int id = 0)
991 { m_eventType = type; m_menuId = id; }
c801d85f 992
aadbdf11 993 int GetMenuId() const { return m_menuId; }
c801d85f 994
aadbdf11 995 void CopyObject(wxObject& obj) const;
2b854a32 996private:
aadbdf11 997 int m_menuId;
c801d85f
KB
998};
999
1000// Window close or session close event class
1001/*
1002 wxEVT_CLOSE_WINDOW,
1003 wxEVT_END_SESSION,
1004 wxEVT_QUERY_END_SESSION
1005 */
1006
2b854a32 1007class WXDLLEXPORT wxCloseEvent : public wxEvent
c801d85f 1008{
2b854a32
VZ
1009 DECLARE_DYNAMIC_CLASS(wxCloseEvent)
1010
c801d85f 1011public:
2b854a32
VZ
1012 wxCloseEvent(wxEventType type = wxEVT_NULL, int id = 0)
1013 {
1014 m_eventType = type;
1015 m_loggingOff = TRUE;
1016 m_veto = FALSE; // should be FALSE by default
1017 m_id = id;
1018#if WXWIN_COMPATIBILITY
1019 m_force = FALSE;
1020#endif // WXWIN_COMPATIBILITY
1021 m_canVeto = TRUE;
1022 }
1023
1024 void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
1025 bool GetLoggingOff() const { return m_loggingOff; }
1026
fe4e9e6c
VZ
1027 void Veto(bool veto = TRUE)
1028 {
1029 // GetVeto() will return FALSE anyhow...
1030 wxCHECK_RET( m_canVeto,
223d09f6 1031 wxT("call to Veto() ignored (can't veto this event)") );
fe4e9e6c
VZ
1032
1033 m_veto = veto;
1034 }
2b854a32 1035 void SetCanVeto(bool canVeto) { m_canVeto = canVeto; }
e3065973 1036 // No more asserts here please, the one you put here was wrong.
2b854a32 1037 bool CanVeto() const { return m_canVeto; }
fe4e9e6c 1038 bool GetVeto() const { return m_canVeto && m_veto; }
c801d85f 1039
2b854a32
VZ
1040#if WXWIN_COMPATIBILITY
1041 // This is probably obsolete now, since we use CanVeto instead, in
1042 // both OnCloseWindow and OnQueryEndSession.
1043 // m_force == ! m_canVeto i.e., can't veto means we must force it to close.
1044 void SetForce(bool force) { m_force = force; }
1045 bool GetForce() const { return m_force; }
1046#endif
1047
aadbdf11
GL
1048 void CopyObject(wxObject& obj) const;
1049
2b854a32
VZ
1050protected:
1051 bool m_loggingOff;
1052 bool m_veto, m_canVeto;
1053
1054#if WXWIN_COMPATIBILITY
1055 bool m_force;
1056#endif
c801d85f
KB
1057};
1058
1059/*
1060 wxEVT_SHOW
1061 */
1062
2b854a32 1063class WXDLLEXPORT wxShowEvent : public wxEvent
c801d85f 1064{
2b854a32
VZ
1065 DECLARE_DYNAMIC_CLASS(wxShowEvent)
1066
c801d85f
KB
1067public:
1068
2b854a32
VZ
1069 wxShowEvent(int id = 0, bool show = FALSE)
1070 { m_eventType = wxEVT_SHOW; m_id = id; m_show = show; }
c801d85f 1071
2b854a32
VZ
1072 void SetShow(bool show) { m_show = show; }
1073 bool GetShow() const { return m_show; }
c801d85f 1074
aadbdf11
GL
1075 void CopyObject(wxObject& obj) const;
1076
c801d85f 1077protected:
2b854a32 1078 bool m_show;
c801d85f
KB
1079};
1080
1081/*
1082 wxEVT_ICONIZE
1083 */
1084
2b854a32 1085class WXDLLEXPORT wxIconizeEvent : public wxEvent
c801d85f 1086{
2b854a32 1087 DECLARE_DYNAMIC_CLASS(wxIconizeEvent)
c801d85f 1088
2b854a32
VZ
1089public:
1090 wxIconizeEvent(int id = 0)
1091 { m_eventType = wxEVT_ICONIZE; m_id = id; }
c801d85f
KB
1092};
1093
1094/*
1095 wxEVT_MAXIMIZE
1096 */
1097
2b854a32 1098class WXDLLEXPORT wxMaximizeEvent : public wxEvent
c801d85f 1099{
2b854a32 1100 DECLARE_DYNAMIC_CLASS(wxMaximizeEvent)
c801d85f 1101
2b854a32
VZ
1102public:
1103 wxMaximizeEvent(int id = 0)
1104 { m_eventType = wxEVT_MAXIMIZE; m_id = id; }
c801d85f
KB
1105};
1106
1107// Joystick event class
1108/*
1109 wxEVT_JOY_BUTTON_DOWN,
1110 wxEVT_JOY_BUTTON_UP,
1111 wxEVT_JOY_MOVE,
1112 wxEVT_JOY_ZMOVE
1113*/
1114
1115// Which joystick? Same as Windows ids so no conversion necessary.
1116#define wxJOYSTICK1 0
1117#define wxJOYSTICK2 1
1118
1119// Which button is down?
1120#define wxJOY_BUTTON1 1
1121#define wxJOY_BUTTON2 2
1122#define wxJOY_BUTTON3 4
1123#define wxJOY_BUTTON4 8
1124#define wxJOY_BUTTON_ANY -1
1125
2b854a32 1126class WXDLLEXPORT wxJoystickEvent : public wxEvent
c801d85f 1127{
2b854a32
VZ
1128 DECLARE_DYNAMIC_CLASS(wxJoystickEvent)
1129
1130public:
1131 wxPoint m_pos;
1132 int m_zPosition;
1133 int m_buttonChange; // Which button changed?
1134 int m_buttonState; // Which buttons are down?
1135 int m_joyStick; // Which joystick?
1136
1137 wxJoystickEvent(wxEventType type = wxEVT_NULL,
1138 int state = 0,
1139 int joystick = wxJOYSTICK1,
1140 int change = 0)
1141 {
1142 m_eventType = type;
1143 m_buttonState = state;
1144 m_pos = wxPoint(0,0);
1145 m_zPosition = 0;
1146 m_joyStick = joystick;
1147 m_buttonChange = change;
1148 }
1149
1150 wxPoint GetPosition() const { return m_pos; }
1151 int GetZPosition() const { return m_zPosition; }
1152 int GetButtonState() const { return m_buttonState; }
1153 int GetButtonChange() const { return m_buttonChange; }
1154 int GetJoystick() const { return m_joyStick; }
1155
1156 void SetJoystick(int stick) { m_joyStick = stick; }
1157 void SetButtonState(int state) { m_buttonState = state; }
1158 void SetButtonChange(int change) { m_buttonChange = change; }
1159 void SetPosition(const wxPoint& pos) { m_pos = pos; }
1160 void SetZPosition(int zPos) { m_zPosition = zPos; }
1161
1162 // Was it a button event? (*doesn't* mean: is any button *down*?)
1163 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) ||
b70ababc 1164 (GetEventType() == wxEVT_JOY_BUTTON_UP)); }
2b854a32
VZ
1165
1166 // Was it a move event?
1167 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE) ; }
1168
1169 // Was it a zmove event?
1170 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE) ; }
1171
1172 // Was it a down event from button 1, 2, 3, 4 or any?
1173 bool ButtonDown(int but = wxJOY_BUTTON_ANY) const
c801d85f 1174 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) &&
2b854a32 1175 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
c801d85f 1176
2b854a32
VZ
1177 // Was it a up event from button 1, 2, 3 or any?
1178 bool ButtonUp(int but = wxJOY_BUTTON_ANY) const
c801d85f 1179 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP) &&
2b854a32 1180 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
c801d85f 1181
2b854a32
VZ
1182 // Was the given button 1,2,3,4 or any in Down state?
1183 bool ButtonIsDown(int but = wxJOY_BUTTON_ANY) const
c801d85f 1184 { return (((but == wxJOY_BUTTON_ANY) && (m_buttonState != 0)) ||
2b854a32 1185 ((m_buttonState & but) == but)); }
f305c661
GL
1186
1187 void CopyObject(wxObject& obj) const;
c801d85f
KB
1188};
1189
1190// Drop files event class
1191/*
1192 wxEVT_DROP_FILES
1193 */
1194
2b854a32 1195class WXDLLEXPORT wxDropFilesEvent : public wxEvent
c801d85f 1196{
2b854a32 1197 DECLARE_DYNAMIC_CLASS(wxDropFilesEvent)
c801d85f 1198
2b854a32
VZ
1199public:
1200 int m_noFiles;
1201 wxPoint m_pos;
1202 wxString* m_files; // Memory (de)allocated by code calling ProcessEvent
1203
1204 wxDropFilesEvent(wxEventType type = wxEVT_NULL,
1205 int noFiles = 0,
1206 wxString *files = (wxString *) NULL)
1207 { m_eventType = type; m_noFiles = noFiles; m_files = files; }
1208
1209 wxPoint GetPosition() const { return m_pos; }
1210 int GetNumberOfFiles() const { return m_noFiles; }
1211 wxString *GetFiles() const { return m_files; }
f305c661
GL
1212
1213 void CopyObject(wxObject& obj) const;
c801d85f
KB
1214};
1215
c801d85f
KB
1216// Update UI event
1217/*
1218 wxEVT_UPDATE_UI
1219 */
1220
2b854a32 1221class WXDLLEXPORT wxUpdateUIEvent : public wxCommandEvent
c801d85f 1222{
2b854a32 1223 DECLARE_DYNAMIC_CLASS(wxUpdateUIEvent)
c801d85f 1224
2b854a32
VZ
1225public:
1226 wxUpdateUIEvent(wxWindowID commandId = 0)
1227 {
1228 m_eventType = wxEVT_UPDATE_UI;
1229 m_id = commandId;
1230 m_checked = FALSE;
1231 m_setChecked = FALSE;
1232 m_enabled = FALSE;
1233 m_setEnabled = FALSE;
1234 m_setText = FALSE;
1235 m_text = "";
1236 }
1237
1238 bool GetChecked() const { return m_checked; }
1239 bool GetEnabled() const { return m_enabled; }
1240 wxString GetText() const { return m_text; }
1241 bool GetSetText() const { return m_setText; }
1242 bool GetSetChecked() const { return m_setChecked; }
1243 bool GetSetEnabled() const { return m_setEnabled; }
1244
1245 void Check(bool check) { m_checked = check; m_setChecked = TRUE; }
1246 void Enable(bool enable) { m_enabled = enable; m_setEnabled = TRUE; }
1247 void SetText(const wxString& text) { m_text = text; m_setText = TRUE; }
c801d85f 1248
f305c661
GL
1249 void CopyObject(wxObject& obj) const;
1250
2b854a32
VZ
1251protected:
1252 bool m_checked;
1253 bool m_enabled;
1254 bool m_setEnabled;
1255 bool m_setText;
1256 bool m_setChecked;
1257 wxString m_text;
c801d85f
KB
1258};
1259
1260/*
1261 wxEVT_SYS_COLOUR_CHANGED
1262 */
1263
1264// TODO: shouldn't all events record the window ID?
2b854a32 1265class WXDLLEXPORT wxSysColourChangedEvent : public wxEvent
c801d85f 1266{
2b854a32 1267 DECLARE_DYNAMIC_CLASS(wxSysColourChangedEvent)
c801d85f 1268
2b854a32
VZ
1269public:
1270 wxSysColourChangedEvent()
1271 { m_eventType = wxEVT_SYS_COLOUR_CHANGED; }
c801d85f
KB
1272};
1273
f7bd2698
JS
1274/*
1275 wxEVT_PALETTE_CHANGED
1276 */
1277
2b854a32 1278class WXDLLEXPORT wxPaletteChangedEvent : public wxEvent
f7bd2698 1279{
2b854a32 1280 DECLARE_DYNAMIC_CLASS(wxPaletteChangedEvent)
f7bd2698
JS
1281
1282public:
2b854a32
VZ
1283 wxPaletteChangedEvent(wxWindowID id = 0) : wxEvent(id)
1284 {
1285 m_eventType = wxEVT_PALETTE_CHANGED;
1286 m_changedWindow = (wxWindow *) NULL;
1287 }
f7bd2698 1288
2b854a32
VZ
1289 void SetChangedWindow(wxWindow* win) { m_changedWindow = win; }
1290 wxWindow* GetChangedWindow() const { return m_changedWindow; }
f7bd2698 1291
f305c661
GL
1292 void CopyObject(wxObject& obj) const;
1293
f7bd2698 1294protected:
2b854a32 1295 wxWindow* m_changedWindow;
f7bd2698
JS
1296};
1297
1298/*
1299 wxEVT_QUERY_NEW_PALETTE
1300 Indicates the window is getting keyboard focus and should re-do its palette.
1301 */
1302
2b854a32 1303class WXDLLEXPORT wxQueryNewPaletteEvent : public wxEvent
f7bd2698 1304{
2b854a32 1305 DECLARE_DYNAMIC_CLASS(wxQueryNewPaletteEvent)
f7bd2698
JS
1306
1307public:
2b854a32
VZ
1308 wxQueryNewPaletteEvent(wxWindowID id = 0): wxEvent(id)
1309 { m_eventType = wxEVT_QUERY_NEW_PALETTE; m_paletteRealized = FALSE; }
f7bd2698 1310
2b854a32
VZ
1311 // App sets this if it changes the palette.
1312 void SetPaletteRealized(bool realized) { m_paletteRealized = realized; }
1313 bool GetPaletteRealized() const { return m_paletteRealized; }
f7bd2698 1314
f305c661
GL
1315 void CopyObject(wxObject& obj) const;
1316
f7bd2698 1317protected:
2b854a32 1318 bool m_paletteRealized;
f7bd2698
JS
1319};
1320
7fdefd57
VZ
1321/*
1322 Event generated by dialog navigation keys
1323 wxEVT_NAVIGATION_KEY
1324 */
d9506e77
VZ
1325// NB: don't derive from command event to avoid being propagated to the parent
1326class WXDLLEXPORT wxNavigationKeyEvent : public wxEvent
7fdefd57 1327{
7fdefd57 1328public:
d9506e77
VZ
1329 wxNavigationKeyEvent()
1330 {
1331 SetEventType(wxEVT_NAVIGATION_KEY);
1332
1333 m_flags = IsForward | Propagate; // defaults are for TAB
1334 m_focus = (wxWindow *)NULL;
1335 }
7fdefd57 1336
2b854a32 1337 // direction: forward (true) or backward (false)
d9506e77
VZ
1338 bool GetDirection() const
1339 { return (m_flags & IsForward) != 0; }
1340 void SetDirection(bool bForward)
1341 { if ( bForward ) m_flags |= IsForward; else m_flags &= ~IsForward; }
7fdefd57 1342
2b854a32
VZ
1343 // it may be a window change event (MDI, notebook pages...) or a control
1344 // change event
d9506e77
VZ
1345 bool IsWindowChange() const
1346 { return (m_flags & WinChange) != 0; }
1347 void SetWindowChange(bool bIs)
1348 { if ( bIs ) m_flags |= WinChange; else m_flags &= ~WinChange; }
1349
1350 // some navigation events are meant to be propagated upwards (Windows
1351 // convention is to do this for TAB events) while others should always
1352 // cycle inside the panel/radiobox/whatever we're current inside
1353 bool ShouldPropagate() const
1354 { return (m_flags & Propagate) != 0; }
1355 void SetPropagate(bool bDoIt)
1356 { if ( bDoIt ) m_flags |= Propagate; else m_flags &= ~Propagate; }
7fdefd57 1357
2b854a32
VZ
1358 // the child which has the focus currently (may be NULL - use
1359 // wxWindow::FindFocus then)
d9506e77
VZ
1360 wxWindow* GetCurrentFocus() const { return m_focus; }
1361 void SetCurrentFocus(wxWindow *win) { m_focus = win; }
1362
1363private:
1364 enum
1365 {
1366 IsForward = 0x0001,
1367 WinChange = 0x0002,
1368 Propagate = 0x0004
1369 };
1370
1371 long m_flags;
1372 wxWindow *m_focus;
1373
1374 DECLARE_DYNAMIC_CLASS(wxNavigationKeyEvent)
7fdefd57
VZ
1375};
1376
42e69d6b
VZ
1377// Window creation/destruction events: the first is sent as soon as window is
1378// created (i.e. the underlying GUI object exists), but when the C++ object is
1379// fully initialized (so virtual functions may be called). The second,
1380// wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
1381// still safe to call virtual functions at this moment
1382/*
1383 wxEVT_CREATE
1384 wxEVT_DESTROY
1385 */
1386
f6bcfd97 1387class WXDLLEXPORT wxWindowCreateEvent : public wxCommandEvent
42e69d6b
VZ
1388{
1389 DECLARE_DYNAMIC_CLASS(wxWindowCreateEvent)
1390
1391public:
1392 wxWindowCreateEvent(wxWindow *win = NULL);
1393
1394 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1395};
1396
f6bcfd97 1397class WXDLLEXPORT wxWindowDestroyEvent : public wxCommandEvent
42e69d6b
VZ
1398{
1399 DECLARE_DYNAMIC_CLASS(wxWindowDestroyEvent)
1400
1401public:
1402 wxWindowDestroyEvent(wxWindow *win = NULL);
1403
1404 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1405};
1406
bd83cb56 1407// A help event is sent when the user clicks on a window in context-help mode.
b96340e6 1408/*
bd83cb56
VZ
1409 wxEVT_HELP
1410 wxEVT_DETAILED_HELP
1411*/
b96340e6
JS
1412
1413class WXDLLEXPORT wxHelpEvent : public wxCommandEvent
1414{
b96340e6 1415public:
bd83cb56
VZ
1416 wxHelpEvent(wxEventType type = wxEVT_NULL,
1417 wxWindowID id = 0,
1418 const wxPoint& pt = wxDefaultPosition)
1419 {
1420 m_eventType = type;
1421 m_id = id;
1422 m_pos = pt;
1423 }
b96340e6 1424
bd83cb56
VZ
1425 // Position of event (in screen coordinates)
1426 const wxPoint& GetPosition() const { return m_pos; }
1427 void SetPosition(const wxPoint& pos) { m_pos = pos; }
b96340e6 1428
bd83cb56
VZ
1429 // Optional link to further help
1430 const wxString& GetLink() const { return m_link; }
1431 void SetLink(const wxString& link) { m_link = link; }
fb6261e9 1432
bd83cb56
VZ
1433 // Optional target to display help in. E.g. a window specification
1434 const wxString& GetTarget() const { return m_target; }
1435 void SetTarget(const wxString& target) { m_target = target; }
fb6261e9 1436
bd83cb56
VZ
1437protected:
1438 wxPoint m_pos;
1439 wxString m_target;
1440 wxString m_link;
1441
1442private:
1443 DECLARE_DYNAMIC_CLASS(wxHelpEvent)
b96340e6
JS
1444};
1445
e90c1d2a
VZ
1446#endif // wxUSE_GUI
1447
1448// Idle event
1449/*
1450 wxEVT_IDLE
1451 */
1452
1453class WXDLLEXPORT wxIdleEvent : public wxEvent
1454{
1455 DECLARE_DYNAMIC_CLASS(wxIdleEvent)
1456
1457public:
1458 wxIdleEvent()
1459 { m_eventType = wxEVT_IDLE; m_requestMore = FALSE; }
1460
1461 void RequestMore(bool needMore = TRUE) { m_requestMore = needMore; }
1462 bool MoreRequested() const { return m_requestMore; }
1463
1464 void CopyObject(wxObject& obj) const;
1465
1466protected:
1467 bool m_requestMore;
1468};
1469
e5fb7191 1470/* TODO
c801d85f 1471 wxEVT_POWER,
c801d85f
KB
1472 wxEVT_MOUSE_CAPTURE_CHANGED,
1473 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
c801d85f
KB
1474// wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
1475 // wxEVT_FONT_CHANGED to all other windows (maybe).
1476 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
1477 wxEVT_MEASURE_ITEM,
1478 wxEVT_COMPARE_ITEM
1479*/
1480
8e193f38
VZ
1481// ============================================================================
1482// event handler and related classes
1483// ============================================================================
1484
c801d85f
KB
1485typedef void (wxObject::*wxObjectEventFunction)(wxEvent&);
1486
1487struct WXDLLEXPORT wxEventTableEntry
1488{
003a43dc 1489 // For some reason, this can't be wxEventType, or VC++ complains.
2b854a32
VZ
1490 int m_eventType; // main event type
1491 int m_id; // control/menu/toolbar id
1492 int m_lastId; // used for ranges of ids
1493 wxObjectEventFunction m_fn; // function to call: not wxEventFunction,
1494 // because of dependency problems
1495
1496 wxObject* m_callbackUserData;
c801d85f
KB
1497};
1498
1499struct WXDLLEXPORT wxEventTable
1500{
2b854a32
VZ
1501 const wxEventTable *baseTable; // Points to base event table (next in chain)
1502 const wxEventTableEntry *entries; // Points to bottom of entry array
c801d85f
KB
1503};
1504
2b854a32 1505class WXDLLEXPORT wxEvtHandler : public wxObject
c801d85f 1506{
2b854a32
VZ
1507 DECLARE_DYNAMIC_CLASS(wxEvtHandler)
1508
1509public:
1510 wxEvtHandler();
1511 ~wxEvtHandler();
1512
1513 wxEvtHandler *GetNextHandler() const { return m_nextHandler; }
1514 wxEvtHandler *GetPreviousHandler() const { return m_previousHandler; }
1515 void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
1516 void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
1517
8e193f38 1518 void SetEvtHandlerEnabled(bool enabled) { m_enabled = enabled; }
2b854a32
VZ
1519 bool GetEvtHandlerEnabled() const { return m_enabled; }
1520
8e193f38
VZ
1521 // process an event right now
1522 virtual bool ProcessEvent(wxEvent& event);
2b854a32 1523
8e193f38
VZ
1524 // add an event to be processed later
1525 void AddPendingEvent(wxEvent& event);
2b854a32 1526
8e193f38
VZ
1527 // process all pending events
1528 void ProcessPendingEvents();
2b854a32 1529
20947e08 1530 // add a
7214297d
GL
1531#if wxUSE_THREADS
1532 bool ProcessThreadEvent(wxEvent& event);
7214297d 1533#endif
2b854a32
VZ
1534
1535 // Dynamic association of a member function handler with the event handler,
1536 // id and event type
1537 void Connect( int id, int lastId, wxEventType eventType,
1538 wxObjectEventFunction func,
1539 wxObject *userData = (wxObject *) NULL );
1540
1541 // Convenience function: take just one id
1542 void Connect( int id, wxEventType eventType,
1543 wxObjectEventFunction func,
1544 wxObject *userData = (wxObject *) NULL )
1545 { Connect(id, -1, eventType, func, userData); }
1546
97d7bfb8
RR
1547 bool Disconnect( int id, int lastId = -1, wxEventType eventType = wxEVT_NULL,
1548 wxObjectEventFunction func = NULL,
1549 wxObject *userData = (wxObject *) NULL );
1550
1551 // Convenience function: take just one id
1552 bool Disconnect( int id, wxEventType eventType = wxEVT_NULL,
1553 wxObjectEventFunction func = NULL,
1554 wxObject *userData = (wxObject *) NULL )
1555 { return Disconnect(id, -1, eventType, func, userData); }
98243fed 1556
8e193f38
VZ
1557 // implementation from now on
1558 virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
2b854a32 1559 bool SearchDynamicEventTable( wxEvent& event );
c801d85f 1560
63863e09 1561#if wxUSE_THREADS
20947e08
DW
1562 void ClearEventLocker()
1563 {
1564# if !defined(__VISAGECPP__)
1565 delete m_eventsLocker;
1566 m_eventsLocker = NULL;
1567#endif
1568 };
63863e09
JS
1569#endif
1570
8e193f38
VZ
1571 // old stuff
1572
1573#if WXWIN_COMPATIBILITY_2
1574 virtual void OnCommand(wxWindow& WXUNUSED(win),
1575 wxCommandEvent& WXUNUSED(event))
1576 {
1577 wxFAIL_MSG(wxT("shouldn't be called any more"));
1578 }
1579
1580 // Called if child control has no callback function
1581 virtual long Default()
1582 { return GetNextHandler() ? GetNextHandler()->Default() : 0; };
1583#endif // WXWIN_COMPATIBILITY_2
1584
1585#if WXWIN_COMPATIBILITY
1586 virtual bool OnClose();
1587#endif
1588
c801d85f 1589private:
8e193f38 1590 static const wxEventTableEntry sm_eventTableEntries[];
2b854a32 1591
c801d85f 1592protected:
193bf013
VZ
1593 static const wxEventTable sm_eventTable;
1594
1595 virtual const wxEventTable *GetEventTable() const;
1596
c801d85f 1597protected:
63863e09
JS
1598 wxEvtHandler* m_nextHandler;
1599 wxEvtHandler* m_previousHandler;
63863e09 1600 wxList* m_dynamicEvents;
42e69d6b 1601 wxList* m_pendingEvents;
7214297d 1602#if wxUSE_THREADS
20947e08
DW
1603#if defined (__VISAGECPP__)
1604 wxCriticalSection m_eventsLocker;
1605# else
63863e09 1606 wxCriticalSection* m_eventsLocker;
20947e08 1607# endif
7214297d 1608#endif
193bf013
VZ
1609
1610 // optimization: instead of using costly IsKindOf() to decide whether we're
1611 // a window (which is true in 99% of cases), use this flag
63863e09 1612 bool m_isWindow;
8e193f38
VZ
1613
1614 // Is event handler enabled?
1615 bool m_enabled;
c801d85f
KB
1616};
1617
1618typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
e90c1d2a 1619#if wxUSE_GUI
c801d85f
KB
1620typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&);
1621typedef void (wxEvtHandler::*wxScrollEventFunction)(wxScrollEvent&);
c5b42c87 1622typedef void (wxEvtHandler::*wxScrollWinEventFunction)(wxScrollWinEvent&);
c801d85f
KB
1623typedef void (wxEvtHandler::*wxSizeEventFunction)(wxSizeEvent&);
1624typedef void (wxEvtHandler::*wxMoveEventFunction)(wxMoveEvent&);
1625typedef void (wxEvtHandler::*wxPaintEventFunction)(wxPaintEvent&);
1626typedef void (wxEvtHandler::*wxEraseEventFunction)(wxEraseEvent&);
1627typedef void (wxEvtHandler::*wxMouseEventFunction)(wxMouseEvent&);
1628typedef void (wxEvtHandler::*wxCharEventFunction)(wxKeyEvent&);
1629typedef void (wxEvtHandler::*wxFocusEventFunction)(wxFocusEvent&);
1630typedef void (wxEvtHandler::*wxActivateEventFunction)(wxActivateEvent&);
1631typedef void (wxEvtHandler::*wxMenuEventFunction)(wxMenuEvent&);
1632typedef void (wxEvtHandler::*wxJoystickEventFunction)(wxJoystickEvent&);
1633typedef void (wxEvtHandler::*wxDropFilesEventFunction)(wxDropFilesEvent&);
1634typedef void (wxEvtHandler::*wxInitDialogEventFunction)(wxInitDialogEvent&);
1635typedef void (wxEvtHandler::*wxSysColourChangedFunction)(wxSysColourChangedEvent&);
1636typedef void (wxEvtHandler::*wxUpdateUIEventFunction)(wxUpdateUIEvent&);
1637typedef void (wxEvtHandler::*wxIdleEventFunction)(wxIdleEvent&);
1638typedef void (wxEvtHandler::*wxCloseEventFunction)(wxCloseEvent&);
1639typedef void (wxEvtHandler::*wxShowEventFunction)(wxShowEvent&);
1640typedef void (wxEvtHandler::*wxIconizeEventFunction)(wxShowEvent&);
1641typedef void (wxEvtHandler::*wxMaximizeEventFunction)(wxShowEvent&);
81d66cf3 1642typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&);
f7bd2698
JS
1643typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&);
1644typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&);
43b5058d
VZ
1645typedef void (wxEvtHandler::*wxWindowCreateEventFunction)(wxWindowCreateEvent&);
1646typedef void (wxEvtHandler::*wxWindowDestroyEventFunction)(wxWindowDestroyEvent&);
1647typedef void (wxEvtHandler::*wxSetCursorEventFunction)(wxSetCursorEvent&);
669f7a11 1648typedef void (wxEvtHandler::*wxNotifyEventFunction)(wxNotifyEvent&);
b96340e6 1649typedef void (wxEvtHandler::*wxHelpEventFunction)(wxHelpEvent&);
e90c1d2a 1650#endif // wxUSE_GUI
c801d85f
KB
1651
1652// N.B. In GNU-WIN32, you *have* to take the address of a member function
1653// (use &) or the compiler crashes...
1654
1655#define DECLARE_EVENT_TABLE() \
1656private:\
2b854a32 1657 static const wxEventTableEntry sm_eventTableEntries[];\
c801d85f 1658protected:\
2b854a32
VZ
1659 static const wxEventTable sm_eventTable;\
1660 virtual const wxEventTable* GetEventTable() const;
c801d85f
KB
1661
1662#define BEGIN_EVENT_TABLE(theClass, baseClass) \
1663const wxEventTable *theClass::GetEventTable() const { return &theClass::sm_eventTable; }\
1664const wxEventTable theClass::sm_eventTable =\
2b854a32 1665 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] };\
c801d85f
KB
1666const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
1667
1668#define END_EVENT_TABLE() \
74e34480 1669 { 0, 0, 0, 0, 0 } };
2b854a32 1670
c801d85f
KB
1671/*
1672 * Event table macros
1673 */
1674
1675// Generic events
c67daf87
UR
1676#define EVT_CUSTOM(event, id, func) { event, id, -1, (wxObjectEventFunction) (wxEventFunction) & func, (wxObject *) NULL },
1677#define EVT_CUSTOM_RANGE(event, id1, id2, func) { event, id1, id2, (wxObjectEventFunction) (wxEventFunction) & func, (wxObject *) NULL },
c801d85f
KB
1678
1679// Miscellaneous
c67daf87
UR
1680#define EVT_SIZE(func) { wxEVT_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxSizeEventFunction) & func, (wxObject *) NULL },
1681#define EVT_MOVE(func) { wxEVT_MOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMoveEventFunction) & func, (wxObject *) NULL },
1682#define EVT_CLOSE(func) { wxEVT_CLOSE_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL },
387a3b02
JS
1683#define EVT_END_SESSION(func) { wxEVT_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL },
1684#define EVT_QUERY_END_SESSION(func) { wxEVT_QUERY_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL },
c67daf87
UR
1685#define EVT_PAINT(func) { wxEVT_PAINT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxPaintEventFunction) & func, (wxObject *) NULL },
1686#define EVT_ERASE_BACKGROUND(func) { wxEVT_ERASE_BACKGROUND, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxEraseEventFunction) & func, (wxObject *) NULL },
1687#define EVT_CHAR(func) { wxEVT_CHAR, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, (wxObject *) NULL },
4ce81a75
JS
1688#define EVT_KEY_DOWN(func) { wxEVT_KEY_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, (wxObject *) NULL },
1689#define EVT_KEY_UP(func) { wxEVT_KEY_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, (wxObject *) NULL },
fe71f65c 1690#define EVT_CHAR_HOOK(func) { wxEVT_CHAR_HOOK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, NULL },
c67daf87
UR
1691#define EVT_MENU_HIGHLIGHT(id, func) { wxEVT_MENU_HIGHLIGHT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxMenuEventFunction) & func, (wxObject *) NULL },
1692#define EVT_MENU_HIGHLIGHT_ALL(func) { wxEVT_MENU_HIGHLIGHT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMenuEventFunction) & func, (wxObject *) NULL },
1693#define EVT_SET_FOCUS(func) { wxEVT_SET_FOCUS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxFocusEventFunction) & func, (wxObject *) NULL },
1694#define EVT_KILL_FOCUS(func) { wxEVT_KILL_FOCUS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxFocusEventFunction) & func, (wxObject *) NULL },
1695#define EVT_ACTIVATE(func) { wxEVT_ACTIVATE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxActivateEventFunction) & func, (wxObject *) NULL },
1696#define EVT_ACTIVATE_APP(func) { wxEVT_ACTIVATE_APP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxActivateEventFunction) & func, (wxObject *) NULL },
1697#define EVT_END_SESSION(func) { wxEVT_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL },
1698#define EVT_QUERY_END_SESSION(func) { wxEVT_QUERY_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL },
1699#define EVT_DROP_FILES(func) { wxEVT_DROP_FILES, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxDropFilesEventFunction) & func, (wxObject *) NULL },
1700#define EVT_INIT_DIALOG(func) { wxEVT_INIT_DIALOG, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxInitDialogEventFunction) & func, (wxObject *) NULL },
1701#define EVT_SYS_COLOUR_CHANGED(func) { wxEVT_SYS_COLOUR_CHANGED, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxSysColourChangedFunction) & func, (wxObject *) NULL },
1702#define EVT_SHOW(func) { wxEVT_SHOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxShowEventFunction) & func, (wxObject *) NULL },
1703#define EVT_MAXIMIZE(func) { wxEVT_MAXIMIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMaximizeEventFunction) & func, (wxObject *) NULL },
1704#define EVT_ICONIZE(func) { wxEVT_ICONIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxIconizeEventFunction) & func, (wxObject *) NULL },
1705#define EVT_NAVIGATION_KEY(func) { wxEVT_NAVIGATION_KEY, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxNavigationKeyEventFunction) & func, (wxObject *) NULL },
1706#define EVT_PALETTE_CHANGED(func) { wxEVT_PALETTE_CHANGED, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxPaletteChangedEventFunction) & func, (wxObject *) NULL },
1707#define EVT_QUERY_NEW_PALETTE(func) { wxEVT_QUERY_NEW_PALETTE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxQueryNewPaletteEventFunction) & func, (wxObject *) NULL },
43b5058d
VZ
1708#define EVT_WINDOW_CREATE(func) { wxEVT_CREATE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxWindowCreateEventFunction) & func, (wxObject *) NULL },
1709#define EVT_WINDOW_DESTROY(func) { wxEVT_DESTROY, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxWindowDestroyEventFunction) & func, (wxObject *) NULL },
1710#define EVT_SET_CURSOR(func) { wxEVT_SET_CURSOR, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxSetCursorEventFunction) & func, (wxObject *) NULL },
c801d85f
KB
1711
1712// Mouse events
c67daf87
UR
1713#define EVT_LEFT_DOWN(func) { wxEVT_LEFT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1714#define EVT_LEFT_UP(func) { wxEVT_LEFT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1715#define EVT_MIDDLE_DOWN(func) { wxEVT_MIDDLE_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1716#define EVT_MIDDLE_UP(func) { wxEVT_MIDDLE_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1717#define EVT_RIGHT_DOWN(func) { wxEVT_RIGHT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1718#define EVT_RIGHT_UP(func) { wxEVT_RIGHT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1719#define EVT_MOTION(func) { wxEVT_MOTION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1720#define EVT_LEFT_DCLICK(func) { wxEVT_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1721#define EVT_MIDDLE_DCLICK(func) { wxEVT_MIDDLE_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1722#define EVT_RIGHT_DCLICK(func) { wxEVT_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1723#define EVT_LEAVE_WINDOW(func) { wxEVT_LEAVE_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1724#define EVT_ENTER_WINDOW(func) { wxEVT_ENTER_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
c801d85f
KB
1725
1726// All mouse events
1727#define EVT_MOUSE_EVENTS(func) \
c67daf87
UR
1728 { wxEVT_LEFT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1729 { wxEVT_LEFT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1730 { wxEVT_MIDDLE_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1731 { wxEVT_MIDDLE_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1732 { wxEVT_RIGHT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1733 { wxEVT_RIGHT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1734 { wxEVT_MOTION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1735 { wxEVT_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1736 { wxEVT_MIDDLE_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1737 { wxEVT_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1738 { wxEVT_ENTER_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1739 { wxEVT_LEAVE_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
c801d85f
KB
1740
1741// EVT_COMMAND
1f112209 1742#define EVT_COMMAND(id, event, fn) { event, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
dbdb39b2 1743#define EVT_COMMAND_RANGE(id1, id2, event, fn) { event, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
c801d85f 1744
c5b42c87
RR
1745// Scrolling from wxWindow (sent to wxScrolledWindow)
1746#define EVT_SCROLLWIN(func) \
1747 { wxEVT_SCROLLWIN_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\
1748 { wxEVT_SCROLLWIN_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\
1749 { wxEVT_SCROLLWIN_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\
1750 { wxEVT_SCROLLWIN_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\
1751 { wxEVT_SCROLLWIN_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\
1752 { wxEVT_SCROLLWIN_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\
7d56fb8f
GRG
1753 { wxEVT_SCROLLWIN_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },\
1754 { wxEVT_SCROLLWIN_THUMBRELEASE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
c5b42c87
RR
1755
1756#define EVT_SCROLLWIN_TOP(func) { wxEVT_SCROLLWIN_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
1757#define EVT_SCROLLWIN_BOTTOM(func) { wxEVT_SCROLLWIN_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
1758#define EVT_SCROLLWIN_LINEUP(func) { wxEVT_SCROLLWIN_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
1759#define EVT_SCROLLWIN_LINEDOWN(func) { wxEVT_SCROLLWIN_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
1760#define EVT_SCROLLWIN_PAGEUP(func) { wxEVT_SCROLLWIN_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
1761#define EVT_SCROLLWIN_PAGEDOWN(func) { wxEVT_SCROLLWIN_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
1762#define EVT_SCROLLWIN_THUMBTRACK(func) { wxEVT_SCROLLWIN_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
7d56fb8f 1763#define EVT_SCROLLWIN_THUMBRELEASE(func) { wxEVT_SCROLLWIN_THUMBRELEASE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollWinEventFunction) & func, (wxObject *) NULL },
c5b42c87
RR
1764
1765// Scrolling from wxSlider and wxScrollBar
c801d85f 1766#define EVT_SCROLL(func) \
c67daf87
UR
1767 { wxEVT_SCROLL_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1768 { wxEVT_SCROLL_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1769 { wxEVT_SCROLL_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1770 { wxEVT_SCROLL_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1771 { wxEVT_SCROLL_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1772 { wxEVT_SCROLL_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
7d56fb8f
GRG
1773 { wxEVT_SCROLL_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1774 { wxEVT_SCROLL_THUMBRELEASE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
c67daf87
UR
1775
1776#define EVT_SCROLL_TOP(func) { wxEVT_SCROLL_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1777#define EVT_SCROLL_BOTTOM(func) { wxEVT_SCROLL_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1778#define EVT_SCROLL_LINEUP(func) { wxEVT_SCROLL_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1779#define EVT_SCROLL_LINEDOWN(func) { wxEVT_SCROLL_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1780#define EVT_SCROLL_PAGEUP(func) { wxEVT_SCROLL_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1781#define EVT_SCROLL_PAGEDOWN(func) { wxEVT_SCROLL_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1782#define EVT_SCROLL_THUMBTRACK(func) { wxEVT_SCROLL_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
7d56fb8f 1783#define EVT_SCROLL_THUMBRELEASE(func) { wxEVT_SCROLL_THUMBRELEASE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
c801d85f 1784
c5b42c87 1785// Scrolling from wxSlider and wxScrollBar, with an id
c801d85f 1786#define EVT_COMMAND_SCROLL(id, func) \
c67daf87
UR
1787 { wxEVT_SCROLL_TOP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1788 { wxEVT_SCROLL_BOTTOM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1789 { wxEVT_SCROLL_LINEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1790 { wxEVT_SCROLL_LINEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1791 { wxEVT_SCROLL_PAGEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1792 { wxEVT_SCROLL_PAGEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
7d56fb8f
GRG
1793 { wxEVT_SCROLL_THUMBTRACK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1794 { wxEVT_SCROLL_THUMBRELEASE, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
c67daf87
UR
1795
1796#define EVT_COMMAND_SCROLL_TOP(id, func) { wxEVT_SCROLL_TOP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1797#define EVT_COMMAND_SCROLL_BOTTOM(id, func) { wxEVT_SCROLL_BOTTOM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1798#define EVT_COMMAND_SCROLL_LINEUP(id, func) { wxEVT_SCROLL_LINEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1799#define EVT_COMMAND_SCROLL_LINEDOWN(id, func) { wxEVT_SCROLL_LINEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1800#define EVT_COMMAND_SCROLL_PAGEUP(id, func) { wxEVT_SCROLL_PAGEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1801#define EVT_COMMAND_SCROLL_PAGEDOWN(id, func) { wxEVT_SCROLL_PAGEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1802#define EVT_COMMAND_SCROLL_THUMBTRACK(id, func) { wxEVT_SCROLL_THUMBTRACK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
7d56fb8f 1803#define EVT_COMMAND_SCROLL_THUMBRELEASE(id, func) { wxEVT_SCROLL_THUMBRELEASE, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
c801d85f
KB
1804
1805// Convenience macros for commonly-used commands
c67daf87
UR
1806#define EVT_BUTTON(id, fn) { wxEVT_COMMAND_BUTTON_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1807#define EVT_CHECKBOX(id, fn) { wxEVT_COMMAND_CHECKBOX_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1808#define EVT_CHOICE(id, fn) { wxEVT_COMMAND_CHOICE_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1809#define EVT_LISTBOX(id, fn) { wxEVT_COMMAND_LISTBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1810#define EVT_LISTBOX_DCLICK(id, fn) { wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1811#define EVT_TEXT(id, fn) { wxEVT_COMMAND_TEXT_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1812#define EVT_TEXT_ENTER(id, fn) { wxEVT_COMMAND_TEXT_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1813#define EVT_MENU(id, fn) { wxEVT_COMMAND_MENU_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1814#define EVT_MENU_RANGE(id1, id2, fn) { wxEVT_COMMAND_MENU_SELECTED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1815#define EVT_SLIDER(id, fn) { wxEVT_COMMAND_SLIDER_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1816#define EVT_RADIOBOX(id, fn) { wxEVT_COMMAND_RADIOBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1817#define EVT_RADIOBUTTON(id, fn) { wxEVT_COMMAND_RADIOBUTTON_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
c801d85f 1818// EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
c67daf87
UR
1819#define EVT_SCROLLBAR(id, fn) { wxEVT_COMMAND_SCROLLBAR_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1820#define EVT_VLBOX(id, fn) { wxEVT_COMMAND_VLBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1821#define EVT_COMBOBOX(id, fn) { wxEVT_COMMAND_COMBOBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1822#define EVT_TOOL(id, fn) { wxEVT_COMMAND_TOOL_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1823#define EVT_TOOL_RANGE(id1, id2, fn) { wxEVT_COMMAND_TOOL_CLICKED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1824#define EVT_TOOL_RCLICKED(id, fn) { wxEVT_COMMAND_TOOL_RCLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1825#define EVT_TOOL_RCLICKED_RANGE(id1, id2, fn) { wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1826#define EVT_TOOL_ENTER(id, fn) { wxEVT_COMMAND_TOOL_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1827#define EVT_CHECKLISTBOX(id, fn) { wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
c801d85f
KB
1828
1829// Generic command events
c67daf87
UR
1830#define EVT_COMMAND_LEFT_CLICK(id, fn) { wxEVT_COMMAND_LEFT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1831#define EVT_COMMAND_LEFT_DCLICK(id, fn) { wxEVT_COMMAND_LEFT_DCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1832#define EVT_COMMAND_RIGHT_CLICK(id, fn) { wxEVT_COMMAND_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1833#define EVT_COMMAND_RIGHT_DCLICK(id, fn) { wxEVT_COMMAND_RIGHT_DCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1834#define EVT_COMMAND_SET_FOCUS(id, fn) { wxEVT_COMMAND_SET_FOCUS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1835#define EVT_COMMAND_KILL_FOCUS(id, fn) { wxEVT_COMMAND_KILL_FOCUS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1836#define EVT_COMMAND_ENTER(id, fn) { wxEVT_COMMAND_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
c801d85f
KB
1837
1838// Joystick events
1839#define EVT_JOY_DOWN(func) \
c67daf87 1840 { wxEVT_JOY_BUTTON_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },
c801d85f 1841#define EVT_JOY_UP(func) \
c67daf87 1842 { wxEVT_JOY_BUTTON_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },
c801d85f 1843#define EVT_JOY_MOVE(func) \
c67daf87 1844 { wxEVT_JOY_MOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },
c801d85f 1845#define EVT_JOY_ZMOVE(func) \
c67daf87 1846 { wxEVT_JOY_ZMOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },
c801d85f
KB
1847
1848// All joystick events
1849#define EVT_JOYSTICK_EVENTS(func) \
c67daf87
UR
1850 { wxEVT_JOY_BUTTON_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },\
1851 { wxEVT_JOY_BUTTON_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },\
1852 { wxEVT_JOY_MOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },\
3ca6a5f0 1853 { wxEVT_JOY_ZMOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },
c801d85f
KB
1854
1855// Idle event
1856#define EVT_IDLE(func) \
3ca6a5f0 1857 { wxEVT_IDLE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxIdleEventFunction) & func, (wxObject *) NULL },
c801d85f
KB
1858
1859// Update UI event
1860#define EVT_UPDATE_UI(id, func) \
3ca6a5f0
BP
1861 { wxEVT_UPDATE_UI, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxUpdateUIEventFunction) & func, (wxObject *) NULL },
1862#define EVT_UPDATE_UI_RANGE(id1, id2, func) \
1863 { wxEVT_UPDATE_UI, id1, id2, (wxObjectEventFunction)(wxEventFunction)(wxUpdateUIEventFunction)&func, (wxObject *) NULL },
c801d85f 1864
b96340e6
JS
1865// Help events
1866#define EVT_HELP(id, func) \
1867 { wxEVT_HELP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxHelpEventFunction) & func, (wxObject *) NULL },
1868
1869#define EVT_HELP_RANGE(id1, id2, func) \
1870 { wxEVT_HELP, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxHelpEventFunction) & func, (wxObject *) NULL },
1871
fb6261e9
JS
1872#define EVT_DETAILED_HELP(id, func) \
1873 { wxEVT_DETAILED_HELP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxHelpEventFunction) & func, (wxObject *) NULL },
1874
1875#define EVT_DETAILED_HELP_RANGE(id1, id2, func) \
1876 { wxEVT_DETAILED_HELP, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxHelpEventFunction) & func, (wxObject *) NULL },
1877
8e193f38
VZ
1878// ----------------------------------------------------------------------------
1879// Global data
1880// ----------------------------------------------------------------------------
1881
1882// for pending event processing - notice that there is intentionally no
1883// WXDLLEXPORT here
1884extern wxList *wxPendingEvents;
1885#if wxUSE_THREADS
1886 extern wxCriticalSection *wxPendingEventsLocker;
1887#endif
1888
e90c1d2a
VZ
1889// ----------------------------------------------------------------------------
1890// Helper functions
1891// ----------------------------------------------------------------------------
1892
1893#if wxUSE_GUI
e702ff0f
JS
1894
1895// Find a window with the focus, that is also a descendant of the given window.
1896// This is used to determine the window to initially send commands to.
1897wxWindow* wxFindFocusDescendant(wxWindow* ancestor);
1898
e90c1d2a
VZ
1899#endif // wxUSE_GUI
1900
c801d85f 1901#endif
2b854a32 1902 // _WX_EVENTH__