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