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