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