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