]> git.saurik.com Git - wxWidgets.git/blame - include/wx/event.h
Updated for Mahogany.
[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
aadbdf11 293 void CopyObject(wxObject& object_dest) const;
a737331d 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
aadbdf11
GL
369 void CopyObject(wxObject& obj) const;
370
2b854a32 371public:
29006414 372 wxString m_commandString; // String event argument
2b854a32
VZ
373 int m_commandInt;
374 long m_extraLong; // Additional information (e.g. select/deselect)
375 void* m_clientData; // Arbitrary client data
376 wxClientData* m_clientObject; // Arbitrary client object
c801d85f
KB
377};
378
fd3f686c
VZ
379// this class adds a possibility to react (from the user) code to a control
380// notification: allow or veto the operation being reported.
2b854a32 381class WXDLLEXPORT wxNotifyEvent : public wxCommandEvent
fd3f686c
VZ
382{
383public:
384 wxNotifyEvent(wxEventType commandType = wxEVT_NULL, int id = 0)
385 : wxCommandEvent(commandType, id) { m_bAllow = TRUE; }
386
387 // veto the operation (by default it's allowed)
388 void Veto() { m_bAllow = FALSE; }
389
390 // for implementation code only: is the operation allowed?
391 bool IsAllowed() const { return m_bAllow; }
392
393private:
394 bool m_bAllow;
395
92976ab6 396 DECLARE_DYNAMIC_CLASS(wxNotifyEvent)
fd3f686c
VZ
397};
398
c801d85f
KB
399// Scroll event class
400/*
401 wxEVT_SCROLL_TOP
402 wxEVT_SCROLL_BOTTOM
403 wxEVT_SCROLL_LINEUP
404 wxEVT_SCROLL_LINEDOWN
405 wxEVT_SCROLL_PAGEUP
406 wxEVT_SCROLL_PAGEDOWN
407 wxEVT_SCROLL_THUMBTRACK
408*/
409
2b854a32 410class WXDLLEXPORT wxScrollEvent : public wxCommandEvent
c801d85f 411{
2b854a32 412 DECLARE_DYNAMIC_CLASS(wxScrollEvent)
c801d85f 413
2b854a32
VZ
414public:
415 wxScrollEvent(wxEventType commandType = wxEVT_NULL,
416 int id = 0, int pos = 0, int orient = 0);
417 ~wxScrollEvent() {}
418
419 /*
420 * Accessors
421 *
422 */
423
424 int GetOrientation() const { return (int) m_extraLong ; }
425 int GetPosition() const { return m_commandInt ; }
426 void SetOrientation(int orient) { m_extraLong = (long) orient; }
427 void SetPosition(int pos) { m_commandInt = pos; }
c801d85f
KB
428};
429
430// Mouse event class
431
432/*
433 wxEVT_LEFT_DOWN
434 wxEVT_LEFT_UP
435 wxEVT_MIDDLE_DOWN
436 wxEVT_MIDDLE_UP
437 wxEVT_RIGHT_DOWN
438 wxEVT_RIGHT_UP
439 wxEVT_MOTION
440 wxEVT_ENTER_WINDOW
441 wxEVT_LEAVE_WINDOW
442 wxEVT_LEFT_DCLICK
443 wxEVT_MIDDLE_DCLICK
444 wxEVT_RIGHT_DCLICK
445 wxEVT_NC_LEFT_DOWN
446 wxEVT_NC_LEFT_UP,
447 wxEVT_NC_MIDDLE_DOWN,
448 wxEVT_NC_MIDDLE_UP,
449 wxEVT_NC_RIGHT_DOWN,
450 wxEVT_NC_RIGHT_UP,
451 wxEVT_NC_MOTION,
452 wxEVT_NC_ENTER_WINDOW,
453 wxEVT_NC_LEAVE_WINDOW,
454 wxEVT_NC_LEFT_DCLICK,
455 wxEVT_NC_MIDDLE_DCLICK,
456 wxEVT_NC_RIGHT_DCLICK,
457*/
458
34138703 459class WXDLLEXPORT wxDC;
2b854a32 460class WXDLLEXPORT wxMouseEvent : public wxEvent
c801d85f 461{
2b854a32 462 DECLARE_DYNAMIC_CLASS(wxMouseEvent)
c801d85f 463
2b854a32
VZ
464public:
465 wxMouseEvent(wxEventType mouseType = wxEVT_NULL);
c801d85f 466
2b854a32
VZ
467 // Was it a button event? (*doesn't* mean: is any button *down*?)
468 bool IsButton() const { return Button(-1); }
c801d85f 469
2b854a32
VZ
470 // Was it a down event from button 1, 2 or 3 or any?
471 bool ButtonDown(int but = -1) const;
c801d85f 472
2b854a32
VZ
473 // Was it a dclick event from button 1, 2 or 3 or any?
474 bool ButtonDClick(int but = -1) const;
c801d85f 475
2b854a32
VZ
476 // Was it a up event from button 1, 2 or 3 or any?
477 bool ButtonUp(int but = -1) const;
c801d85f 478
2b854a32
VZ
479 // Was the given button 1,2,3 or any changing state?
480 bool Button(int but) const;
c801d85f 481
2b854a32
VZ
482 // Was the given button 1,2,3 or any in Down state?
483 bool ButtonIsDown(int but) const;
c801d85f 484
2b854a32
VZ
485 // Find state of shift/control keys
486 bool ControlDown() const { return m_controlDown; }
487 bool MetaDown() const { return m_metaDown; }
488 bool AltDown() const { return m_altDown; }
489 bool ShiftDown() const { return m_shiftDown; }
c801d85f 490
2b854a32
VZ
491 // Find which event was just generated
492 bool LeftDown() const { return (m_eventType == wxEVT_LEFT_DOWN); }
493 bool MiddleDown() const { return (m_eventType == wxEVT_MIDDLE_DOWN); }
494 bool RightDown() const { return (m_eventType == wxEVT_RIGHT_DOWN); }
c801d85f 495
2b854a32
VZ
496 bool LeftUp() const { return (m_eventType == wxEVT_LEFT_UP); }
497 bool MiddleUp() const { return (m_eventType == wxEVT_MIDDLE_UP); }
498 bool RightUp() const { return (m_eventType == wxEVT_RIGHT_UP); }
c801d85f 499
2b854a32
VZ
500 bool LeftDClick() const { return (m_eventType == wxEVT_LEFT_DCLICK); }
501 bool MiddleDClick() const { return (m_eventType == wxEVT_MIDDLE_DCLICK); }
502 bool RightDClick() const { return (m_eventType == wxEVT_RIGHT_DCLICK); }
c801d85f 503
2b854a32
VZ
504 // Find the current state of the mouse buttons (regardless
505 // of current event type)
506 bool LeftIsDown() const { return m_leftDown; }
507 bool MiddleIsDown() const { return m_middleDown; }
508 bool RightIsDown() const { return m_rightDown; }
c801d85f 509
2b854a32
VZ
510 // True if a button is down and the mouse is moving
511 bool Dragging() const
512 {
513 return ((m_eventType == wxEVT_MOTION) &&
514 (LeftIsDown() || MiddleIsDown() || RightIsDown()));
515 }
c801d85f 516
2b854a32
VZ
517 // True if the mouse is moving, and no button is down
518 bool Moving() const { return (m_eventType == wxEVT_MOTION); }
c801d85f 519
2b854a32
VZ
520 // True if the mouse is just entering the window
521 bool Entering() const { return (m_eventType == wxEVT_ENTER_WINDOW); }
c801d85f 522
2b854a32
VZ
523 // True if the mouse is just leaving the window
524 bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); }
c801d85f 525
2b854a32 526 // Find the position of the event
803ef874 527 void GetPosition(long *xpos, long *ypos) const { *xpos = m_x; *ypos = m_y; }
2b854a32 528 void Position(long *xpos, long *ypos) const { *xpos = m_x; *ypos = m_y; }
c801d85f 529
2b854a32
VZ
530 // Find the position of the event
531 wxPoint GetPosition() const { return wxPoint(m_x, m_y); }
c801d85f 532
2b854a32
VZ
533 // Find the logical position of the event given the DC
534 wxPoint GetLogicalPosition(const wxDC& dc) const ;
c801d85f 535
2b854a32
VZ
536 // Compatibility
537#if WXWIN_COMPATIBILITY
538 void Position(float *xpos, float *ypos) const
539 {
540 *xpos = (float) m_x; *ypos = (float) m_y;
541 }
542#endif // WXWIN_COMPATIBILITY
c801d85f 543
2b854a32
VZ
544 // Get X position
545 long GetX() const { return m_x; }
c801d85f 546
2b854a32
VZ
547 // Get Y position
548 long GetY() const { return m_y; }
c801d85f 549
aadbdf11
GL
550 void CopyObject(wxObject& obj) const;
551
c801d85f 552public:
2b854a32
VZ
553 long m_x;
554 long m_y;
555 bool m_leftDown;
556 bool m_middleDown;
557 bool m_rightDown;
558
559 bool m_controlDown;
560 bool m_shiftDown;
561 bool m_altDown;
562 bool m_metaDown;
c801d85f
KB
563};
564
565// Keyboard input event class
566
567/*
568 wxEVT_CHAR
569 wxEVT_CHAR_HOOK
4ce81a75 570 wxEVT_KEY_DOWN
c801d85f
KB
571 wxEVT_KEY_UP
572 */
573
2b854a32 574class WXDLLEXPORT wxKeyEvent : public wxEvent
c801d85f 575{
2b854a32 576 DECLARE_DYNAMIC_CLASS(wxKeyEvent)
c801d85f
KB
577
578public:
2b854a32 579 wxKeyEvent(wxEventType keyType = wxEVT_NULL);
c801d85f 580
2b854a32
VZ
581 // Find state of shift/control keys
582 bool ControlDown() const { return m_controlDown; }
583 bool MetaDown() const { return m_metaDown; }
584 bool AltDown() const { return m_altDown; }
585 bool ShiftDown() const { return m_shiftDown; }
586 long KeyCode() const { return m_keyCode; }
c801d85f 587
2b854a32 588 // Find the position of the event
803ef874
JS
589 void GetPosition(long *xpos, long *ypos) const
590 { *xpos = m_x; *ypos = m_y; }
591
592 wxPoint GetPosition() const
593 { return wxPoint(m_x, m_y); }
c801d85f 594
2b854a32 595 // Get X position
803ef874 596 long GetX() const { return m_x; }
c801d85f 597
2b854a32 598 // Get Y position
803ef874 599 long GetY() const { return m_y; }
c801d85f 600
aadbdf11
GL
601 void CopyObject(wxObject& obj) const;
602
2b854a32
VZ
603public:
604 long m_x;
605 long m_y;
606 long m_keyCode;
607 bool m_controlDown;
608 bool m_shiftDown;
609 bool m_altDown;
610 bool m_metaDown;
c801d85f
KB
611};
612
613// Size event class
614/*
615 wxEVT_SIZE
616 */
617
2b854a32 618class WXDLLEXPORT wxSizeEvent : public wxEvent
c801d85f 619{
2b854a32 620 DECLARE_DYNAMIC_CLASS(wxSizeEvent)
c801d85f 621
2b854a32
VZ
622public:
623 wxSize m_size;
c801d85f 624
2b854a32
VZ
625 wxSizeEvent() { m_eventType = wxEVT_SIZE; }
626 wxSizeEvent(const wxSize& sz, int id = 0)
627 : m_size(sz)
628 { m_eventType = wxEVT_SIZE; m_id = id; }
c801d85f 629
2b854a32 630 wxSize GetSize() const { return m_size; }
aadbdf11
GL
631
632 void CopyObject(wxObject& obj) const;
c801d85f
KB
633};
634
635// Move event class
636
637/*
638 wxEVT_MOVE
639 */
640
2b854a32 641class WXDLLEXPORT wxMoveEvent : public wxEvent
c801d85f 642{
2b854a32 643 DECLARE_DYNAMIC_CLASS(wxMoveEvent)
c801d85f 644
2b854a32
VZ
645public:
646 wxPoint m_pos;
c801d85f 647
2b854a32
VZ
648 wxMoveEvent() { m_eventType = wxEVT_MOVE; }
649 wxMoveEvent(const wxPoint& pos, int id = 0)
650 : m_pos(pos)
651 { m_eventType = wxEVT_MOVE; m_id = id; }
c801d85f 652
2b854a32 653 wxPoint GetPosition() const { return m_pos; }
aadbdf11
GL
654
655 void CopyObject(wxObject& obj) const;
c801d85f
KB
656};
657
658// Paint event class
659/*
660 wxEVT_PAINT
661 wxEVT_NC_PAINT
662 wxEVT_PAINT_ICON
663 */
664
2b854a32 665class WXDLLEXPORT wxPaintEvent : public wxEvent
c801d85f 666{
2b854a32 667 DECLARE_DYNAMIC_CLASS(wxPaintEvent)
c801d85f 668
2b854a32
VZ
669public:
670 wxPaintEvent(int Id = 0) { m_eventType = wxEVT_PAINT; m_id = Id; }
c801d85f
KB
671};
672
673// Erase background event class
674/*
675 wxEVT_ERASE_BACKGROUND
676 */
677
678class WXDLLEXPORT wxDC;
2b854a32 679class WXDLLEXPORT wxEraseEvent : public wxEvent
c801d85f 680{
2b854a32
VZ
681 DECLARE_DYNAMIC_CLASS(wxEraseEvent)
682
683public:
684 wxDC *m_dc;
685
686 wxEraseEvent(int Id = 0, wxDC *dc = (wxDC *) NULL)
687 { m_eventType = wxEVT_ERASE_BACKGROUND; m_id = Id; m_dc = dc; }
688 wxDC *GetDC() const { return m_dc; }
aadbdf11
GL
689
690 void CopyObject(wxObject& obj) const;
c801d85f
KB
691};
692
693// Focus event class
694/*
695 wxEVT_SET_FOCUS
696 wxEVT_KILL_FOCUS
697 */
698
2b854a32 699class WXDLLEXPORT wxFocusEvent : public wxEvent
c801d85f 700{
2b854a32 701 DECLARE_DYNAMIC_CLASS(wxFocusEvent)
c801d85f 702
2b854a32
VZ
703public:
704 wxFocusEvent(wxEventType type = wxEVT_NULL, int Id = 0)
705 { m_eventType = type; m_id = Id; }
c801d85f
KB
706};
707
708// Activate event class
709/*
710 wxEVT_ACTIVATE
711 wxEVT_ACTIVATE_APP
712 */
713
2b854a32 714class WXDLLEXPORT wxActivateEvent : public wxEvent
c801d85f 715{
2b854a32
VZ
716 DECLARE_DYNAMIC_CLASS(wxActivateEvent)
717
718public:
719 wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = TRUE, int Id = 0)
720 { m_eventType = type; m_active = active; m_id = Id; }
721 bool GetActive() const { return m_active; }
c801d85f 722
aadbdf11
GL
723 void CopyObject(wxObject& obj) const;
724
2b854a32
VZ
725private:
726 bool m_active;
c801d85f
KB
727};
728
729// InitDialog event class
730/*
731 wxEVT_INIT_DIALOG
732 */
733
2b854a32 734class WXDLLEXPORT wxInitDialogEvent : public wxEvent
c801d85f 735{
2b854a32 736 DECLARE_DYNAMIC_CLASS(wxInitDialogEvent)
c801d85f 737
2b854a32
VZ
738public:
739 wxInitDialogEvent(int Id = 0)
740 { m_eventType = wxEVT_INIT_DIALOG; m_id = Id; }
c801d85f
KB
741};
742
743// Miscellaneous menu event class
744/*
745 wxEVT_MENU_CHAR,
746 wxEVT_MENU_INIT,
747 wxEVT_MENU_HIGHLIGHT,
748 wxEVT_POPUP_MENU_INIT,
749 wxEVT_CONTEXT_MENU,
750*/
751
2b854a32 752class WXDLLEXPORT wxMenuEvent : public wxEvent
c801d85f 753{
2b854a32 754 DECLARE_DYNAMIC_CLASS(wxMenuEvent)
c801d85f
KB
755
756public:
aadbdf11
GL
757 wxMenuEvent(wxEventType type = wxEVT_NULL, int id = 0)
758 { m_eventType = type; m_menuId = id; }
c801d85f 759
aadbdf11 760 int GetMenuId() const { return m_menuId; }
c801d85f 761
aadbdf11 762 void CopyObject(wxObject& obj) const;
2b854a32 763private:
aadbdf11 764 int m_menuId;
c801d85f
KB
765};
766
767// Window close or session close event class
768/*
769 wxEVT_CLOSE_WINDOW,
770 wxEVT_END_SESSION,
771 wxEVT_QUERY_END_SESSION
772 */
773
2b854a32 774class WXDLLEXPORT wxCloseEvent : public wxEvent
c801d85f 775{
2b854a32
VZ
776 DECLARE_DYNAMIC_CLASS(wxCloseEvent)
777
c801d85f 778public:
2b854a32
VZ
779 wxCloseEvent(wxEventType type = wxEVT_NULL, int id = 0)
780 {
781 m_eventType = type;
782 m_loggingOff = TRUE;
783 m_veto = FALSE; // should be FALSE by default
784 m_id = id;
785#if WXWIN_COMPATIBILITY
786 m_force = FALSE;
787#endif // WXWIN_COMPATIBILITY
788 m_canVeto = TRUE;
789 }
790
791 void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
792 bool GetLoggingOff() const { return m_loggingOff; }
793
fe4e9e6c
VZ
794 void Veto(bool veto = TRUE)
795 {
796 // GetVeto() will return FALSE anyhow...
797 wxCHECK_RET( m_canVeto,
9d2f3c71 798 _T("call to Veto() ignored (can't veto this event)") );
fe4e9e6c
VZ
799
800 m_veto = veto;
801 }
2b854a32 802 void SetCanVeto(bool canVeto) { m_canVeto = canVeto; }
e3065973 803 // No more asserts here please, the one you put here was wrong.
2b854a32 804 bool CanVeto() const { return m_canVeto; }
fe4e9e6c 805 bool GetVeto() const { return m_canVeto && m_veto; }
c801d85f 806
2b854a32
VZ
807#if WXWIN_COMPATIBILITY
808 // This is probably obsolete now, since we use CanVeto instead, in
809 // both OnCloseWindow and OnQueryEndSession.
810 // m_force == ! m_canVeto i.e., can't veto means we must force it to close.
811 void SetForce(bool force) { m_force = force; }
812 bool GetForce() const { return m_force; }
813#endif
814
aadbdf11
GL
815 void CopyObject(wxObject& obj) const;
816
2b854a32
VZ
817protected:
818 bool m_loggingOff;
819 bool m_veto, m_canVeto;
820
821#if WXWIN_COMPATIBILITY
822 bool m_force;
823#endif
c801d85f
KB
824};
825
826/*
827 wxEVT_SHOW
828 */
829
2b854a32 830class WXDLLEXPORT wxShowEvent : public wxEvent
c801d85f 831{
2b854a32
VZ
832 DECLARE_DYNAMIC_CLASS(wxShowEvent)
833
c801d85f
KB
834public:
835
2b854a32
VZ
836 wxShowEvent(int id = 0, bool show = FALSE)
837 { m_eventType = wxEVT_SHOW; m_id = id; m_show = show; }
c801d85f 838
2b854a32
VZ
839 void SetShow(bool show) { m_show = show; }
840 bool GetShow() const { return m_show; }
c801d85f 841
aadbdf11
GL
842 void CopyObject(wxObject& obj) const;
843
c801d85f 844protected:
2b854a32 845 bool m_show;
c801d85f
KB
846};
847
848/*
849 wxEVT_ICONIZE
850 */
851
2b854a32 852class WXDLLEXPORT wxIconizeEvent : public wxEvent
c801d85f 853{
2b854a32 854 DECLARE_DYNAMIC_CLASS(wxIconizeEvent)
c801d85f 855
2b854a32
VZ
856public:
857 wxIconizeEvent(int id = 0)
858 { m_eventType = wxEVT_ICONIZE; m_id = id; }
c801d85f
KB
859};
860
861/*
862 wxEVT_MAXIMIZE
863 */
864
2b854a32 865class WXDLLEXPORT wxMaximizeEvent : public wxEvent
c801d85f 866{
2b854a32 867 DECLARE_DYNAMIC_CLASS(wxMaximizeEvent)
c801d85f 868
2b854a32
VZ
869public:
870 wxMaximizeEvent(int id = 0)
871 { m_eventType = wxEVT_MAXIMIZE; m_id = id; }
c801d85f
KB
872};
873
874// Joystick event class
875/*
876 wxEVT_JOY_BUTTON_DOWN,
877 wxEVT_JOY_BUTTON_UP,
878 wxEVT_JOY_MOVE,
879 wxEVT_JOY_ZMOVE
880*/
881
882// Which joystick? Same as Windows ids so no conversion necessary.
883#define wxJOYSTICK1 0
884#define wxJOYSTICK2 1
885
886// Which button is down?
887#define wxJOY_BUTTON1 1
888#define wxJOY_BUTTON2 2
889#define wxJOY_BUTTON3 4
890#define wxJOY_BUTTON4 8
891#define wxJOY_BUTTON_ANY -1
892
2b854a32 893class WXDLLEXPORT wxJoystickEvent : public wxEvent
c801d85f 894{
2b854a32
VZ
895 DECLARE_DYNAMIC_CLASS(wxJoystickEvent)
896
897public:
898 wxPoint m_pos;
899 int m_zPosition;
900 int m_buttonChange; // Which button changed?
901 int m_buttonState; // Which buttons are down?
902 int m_joyStick; // Which joystick?
903
904 wxJoystickEvent(wxEventType type = wxEVT_NULL,
905 int state = 0,
906 int joystick = wxJOYSTICK1,
907 int change = 0)
908 {
909 m_eventType = type;
910 m_buttonState = state;
911 m_pos = wxPoint(0,0);
912 m_zPosition = 0;
913 m_joyStick = joystick;
914 m_buttonChange = change;
915 }
916
917 wxPoint GetPosition() const { return m_pos; }
918 int GetZPosition() const { return m_zPosition; }
919 int GetButtonState() const { return m_buttonState; }
920 int GetButtonChange() const { return m_buttonChange; }
921 int GetJoystick() const { return m_joyStick; }
922
923 void SetJoystick(int stick) { m_joyStick = stick; }
924 void SetButtonState(int state) { m_buttonState = state; }
925 void SetButtonChange(int change) { m_buttonChange = change; }
926 void SetPosition(const wxPoint& pos) { m_pos = pos; }
927 void SetZPosition(int zPos) { m_zPosition = zPos; }
928
929 // Was it a button event? (*doesn't* mean: is any button *down*?)
930 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) ||
931 (GetEventType() == wxEVT_JOY_BUTTON_DOWN)); }
932
933 // Was it a move event?
934 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE) ; }
935
936 // Was it a zmove event?
937 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE) ; }
938
939 // Was it a down event from button 1, 2, 3, 4 or any?
940 bool ButtonDown(int but = wxJOY_BUTTON_ANY) const
c801d85f 941 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) &&
2b854a32 942 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
c801d85f 943
2b854a32
VZ
944 // Was it a up event from button 1, 2, 3 or any?
945 bool ButtonUp(int but = wxJOY_BUTTON_ANY) const
c801d85f 946 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP) &&
2b854a32 947 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
c801d85f 948
2b854a32
VZ
949 // Was the given button 1,2,3,4 or any in Down state?
950 bool ButtonIsDown(int but = wxJOY_BUTTON_ANY) const
c801d85f 951 { return (((but == wxJOY_BUTTON_ANY) && (m_buttonState != 0)) ||
2b854a32 952 ((m_buttonState & but) == but)); }
c801d85f
KB
953};
954
955// Drop files event class
956/*
957 wxEVT_DROP_FILES
958 */
959
2b854a32 960class WXDLLEXPORT wxDropFilesEvent : public wxEvent
c801d85f 961{
2b854a32 962 DECLARE_DYNAMIC_CLASS(wxDropFilesEvent)
c801d85f 963
2b854a32
VZ
964public:
965 int m_noFiles;
966 wxPoint m_pos;
967 wxString* m_files; // Memory (de)allocated by code calling ProcessEvent
968
969 wxDropFilesEvent(wxEventType type = wxEVT_NULL,
970 int noFiles = 0,
971 wxString *files = (wxString *) NULL)
972 { m_eventType = type; m_noFiles = noFiles; m_files = files; }
973
974 wxPoint GetPosition() const { return m_pos; }
975 int GetNumberOfFiles() const { return m_noFiles; }
976 wxString *GetFiles() const { return m_files; }
c801d85f
KB
977};
978
979// Idle event
980/*
981 wxEVT_IDLE
982 */
983
2b854a32 984class WXDLLEXPORT wxIdleEvent : public wxEvent
c801d85f 985{
2b854a32 986 DECLARE_DYNAMIC_CLASS(wxIdleEvent)
c801d85f
KB
987
988public:
2b854a32
VZ
989 wxIdleEvent()
990 { m_eventType = wxEVT_IDLE; m_requestMore = FALSE; }
c801d85f 991
2b854a32
VZ
992 void RequestMore(bool needMore = TRUE) { m_requestMore = needMore; }
993 bool MoreRequested() const { return m_requestMore; }
c801d85f
KB
994
995protected:
2b854a32 996 bool m_requestMore;
c801d85f
KB
997};
998
999// Update UI event
1000/*
1001 wxEVT_UPDATE_UI
1002 */
1003
1004class WXDLLEXPORT wxMenu;
1005class WXDLLEXPORT wxWindow;
1006
2b854a32 1007class WXDLLEXPORT wxUpdateUIEvent : public wxCommandEvent
c801d85f 1008{
2b854a32 1009 DECLARE_DYNAMIC_CLASS(wxUpdateUIEvent)
c801d85f 1010
2b854a32
VZ
1011public:
1012 wxUpdateUIEvent(wxWindowID commandId = 0)
1013 {
1014 m_eventType = wxEVT_UPDATE_UI;
1015 m_id = commandId;
1016 m_checked = FALSE;
1017 m_setChecked = FALSE;
1018 m_enabled = FALSE;
1019 m_setEnabled = FALSE;
1020 m_setText = FALSE;
1021 m_text = "";
1022 }
1023
1024 bool GetChecked() const { return m_checked; }
1025 bool GetEnabled() const { return m_enabled; }
1026 wxString GetText() const { return m_text; }
1027 bool GetSetText() const { return m_setText; }
1028 bool GetSetChecked() const { return m_setChecked; }
1029 bool GetSetEnabled() const { return m_setEnabled; }
1030
1031 void Check(bool check) { m_checked = check; m_setChecked = TRUE; }
1032 void Enable(bool enable) { m_enabled = enable; m_setEnabled = TRUE; }
1033 void SetText(const wxString& text) { m_text = text; m_setText = TRUE; }
c801d85f 1034
2b854a32
VZ
1035protected:
1036 bool m_checked;
1037 bool m_enabled;
1038 bool m_setEnabled;
1039 bool m_setText;
1040 bool m_setChecked;
1041 wxString m_text;
c801d85f
KB
1042};
1043
1044/*
1045 wxEVT_SYS_COLOUR_CHANGED
1046 */
1047
1048// TODO: shouldn't all events record the window ID?
2b854a32 1049class WXDLLEXPORT wxSysColourChangedEvent : public wxEvent
c801d85f 1050{
2b854a32 1051 DECLARE_DYNAMIC_CLASS(wxSysColourChangedEvent)
c801d85f 1052
2b854a32
VZ
1053public:
1054 wxSysColourChangedEvent()
1055 { m_eventType = wxEVT_SYS_COLOUR_CHANGED; }
c801d85f
KB
1056};
1057
f7bd2698
JS
1058/*
1059 wxEVT_PALETTE_CHANGED
1060 */
1061
2b854a32 1062class WXDLLEXPORT wxPaletteChangedEvent : public wxEvent
f7bd2698 1063{
2b854a32 1064 DECLARE_DYNAMIC_CLASS(wxPaletteChangedEvent)
f7bd2698
JS
1065
1066public:
2b854a32
VZ
1067 wxPaletteChangedEvent(wxWindowID id = 0) : wxEvent(id)
1068 {
1069 m_eventType = wxEVT_PALETTE_CHANGED;
1070 m_changedWindow = (wxWindow *) NULL;
1071 }
f7bd2698 1072
2b854a32
VZ
1073 void SetChangedWindow(wxWindow* win) { m_changedWindow = win; }
1074 wxWindow* GetChangedWindow() const { return m_changedWindow; }
f7bd2698
JS
1075
1076protected:
2b854a32 1077 wxWindow* m_changedWindow;
f7bd2698
JS
1078};
1079
1080/*
1081 wxEVT_QUERY_NEW_PALETTE
1082 Indicates the window is getting keyboard focus and should re-do its palette.
1083 */
1084
2b854a32 1085class WXDLLEXPORT wxQueryNewPaletteEvent : public wxEvent
f7bd2698 1086{
2b854a32 1087 DECLARE_DYNAMIC_CLASS(wxQueryNewPaletteEvent)
f7bd2698
JS
1088
1089public:
2b854a32
VZ
1090 wxQueryNewPaletteEvent(wxWindowID id = 0): wxEvent(id)
1091 { m_eventType = wxEVT_QUERY_NEW_PALETTE; m_paletteRealized = FALSE; }
f7bd2698 1092
2b854a32
VZ
1093 // App sets this if it changes the palette.
1094 void SetPaletteRealized(bool realized) { m_paletteRealized = realized; }
1095 bool GetPaletteRealized() const { return m_paletteRealized; }
f7bd2698
JS
1096
1097protected:
2b854a32 1098 bool m_paletteRealized;
f7bd2698
JS
1099};
1100
7fdefd57
VZ
1101/*
1102 Event generated by dialog navigation keys
1103 wxEVT_NAVIGATION_KEY
1104 */
1105// must derive from command event to be propagated to the parent
2b854a32 1106class WXDLLEXPORT wxNavigationKeyEvent : public wxCommandEvent
7fdefd57 1107{
2b854a32 1108 DECLARE_DYNAMIC_CLASS(wxNavigationKeyEvent)
7fdefd57
VZ
1109
1110public:
2b854a32 1111 wxNavigationKeyEvent() : wxCommandEvent(wxEVT_NAVIGATION_KEY) { }
7fdefd57 1112
2b854a32
VZ
1113 // direction: forward (true) or backward (false)
1114 bool GetDirection() const { return m_commandInt == 1; }
1115 void SetDirection(bool bForward) { m_commandInt = bForward; }
7fdefd57 1116
2b854a32
VZ
1117 // it may be a window change event (MDI, notebook pages...) or a control
1118 // change event
1119 bool IsWindowChange() const { return m_extraLong == 1; }
1120 void SetWindowChange(bool bIs) { m_extraLong = bIs; }
7fdefd57 1121
2b854a32
VZ
1122 // the child which has the focus currently (may be NULL - use
1123 // wxWindow::FindFocus then)
1124 wxWindow* GetCurrentFocus() const { return (wxWindow *)m_clientData; }
1125 void SetCurrentFocus(wxWindow *win) { m_clientData = (void *)win; }
7fdefd57
VZ
1126};
1127
e5fb7191 1128/* TODO
c801d85f
KB
1129 wxEVT_POWER,
1130 wxEVT_CREATE,
1131 wxEVT_DESTROY,
c801d85f
KB
1132 wxEVT_MOUSE_CAPTURE_CHANGED,
1133 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
c801d85f
KB
1134// wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
1135 // wxEVT_FONT_CHANGED to all other windows (maybe).
1136 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
1137 wxEVT_MEASURE_ITEM,
1138 wxEVT_COMPARE_ITEM
1139*/
1140
1141class WXDLLEXPORT wxWindow;
1142class WXDLLEXPORT wxControl;
1143
1144// struct WXDLLEXPORT wxEventTableEntry;
1145
1146typedef void (wxObject::*wxObjectEventFunction)(wxEvent&);
1147
1148struct WXDLLEXPORT wxEventTableEntry
1149{
003a43dc 1150 // For some reason, this can't be wxEventType, or VC++ complains.
2b854a32
VZ
1151 int m_eventType; // main event type
1152 int m_id; // control/menu/toolbar id
1153 int m_lastId; // used for ranges of ids
1154 wxObjectEventFunction m_fn; // function to call: not wxEventFunction,
1155 // because of dependency problems
1156
1157 wxObject* m_callbackUserData;
c801d85f
KB
1158};
1159
1160struct WXDLLEXPORT wxEventTable
1161{
2b854a32
VZ
1162 const wxEventTable *baseTable; // Points to base event table (next in chain)
1163 const wxEventTableEntry *entries; // Points to bottom of entry array
c801d85f
KB
1164};
1165
2b854a32 1166class WXDLLEXPORT wxEvtHandler : public wxObject
c801d85f 1167{
2b854a32
VZ
1168 DECLARE_DYNAMIC_CLASS(wxEvtHandler)
1169
1170public:
1171 wxEvtHandler();
1172 ~wxEvtHandler();
1173
1174 wxEvtHandler *GetNextHandler() const { return m_nextHandler; }
1175 wxEvtHandler *GetPreviousHandler() const { return m_previousHandler; }
1176 void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
1177 void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
1178
1179 void SetEvtHandlerEnabled(bool en) { m_enabled = en; }
1180 bool GetEvtHandlerEnabled() const { return m_enabled; }
1181
1182 virtual void OnCommand(wxWindow& WXUNUSED(win),
1183 wxCommandEvent& WXUNUSED(event))
1184 {
1185 }
1186
1187 // Called if child control has no
1188 // callback function
1189 // Default behaviour
1190 virtual long Default()
1191 { return GetNextHandler() ? GetNextHandler()->Default() : 0; };
1192
e3065973 1193#if WXWIN_COMPATIBILITY
2b854a32 1194 virtual bool OnClose();
e3065973 1195#endif
2b854a32 1196
7214297d
GL
1197#if wxUSE_THREADS
1198 bool ProcessThreadEvent(wxEvent& event);
1199 void ProcessPendingEvents();
1200#endif
2b854a32
VZ
1201 virtual bool ProcessEvent(wxEvent& event);
1202 virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
1203
1204 // Dynamic association of a member function handler with the event handler,
1205 // id and event type
1206 void Connect( int id, int lastId, wxEventType eventType,
1207 wxObjectEventFunction func,
1208 wxObject *userData = (wxObject *) NULL );
1209
1210 // Convenience function: take just one id
1211 void Connect( int id, wxEventType eventType,
1212 wxObjectEventFunction func,
1213 wxObject *userData = (wxObject *) NULL )
1214 { Connect(id, -1, eventType, func, userData); }
1215
1216 bool SearchDynamicEventTable( wxEvent& event );
c801d85f 1217
63863e09
JS
1218#if wxUSE_THREADS
1219 void ClearEventLocker() { delete m_eventsLocker; m_eventsLocker = NULL; };
1220#endif
1221
c801d85f 1222private:
2b854a32
VZ
1223 static const wxEventTableEntry sm_eventTableEntries[];
1224
c801d85f 1225protected:
193bf013
VZ
1226 static const wxEventTable sm_eventTable;
1227
1228 virtual const wxEventTable *GetEventTable() const;
1229
c801d85f 1230protected:
63863e09
JS
1231 wxEvtHandler* m_nextHandler;
1232 wxEvtHandler* m_previousHandler;
1233 bool m_enabled; // Is event handler enabled?
1234 wxList* m_dynamicEvents;
1235 wxList* m_pendingEvents;
7214297d 1236#if wxUSE_THREADS
63863e09 1237 wxCriticalSection* m_eventsLocker;
7214297d 1238#endif
193bf013
VZ
1239
1240 // optimization: instead of using costly IsKindOf() to decide whether we're
1241 // a window (which is true in 99% of cases), use this flag
63863e09 1242 bool m_isWindow;
c801d85f
KB
1243};
1244
1245typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
1246typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&);
1247typedef void (wxEvtHandler::*wxScrollEventFunction)(wxScrollEvent&);
1248typedef void (wxEvtHandler::*wxSizeEventFunction)(wxSizeEvent&);
1249typedef void (wxEvtHandler::*wxMoveEventFunction)(wxMoveEvent&);
1250typedef void (wxEvtHandler::*wxPaintEventFunction)(wxPaintEvent&);
1251typedef void (wxEvtHandler::*wxEraseEventFunction)(wxEraseEvent&);
1252typedef void (wxEvtHandler::*wxMouseEventFunction)(wxMouseEvent&);
1253typedef void (wxEvtHandler::*wxCharEventFunction)(wxKeyEvent&);
1254typedef void (wxEvtHandler::*wxFocusEventFunction)(wxFocusEvent&);
1255typedef void (wxEvtHandler::*wxActivateEventFunction)(wxActivateEvent&);
1256typedef void (wxEvtHandler::*wxMenuEventFunction)(wxMenuEvent&);
1257typedef void (wxEvtHandler::*wxJoystickEventFunction)(wxJoystickEvent&);
1258typedef void (wxEvtHandler::*wxDropFilesEventFunction)(wxDropFilesEvent&);
1259typedef void (wxEvtHandler::*wxInitDialogEventFunction)(wxInitDialogEvent&);
1260typedef void (wxEvtHandler::*wxSysColourChangedFunction)(wxSysColourChangedEvent&);
1261typedef void (wxEvtHandler::*wxUpdateUIEventFunction)(wxUpdateUIEvent&);
1262typedef void (wxEvtHandler::*wxIdleEventFunction)(wxIdleEvent&);
1263typedef void (wxEvtHandler::*wxCloseEventFunction)(wxCloseEvent&);
1264typedef void (wxEvtHandler::*wxShowEventFunction)(wxShowEvent&);
1265typedef void (wxEvtHandler::*wxIconizeEventFunction)(wxShowEvent&);
1266typedef void (wxEvtHandler::*wxMaximizeEventFunction)(wxShowEvent&);
81d66cf3 1267typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&);
f7bd2698
JS
1268typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&);
1269typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&);
c801d85f
KB
1270
1271// N.B. In GNU-WIN32, you *have* to take the address of a member function
1272// (use &) or the compiler crashes...
1273
1274#define DECLARE_EVENT_TABLE() \
1275private:\
2b854a32 1276 static const wxEventTableEntry sm_eventTableEntries[];\
c801d85f 1277protected:\
2b854a32
VZ
1278 static const wxEventTable sm_eventTable;\
1279 virtual const wxEventTable* GetEventTable() const;
c801d85f
KB
1280
1281#define BEGIN_EVENT_TABLE(theClass, baseClass) \
1282const wxEventTable *theClass::GetEventTable() const { return &theClass::sm_eventTable; }\
1283const wxEventTable theClass::sm_eventTable =\
2b854a32 1284 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] };\
c801d85f
KB
1285const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
1286
1287#define END_EVENT_TABLE() \
74e34480 1288 { 0, 0, 0, 0, 0 } };
2b854a32 1289
c801d85f
KB
1290/*
1291 * Event table macros
1292 */
1293
1294// Generic events
c67daf87
UR
1295#define EVT_CUSTOM(event, id, func) { event, id, -1, (wxObjectEventFunction) (wxEventFunction) & func, (wxObject *) NULL },
1296#define EVT_CUSTOM_RANGE(event, id1, id2, func) { event, id1, id2, (wxObjectEventFunction) (wxEventFunction) & func, (wxObject *) NULL },
c801d85f
KB
1297
1298// Miscellaneous
c67daf87
UR
1299#define EVT_SIZE(func) { wxEVT_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxSizeEventFunction) & func, (wxObject *) NULL },
1300#define EVT_MOVE(func) { wxEVT_MOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMoveEventFunction) & func, (wxObject *) NULL },
1301#define EVT_CLOSE(func) { wxEVT_CLOSE_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL },
387a3b02
JS
1302#define EVT_END_SESSION(func) { wxEVT_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL },
1303#define EVT_QUERY_END_SESSION(func) { wxEVT_QUERY_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL },
c67daf87
UR
1304#define EVT_PAINT(func) { wxEVT_PAINT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxPaintEventFunction) & func, (wxObject *) NULL },
1305#define EVT_ERASE_BACKGROUND(func) { wxEVT_ERASE_BACKGROUND, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxEraseEventFunction) & func, (wxObject *) NULL },
1306#define EVT_CHAR(func) { wxEVT_CHAR, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, (wxObject *) NULL },
4ce81a75
JS
1307#define EVT_KEY_DOWN(func) { wxEVT_KEY_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, (wxObject *) NULL },
1308#define EVT_KEY_UP(func) { wxEVT_KEY_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, (wxObject *) NULL },
fe71f65c 1309#define EVT_CHAR_HOOK(func) { wxEVT_CHAR_HOOK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCharEventFunction) & func, NULL },
c67daf87
UR
1310#define EVT_MENU_HIGHLIGHT(id, func) { wxEVT_MENU_HIGHLIGHT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxMenuEventFunction) & func, (wxObject *) NULL },
1311#define EVT_MENU_HIGHLIGHT_ALL(func) { wxEVT_MENU_HIGHLIGHT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMenuEventFunction) & func, (wxObject *) NULL },
1312#define EVT_SET_FOCUS(func) { wxEVT_SET_FOCUS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxFocusEventFunction) & func, (wxObject *) NULL },
1313#define EVT_KILL_FOCUS(func) { wxEVT_KILL_FOCUS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxFocusEventFunction) & func, (wxObject *) NULL },
1314#define EVT_ACTIVATE(func) { wxEVT_ACTIVATE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxActivateEventFunction) & func, (wxObject *) NULL },
1315#define EVT_ACTIVATE_APP(func) { wxEVT_ACTIVATE_APP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxActivateEventFunction) & func, (wxObject *) NULL },
1316#define EVT_END_SESSION(func) { wxEVT_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL },
1317#define EVT_QUERY_END_SESSION(func) { wxEVT_QUERY_END_SESSION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCloseEventFunction) & func, (wxObject *) NULL },
1318#define EVT_DROP_FILES(func) { wxEVT_DROP_FILES, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxDropFilesEventFunction) & func, (wxObject *) NULL },
1319#define EVT_INIT_DIALOG(func) { wxEVT_INIT_DIALOG, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxInitDialogEventFunction) & func, (wxObject *) NULL },
1320#define EVT_SYS_COLOUR_CHANGED(func) { wxEVT_SYS_COLOUR_CHANGED, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxSysColourChangedFunction) & func, (wxObject *) NULL },
1321#define EVT_SHOW(func) { wxEVT_SHOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxShowEventFunction) & func, (wxObject *) NULL },
1322#define EVT_MAXIMIZE(func) { wxEVT_MAXIMIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMaximizeEventFunction) & func, (wxObject *) NULL },
1323#define EVT_ICONIZE(func) { wxEVT_ICONIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxIconizeEventFunction) & func, (wxObject *) NULL },
1324#define EVT_NAVIGATION_KEY(func) { wxEVT_NAVIGATION_KEY, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxNavigationKeyEventFunction) & func, (wxObject *) NULL },
1325#define EVT_PALETTE_CHANGED(func) { wxEVT_PALETTE_CHANGED, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxPaletteChangedEventFunction) & func, (wxObject *) NULL },
1326#define EVT_QUERY_NEW_PALETTE(func) { wxEVT_QUERY_NEW_PALETTE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxQueryNewPaletteEventFunction) & func, (wxObject *) NULL },
c801d85f
KB
1327
1328// Mouse events
c67daf87
UR
1329#define EVT_LEFT_DOWN(func) { wxEVT_LEFT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1330#define EVT_LEFT_UP(func) { wxEVT_LEFT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1331#define EVT_MIDDLE_DOWN(func) { wxEVT_MIDDLE_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1332#define EVT_MIDDLE_UP(func) { wxEVT_MIDDLE_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1333#define EVT_RIGHT_DOWN(func) { wxEVT_RIGHT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1334#define EVT_RIGHT_UP(func) { wxEVT_RIGHT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1335#define EVT_MOTION(func) { wxEVT_MOTION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1336#define EVT_LEFT_DCLICK(func) { wxEVT_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1337#define EVT_MIDDLE_DCLICK(func) { wxEVT_MIDDLE_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1338#define EVT_RIGHT_DCLICK(func) { wxEVT_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1339#define EVT_LEAVE_WINDOW(func) { wxEVT_LEAVE_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
1340#define EVT_ENTER_WINDOW(func) { wxEVT_ENTER_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
c801d85f
KB
1341
1342// All mouse events
1343#define EVT_MOUSE_EVENTS(func) \
c67daf87
UR
1344 { wxEVT_LEFT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1345 { wxEVT_LEFT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1346 { wxEVT_MIDDLE_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1347 { wxEVT_MIDDLE_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1348 { wxEVT_RIGHT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1349 { wxEVT_RIGHT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1350 { wxEVT_MOTION, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1351 { wxEVT_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1352 { wxEVT_MIDDLE_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1353 { wxEVT_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1354 { wxEVT_ENTER_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },\
1355 { wxEVT_LEAVE_WINDOW, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxMouseEventFunction) & func, (wxObject *) NULL },
c801d85f
KB
1356
1357// EVT_COMMAND
1f112209 1358#define EVT_COMMAND(id, event, fn) { event, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
dbdb39b2 1359#define EVT_COMMAND_RANGE(id1, id2, event, fn) { event, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
c801d85f
KB
1360
1361// Scrolling
1362#define EVT_SCROLL(func) \
c67daf87
UR
1363 { wxEVT_SCROLL_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1364 { wxEVT_SCROLL_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1365 { wxEVT_SCROLL_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1366 { wxEVT_SCROLL_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1367 { wxEVT_SCROLL_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1368 { wxEVT_SCROLL_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1369 { wxEVT_SCROLL_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1370
1371#define EVT_SCROLL_TOP(func) { wxEVT_SCROLL_TOP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1372#define EVT_SCROLL_BOTTOM(func) { wxEVT_SCROLL_BOTTOM, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1373#define EVT_SCROLL_LINEUP(func) { wxEVT_SCROLL_LINEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1374#define EVT_SCROLL_LINEDOWN(func) { wxEVT_SCROLL_LINEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1375#define EVT_SCROLL_PAGEUP(func) { wxEVT_SCROLL_PAGEUP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1376#define EVT_SCROLL_PAGEDOWN(func) { wxEVT_SCROLL_PAGEDOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1377#define EVT_SCROLL_THUMBTRACK(func) { wxEVT_SCROLL_THUMBTRACK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
c801d85f
KB
1378
1379// Scrolling, with an id
1380#define EVT_COMMAND_SCROLL(id, func) \
c67daf87
UR
1381 { wxEVT_SCROLL_TOP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1382 { wxEVT_SCROLL_BOTTOM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1383 { wxEVT_SCROLL_LINEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1384 { wxEVT_SCROLL_LINEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1385 { wxEVT_SCROLL_PAGEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1386 { wxEVT_SCROLL_PAGEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },\
1387 { wxEVT_SCROLL_THUMBTRACK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1388
1389#define EVT_COMMAND_SCROLL_TOP(id, func) { wxEVT_SCROLL_TOP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1390#define EVT_COMMAND_SCROLL_BOTTOM(id, func) { wxEVT_SCROLL_BOTTOM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1391#define EVT_COMMAND_SCROLL_LINEUP(id, func) { wxEVT_SCROLL_LINEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1392#define EVT_COMMAND_SCROLL_LINEDOWN(id, func) { wxEVT_SCROLL_LINEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1393#define EVT_COMMAND_SCROLL_PAGEUP(id, func) { wxEVT_SCROLL_PAGEUP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1394#define EVT_COMMAND_SCROLL_PAGEDOWN(id, func) { wxEVT_SCROLL_PAGEDOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
1395#define EVT_COMMAND_SCROLL_THUMBTRACK(id, func) { wxEVT_SCROLL_THUMBTRACK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxScrollEventFunction) & func, (wxObject *) NULL },
c801d85f
KB
1396
1397// Convenience macros for commonly-used commands
c67daf87
UR
1398#define EVT_BUTTON(id, fn) { wxEVT_COMMAND_BUTTON_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1399#define EVT_CHECKBOX(id, fn) { wxEVT_COMMAND_CHECKBOX_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1400#define EVT_CHOICE(id, fn) { wxEVT_COMMAND_CHOICE_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1401#define EVT_LISTBOX(id, fn) { wxEVT_COMMAND_LISTBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1402#define EVT_LISTBOX_DCLICK(id, fn) { wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1403#define EVT_TEXT(id, fn) { wxEVT_COMMAND_TEXT_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1404#define EVT_TEXT_ENTER(id, fn) { wxEVT_COMMAND_TEXT_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1405#define EVT_MENU(id, fn) { wxEVT_COMMAND_MENU_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1406#define EVT_MENU_RANGE(id1, id2, fn) { wxEVT_COMMAND_MENU_SELECTED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1407#define EVT_SLIDER(id, fn) { wxEVT_COMMAND_SLIDER_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1408#define EVT_RADIOBOX(id, fn) { wxEVT_COMMAND_RADIOBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1409#define EVT_RADIOBUTTON(id, fn) { wxEVT_COMMAND_RADIOBUTTON_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
c801d85f 1410// EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
c67daf87
UR
1411#define EVT_SCROLLBAR(id, fn) { wxEVT_COMMAND_SCROLLBAR_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1412#define EVT_VLBOX(id, fn) { wxEVT_COMMAND_VLBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1413#define EVT_COMBOBOX(id, fn) { wxEVT_COMMAND_COMBOBOX_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1414#define EVT_TOOL(id, fn) { wxEVT_COMMAND_TOOL_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1415#define EVT_TOOL_RANGE(id1, id2, fn) { wxEVT_COMMAND_TOOL_CLICKED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1416#define EVT_TOOL_RCLICKED(id, fn) { wxEVT_COMMAND_TOOL_RCLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1417#define EVT_TOOL_RCLICKED_RANGE(id1, id2, fn) { wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1418#define EVT_TOOL_ENTER(id, fn) { wxEVT_COMMAND_TOOL_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1419#define EVT_CHECKLISTBOX(id, fn) { wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
c801d85f
KB
1420
1421// Generic command events
c67daf87
UR
1422#define EVT_COMMAND_LEFT_CLICK(id, fn) { wxEVT_COMMAND_LEFT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1423#define EVT_COMMAND_LEFT_DCLICK(id, fn) { wxEVT_COMMAND_LEFT_DCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1424#define EVT_COMMAND_RIGHT_CLICK(id, fn) { wxEVT_COMMAND_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1425#define EVT_COMMAND_RIGHT_DCLICK(id, fn) { wxEVT_COMMAND_RIGHT_DCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1426#define EVT_COMMAND_SET_FOCUS(id, fn) { wxEVT_COMMAND_SET_FOCUS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1427#define EVT_COMMAND_KILL_FOCUS(id, fn) { wxEVT_COMMAND_KILL_FOCUS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
1428#define EVT_COMMAND_ENTER(id, fn) { wxEVT_COMMAND_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
c801d85f
KB
1429
1430// Joystick events
1431#define EVT_JOY_DOWN(func) \
c67daf87 1432 { wxEVT_JOY_BUTTON_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },
c801d85f 1433#define EVT_JOY_UP(func) \
c67daf87 1434 { wxEVT_JOY_BUTTON_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },
c801d85f 1435#define EVT_JOY_MOVE(func) \
c67daf87 1436 { wxEVT_JOY_MOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },
c801d85f 1437#define EVT_JOY_ZMOVE(func) \
c67daf87 1438 { wxEVT_JOY_ZMOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },
c801d85f
KB
1439
1440// All joystick events
1441#define EVT_JOYSTICK_EVENTS(func) \
c67daf87
UR
1442 { wxEVT_JOY_BUTTON_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },\
1443 { wxEVT_JOY_BUTTON_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },\
1444 { wxEVT_JOY_MOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },\
1445 { wxEVT_JOY_ZMOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxJoystickEventFunction) & func, (wxObject *) NULL },\
c801d85f
KB
1446
1447// Idle event
1448#define EVT_IDLE(func) \
c67daf87 1449 { wxEVT_IDLE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxIdleEventFunction) & func, (wxObject *) NULL },\
c801d85f
KB
1450
1451// Update UI event
1452#define EVT_UPDATE_UI(id, func) \
c67daf87 1453 { wxEVT_UPDATE_UI, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxUpdateUIEventFunction) & func, (wxObject *) NULL },\
c801d85f 1454
e702ff0f
JS
1455/*
1456 * Helper functions
1457 */
1458
1459// Find a window with the focus, that is also a descendant of the given window.
1460// This is used to determine the window to initially send commands to.
1461wxWindow* wxFindFocusDescendant(wxWindow* ancestor);
1462
c801d85f 1463#endif
2b854a32 1464 // _WX_EVENTH__