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