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