]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/event.h
use wxSizerFlags and updated CreateButtonSizer() in all generic dialogs
[wxWidgets.git] / include / wx / event.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: wx/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) wxWidgets team
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_EVENT_H__
13#define _WX_EVENT_H__
14
15#include "wx/defs.h"
16#include "wx/object.h"
17#include "wx/clntdata.h"
18
19#if wxUSE_GUI
20 #include "wx/gdicmn.h"
21 #include "wx/cursor.h"
22#endif
23
24#include "wx/thread.h"
25
26#include "wx/dynarray.h"
27
28// ----------------------------------------------------------------------------
29// forward declarations
30// ----------------------------------------------------------------------------
31
32class WXDLLIMPEXP_BASE wxList;
33
34#if wxUSE_GUI
35 class WXDLLIMPEXP_CORE wxDC;
36 class WXDLLIMPEXP_CORE wxMenu;
37 class WXDLLIMPEXP_CORE wxWindow;
38 class WXDLLIMPEXP_CORE wxWindowBase;
39#endif // wxUSE_GUI
40
41class WXDLLIMPEXP_BASE wxEvtHandler;
42
43// ----------------------------------------------------------------------------
44// Event types
45// ----------------------------------------------------------------------------
46
47typedef int wxEventType;
48
49// this is used to make the event table entry type safe, so that for an event
50// handler only a function with proper parameter list can be given.
51#define wxStaticCastEvent(type, val) wx_static_cast(type, val)
52
53// in previous versions of wxWidgets the event types used to be constants
54// which created difficulties with custom/user event types definition
55//
56// starting from wxWidgets 2.4 the event types are now dynamically assigned
57// using wxNewEventType() which solves this problem, however at price of
58// several incompatibilities:
59//
60// a) event table macros declaration changed, it now uses wxEventTableEntry
61// ctor instead of initialisation from an agregate - the macro
62// DECLARE_EVENT_TABLE_ENTRY may be used to write code which can compile
63// with all versions of wxWidgets
64//
65// b) event types can't be used as switch() cases as they're not really
66// constant any more - there is no magic solution here, you just have to
67// change the switch()es to if()s
68//
69// if these are real problems for you, define WXWIN_COMPATIBILITY_EVENT_TYPES
70// as 1 to get 100% old behaviour, however you won't be able to use the
71// libraries using the new dynamic event type allocation in such case, so avoid
72// it if possible.
73#ifndef WXWIN_COMPATIBILITY_EVENT_TYPES
74 #define WXWIN_COMPATIBILITY_EVENT_TYPES 0
75#endif
76
77#if WXWIN_COMPATIBILITY_EVENT_TYPES
78
79#define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
80 { type, winid, idLast, fn, obj }
81
82#define BEGIN_DECLARE_EVENT_TYPES() enum {
83#define END_DECLARE_EVENT_TYPES() };
84#define DECLARE_EVENT_TYPE(name, value) name = wxEVT_FIRST + value,
85#define DECLARE_LOCAL_EVENT_TYPE(name, value) name = wxEVT_USER_FIRST + value,
86#define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \
87 DECLARE_LOCAL_EVENT_TYPE(name, value)
88#define DEFINE_EVENT_TYPE(name)
89#define DEFINE_LOCAL_EVENT_TYPE(name)
90
91
92#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
93
94#define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
95 wxEventTableEntry(type, winid, idLast, fn, obj)
96
97#define EMPTY_PARAMETER_VALUE /* Fake macro parameter value */
98
99#define BEGIN_DECLARE_EVENT_TYPES()
100#define END_DECLARE_EVENT_TYPES()
101#define DECLARE_EXPORTED_EVENT_TYPE(expdecl, name, value) \
102 extern expdecl const wxEventType name;
103#define DECLARE_EVENT_TYPE(name, value) \
104 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_CORE, name, value)
105#define DECLARE_LOCAL_EVENT_TYPE(name, value) \
106 DECLARE_EXPORTED_EVENT_TYPE(EMPTY_PARAMETER_VALUE, name, value)
107#define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
108#define DEFINE_LOCAL_EVENT_TYPE(name) DEFINE_EVENT_TYPE(name)
109
110// generate a new unique event type
111extern WXDLLIMPEXP_BASE wxEventType wxNewEventType();
112
113#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
114
115BEGIN_DECLARE_EVENT_TYPES()
116
117#if WXWIN_COMPATIBILITY_EVENT_TYPES
118 wxEVT_NULL = 0,
119 wxEVT_FIRST = 10000,
120 wxEVT_USER_FIRST = wxEVT_FIRST + 2000,
121#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
122 // it is important to still have these as constants to avoid
123 // initialization order related problems
124 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_NULL, 0)
125 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_FIRST, 10000)
126 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_USER_FIRST, wxEVT_FIRST + 2000)
127#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
128
129 DECLARE_EVENT_TYPE(wxEVT_COMMAND_BUTTON_CLICKED, 1)
130 DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHECKBOX_CLICKED, 2)
131 DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHOICE_SELECTED, 3)
132 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_SELECTED, 4)
133 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 5)
134 DECLARE_EVENT_TYPE(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 6)
135 // now they are in wx/textctrl.h
136#if WXWIN_COMPATIBILITY_EVENT_TYPES
137 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_UPDATED, 7)
138 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_ENTER, 8)
139 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_URL, 13)
140 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_MAXLEN, 14)
141#endif // WXWIN_COMPATIBILITY_EVENT_TYPES
142 DECLARE_EVENT_TYPE(wxEVT_COMMAND_MENU_SELECTED, 9)
143 DECLARE_EVENT_TYPE(wxEVT_COMMAND_SLIDER_UPDATED, 10)
144 DECLARE_EVENT_TYPE(wxEVT_COMMAND_RADIOBOX_SELECTED, 11)
145 DECLARE_EVENT_TYPE(wxEVT_COMMAND_RADIOBUTTON_SELECTED, 12)
146
147 // wxEVT_COMMAND_SCROLLBAR_UPDATED is now obsolete since we use
148 // wxEVT_SCROLL... events
149
150 DECLARE_EVENT_TYPE(wxEVT_COMMAND_SCROLLBAR_UPDATED, 13)
151 DECLARE_EVENT_TYPE(wxEVT_COMMAND_VLBOX_SELECTED, 14)
152 DECLARE_EVENT_TYPE(wxEVT_COMMAND_COMBOBOX_SELECTED, 15)
153 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED, 16)
154 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER, 17)
155 DECLARE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED, 18)
156
157 // Sockets and timers send events, too
158 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_SOCKET, 50)
159 DECLARE_EVENT_TYPE(wxEVT_TIMER , 80)
160
161 // Mouse event types
162 DECLARE_EVENT_TYPE(wxEVT_LEFT_DOWN, 100)
163 DECLARE_EVENT_TYPE(wxEVT_LEFT_UP, 101)
164 DECLARE_EVENT_TYPE(wxEVT_MIDDLE_DOWN, 102)
165 DECLARE_EVENT_TYPE(wxEVT_MIDDLE_UP, 103)
166 DECLARE_EVENT_TYPE(wxEVT_RIGHT_DOWN, 104)
167 DECLARE_EVENT_TYPE(wxEVT_RIGHT_UP, 105)
168 DECLARE_EVENT_TYPE(wxEVT_MOTION, 106)
169 DECLARE_EVENT_TYPE(wxEVT_ENTER_WINDOW, 107)
170 DECLARE_EVENT_TYPE(wxEVT_LEAVE_WINDOW, 108)
171 DECLARE_EVENT_TYPE(wxEVT_LEFT_DCLICK, 109)
172 DECLARE_EVENT_TYPE(wxEVT_MIDDLE_DCLICK, 110)
173 DECLARE_EVENT_TYPE(wxEVT_RIGHT_DCLICK, 111)
174 DECLARE_EVENT_TYPE(wxEVT_SET_FOCUS, 112)
175 DECLARE_EVENT_TYPE(wxEVT_KILL_FOCUS, 113)
176 DECLARE_EVENT_TYPE(wxEVT_CHILD_FOCUS, 114)
177 DECLARE_EVENT_TYPE(wxEVT_MOUSEWHEEL, 115)
178
179 // Non-client mouse events
180 DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN, 200)
181 DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_UP, 201)
182 DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_DOWN, 202)
183 DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_UP, 203)
184 DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_DOWN, 204)
185 DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_UP, 205)
186 DECLARE_EVENT_TYPE(wxEVT_NC_MOTION, 206)
187 DECLARE_EVENT_TYPE(wxEVT_NC_ENTER_WINDOW, 207)
188 DECLARE_EVENT_TYPE(wxEVT_NC_LEAVE_WINDOW, 208)
189 DECLARE_EVENT_TYPE(wxEVT_NC_LEFT_DCLICK, 209)
190 DECLARE_EVENT_TYPE(wxEVT_NC_MIDDLE_DCLICK, 210)
191 DECLARE_EVENT_TYPE(wxEVT_NC_RIGHT_DCLICK, 211)
192
193 // Character input event type
194 DECLARE_EVENT_TYPE(wxEVT_CHAR, 212)
195 DECLARE_EVENT_TYPE(wxEVT_CHAR_HOOK, 213)
196 DECLARE_EVENT_TYPE(wxEVT_NAVIGATION_KEY, 214)
197 DECLARE_EVENT_TYPE(wxEVT_KEY_DOWN, 215)
198 DECLARE_EVENT_TYPE(wxEVT_KEY_UP, 216)
199#if wxUSE_HOTKEY
200 DECLARE_EVENT_TYPE(wxEVT_HOTKEY, 217)
201#endif
202 // Set cursor event
203 DECLARE_EVENT_TYPE(wxEVT_SET_CURSOR, 230)
204
205 // wxScrollBar and wxSlider event identifiers
206 DECLARE_EVENT_TYPE(wxEVT_SCROLL_TOP, 300)
207 DECLARE_EVENT_TYPE(wxEVT_SCROLL_BOTTOM, 301)
208 DECLARE_EVENT_TYPE(wxEVT_SCROLL_LINEUP, 302)
209 DECLARE_EVENT_TYPE(wxEVT_SCROLL_LINEDOWN, 303)
210 DECLARE_EVENT_TYPE(wxEVT_SCROLL_PAGEUP, 304)
211 DECLARE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN, 305)
212 DECLARE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK, 306)
213 DECLARE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE, 307)
214 DECLARE_EVENT_TYPE(wxEVT_SCROLL_CHANGED, 308)
215
216 // Scroll events from wxWindow
217 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP, 320)
218 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_BOTTOM, 321)
219 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEUP, 322)
220 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEDOWN, 323)
221 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEUP, 324)
222 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEDOWN, 325)
223 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBTRACK, 326)
224 DECLARE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBRELEASE, 327)
225
226 // System events
227 DECLARE_EVENT_TYPE(wxEVT_SIZE, 400)
228 DECLARE_EVENT_TYPE(wxEVT_MOVE, 401)
229 DECLARE_EVENT_TYPE(wxEVT_CLOSE_WINDOW, 402)
230 DECLARE_EVENT_TYPE(wxEVT_END_SESSION, 403)
231 DECLARE_EVENT_TYPE(wxEVT_QUERY_END_SESSION, 404)
232 DECLARE_EVENT_TYPE(wxEVT_ACTIVATE_APP, 405)
233 // 406..408 are power events
234 DECLARE_EVENT_TYPE(wxEVT_ACTIVATE, 409)
235 DECLARE_EVENT_TYPE(wxEVT_CREATE, 410)
236 DECLARE_EVENT_TYPE(wxEVT_DESTROY, 411)
237 DECLARE_EVENT_TYPE(wxEVT_SHOW, 412)
238 DECLARE_EVENT_TYPE(wxEVT_ICONIZE, 413)
239 DECLARE_EVENT_TYPE(wxEVT_MAXIMIZE, 414)
240 DECLARE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED, 415)
241 DECLARE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_LOST, 416)
242 DECLARE_EVENT_TYPE(wxEVT_PAINT, 417)
243 DECLARE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND, 418)
244 DECLARE_EVENT_TYPE(wxEVT_NC_PAINT, 419)
245 DECLARE_EVENT_TYPE(wxEVT_PAINT_ICON, 420)
246 DECLARE_EVENT_TYPE(wxEVT_MENU_OPEN, 421)
247 DECLARE_EVENT_TYPE(wxEVT_MENU_CLOSE, 422)
248 DECLARE_EVENT_TYPE(wxEVT_MENU_HIGHLIGHT, 423)
249 DECLARE_EVENT_TYPE(wxEVT_CONTEXT_MENU, 424)
250 DECLARE_EVENT_TYPE(wxEVT_SYS_COLOUR_CHANGED, 425)
251 DECLARE_EVENT_TYPE(wxEVT_DISPLAY_CHANGED, 426)
252 DECLARE_EVENT_TYPE(wxEVT_SETTING_CHANGED, 427)
253 DECLARE_EVENT_TYPE(wxEVT_QUERY_NEW_PALETTE, 428)
254 DECLARE_EVENT_TYPE(wxEVT_PALETTE_CHANGED, 429)
255 DECLARE_EVENT_TYPE(wxEVT_JOY_BUTTON_DOWN, 430)
256 DECLARE_EVENT_TYPE(wxEVT_JOY_BUTTON_UP, 431)
257 DECLARE_EVENT_TYPE(wxEVT_JOY_MOVE, 432)
258 DECLARE_EVENT_TYPE(wxEVT_JOY_ZMOVE, 433)
259 DECLARE_EVENT_TYPE(wxEVT_DROP_FILES, 434)
260 DECLARE_EVENT_TYPE(wxEVT_DRAW_ITEM, 435)
261 DECLARE_EVENT_TYPE(wxEVT_MEASURE_ITEM, 436)
262 DECLARE_EVENT_TYPE(wxEVT_COMPARE_ITEM, 437)
263 DECLARE_EVENT_TYPE(wxEVT_INIT_DIALOG, 438)
264 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_BASE, wxEVT_IDLE, 439)
265 DECLARE_EVENT_TYPE(wxEVT_UPDATE_UI, 440)
266 DECLARE_EVENT_TYPE(wxEVT_SIZING, 441)
267 DECLARE_EVENT_TYPE(wxEVT_MOVING, 442)
268 DECLARE_EVENT_TYPE(wxEVT_HIBERNATE, 443)
269 // more power events follow -- see wx/power.h
270
271 // Clipboard events
272 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_COPY, 444)
273 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_CUT, 445)
274 DECLARE_EVENT_TYPE(wxEVT_COMMAND_TEXT_PASTE, 446)
275
276 // Generic command events
277 // Note: a click is a higher-level event than button down/up
278 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK, 500)
279 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LEFT_DCLICK, 501)
280 DECLARE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_CLICK, 502)
281 DECLARE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_DCLICK, 503)
282 DECLARE_EVENT_TYPE(wxEVT_COMMAND_SET_FOCUS, 504)
283 DECLARE_EVENT_TYPE(wxEVT_COMMAND_KILL_FOCUS, 505)
284 DECLARE_EVENT_TYPE(wxEVT_COMMAND_ENTER, 506)
285
286 // Help events
287 DECLARE_EVENT_TYPE(wxEVT_HELP, 1050)
288 DECLARE_EVENT_TYPE(wxEVT_DETAILED_HELP, 1051)
289
290END_DECLARE_EVENT_TYPES()
291
292// these 2 events are the same
293#define wxEVT_COMMAND_TOOL_CLICKED wxEVT_COMMAND_MENU_SELECTED
294
295// ----------------------------------------------------------------------------
296// Compatibility
297// ----------------------------------------------------------------------------
298
299// this event is also used by wxComboBox and wxSpinCtrl which don't include
300// wx/textctrl.h in all ports [yet], so declare it here as well
301//
302// still, any new code using it should include wx/textctrl.h explicitly
303#if !WXWIN_COMPATIBILITY_EVENT_TYPES
304 extern const wxEventType WXDLLIMPEXP_CORE wxEVT_COMMAND_TEXT_UPDATED;
305#endif
306
307// the predefined constants for the number of times we propagate event
308// upwards window child-parent chain
309enum Propagation_state
310{
311 // don't propagate it at all
312 wxEVENT_PROPAGATE_NONE = 0,
313
314 // propagate it until it is processed
315 wxEVENT_PROPAGATE_MAX = INT_MAX
316};
317
318/*
319 * wxWidgets events, covering all interesting things that might happen
320 * (button clicking, resizing, setting text in widgets, etc.).
321 *
322 * For each completely new event type, derive a new event class.
323 * An event CLASS represents a C++ class defining a range of similar event TYPES;
324 * examples are canvas events, panel item command events.
325 * An event TYPE is a unique identifier for a particular system event,
326 * such as a button press or a listbox deselection.
327 *
328 */
329
330class WXDLLIMPEXP_BASE wxEvent : public wxObject
331{
332private:
333 wxEvent& operator=(const wxEvent&);
334
335protected:
336 wxEvent(const wxEvent&); // for implementing Clone()
337
338public:
339 wxEvent(int winid = 0, wxEventType commandType = wxEVT_NULL );
340
341 void SetEventType(wxEventType typ) { m_eventType = typ; }
342 wxEventType GetEventType() const { return m_eventType; }
343 wxObject *GetEventObject() const { return m_eventObject; }
344 void SetEventObject(wxObject *obj) { m_eventObject = obj; }
345 long GetTimestamp() const { return m_timeStamp; }
346 void SetTimestamp(long ts = 0) { m_timeStamp = ts; }
347 int GetId() const { return m_id; }
348 void SetId(int Id) { m_id = Id; }
349
350 // Can instruct event processor that we wish to ignore this event
351 // (treat as if the event table entry had not been found): this must be done
352 // to allow the event processing by the base classes (calling event.Skip()
353 // is the analog of calling the base class version of a virtual function)
354 void Skip(bool skip = true) { m_skipped = skip; }
355 bool GetSkipped() const { return m_skipped; };
356
357 // this function is used to create a copy of the event polymorphically and
358 // all derived classes must implement it because otherwise wxPostEvent()
359 // for them wouldn't work (it needs to do a copy of the event)
360 virtual wxEvent *Clone() const = 0;
361
362 // Implementation only: this test is explicitly anti OO and this function
363 // exists only for optimization purposes.
364 bool IsCommandEvent() const { return m_isCommandEvent; }
365
366 // Determine if this event should be propagating to the parent window.
367 bool ShouldPropagate() const
368 { return m_propagationLevel != wxEVENT_PROPAGATE_NONE; }
369
370 // Stop an event from propagating to its parent window, returns the old
371 // propagation level value
372 int StopPropagation()
373 {
374 int propagationLevel = m_propagationLevel;
375 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
376 return propagationLevel;
377 }
378
379 // Resume the event propagation by restoring the propagation level
380 // (returned by StopPropagation())
381 void ResumePropagation(int propagationLevel)
382 {
383 m_propagationLevel = propagationLevel;
384 }
385
386#if WXWIN_COMPATIBILITY_2_4
387public:
388#else
389protected:
390#endif
391 wxObject* m_eventObject;
392 wxEventType m_eventType;
393 long m_timeStamp;
394 int m_id;
395
396public:
397 // m_callbackUserData is for internal usage only
398 wxObject* m_callbackUserData;
399
400protected:
401 // the propagation level: while it is positive, we propagate the event to
402 // the parent window (if any)
403 //
404 // this one doesn't have to be public, we don't have to worry about
405 // backwards compatibility as it is new
406 int m_propagationLevel;
407
408#if WXWIN_COMPATIBILITY_2_4
409public:
410#else
411protected:
412#endif
413 bool m_skipped;
414 bool m_isCommandEvent;
415
416private:
417 // it needs to access our m_propagationLevel
418 friend class WXDLLIMPEXP_BASE wxPropagateOnce;
419
420 DECLARE_ABSTRACT_CLASS(wxEvent)
421};
422
423/*
424 * Helper class to temporarily change an event not to propagate.
425 */
426class WXDLLIMPEXP_BASE wxPropagationDisabler
427{
428public:
429 wxPropagationDisabler(wxEvent& event) : m_event(event)
430 {
431 m_propagationLevelOld = m_event.StopPropagation();
432 }
433
434 ~wxPropagationDisabler()
435 {
436 m_event.ResumePropagation(m_propagationLevelOld);
437 }
438
439private:
440 wxEvent& m_event;
441 int m_propagationLevelOld;
442
443 DECLARE_NO_COPY_CLASS(wxPropagationDisabler)
444};
445
446/*
447 * Another one to temporarily lower propagation level.
448 */
449class WXDLLIMPEXP_BASE wxPropagateOnce
450{
451public:
452 wxPropagateOnce(wxEvent& event) : m_event(event)
453 {
454 wxASSERT_MSG( m_event.m_propagationLevel > 0,
455 _T("shouldn't be used unless ShouldPropagate()!") );
456
457 m_event.m_propagationLevel--;
458 }
459
460 ~wxPropagateOnce()
461 {
462 m_event.m_propagationLevel++;
463 }
464
465private:
466 wxEvent& m_event;
467
468 DECLARE_NO_COPY_CLASS(wxPropagateOnce)
469};
470
471#if wxUSE_GUI
472
473
474// Item or menu event class
475/*
476 wxEVT_COMMAND_BUTTON_CLICKED
477 wxEVT_COMMAND_CHECKBOX_CLICKED
478 wxEVT_COMMAND_CHOICE_SELECTED
479 wxEVT_COMMAND_LISTBOX_SELECTED
480 wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
481 wxEVT_COMMAND_TEXT_UPDATED
482 wxEVT_COMMAND_TEXT_ENTER
483 wxEVT_COMMAND_MENU_SELECTED
484 wxEVT_COMMAND_SLIDER_UPDATED
485 wxEVT_COMMAND_RADIOBOX_SELECTED
486 wxEVT_COMMAND_RADIOBUTTON_SELECTED
487 wxEVT_COMMAND_SCROLLBAR_UPDATED
488 wxEVT_COMMAND_VLBOX_SELECTED
489 wxEVT_COMMAND_COMBOBOX_SELECTED
490 wxEVT_COMMAND_TOGGLEBUTTON_CLICKED
491*/
492
493#if WXWIN_COMPATIBILITY_2_4
494// Backwards compatibility for wxCommandEvent::m_commandString, will lead to compilation errors in some cases of usage
495class WXDLLIMPEXP_CORE wxCommandEvent;
496
497class WXDLLIMPEXP_CORE wxCommandEventStringHelper
498{
499public:
500 wxCommandEventStringHelper(wxCommandEvent * evt)
501 : m_evt(evt)
502 { }
503
504 void operator=(const wxString &str);
505 operator wxString();
506 const wxChar* c_str() const;
507
508private:
509 wxCommandEvent* m_evt;
510};
511#endif
512
513class WXDLLIMPEXP_CORE wxCommandEvent : public wxEvent
514{
515public:
516 wxCommandEvent(wxEventType commandType = wxEVT_NULL, int winid = 0);
517
518 wxCommandEvent(const wxCommandEvent& event)
519 : wxEvent(event),
520#if WXWIN_COMPATIBILITY_2_4
521 m_commandString(this),
522#endif
523 m_cmdString(event.m_cmdString),
524 m_commandInt(event.m_commandInt),
525 m_extraLong(event.m_extraLong),
526 m_clientData(event.m_clientData),
527 m_clientObject(event.m_clientObject)
528 { }
529
530 // Set/Get client data from controls
531 void SetClientData(void* clientData) { m_clientData = clientData; }
532 void *GetClientData() const { return m_clientData; }
533
534 // Set/Get client object from controls
535 void SetClientObject(wxClientData* clientObject) { m_clientObject = clientObject; }
536 wxClientData *GetClientObject() const { return m_clientObject; }
537
538 // Get listbox selection if single-choice
539 int GetSelection() const { return m_commandInt; }
540
541 // Set/Get listbox/choice selection string
542 void SetString(const wxString& s) { m_cmdString = s; }
543 wxString GetString() const;
544
545 // Get checkbox value
546 bool IsChecked() const { return m_commandInt != 0; }
547
548 // true if the listbox event was a selection.
549 bool IsSelection() const { return (m_extraLong != 0); }
550
551 void SetExtraLong(long extraLong) { m_extraLong = extraLong; }
552 long GetExtraLong() const { return m_extraLong; }
553
554 void SetInt(int i) { m_commandInt = i; }
555 int GetInt() const { return m_commandInt; }
556
557 virtual wxEvent *Clone() const { return new wxCommandEvent(*this); }
558
559#if WXWIN_COMPATIBILITY_2_4
560public:
561 wxCommandEventStringHelper m_commandString;
562#else
563protected:
564#endif
565 wxString m_cmdString; // String event argument
566 int m_commandInt;
567 long m_extraLong; // Additional information (e.g. select/deselect)
568 void* m_clientData; // Arbitrary client data
569 wxClientData* m_clientObject; // Arbitrary client object
570
571private:
572 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCommandEvent)
573};
574
575#if WXWIN_COMPATIBILITY_2_4
576inline void wxCommandEventStringHelper::operator=(const wxString &str)
577{
578 m_evt->SetString(str);
579}
580
581inline wxCommandEventStringHelper::operator wxString()
582{
583 return m_evt->GetString();
584}
585
586inline const wxChar* wxCommandEventStringHelper::c_str() const
587{
588 return m_evt->GetString().c_str();
589}
590#endif
591
592// this class adds a possibility to react (from the user) code to a control
593// notification: allow or veto the operation being reported.
594class WXDLLIMPEXP_CORE wxNotifyEvent : public wxCommandEvent
595{
596public:
597 wxNotifyEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
598 : wxCommandEvent(commandType, winid)
599 { m_bAllow = true; }
600
601 wxNotifyEvent(const wxNotifyEvent& event)
602 : wxCommandEvent(event)
603 { m_bAllow = event.m_bAllow; }
604
605 // veto the operation (usually it's allowed by default)
606 void Veto() { m_bAllow = false; }
607
608 // allow the operation if it was disabled by default
609 void Allow() { m_bAllow = true; }
610
611 // for implementation code only: is the operation allowed?
612 bool IsAllowed() const { return m_bAllow; }
613
614 virtual wxEvent *Clone() const { return new wxNotifyEvent(*this); }
615
616private:
617 bool m_bAllow;
618
619private:
620 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotifyEvent)
621};
622
623// Scroll event class, derived form wxCommandEvent. wxScrollEvents are
624// sent by wxSlider and wxScrollBar.
625/*
626 wxEVT_SCROLL_TOP
627 wxEVT_SCROLL_BOTTOM
628 wxEVT_SCROLL_LINEUP
629 wxEVT_SCROLL_LINEDOWN
630 wxEVT_SCROLL_PAGEUP
631 wxEVT_SCROLL_PAGEDOWN
632 wxEVT_SCROLL_THUMBTRACK
633 wxEVT_SCROLL_THUMBRELEASE
634 wxEVT_SCROLL_CHANGED
635*/
636
637class WXDLLIMPEXP_CORE wxScrollEvent : public wxCommandEvent
638{
639public:
640 wxScrollEvent(wxEventType commandType = wxEVT_NULL,
641 int winid = 0, int pos = 0, int orient = 0);
642
643 int GetOrientation() const { return (int) m_extraLong; }
644 int GetPosition() const { return m_commandInt; }
645 void SetOrientation(int orient) { m_extraLong = (long) orient; }
646 void SetPosition(int pos) { m_commandInt = pos; }
647
648 virtual wxEvent *Clone() const { return new wxScrollEvent(*this); }
649
650private:
651 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollEvent)
652};
653
654// ScrollWin event class, derived fom wxEvent. wxScrollWinEvents
655// are sent by wxWindow.
656/*
657 wxEVT_SCROLLWIN_TOP
658 wxEVT_SCROLLWIN_BOTTOM
659 wxEVT_SCROLLWIN_LINEUP
660 wxEVT_SCROLLWIN_LINEDOWN
661 wxEVT_SCROLLWIN_PAGEUP
662 wxEVT_SCROLLWIN_PAGEDOWN
663 wxEVT_SCROLLWIN_THUMBTRACK
664 wxEVT_SCROLLWIN_THUMBRELEASE
665*/
666
667class WXDLLIMPEXP_CORE wxScrollWinEvent : public wxEvent
668{
669public:
670 wxScrollWinEvent(wxEventType commandType = wxEVT_NULL,
671 int pos = 0, int orient = 0);
672 wxScrollWinEvent(const wxScrollWinEvent & event) : wxEvent(event)
673 { m_commandInt = event.m_commandInt;
674 m_extraLong = event.m_extraLong; }
675
676 int GetOrientation() const { return (int) m_extraLong; }
677 int GetPosition() const { return m_commandInt; }
678 void SetOrientation(int orient) { m_extraLong = (long) orient; }
679 void SetPosition(int pos) { m_commandInt = pos; }
680
681 virtual wxEvent *Clone() const { return new wxScrollWinEvent(*this); }
682
683#if WXWIN_COMPATIBILITY_2_4
684public:
685#else
686protected:
687#endif
688 int m_commandInt;
689 long m_extraLong;
690
691private:
692 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxScrollWinEvent)
693};
694
695// Mouse event class
696
697/*
698 wxEVT_LEFT_DOWN
699 wxEVT_LEFT_UP
700 wxEVT_MIDDLE_DOWN
701 wxEVT_MIDDLE_UP
702 wxEVT_RIGHT_DOWN
703 wxEVT_RIGHT_UP
704 wxEVT_MOTION
705 wxEVT_ENTER_WINDOW
706 wxEVT_LEAVE_WINDOW
707 wxEVT_LEFT_DCLICK
708 wxEVT_MIDDLE_DCLICK
709 wxEVT_RIGHT_DCLICK
710 wxEVT_NC_LEFT_DOWN
711 wxEVT_NC_LEFT_UP,
712 wxEVT_NC_MIDDLE_DOWN,
713 wxEVT_NC_MIDDLE_UP,
714 wxEVT_NC_RIGHT_DOWN,
715 wxEVT_NC_RIGHT_UP,
716 wxEVT_NC_MOTION,
717 wxEVT_NC_ENTER_WINDOW,
718 wxEVT_NC_LEAVE_WINDOW,
719 wxEVT_NC_LEFT_DCLICK,
720 wxEVT_NC_MIDDLE_DCLICK,
721 wxEVT_NC_RIGHT_DCLICK,
722*/
723
724// the symbolic names for the mouse buttons
725enum
726{
727 wxMOUSE_BTN_ANY = -1,
728 wxMOUSE_BTN_NONE = 0,
729 wxMOUSE_BTN_LEFT = 1,
730 wxMOUSE_BTN_MIDDLE = 2,
731 wxMOUSE_BTN_RIGHT = 3
732};
733
734class WXDLLIMPEXP_CORE wxMouseEvent : public wxEvent
735{
736public:
737 wxMouseEvent(wxEventType mouseType = wxEVT_NULL);
738 wxMouseEvent(const wxMouseEvent& event) : wxEvent(event)
739 { Assign(event); }
740
741 // Was it a button event? (*doesn't* mean: is any button *down*?)
742 bool IsButton() const { return Button(wxMOUSE_BTN_ANY); }
743
744 // Was it a down event from this (or any) button?
745 bool ButtonDown(int but = wxMOUSE_BTN_ANY) const;
746
747 // Was it a dclick event from this (or any) button?
748 bool ButtonDClick(int but = wxMOUSE_BTN_ANY) const;
749
750 // Was it a up event from this (or any) button?
751 bool ButtonUp(int but = wxMOUSE_BTN_ANY) const;
752
753 // Was the given button?
754 bool Button(int but) const;
755
756 // Was the given button in Down state?
757 bool ButtonIsDown(int but) const;
758
759 // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
760 int GetButton() const;
761
762 // Find state of shift/control keys
763 bool ControlDown() const { return m_controlDown; }
764 bool MetaDown() const { return m_metaDown; }
765 bool AltDown() const { return m_altDown; }
766 bool ShiftDown() const { return m_shiftDown; }
767 bool CmdDown() const
768 {
769#if defined(__WXMAC__) || defined(__WXCOCOA__)
770 return MetaDown();
771#else
772 return ControlDown();
773#endif
774 }
775
776 // Find which event was just generated
777 bool LeftDown() const { return (m_eventType == wxEVT_LEFT_DOWN); }
778 bool MiddleDown() const { return (m_eventType == wxEVT_MIDDLE_DOWN); }
779 bool RightDown() const { return (m_eventType == wxEVT_RIGHT_DOWN); }
780
781 bool LeftUp() const { return (m_eventType == wxEVT_LEFT_UP); }
782 bool MiddleUp() const { return (m_eventType == wxEVT_MIDDLE_UP); }
783 bool RightUp() const { return (m_eventType == wxEVT_RIGHT_UP); }
784
785 bool LeftDClick() const { return (m_eventType == wxEVT_LEFT_DCLICK); }
786 bool MiddleDClick() const { return (m_eventType == wxEVT_MIDDLE_DCLICK); }
787 bool RightDClick() const { return (m_eventType == wxEVT_RIGHT_DCLICK); }
788
789 // Find the current state of the mouse buttons (regardless
790 // of current event type)
791 bool LeftIsDown() const { return m_leftDown; }
792 bool MiddleIsDown() const { return m_middleDown; }
793 bool RightIsDown() const { return m_rightDown; }
794
795 // True if a button is down and the mouse is moving
796 bool Dragging() const
797 {
798 return (m_eventType == wxEVT_MOTION) && ButtonIsDown(wxMOUSE_BTN_ANY);
799 }
800
801 // True if the mouse is moving, and no button is down
802 bool Moving() const
803 {
804 return (m_eventType == wxEVT_MOTION) && !ButtonIsDown(wxMOUSE_BTN_ANY);
805 }
806
807 // True if the mouse is just entering the window
808 bool Entering() const { return (m_eventType == wxEVT_ENTER_WINDOW); }
809
810 // True if the mouse is just leaving the window
811 bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); }
812
813 // Find the position of the event
814 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
815 {
816 if (xpos)
817 *xpos = m_x;
818 if (ypos)
819 *ypos = m_y;
820 }
821
822 void GetPosition(long *xpos, long *ypos) const
823 {
824 if (xpos)
825 *xpos = (long)m_x;
826 if (ypos)
827 *ypos = (long)m_y;
828 }
829
830 // Find the position of the event
831 wxPoint GetPosition() const { return wxPoint(m_x, m_y); }
832
833 // Find the logical position of the event given the DC
834 wxPoint GetLogicalPosition(const wxDC& dc) const;
835
836 // Get X position
837 wxCoord GetX() const { return m_x; }
838
839 // Get Y position
840 wxCoord GetY() const { return m_y; }
841
842 // Get wheel rotation, positive or negative indicates direction of
843 // rotation. Current devices all send an event when rotation is equal to
844 // +/-WheelDelta, but this allows for finer resolution devices to be
845 // created in the future. Because of this you shouldn't assume that one
846 // event is equal to 1 line or whatever, but you should be able to either
847 // do partial line scrolling or wait until +/-WheelDelta rotation values
848 // have been accumulated before scrolling.
849 int GetWheelRotation() const { return m_wheelRotation; }
850
851 // Get wheel delta, normally 120. This is the threshold for action to be
852 // taken, and one such action (for example, scrolling one increment)
853 // should occur for each delta.
854 int GetWheelDelta() const { return m_wheelDelta; }
855
856 // Returns the configured number of lines (or whatever) to be scrolled per
857 // wheel action. Defaults to one.
858 int GetLinesPerAction() const { return m_linesPerAction; }
859
860 // Is the system set to do page scrolling?
861 bool IsPageScroll() const { return ((unsigned int)m_linesPerAction == UINT_MAX); }
862
863 virtual wxEvent *Clone() const { return new wxMouseEvent(*this); }
864
865 wxMouseEvent& operator=(const wxMouseEvent& event) { Assign(event); return *this; }
866
867public:
868 wxCoord m_x, m_y;
869
870 bool m_leftDown;
871 bool m_middleDown;
872 bool m_rightDown;
873
874 bool m_controlDown;
875 bool m_shiftDown;
876 bool m_altDown;
877 bool m_metaDown;
878
879 int m_wheelRotation;
880 int m_wheelDelta;
881 int m_linesPerAction;
882
883protected:
884 void Assign(const wxMouseEvent& evt);
885
886private:
887 DECLARE_DYNAMIC_CLASS(wxMouseEvent)
888};
889
890// Cursor set event
891
892/*
893 wxEVT_SET_CURSOR
894 */
895
896class WXDLLIMPEXP_CORE wxSetCursorEvent : public wxEvent
897{
898public:
899 wxSetCursorEvent(wxCoord x = 0, wxCoord y = 0)
900 : wxEvent(0, wxEVT_SET_CURSOR),
901 m_x(x), m_y(y), m_cursor()
902 { }
903
904 wxSetCursorEvent(const wxSetCursorEvent & event)
905 : wxEvent(event),
906 m_x(event.m_x),
907 m_y(event.m_y),
908 m_cursor(event.m_cursor)
909 { }
910
911 wxCoord GetX() const { return m_x; }
912 wxCoord GetY() const { return m_y; }
913
914 void SetCursor(const wxCursor& cursor) { m_cursor = cursor; }
915 const wxCursor& GetCursor() const { return m_cursor; }
916 bool HasCursor() const { return m_cursor.Ok(); }
917
918 virtual wxEvent *Clone() const { return new wxSetCursorEvent(*this); }
919
920private:
921 wxCoord m_x, m_y;
922 wxCursor m_cursor;
923
924private:
925 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSetCursorEvent)
926};
927
928// Keyboard input event class
929
930/*
931 wxEVT_CHAR
932 wxEVT_CHAR_HOOK
933 wxEVT_KEY_DOWN
934 wxEVT_KEY_UP
935 wxEVT_HOTKEY
936 */
937
938class WXDLLIMPEXP_CORE wxKeyEvent : public wxEvent
939{
940public:
941 wxKeyEvent(wxEventType keyType = wxEVT_NULL);
942 wxKeyEvent(const wxKeyEvent& evt);
943
944 // can be used check if the key event has exactly the given modifiers:
945 // "GetModifiers() = wxMOD_CONTROL" is easier to write than "ControlDown()
946 // && !MetaDown() && !AltDown() && !ShiftDown()"
947 int GetModifiers() const
948 {
949 return (m_controlDown ? wxMOD_CONTROL : 0) |
950 (m_shiftDown ? wxMOD_SHIFT : 0) |
951 (m_metaDown ? wxMOD_META : 0) |
952 (m_altDown ? wxMOD_ALT : 0);
953 }
954
955 // Find state of shift/control keys
956 bool ControlDown() const { return m_controlDown; }
957 bool ShiftDown() const { return m_shiftDown; }
958 bool MetaDown() const { return m_metaDown; }
959 bool AltDown() const { return m_altDown; }
960
961 // "Cmd" is a pseudo key which is Control for PC and Unix platforms but
962 // Apple ("Command") key under Macs: it makes often sense to use it instead
963 // of, say, ControlDown() because Cmd key is used for the same thing under
964 // Mac as Ctrl elsewhere (but Ctrl still exists, just not used for this
965 // purpose under Mac)
966 bool CmdDown() const
967 {
968#if defined(__WXMAC__) || defined(__WXCOCOA__)
969 return MetaDown();
970#else
971 return ControlDown();
972#endif
973 }
974
975 // exclude MetaDown() from HasModifiers() because NumLock under X is often
976 // configured as mod2 modifier, yet the key events even when it is pressed
977 // should be processed normally, not like Ctrl- or Alt-key
978 bool HasModifiers() const { return ControlDown() || AltDown(); }
979
980 // get the key code: an ASCII7 char or an element of wxKeyCode enum
981 int GetKeyCode() const { return (int)m_keyCode; }
982
983#if wxUSE_UNICODE
984 // get the Unicode character corresponding to this key
985 wxChar GetUnicodeKey() const { return m_uniChar; }
986#endif // wxUSE_UNICODE
987
988 // get the raw key code (platform-dependent)
989 wxUint32 GetRawKeyCode() const { return m_rawCode; }
990
991 // get the raw key flags (platform-dependent)
992 wxUint32 GetRawKeyFlags() const { return m_rawFlags; }
993
994 // Find the position of the event
995 void GetPosition(wxCoord *xpos, wxCoord *ypos) const
996 {
997 if (xpos) *xpos = m_x;
998 if (ypos) *ypos = m_y;
999 }
1000
1001 void GetPosition(long *xpos, long *ypos) const
1002 {
1003 if (xpos) *xpos = (long)m_x;
1004 if (ypos) *ypos = (long)m_y;
1005 }
1006
1007 wxPoint GetPosition() const
1008 { return wxPoint(m_x, m_y); }
1009
1010 // Get X position
1011 wxCoord GetX() const { return m_x; }
1012
1013 // Get Y position
1014 wxCoord GetY() const { return m_y; }
1015
1016#if WXWIN_COMPATIBILITY_2_6
1017 // deprecated, Use GetKeyCode instead.
1018 wxDEPRECATED( long KeyCode() const );
1019#endif // WXWIN_COMPATIBILITY_2_6
1020
1021 virtual wxEvent *Clone() const { return new wxKeyEvent(*this); }
1022
1023 // we do need to copy wxKeyEvent sometimes (in wxTreeCtrl code, for
1024 // example)
1025 wxKeyEvent& operator=(const wxKeyEvent& evt)
1026 {
1027 m_x = evt.m_x;
1028 m_y = evt.m_y;
1029
1030 m_keyCode = evt.m_keyCode;
1031
1032 m_controlDown = evt.m_controlDown;
1033 m_shiftDown = evt.m_shiftDown;
1034 m_altDown = evt.m_altDown;
1035 m_metaDown = evt.m_metaDown;
1036 m_scanCode = evt.m_scanCode;
1037 m_rawCode = evt.m_rawCode;
1038 m_rawFlags = evt.m_rawFlags;
1039#if wxUSE_UNICODE
1040 m_uniChar = evt.m_uniChar;
1041#endif
1042
1043 return *this;
1044 }
1045
1046public:
1047 wxCoord m_x, m_y;
1048
1049 long m_keyCode;
1050
1051 // TODO: replace those with a single m_modifiers bitmask of wxMOD_XXX?
1052 bool m_controlDown;
1053 bool m_shiftDown;
1054 bool m_altDown;
1055 bool m_metaDown;
1056
1057 // FIXME: what is this for? relation to m_rawXXX?
1058 bool m_scanCode;
1059
1060#if wxUSE_UNICODE
1061 // This contains the full Unicode character
1062 // in a character events in Unicode mode
1063 wxChar m_uniChar;
1064#endif
1065
1066 // these fields contain the platform-specific information about
1067 // key that was pressed
1068 wxUint32 m_rawCode;
1069 wxUint32 m_rawFlags;
1070
1071private:
1072 DECLARE_DYNAMIC_CLASS(wxKeyEvent)
1073};
1074
1075// Size event class
1076/*
1077 wxEVT_SIZE
1078 */
1079
1080class WXDLLIMPEXP_CORE wxSizeEvent : public wxEvent
1081{
1082public:
1083 wxSizeEvent() : wxEvent(0, wxEVT_SIZE)
1084 { }
1085 wxSizeEvent(const wxSize& sz, int winid = 0)
1086 : wxEvent(winid, wxEVT_SIZE),
1087 m_size(sz)
1088 { }
1089 wxSizeEvent(const wxSizeEvent & event)
1090 : wxEvent(event),
1091 m_size(event.m_size), m_rect(event.m_rect)
1092 { }
1093 wxSizeEvent(const wxRect& rect, int id = 0)
1094 : m_size(rect.GetSize()), m_rect(rect)
1095 { m_eventType = wxEVT_SIZING; m_id = id; }
1096
1097 wxSize GetSize() const { return m_size; }
1098 wxRect GetRect() const { return m_rect; }
1099 void SetRect(const wxRect& rect) { m_rect = rect; }
1100
1101 virtual wxEvent *Clone() const { return new wxSizeEvent(*this); }
1102
1103public:
1104 // For internal usage only. Will be converted to protected members.
1105 wxSize m_size;
1106 wxRect m_rect; // Used for wxEVT_SIZING
1107
1108private:
1109 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSizeEvent)
1110};
1111
1112// Move event class
1113
1114/*
1115 wxEVT_MOVE
1116 */
1117
1118class WXDLLIMPEXP_CORE wxMoveEvent : public wxEvent
1119{
1120public:
1121 wxMoveEvent()
1122 : wxEvent(0, wxEVT_MOVE)
1123 { }
1124 wxMoveEvent(const wxPoint& pos, int winid = 0)
1125 : wxEvent(winid, wxEVT_MOVE),
1126 m_pos(pos)
1127 { }
1128 wxMoveEvent(const wxMoveEvent& event)
1129 : wxEvent(event),
1130 m_pos(event.m_pos)
1131 { }
1132 wxMoveEvent(const wxRect& rect, int id = 0)
1133 : m_pos(rect.GetPosition()), m_rect(rect)
1134 { m_eventType = wxEVT_MOVING; m_id = id; }
1135
1136 wxPoint GetPosition() const { return m_pos; }
1137 void SetPosition(const wxPoint& pos) { m_pos = pos; }
1138 wxRect GetRect() const { return m_rect; }
1139 void SetRect(const wxRect& rect) { m_rect = rect; }
1140
1141 virtual wxEvent *Clone() const { return new wxMoveEvent(*this); }
1142
1143#if WXWIN_COMPATIBILITY_2_4
1144public:
1145#else
1146protected:
1147#endif
1148 wxPoint m_pos;
1149 wxRect m_rect;
1150
1151private:
1152 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMoveEvent)
1153};
1154
1155// Paint event class
1156/*
1157 wxEVT_PAINT
1158 wxEVT_NC_PAINT
1159 wxEVT_PAINT_ICON
1160 */
1161
1162#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1163 // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
1164 extern WXDLLIMPEXP_CORE int g_isPainting;
1165#endif // debug
1166
1167class WXDLLIMPEXP_CORE wxPaintEvent : public wxEvent
1168{
1169public:
1170 wxPaintEvent(int Id = 0)
1171 : wxEvent(Id, wxEVT_PAINT)
1172 {
1173#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1174 // set the internal flag for the duration of processing of WM_PAINT
1175 g_isPainting++;
1176#endif // debug
1177 }
1178
1179 // default copy ctor and dtor are normally fine, we only need them to keep
1180 // g_isPainting updated in debug build
1181#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
1182 wxPaintEvent(const wxPaintEvent& event)
1183 : wxEvent(event)
1184 {
1185 g_isPainting++;
1186 }
1187
1188 virtual ~wxPaintEvent()
1189 {
1190 g_isPainting--;
1191 }
1192#endif // debug
1193
1194 virtual wxEvent *Clone() const { return new wxPaintEvent(*this); }
1195
1196private:
1197 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaintEvent)
1198};
1199
1200class WXDLLIMPEXP_CORE wxNcPaintEvent : public wxEvent
1201{
1202public:
1203 wxNcPaintEvent(int winid = 0)
1204 : wxEvent(winid, wxEVT_NC_PAINT)
1205 { }
1206
1207 virtual wxEvent *Clone() const { return new wxNcPaintEvent(*this); }
1208
1209private:
1210 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNcPaintEvent)
1211};
1212
1213// Erase background event class
1214/*
1215 wxEVT_ERASE_BACKGROUND
1216 */
1217
1218class WXDLLIMPEXP_CORE wxEraseEvent : public wxEvent
1219{
1220public:
1221 wxEraseEvent(int Id = 0, wxDC *dc = (wxDC *) NULL)
1222 : wxEvent(Id, wxEVT_ERASE_BACKGROUND),
1223 m_dc(dc)
1224 { }
1225
1226 wxEraseEvent(const wxEraseEvent& event)
1227 : wxEvent(event),
1228 m_dc(event.m_dc)
1229 { }
1230
1231 wxDC *GetDC() const { return m_dc; }
1232
1233 virtual wxEvent *Clone() const { return new wxEraseEvent(*this); }
1234
1235#if WXWIN_COMPATIBILITY_2_4
1236public:
1237#else
1238protected:
1239#endif
1240 wxDC *m_dc;
1241
1242private:
1243 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxEraseEvent)
1244};
1245
1246// Focus event class
1247/*
1248 wxEVT_SET_FOCUS
1249 wxEVT_KILL_FOCUS
1250 */
1251
1252class WXDLLIMPEXP_CORE wxFocusEvent : public wxEvent
1253{
1254public:
1255 wxFocusEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1256 : wxEvent(winid, type)
1257 { m_win = NULL; }
1258
1259 wxFocusEvent(const wxFocusEvent& event)
1260 : wxEvent(event)
1261 { m_win = event.m_win; }
1262
1263 // The window associated with this event is the window which had focus
1264 // before for SET event and the window which will have focus for the KILL
1265 // one. NB: it may be NULL in both cases!
1266 wxWindow *GetWindow() const { return m_win; }
1267 void SetWindow(wxWindow *win) { m_win = win; }
1268
1269 virtual wxEvent *Clone() const { return new wxFocusEvent(*this); }
1270
1271private:
1272 wxWindow *m_win;
1273
1274private:
1275 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFocusEvent)
1276};
1277
1278// wxChildFocusEvent notifies the parent that a child has got the focus: unlike
1279// wxFocusEvent it is propagated upwards the window chain
1280class WXDLLIMPEXP_CORE wxChildFocusEvent : public wxCommandEvent
1281{
1282public:
1283 wxChildFocusEvent(wxWindow *win = NULL);
1284
1285 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1286
1287 virtual wxEvent *Clone() const { return new wxChildFocusEvent(*this); }
1288
1289private:
1290 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxChildFocusEvent)
1291};
1292
1293// Activate event class
1294/*
1295 wxEVT_ACTIVATE
1296 wxEVT_ACTIVATE_APP
1297 wxEVT_HIBERNATE
1298 */
1299
1300class WXDLLIMPEXP_CORE wxActivateEvent : public wxEvent
1301{
1302public:
1303 wxActivateEvent(wxEventType type = wxEVT_NULL, bool active = true, int Id = 0)
1304 : wxEvent(Id, type)
1305 { m_active = active; }
1306 wxActivateEvent(const wxActivateEvent& event)
1307 : wxEvent(event)
1308 { m_active = event.m_active; }
1309
1310 bool GetActive() const { return m_active; }
1311
1312 virtual wxEvent *Clone() const { return new wxActivateEvent(*this); }
1313
1314private:
1315 bool m_active;
1316
1317private:
1318 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxActivateEvent)
1319};
1320
1321// InitDialog event class
1322/*
1323 wxEVT_INIT_DIALOG
1324 */
1325
1326class WXDLLIMPEXP_CORE wxInitDialogEvent : public wxEvent
1327{
1328public:
1329 wxInitDialogEvent(int Id = 0)
1330 : wxEvent(Id, wxEVT_INIT_DIALOG)
1331 { }
1332
1333 virtual wxEvent *Clone() const { return new wxInitDialogEvent(*this); }
1334
1335private:
1336 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxInitDialogEvent)
1337};
1338
1339// Miscellaneous menu event class
1340/*
1341 wxEVT_MENU_OPEN,
1342 wxEVT_MENU_CLOSE,
1343 wxEVT_MENU_HIGHLIGHT,
1344*/
1345
1346class WXDLLIMPEXP_CORE wxMenuEvent : public wxEvent
1347{
1348public:
1349 wxMenuEvent(wxEventType type = wxEVT_NULL, int winid = 0, wxMenu* menu = NULL)
1350 : wxEvent(winid, type)
1351 { m_menuId = winid; m_menu = menu; }
1352 wxMenuEvent(const wxMenuEvent & event)
1353 : wxEvent(event)
1354 { m_menuId = event.m_menuId; m_menu = event.m_menu; }
1355
1356 // only for wxEVT_MENU_HIGHLIGHT
1357 int GetMenuId() const { return m_menuId; }
1358
1359 // only for wxEVT_MENU_OPEN/CLOSE
1360 bool IsPopup() const { return m_menuId == wxID_ANY; }
1361
1362 // only for wxEVT_MENU_OPEN/CLOSE
1363 wxMenu* GetMenu() const { return m_menu; }
1364
1365 virtual wxEvent *Clone() const { return new wxMenuEvent(*this); }
1366
1367private:
1368 int m_menuId;
1369 wxMenu* m_menu;
1370
1371 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMenuEvent)
1372};
1373
1374// Window close or session close event class
1375/*
1376 wxEVT_CLOSE_WINDOW,
1377 wxEVT_END_SESSION,
1378 wxEVT_QUERY_END_SESSION
1379 */
1380
1381class WXDLLIMPEXP_CORE wxCloseEvent : public wxEvent
1382{
1383public:
1384 wxCloseEvent(wxEventType type = wxEVT_NULL, int winid = 0)
1385 : wxEvent(winid, type),
1386 m_loggingOff(true),
1387 m_veto(false), // should be false by default
1388 m_canVeto(true) {}
1389
1390 wxCloseEvent(const wxCloseEvent & event)
1391 : wxEvent(event),
1392 m_loggingOff(event.m_loggingOff),
1393 m_veto(event.m_veto),
1394 m_canVeto(event.m_canVeto) {}
1395
1396 void SetLoggingOff(bool logOff) { m_loggingOff = logOff; }
1397 bool GetLoggingOff() const
1398 {
1399 // m_loggingOff flag is only used by wxEVT_[QUERY_]END_SESSION, it
1400 // doesn't make sense for wxEVT_CLOSE_WINDOW
1401 wxASSERT_MSG( m_eventType != wxEVT_CLOSE_WINDOW,
1402 _T("this flag is for end session events only") );
1403
1404 return m_loggingOff;
1405 }
1406
1407 void Veto(bool veto = true)
1408 {
1409 // GetVeto() will return false anyhow...
1410 wxCHECK_RET( m_canVeto,
1411 wxT("call to Veto() ignored (can't veto this event)") );
1412
1413 m_veto = veto;
1414 }
1415 void SetCanVeto(bool canVeto) { m_canVeto = canVeto; }
1416 bool CanVeto() const { return m_canVeto; }
1417 bool GetVeto() const { return m_canVeto && m_veto; }
1418
1419 virtual wxEvent *Clone() const { return new wxCloseEvent(*this); }
1420
1421protected:
1422 bool m_loggingOff,
1423 m_veto,
1424 m_canVeto;
1425
1426private:
1427 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxCloseEvent)
1428};
1429
1430/*
1431 wxEVT_SHOW
1432 */
1433
1434class WXDLLIMPEXP_CORE wxShowEvent : public wxEvent
1435{
1436public:
1437 wxShowEvent(int winid = 0, bool show = false)
1438 : wxEvent(winid, wxEVT_SHOW)
1439 { m_show = show; }
1440 wxShowEvent(const wxShowEvent & event)
1441 : wxEvent(event)
1442 { m_show = event.m_show; }
1443
1444 void SetShow(bool show) { m_show = show; }
1445 bool GetShow() const { return m_show; }
1446
1447 virtual wxEvent *Clone() const { return new wxShowEvent(*this); }
1448
1449protected:
1450 bool m_show;
1451
1452private:
1453 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxShowEvent)
1454};
1455
1456/*
1457 wxEVT_ICONIZE
1458 */
1459
1460class WXDLLIMPEXP_CORE wxIconizeEvent : public wxEvent
1461{
1462public:
1463 wxIconizeEvent(int winid = 0, bool iconized = true)
1464 : wxEvent(winid, wxEVT_ICONIZE)
1465 { m_iconized = iconized; }
1466 wxIconizeEvent(const wxIconizeEvent & event)
1467 : wxEvent(event)
1468 { m_iconized = event.m_iconized; }
1469
1470 // return true if the frame was iconized, false if restored
1471 bool Iconized() const { return m_iconized; }
1472
1473 virtual wxEvent *Clone() const { return new wxIconizeEvent(*this); }
1474
1475protected:
1476 bool m_iconized;
1477
1478private:
1479 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIconizeEvent)
1480};
1481/*
1482 wxEVT_MAXIMIZE
1483 */
1484
1485class WXDLLIMPEXP_CORE wxMaximizeEvent : public wxEvent
1486{
1487public:
1488 wxMaximizeEvent(int winid = 0)
1489 : wxEvent(winid, wxEVT_MAXIMIZE)
1490 { }
1491
1492 virtual wxEvent *Clone() const { return new wxMaximizeEvent(*this); }
1493
1494private:
1495 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMaximizeEvent)
1496};
1497
1498// Joystick event class
1499/*
1500 wxEVT_JOY_BUTTON_DOWN,
1501 wxEVT_JOY_BUTTON_UP,
1502 wxEVT_JOY_MOVE,
1503 wxEVT_JOY_ZMOVE
1504*/
1505
1506// Which joystick? Same as Windows ids so no conversion necessary.
1507enum
1508{
1509 wxJOYSTICK1,
1510 wxJOYSTICK2
1511};
1512
1513// Which button is down?
1514enum
1515{
1516 wxJOY_BUTTON_ANY = -1,
1517 wxJOY_BUTTON1 = 1,
1518 wxJOY_BUTTON2 = 2,
1519 wxJOY_BUTTON3 = 4,
1520 wxJOY_BUTTON4 = 8
1521};
1522
1523class WXDLLIMPEXP_CORE wxJoystickEvent : public wxEvent
1524{
1525#if WXWIN_COMPATIBILITY_2_4
1526public:
1527#else
1528protected:
1529#endif
1530 wxPoint m_pos;
1531 int m_zPosition;
1532 int m_buttonChange; // Which button changed?
1533 int m_buttonState; // Which buttons are down?
1534 int m_joyStick; // Which joystick?
1535
1536public:
1537 wxJoystickEvent(wxEventType type = wxEVT_NULL,
1538 int state = 0,
1539 int joystick = wxJOYSTICK1,
1540 int change = 0)
1541 : wxEvent(0, type),
1542 m_pos(),
1543 m_zPosition(0),
1544 m_buttonChange(change),
1545 m_buttonState(state),
1546 m_joyStick(joystick)
1547 {
1548 }
1549 wxJoystickEvent(const wxJoystickEvent & event)
1550 : wxEvent(event),
1551 m_pos(event.m_pos),
1552 m_zPosition(event.m_zPosition),
1553 m_buttonChange(event.m_buttonChange),
1554 m_buttonState(event.m_buttonState),
1555 m_joyStick(event.m_joyStick)
1556 { }
1557
1558 wxPoint GetPosition() const { return m_pos; }
1559 int GetZPosition() const { return m_zPosition; }
1560 int GetButtonState() const { return m_buttonState; }
1561 int GetButtonChange() const { return m_buttonChange; }
1562 int GetJoystick() const { return m_joyStick; }
1563
1564 void SetJoystick(int stick) { m_joyStick = stick; }
1565 void SetButtonState(int state) { m_buttonState = state; }
1566 void SetButtonChange(int change) { m_buttonChange = change; }
1567 void SetPosition(const wxPoint& pos) { m_pos = pos; }
1568 void SetZPosition(int zPos) { m_zPosition = zPos; }
1569
1570 // Was it a button event? (*doesn't* mean: is any button *down*?)
1571 bool IsButton() const { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) ||
1572 (GetEventType() == wxEVT_JOY_BUTTON_UP)); }
1573
1574 // Was it a move event?
1575 bool IsMove() const { return (GetEventType() == wxEVT_JOY_MOVE); }
1576
1577 // Was it a zmove event?
1578 bool IsZMove() const { return (GetEventType() == wxEVT_JOY_ZMOVE); }
1579
1580 // Was it a down event from button 1, 2, 3, 4 or any?
1581 bool ButtonDown(int but = wxJOY_BUTTON_ANY) const
1582 { return ((GetEventType() == wxEVT_JOY_BUTTON_DOWN) &&
1583 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
1584
1585 // Was it a up event from button 1, 2, 3 or any?
1586 bool ButtonUp(int but = wxJOY_BUTTON_ANY) const
1587 { return ((GetEventType() == wxEVT_JOY_BUTTON_UP) &&
1588 ((but == wxJOY_BUTTON_ANY) || (but == m_buttonChange))); }
1589
1590 // Was the given button 1,2,3,4 or any in Down state?
1591 bool ButtonIsDown(int but = wxJOY_BUTTON_ANY) const
1592 { return (((but == wxJOY_BUTTON_ANY) && (m_buttonState != 0)) ||
1593 ((m_buttonState & but) == but)); }
1594
1595 virtual wxEvent *Clone() const { return new wxJoystickEvent(*this); }
1596
1597private:
1598 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxJoystickEvent)
1599};
1600
1601// Drop files event class
1602/*
1603 wxEVT_DROP_FILES
1604 */
1605
1606class WXDLLIMPEXP_CORE wxDropFilesEvent : public wxEvent
1607{
1608public:
1609 int m_noFiles;
1610 wxPoint m_pos;
1611 wxString* m_files;
1612
1613 wxDropFilesEvent(wxEventType type = wxEVT_NULL,
1614 int noFiles = 0,
1615 wxString *files = (wxString *) NULL)
1616 : wxEvent(0, type),
1617 m_noFiles(noFiles),
1618 m_pos(),
1619 m_files(files)
1620 { }
1621
1622 // we need a copy ctor to avoid deleting m_files pointer twice
1623 wxDropFilesEvent(const wxDropFilesEvent& other)
1624 : wxEvent(other),
1625 m_noFiles(other.m_noFiles),
1626 m_pos(other.m_pos),
1627 m_files(NULL)
1628 {
1629 m_files = new wxString[m_noFiles];
1630 for ( int n = 0; n < m_noFiles; n++ )
1631 {
1632 m_files[n] = other.m_files[n];
1633 }
1634 }
1635
1636 virtual ~wxDropFilesEvent()
1637 {
1638 delete [] m_files;
1639 }
1640
1641 wxPoint GetPosition() const { return m_pos; }
1642 int GetNumberOfFiles() const { return m_noFiles; }
1643 wxString *GetFiles() const { return m_files; }
1644
1645 virtual wxEvent *Clone() const { return new wxDropFilesEvent(*this); }
1646
1647private:
1648 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDropFilesEvent)
1649};
1650
1651// Update UI event
1652/*
1653 wxEVT_UPDATE_UI
1654 */
1655
1656// Whether to always send update events to windows, or
1657// to only send update events to those with the
1658// wxWS_EX_PROCESS_UI_UPDATES style.
1659
1660enum wxUpdateUIMode
1661{
1662 // Send UI update events to all windows
1663 wxUPDATE_UI_PROCESS_ALL,
1664
1665 // Send UI update events to windows that have
1666 // the wxWS_EX_PROCESS_UI_UPDATES flag specified
1667 wxUPDATE_UI_PROCESS_SPECIFIED
1668};
1669
1670class WXDLLIMPEXP_CORE wxUpdateUIEvent : public wxCommandEvent
1671{
1672public:
1673 wxUpdateUIEvent(wxWindowID commandId = 0)
1674 : wxCommandEvent(wxEVT_UPDATE_UI, commandId)
1675 {
1676 m_checked =
1677 m_enabled =
1678 m_shown =
1679 m_setEnabled =
1680 m_setShown =
1681 m_setText =
1682 m_setChecked = false;
1683 }
1684 wxUpdateUIEvent(const wxUpdateUIEvent & event)
1685 : wxCommandEvent(event),
1686 m_checked(event.m_checked),
1687 m_enabled(event.m_enabled),
1688 m_shown(event.m_shown),
1689 m_setEnabled(event.m_setEnabled),
1690 m_setShown(event.m_setShown),
1691 m_setText(event.m_setText),
1692 m_setChecked(event.m_setChecked),
1693 m_text(event.m_text)
1694 { }
1695
1696 bool GetChecked() const { return m_checked; }
1697 bool GetEnabled() const { return m_enabled; }
1698 bool GetShown() const { return m_shown; }
1699 wxString GetText() const { return m_text; }
1700 bool GetSetText() const { return m_setText; }
1701 bool GetSetChecked() const { return m_setChecked; }
1702 bool GetSetEnabled() const { return m_setEnabled; }
1703 bool GetSetShown() const { return m_setShown; }
1704
1705 void Check(bool check) { m_checked = check; m_setChecked = true; }
1706 void Enable(bool enable) { m_enabled = enable; m_setEnabled = true; }
1707 void Show(bool show) { m_shown = show; m_setShown = true; }
1708 void SetText(const wxString& text) { m_text = text; m_setText = true; }
1709
1710 // Sets the interval between updates in milliseconds.
1711 // Set to -1 to disable updates, or to 0 to update as frequently as possible.
1712 static void SetUpdateInterval(long updateInterval) { sm_updateInterval = updateInterval; }
1713
1714 // Returns the current interval between updates in milliseconds
1715 static long GetUpdateInterval() { return sm_updateInterval; }
1716
1717 // Can we update this window?
1718 static bool CanUpdate(wxWindowBase *win);
1719
1720 // Reset the update time to provide a delay until the next
1721 // time we should update
1722 static void ResetUpdateTime();
1723
1724 // Specify how wxWidgets will send update events: to
1725 // all windows, or only to those which specify that they
1726 // will process the events.
1727 static void SetMode(wxUpdateUIMode mode) { sm_updateMode = mode; }
1728
1729 // Returns the UI update mode
1730 static wxUpdateUIMode GetMode() { return sm_updateMode; }
1731
1732 virtual wxEvent *Clone() const { return new wxUpdateUIEvent(*this); }
1733
1734protected:
1735 bool m_checked;
1736 bool m_enabled;
1737 bool m_shown;
1738 bool m_setEnabled;
1739 bool m_setShown;
1740 bool m_setText;
1741 bool m_setChecked;
1742 wxString m_text;
1743#if wxUSE_LONGLONG
1744 static wxLongLong sm_lastUpdate;
1745#endif
1746 static long sm_updateInterval;
1747 static wxUpdateUIMode sm_updateMode;
1748
1749private:
1750 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxUpdateUIEvent)
1751};
1752
1753/*
1754 wxEVT_SYS_COLOUR_CHANGED
1755 */
1756
1757// TODO: shouldn't all events record the window ID?
1758class WXDLLIMPEXP_CORE wxSysColourChangedEvent : public wxEvent
1759{
1760public:
1761 wxSysColourChangedEvent()
1762 : wxEvent(0, wxEVT_SYS_COLOUR_CHANGED)
1763 { }
1764
1765 virtual wxEvent *Clone() const { return new wxSysColourChangedEvent(*this); }
1766
1767private:
1768 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSysColourChangedEvent)
1769};
1770
1771/*
1772 wxEVT_MOUSE_CAPTURE_CHANGED
1773 The window losing the capture receives this message
1774 (even if it released the capture itself).
1775 */
1776
1777class WXDLLIMPEXP_CORE wxMouseCaptureChangedEvent : public wxEvent
1778{
1779public:
1780 wxMouseCaptureChangedEvent(wxWindowID winid = 0, wxWindow* gainedCapture = NULL)
1781 : wxEvent(winid, wxEVT_MOUSE_CAPTURE_CHANGED),
1782 m_gainedCapture(gainedCapture)
1783 { }
1784
1785 wxMouseCaptureChangedEvent(const wxMouseCaptureChangedEvent& event)
1786 : wxEvent(event),
1787 m_gainedCapture(event.m_gainedCapture)
1788 { }
1789
1790 virtual wxEvent *Clone() const { return new wxMouseCaptureChangedEvent(*this); }
1791
1792 wxWindow* GetCapturedWindow() const { return m_gainedCapture; };
1793
1794private:
1795 wxWindow* m_gainedCapture;
1796
1797 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureChangedEvent)
1798};
1799
1800/*
1801 wxEVT_MOUSE_CAPTURE_LOST
1802 The window losing the capture receives this message, unless it released it
1803 it itself or unless wxWindow::CaptureMouse was called on another window
1804 (and so capture will be restored when the new capturer releases it).
1805 */
1806
1807class WXDLLIMPEXP_CORE wxMouseCaptureLostEvent : public wxEvent
1808{
1809public:
1810 wxMouseCaptureLostEvent(wxWindowID winid = 0)
1811 : wxEvent(winid, wxEVT_MOUSE_CAPTURE_LOST)
1812 {}
1813
1814 wxMouseCaptureLostEvent(const wxMouseCaptureLostEvent& event)
1815 : wxEvent(event)
1816 {}
1817
1818 virtual wxEvent *Clone() const { return new wxMouseCaptureLostEvent(*this); }
1819
1820 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxMouseCaptureLostEvent)
1821};
1822
1823/*
1824 wxEVT_DISPLAY_CHANGED
1825 */
1826class WXDLLIMPEXP_CORE wxDisplayChangedEvent : public wxEvent
1827{
1828private:
1829 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDisplayChangedEvent)
1830
1831public:
1832 wxDisplayChangedEvent()
1833 : wxEvent(0, wxEVT_DISPLAY_CHANGED)
1834 { }
1835
1836 virtual wxEvent *Clone() const { return new wxDisplayChangedEvent(*this); }
1837};
1838
1839/*
1840 wxEVT_PALETTE_CHANGED
1841 */
1842
1843class WXDLLIMPEXP_CORE wxPaletteChangedEvent : public wxEvent
1844{
1845public:
1846 wxPaletteChangedEvent(wxWindowID winid = 0)
1847 : wxEvent(winid, wxEVT_PALETTE_CHANGED),
1848 m_changedWindow((wxWindow *) NULL)
1849 { }
1850
1851 wxPaletteChangedEvent(const wxPaletteChangedEvent& event)
1852 : wxEvent(event),
1853 m_changedWindow(event.m_changedWindow)
1854 { }
1855
1856 void SetChangedWindow(wxWindow* win) { m_changedWindow = win; }
1857 wxWindow* GetChangedWindow() const { return m_changedWindow; }
1858
1859 virtual wxEvent *Clone() const { return new wxPaletteChangedEvent(*this); }
1860
1861protected:
1862 wxWindow* m_changedWindow;
1863
1864private:
1865 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxPaletteChangedEvent)
1866};
1867
1868/*
1869 wxEVT_QUERY_NEW_PALETTE
1870 Indicates the window is getting keyboard focus and should re-do its palette.
1871 */
1872
1873class WXDLLIMPEXP_CORE wxQueryNewPaletteEvent : public wxEvent
1874{
1875public:
1876 wxQueryNewPaletteEvent(wxWindowID winid = 0)
1877 : wxEvent(winid, wxEVT_QUERY_NEW_PALETTE),
1878 m_paletteRealized(false)
1879 { }
1880 wxQueryNewPaletteEvent(const wxQueryNewPaletteEvent & event)
1881 : wxEvent(event),
1882 m_paletteRealized(event.m_paletteRealized)
1883 { }
1884
1885 // App sets this if it changes the palette.
1886 void SetPaletteRealized(bool realized) { m_paletteRealized = realized; }
1887 bool GetPaletteRealized() const { return m_paletteRealized; }
1888
1889 virtual wxEvent *Clone() const { return new wxQueryNewPaletteEvent(*this); }
1890
1891protected:
1892 bool m_paletteRealized;
1893
1894private:
1895 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxQueryNewPaletteEvent)
1896};
1897
1898/*
1899 Event generated by dialog navigation keys
1900 wxEVT_NAVIGATION_KEY
1901 */
1902// NB: don't derive from command event to avoid being propagated to the parent
1903class WXDLLIMPEXP_CORE wxNavigationKeyEvent : public wxEvent
1904{
1905public:
1906 wxNavigationKeyEvent()
1907 : wxEvent(0, wxEVT_NAVIGATION_KEY),
1908 m_flags(IsForward | FromTab), // defaults are for TAB
1909 m_focus((wxWindow *)NULL)
1910 {
1911 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
1912 }
1913
1914 wxNavigationKeyEvent(const wxNavigationKeyEvent& event)
1915 : wxEvent(event),
1916 m_flags(event.m_flags),
1917 m_focus(event.m_focus)
1918 { }
1919
1920 // direction: forward (true) or backward (false)
1921 bool GetDirection() const
1922 { return (m_flags & IsForward) != 0; }
1923 void SetDirection(bool bForward)
1924 { if ( bForward ) m_flags |= IsForward; else m_flags &= ~IsForward; }
1925
1926 // it may be a window change event (MDI, notebook pages...) or a control
1927 // change event
1928 bool IsWindowChange() const
1929 { return (m_flags & WinChange) != 0; }
1930 void SetWindowChange(bool bIs)
1931 { if ( bIs ) m_flags |= WinChange; else m_flags &= ~WinChange; }
1932
1933 // Set to true under MSW if the event was generated using the tab key.
1934 // This is required for proper navogation over radio buttons
1935 bool IsFromTab() const
1936 { return (m_flags & FromTab) != 0; }
1937 void SetFromTab(bool bIs)
1938 { if ( bIs ) m_flags |= FromTab; else m_flags &= ~FromTab; }
1939
1940 // the child which has the focus currently (may be NULL - use
1941 // wxWindow::FindFocus then)
1942 wxWindow* GetCurrentFocus() const { return m_focus; }
1943 void SetCurrentFocus(wxWindow *win) { m_focus = win; }
1944
1945 // Set flags
1946 void SetFlags(long flags) { m_flags = flags; }
1947
1948 virtual wxEvent *Clone() const { return new wxNavigationKeyEvent(*this); }
1949
1950 enum
1951 {
1952 IsBackward = 0x0000,
1953 IsForward = 0x0001,
1954 WinChange = 0x0002,
1955 FromTab = 0x0004
1956 };
1957
1958 long m_flags;
1959 wxWindow *m_focus;
1960
1961private:
1962 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNavigationKeyEvent)
1963};
1964
1965// Window creation/destruction events: the first is sent as soon as window is
1966// created (i.e. the underlying GUI object exists), but when the C++ object is
1967// fully initialized (so virtual functions may be called). The second,
1968// wxEVT_DESTROY, is sent right before the window is destroyed - again, it's
1969// still safe to call virtual functions at this moment
1970/*
1971 wxEVT_CREATE
1972 wxEVT_DESTROY
1973 */
1974
1975class WXDLLIMPEXP_CORE wxWindowCreateEvent : public wxCommandEvent
1976{
1977public:
1978 wxWindowCreateEvent(wxWindow *win = NULL);
1979
1980 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1981
1982 virtual wxEvent *Clone() const { return new wxWindowCreateEvent(*this); }
1983
1984private:
1985 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowCreateEvent)
1986};
1987
1988class WXDLLIMPEXP_CORE wxWindowDestroyEvent : public wxCommandEvent
1989{
1990public:
1991 wxWindowDestroyEvent(wxWindow *win = NULL);
1992
1993 wxWindow *GetWindow() const { return (wxWindow *)GetEventObject(); }
1994
1995 virtual wxEvent *Clone() const { return new wxWindowDestroyEvent(*this); }
1996
1997private:
1998 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWindowDestroyEvent)
1999};
2000
2001// A help event is sent when the user clicks on a window in context-help mode.
2002/*
2003 wxEVT_HELP
2004 wxEVT_DETAILED_HELP
2005*/
2006
2007class WXDLLIMPEXP_CORE wxHelpEvent : public wxCommandEvent
2008{
2009public:
2010 // how was this help event generated?
2011 enum Origin
2012 {
2013 Origin_Unknown, // unrecognized event source
2014 Origin_Keyboard, // event generated from F1 key press
2015 Origin_HelpButton // event from [?] button on the title bar (Windows)
2016 };
2017
2018 wxHelpEvent(wxEventType type = wxEVT_NULL,
2019 wxWindowID winid = 0,
2020 const wxPoint& pt = wxDefaultPosition,
2021 Origin origin = Origin_Unknown)
2022 : wxCommandEvent(type, winid),
2023 m_pos(pt),
2024 m_origin(GuessOrigin(origin))
2025 { }
2026 wxHelpEvent(const wxHelpEvent & event)
2027 : wxCommandEvent(event),
2028 m_pos(event.m_pos),
2029 m_target(event.m_target),
2030 m_link(event.m_link),
2031 m_origin(event.m_origin)
2032 { }
2033
2034 // Position of event (in screen coordinates)
2035 const wxPoint& GetPosition() const { return m_pos; }
2036 void SetPosition(const wxPoint& pos) { m_pos = pos; }
2037
2038 // Optional link to further help
2039 const wxString& GetLink() const { return m_link; }
2040 void SetLink(const wxString& link) { m_link = link; }
2041
2042 // Optional target to display help in. E.g. a window specification
2043 const wxString& GetTarget() const { return m_target; }
2044 void SetTarget(const wxString& target) { m_target = target; }
2045
2046 virtual wxEvent *Clone() const { return new wxHelpEvent(*this); }
2047
2048 // optional indication of the event source
2049 Origin GetOrigin() const { return m_origin; }
2050 void SetOrigin(Origin origin) { m_origin = origin; }
2051
2052protected:
2053 wxPoint m_pos;
2054 wxString m_target;
2055 wxString m_link;
2056 Origin m_origin;
2057
2058 // we can try to guess the event origin ourselves, even if none is
2059 // specified in the ctor
2060 static Origin GuessOrigin(Origin origin);
2061
2062private:
2063 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHelpEvent)
2064};
2065
2066// A Clipboard Text event is sent when a window intercepts text copy/cut/paste
2067// message, i.e. the user has cut/copied/pasted data from/into a text control
2068// via ctrl-C/X/V, ctrl/shift-del/insert, a popup menu command, etc.
2069// NOTE : under windows these events are *NOT* generated automatically
2070// for a Rich Edit text control.
2071/*
2072wxEVT_COMMAND_TEXT_COPY
2073wxEVT_COMMAND_TEXT_CUT
2074wxEVT_COMMAND_TEXT_PASTE
2075*/
2076
2077class WXDLLIMPEXP_CORE wxClipboardTextEvent : public wxCommandEvent
2078{
2079public:
2080 wxClipboardTextEvent(wxEventType type = wxEVT_NULL,
2081 wxWindowID winid = 0)
2082 : wxCommandEvent(type, winid)
2083 { }
2084 wxClipboardTextEvent(const wxClipboardTextEvent & event)
2085 : wxCommandEvent(event)
2086 { }
2087
2088 virtual wxEvent *Clone() const { return new wxClipboardTextEvent(*this); }
2089
2090private:
2091 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxClipboardTextEvent)
2092};
2093
2094// A Context event is sent when the user right clicks on a window or
2095// presses Shift-F10
2096// NOTE : Under windows this is a repackaged WM_CONTETXMENU message
2097// Under other systems it may have to be generated from a right click event
2098/*
2099 wxEVT_CONTEXT_MENU
2100*/
2101
2102class WXDLLIMPEXP_CORE wxContextMenuEvent : public wxCommandEvent
2103{
2104public:
2105 wxContextMenuEvent(wxEventType type = wxEVT_NULL,
2106 wxWindowID winid = 0,
2107 const wxPoint& pt = wxDefaultPosition)
2108 : wxCommandEvent(type, winid),
2109 m_pos(pt)
2110 { }
2111 wxContextMenuEvent(const wxContextMenuEvent & event)
2112 : wxCommandEvent(event),
2113 m_pos(event.m_pos)
2114 { }
2115
2116 // Position of event (in screen coordinates)
2117 const wxPoint& GetPosition() const { return m_pos; }
2118 void SetPosition(const wxPoint& pos) { m_pos = pos; }
2119
2120 virtual wxEvent *Clone() const { return new wxContextMenuEvent(*this); }
2121
2122protected:
2123 wxPoint m_pos;
2124
2125private:
2126 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxContextMenuEvent)
2127};
2128
2129// Idle event
2130/*
2131 wxEVT_IDLE
2132 */
2133
2134// Whether to always send idle events to windows, or
2135// to only send update events to those with the
2136// wxWS_EX_PROCESS_IDLE style.
2137
2138enum wxIdleMode
2139{
2140 // Send idle events to all windows
2141 wxIDLE_PROCESS_ALL,
2142
2143 // Send idle events to windows that have
2144 // the wxWS_EX_PROCESS_IDLE flag specified
2145 wxIDLE_PROCESS_SPECIFIED
2146};
2147
2148class WXDLLIMPEXP_CORE wxIdleEvent : public wxEvent
2149{
2150public:
2151 wxIdleEvent()
2152 : wxEvent(0, wxEVT_IDLE),
2153 m_requestMore(false)
2154 { }
2155 wxIdleEvent(const wxIdleEvent & event)
2156 : wxEvent(event),
2157 m_requestMore(event.m_requestMore)
2158 { }
2159
2160 void RequestMore(bool needMore = true) { m_requestMore = needMore; }
2161 bool MoreRequested() const { return m_requestMore; }
2162
2163 virtual wxEvent *Clone() const { return new wxIdleEvent(*this); }
2164
2165 // Specify how wxWidgets will send idle events: to
2166 // all windows, or only to those which specify that they
2167 // will process the events.
2168 static void SetMode(wxIdleMode mode) { sm_idleMode = mode; }
2169
2170 // Returns the idle event mode
2171 static wxIdleMode GetMode() { return sm_idleMode; }
2172
2173 // Can we send an idle event?
2174 static bool CanSend(wxWindow* win);
2175
2176protected:
2177 bool m_requestMore;
2178 static wxIdleMode sm_idleMode;
2179
2180private:
2181 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxIdleEvent)
2182};
2183
2184#endif // wxUSE_GUI
2185
2186/* TODO
2187 wxEVT_MOUSE_CAPTURE_CHANGED,
2188 wxEVT_SETTING_CHANGED, // WM_WININICHANGE (NT) / WM_SETTINGCHANGE (Win95)
2189// wxEVT_FONT_CHANGED, // WM_FONTCHANGE: roll into wxEVT_SETTING_CHANGED, but remember to propagate
2190 // wxEVT_FONT_CHANGED to all other windows (maybe).
2191 wxEVT_DRAW_ITEM, // Leave these three as virtual functions in wxControl?? Platform-specific.
2192 wxEVT_MEASURE_ITEM,
2193 wxEVT_COMPARE_ITEM
2194*/
2195
2196
2197// ============================================================================
2198// event handler and related classes
2199// ============================================================================
2200
2201// for backwards compatibility and to prevent eVC 4 for ARM from crashing with
2202// internal compiler error when compiling wx, we define wxObjectEventFunction
2203// as a wxObject method even though it can only be a wxEvtHandler one
2204typedef void (wxObject::*wxObjectEventFunction)(wxEvent&);
2205
2206// we can't have ctors nor base struct in backwards compatibility mode or
2207// otherwise we won't be able to initialize the objects with an agregate, so
2208// we have to keep both versions
2209#if WXWIN_COMPATIBILITY_EVENT_TYPES
2210
2211struct WXDLLIMPEXP_BASE wxEventTableEntry
2212{
2213 // For some reason, this can't be wxEventType, or VC++ complains.
2214 int m_eventType; // main event type
2215 int m_id; // control/menu/toolbar id
2216 int m_lastId; // used for ranges of ids
2217 wxObjectEventFunction m_fn; // function to call: not wxEventFunction,
2218 // because of dependency problems
2219
2220 wxObject* m_callbackUserData;
2221};
2222
2223#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
2224
2225// struct containing the members common to static and dynamic event tables
2226// entries
2227struct WXDLLIMPEXP_BASE wxEventTableEntryBase
2228{
2229private:
2230 wxEventTableEntryBase& operator=(const wxEventTableEntryBase& event);
2231
2232public:
2233 wxEventTableEntryBase(int winid, int idLast,
2234 wxObjectEventFunction fn, wxObject *data)
2235 : m_id(winid),
2236 m_lastId(idLast),
2237 m_fn(fn),
2238 m_callbackUserData(data)
2239 { }
2240
2241 wxEventTableEntryBase(const wxEventTableEntryBase& event)
2242 : m_id(event.m_id),
2243 m_lastId(event.m_lastId),
2244 m_fn(event.m_fn),
2245 m_callbackUserData(event.m_callbackUserData)
2246 { }
2247
2248 // the range of ids for this entry: if m_lastId == wxID_ANY, the range
2249 // consists only of m_id, otherwise it is m_id..m_lastId inclusive
2250 int m_id,
2251 m_lastId;
2252
2253 // function to call: not wxEventFunction, because of dependency problems
2254 wxObjectEventFunction m_fn;
2255
2256 // arbitrary user data asosciated with the callback
2257 wxObject* m_callbackUserData;
2258};
2259
2260// an entry from a static event table
2261struct WXDLLIMPEXP_BASE wxEventTableEntry : public wxEventTableEntryBase
2262{
2263 wxEventTableEntry(const int& evType, int winid, int idLast,
2264 wxObjectEventFunction fn, wxObject *data)
2265 : wxEventTableEntryBase(winid, idLast, fn, data),
2266 m_eventType(evType)
2267 { }
2268
2269 // the reference to event type: this allows us to not care about the
2270 // (undefined) order in which the event table entries and the event types
2271 // are initialized: initially the value of this reference might be
2272 // invalid, but by the time it is used for the first time, all global
2273 // objects will have been initialized (including the event type constants)
2274 // and so it will have the correct value when it is needed
2275 const int& m_eventType;
2276
2277private:
2278 wxEventTableEntry& operator=(const wxEventTableEntry&);
2279};
2280
2281// an entry used in dynamic event table managed by wxEvtHandler::Connect()
2282struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry : public wxEventTableEntryBase
2283{
2284 wxDynamicEventTableEntry(int evType, int winid, int idLast,
2285 wxObjectEventFunction fn, wxObject *data, wxEvtHandler* eventSink)
2286 : wxEventTableEntryBase(winid, idLast, fn, data),
2287 m_eventType(evType),
2288 m_eventSink(eventSink)
2289 { }
2290
2291 // not a reference here as we can't keep a reference to a temporary int
2292 // created to wrap the constant value typically passed to Connect() - nor
2293 // do we need it
2294 int m_eventType;
2295
2296 // Pointer to object whose function is fn - so we don't assume the
2297 // EventFunction is always a member of the EventHandler receiving the
2298 // message
2299 wxEvtHandler* m_eventSink;
2300
2301 DECLARE_NO_COPY_CLASS(wxDynamicEventTableEntry)
2302};
2303
2304#endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
2305
2306// ----------------------------------------------------------------------------
2307// wxEventTable: an array of event entries terminated with {0, 0, 0, 0, 0}
2308// ----------------------------------------------------------------------------
2309
2310struct WXDLLIMPEXP_BASE wxEventTable
2311{
2312 const wxEventTable *baseTable; // base event table (next in chain)
2313 const wxEventTableEntry *entries; // bottom of entry array
2314};
2315
2316// ----------------------------------------------------------------------------
2317// wxEventHashTable: a helper of wxEvtHandler to speed up wxEventTable lookups.
2318// ----------------------------------------------------------------------------
2319
2320WX_DEFINE_ARRAY_PTR(const wxEventTableEntry*, wxEventTableEntryPointerArray);
2321
2322class WXDLLIMPEXP_BASE wxEventHashTable
2323{
2324private:
2325 // Internal data structs
2326 struct EventTypeTable
2327 {
2328 wxEventType eventType;
2329 wxEventTableEntryPointerArray eventEntryTable;
2330 };
2331 typedef EventTypeTable* EventTypeTablePointer;
2332
2333public:
2334 // Constructor, needs the event table it needs to hash later on.
2335 // Note: hashing of the event table is not done in the constructor as it
2336 // can be that the event table is not yet full initialize, the hash
2337 // will gets initialized when handling the first event look-up request.
2338 wxEventHashTable(const wxEventTable &table);
2339 // Destructor.
2340 ~wxEventHashTable();
2341
2342 // Handle the given event, in other words search the event table hash
2343 // and call self->ProcessEvent() if a match was found.
2344 bool HandleEvent(wxEvent &event, wxEvtHandler *self);
2345
2346 // Clear table
2347 void Clear();
2348
2349 // Clear all tables
2350 static void ClearAll();
2351
2352protected:
2353 // Init the hash table with the entries of the static event table.
2354 void InitHashTable();
2355 // Helper funtion of InitHashTable() to insert 1 entry into the hash table.
2356 void AddEntry(const wxEventTableEntry &entry);
2357 // Allocate and init with null pointers the base hash table.
2358 void AllocEventTypeTable(size_t size);
2359 // Grow the hash table in size and transfer all items currently
2360 // in the table to the correct location in the new table.
2361 void GrowEventTypeTable();
2362
2363protected:
2364 const wxEventTable &m_table;
2365 bool m_rebuildHash;
2366
2367 size_t m_size;
2368 EventTypeTablePointer *m_eventTypeTable;
2369
2370 static wxEventHashTable* sm_first;
2371 wxEventHashTable* m_previous;
2372 wxEventHashTable* m_next;
2373
2374 DECLARE_NO_COPY_CLASS(wxEventHashTable)
2375};
2376
2377// ----------------------------------------------------------------------------
2378// wxEvtHandler: the base class for all objects handling wxWidgets events
2379// ----------------------------------------------------------------------------
2380
2381class WXDLLIMPEXP_BASE wxEvtHandler : public wxObject
2382{
2383public:
2384 wxEvtHandler();
2385 virtual ~wxEvtHandler();
2386
2387 wxEvtHandler *GetNextHandler() const { return m_nextHandler; }
2388 wxEvtHandler *GetPreviousHandler() const { return m_previousHandler; }
2389 void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
2390 void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
2391
2392 void SetEvtHandlerEnabled(bool enabled) { m_enabled = enabled; }
2393 bool GetEvtHandlerEnabled() const { return m_enabled; }
2394
2395 // process an event right now
2396 virtual bool ProcessEvent(wxEvent& event);
2397
2398 // add an event to be processed later
2399 void AddPendingEvent(wxEvent& event);
2400
2401 // process all pending events
2402 void ProcessPendingEvents();
2403
2404#if wxUSE_THREADS
2405 bool ProcessThreadEvent(wxEvent& event);
2406#endif
2407
2408 // Dynamic association of a member function handler with the event handler,
2409 // winid and event type
2410 void Connect(int winid,
2411 int lastId,
2412 int eventType,
2413 wxObjectEventFunction func,
2414 wxObject *userData = (wxObject *) NULL,
2415 wxEvtHandler *eventSink = (wxEvtHandler *) NULL);
2416
2417 // Convenience function: take just one id
2418 void Connect(int winid,
2419 int eventType,
2420 wxObjectEventFunction func,
2421 wxObject *userData = (wxObject *) NULL,
2422 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2423 { Connect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2424
2425 // Even more convenient: without id (same as using id of wxID_ANY)
2426 void Connect(int eventType,
2427 wxObjectEventFunction func,
2428 wxObject *userData = (wxObject *) NULL,
2429 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2430 { Connect(wxID_ANY, wxID_ANY, eventType, func, userData, eventSink); }
2431
2432 bool Disconnect(int winid,
2433 int lastId,
2434 wxEventType eventType,
2435 wxObjectEventFunction func = NULL,
2436 wxObject *userData = (wxObject *) NULL,
2437 wxEvtHandler *eventSink = (wxEvtHandler *) NULL);
2438
2439 bool Disconnect(int winid = wxID_ANY,
2440 wxEventType eventType = wxEVT_NULL,
2441 wxObjectEventFunction func = NULL,
2442 wxObject *userData = (wxObject *) NULL,
2443 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2444 { return Disconnect(winid, wxID_ANY, eventType, func, userData, eventSink); }
2445
2446 bool Disconnect(wxEventType eventType,
2447 wxObjectEventFunction func,
2448 wxObject *userData = (wxObject *) NULL,
2449 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
2450 { return Disconnect(wxID_ANY, eventType, func, userData, eventSink); }
2451
2452 wxList* GetDynamicEventTable() const { return m_dynamicEvents ; }
2453
2454 // User data can be associated with each wxEvtHandler
2455 void SetClientObject( wxClientData *data ) { DoSetClientObject(data); }
2456 wxClientData *GetClientObject() const { return DoGetClientObject(); }
2457
2458 void SetClientData( void *data ) { DoSetClientData(data); }
2459 void *GetClientData() const { return DoGetClientData(); }
2460
2461 // check if the given event table entry matches this event and call the
2462 // handler if it does
2463 //
2464 // return true if the event was processed, false otherwise (no match or the
2465 // handler decided to skip the event)
2466 static bool ProcessEventIfMatches(const wxEventTableEntryBase& tableEntry,
2467 wxEvtHandler *handler,
2468 wxEvent& event);
2469
2470 // implementation from now on
2471 virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
2472 bool SearchDynamicEventTable( wxEvent& event );
2473
2474#if wxUSE_THREADS
2475 void ClearEventLocker();
2476#endif // wxUSE_THREADS
2477
2478 // Avoid problems at exit by cleaning up static hash table gracefully
2479 void ClearEventHashTable() { GetEventHashTable().Clear(); }
2480
2481private:
2482 static const wxEventTableEntry sm_eventTableEntries[];
2483
2484protected:
2485 // hooks for wxWindow used by ProcessEvent()
2486 // -----------------------------------------
2487
2488 // This one is called before trying our own event table to allow plugging
2489 // in the validators.
2490 //
2491 // NB: This method is intentionally *not* inside wxUSE_VALIDATORS!
2492 // It is part of wxBase which doesn't use validators and the code
2493 // is compiled out when building wxBase w/o GUI classes, which affects
2494 // binary compatibility and wxBase library can't be used by GUI
2495 // ports.
2496 virtual bool TryValidator(wxEvent& WXUNUSED(event)) { return false; }
2497
2498 // this one is called after failing to find the event handle in our own
2499 // table to give a chance to the other windows to process it
2500 //
2501 // base class implementation passes the event to wxTheApp
2502 virtual bool TryParent(wxEvent& event);
2503
2504
2505 static const wxEventTable sm_eventTable;
2506 virtual const wxEventTable *GetEventTable() const;
2507
2508 static wxEventHashTable sm_eventHashTable;
2509 virtual wxEventHashTable& GetEventHashTable() const;
2510
2511 wxEvtHandler* m_nextHandler;
2512 wxEvtHandler* m_previousHandler;
2513 wxList* m_dynamicEvents;
2514 wxList* m_pendingEvents;
2515
2516#if wxUSE_THREADS
2517#if defined (__VISAGECPP__)
2518 const wxCriticalSection& Lock() const { return m_eventsLocker; }
2519 wxCriticalSection& Lock() { return m_eventsLocker; }
2520
2521 wxCriticalSection m_eventsLocker;
2522# else
2523 const wxCriticalSection& Lock() const { return *m_eventsLocker; }
2524 wxCriticalSection& Lock() { return *m_eventsLocker; }
2525
2526 wxCriticalSection* m_eventsLocker;
2527# endif
2528#endif
2529
2530 // Is event handler enabled?
2531 bool m_enabled;
2532
2533
2534 // The user data: either an object which will be deleted by the container
2535 // when it's deleted or some raw pointer which we do nothing with - only
2536 // one type of data can be used with the given window (i.e. you cannot set
2537 // the void data and then associate the container with wxClientData or vice
2538 // versa)
2539 union
2540 {
2541 wxClientData *m_clientObject;
2542 void *m_clientData;
2543 };
2544
2545 // what kind of data do we have?
2546 wxClientDataType m_clientDataType;
2547
2548 // client data accessors
2549 virtual void DoSetClientObject( wxClientData *data );
2550 virtual wxClientData *DoGetClientObject() const;
2551
2552 virtual void DoSetClientData( void *data );
2553 virtual void *DoGetClientData() const;
2554
2555private:
2556 DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler)
2557};
2558
2559// Post a message to the given eventhandler which will be processed during the
2560// next event loop iteration
2561inline void wxPostEvent(wxEvtHandler *dest, wxEvent& event)
2562{
2563 wxCHECK_RET( dest, wxT("need an object to post event to in wxPostEvent") );
2564
2565 dest->AddPendingEvent(event);
2566}
2567
2568typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
2569
2570#define wxEventHandler(func) \
2571 (wxObjectEventFunction)wxStaticCastEvent(wxEventFunction, &func)
2572
2573#if wxUSE_GUI
2574
2575typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&);
2576typedef void (wxEvtHandler::*wxScrollEventFunction)(wxScrollEvent&);
2577typedef void (wxEvtHandler::*wxScrollWinEventFunction)(wxScrollWinEvent&);
2578typedef void (wxEvtHandler::*wxSizeEventFunction)(wxSizeEvent&);
2579typedef void (wxEvtHandler::*wxMoveEventFunction)(wxMoveEvent&);
2580typedef void (wxEvtHandler::*wxPaintEventFunction)(wxPaintEvent&);
2581typedef void (wxEvtHandler::*wxNcPaintEventFunction)(wxNcPaintEvent&);
2582typedef void (wxEvtHandler::*wxEraseEventFunction)(wxEraseEvent&);
2583typedef void (wxEvtHandler::*wxMouseEventFunction)(wxMouseEvent&);
2584typedef void (wxEvtHandler::*wxCharEventFunction)(wxKeyEvent&);
2585typedef void (wxEvtHandler::*wxFocusEventFunction)(wxFocusEvent&);
2586typedef void (wxEvtHandler::*wxChildFocusEventFunction)(wxChildFocusEvent&);
2587typedef void (wxEvtHandler::*wxActivateEventFunction)(wxActivateEvent&);
2588typedef void (wxEvtHandler::*wxMenuEventFunction)(wxMenuEvent&);
2589typedef void (wxEvtHandler::*wxJoystickEventFunction)(wxJoystickEvent&);
2590typedef void (wxEvtHandler::*wxDropFilesEventFunction)(wxDropFilesEvent&);
2591typedef void (wxEvtHandler::*wxInitDialogEventFunction)(wxInitDialogEvent&);
2592typedef void (wxEvtHandler::*wxSysColourChangedEventFunction)(wxSysColourChangedEvent&);
2593typedef void (wxEvtHandler::*wxDisplayChangedEventFunction)(wxDisplayChangedEvent&);
2594typedef void (wxEvtHandler::*wxUpdateUIEventFunction)(wxUpdateUIEvent&);
2595typedef void (wxEvtHandler::*wxIdleEventFunction)(wxIdleEvent&);
2596typedef void (wxEvtHandler::*wxCloseEventFunction)(wxCloseEvent&);
2597typedef void (wxEvtHandler::*wxShowEventFunction)(wxShowEvent&);
2598typedef void (wxEvtHandler::*wxIconizeEventFunction)(wxIconizeEvent&);
2599typedef void (wxEvtHandler::*wxMaximizeEventFunction)(wxMaximizeEvent&);
2600typedef void (wxEvtHandler::*wxNavigationKeyEventFunction)(wxNavigationKeyEvent&);
2601typedef void (wxEvtHandler::*wxPaletteChangedEventFunction)(wxPaletteChangedEvent&);
2602typedef void (wxEvtHandler::*wxQueryNewPaletteEventFunction)(wxQueryNewPaletteEvent&);
2603typedef void (wxEvtHandler::*wxWindowCreateEventFunction)(wxWindowCreateEvent&);
2604typedef void (wxEvtHandler::*wxWindowDestroyEventFunction)(wxWindowDestroyEvent&);
2605typedef void (wxEvtHandler::*wxSetCursorEventFunction)(wxSetCursorEvent&);
2606typedef void (wxEvtHandler::*wxNotifyEventFunction)(wxNotifyEvent&);
2607typedef void (wxEvtHandler::*wxHelpEventFunction)(wxHelpEvent&);
2608typedef void (wxEvtHandler::*wxContextMenuEventFunction)(wxContextMenuEvent&);
2609typedef void (wxEvtHandler::*wxMouseCaptureChangedEventFunction)(wxMouseCaptureChangedEvent&);
2610typedef void (wxEvtHandler::*wxMouseCaptureLostEventFunction)(wxMouseCaptureLostEvent&);
2611typedef void (wxEvtHandler::*wxClipboardTextEventFunction)(wxClipboardTextEvent&);
2612
2613// these typedefs don't have the same name structure as the others, keep for
2614// backwards compatibility only
2615#if WXWIN_COMPATIBILITY_2_4
2616 typedef wxSysColourChangedEventFunction wxSysColourChangedFunction;
2617 typedef wxDisplayChangedEventFunction wxDisplayChangedFunction;
2618#endif // WXWIN_COMPATIBILITY_2_4
2619
2620
2621#define wxCommandEventHandler(func) \
2622 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCommandEventFunction, &func)
2623#define wxScrollEventHandler(func) \
2624 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxScrollEventFunction, &func)
2625#define wxScrollWinEventHandler(func) \
2626 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxScrollWinEventFunction, &func)
2627#define wxSizeEventHandler(func) \
2628 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSizeEventFunction, &func)
2629#define wxMoveEventHandler(func) \
2630 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMoveEventFunction, &func)
2631#define wxPaintEventHandler(func) \
2632 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxPaintEventFunction, &func)
2633#define wxNcPaintEventHandler(func) \
2634 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNcPaintEventFunction, &func)
2635#define wxEraseEventHandler(func) \
2636 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxEraseEventFunction, &func)
2637#define wxMouseEventHandler(func) \
2638 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseEventFunction, &func)
2639#define wxCharEventHandler(func) \
2640 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCharEventFunction, &func)
2641#define wxKeyEventHandler(func) wxCharEventHandler(func)
2642#define wxFocusEventHandler(func) \
2643 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxFocusEventFunction, &func)
2644#define wxChildFocusEventHandler(func) \
2645 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxChildFocusEventFunction, &func)
2646#define wxActivateEventHandler(func) \
2647 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxActivateEventFunction, &func)
2648#define wxMenuEventHandler(func) \
2649 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMenuEventFunction, &func)
2650#define wxJoystickEventHandler(func) \
2651 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxJoystickEventFunction, &func)
2652#define wxDropFilesEventHandler(func) \
2653 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDropFilesEventFunction, &func)
2654#define wxInitDialogEventHandler(func) \
2655 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxInitDialogEventFunction, &func)
2656#define wxSysColourChangedEventHandler(func) \
2657 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSysColourChangedEventFunction, &func)
2658#define wxDisplayChangedEventHandler(func) \
2659 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDisplayChangedEventFunction, &func)
2660#define wxUpdateUIEventHandler(func) \
2661 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxUpdateUIEventFunction, &func)
2662#define wxIdleEventHandler(func) \
2663 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxIdleEventFunction, &func)
2664#define wxCloseEventHandler(func) \
2665 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxCloseEventFunction, &func)
2666#define wxShowEventHandler(func) \
2667 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxShowEventFunction, &func)
2668#define wxIconizeEventHandler(func) \
2669 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxIconizeEventFunction, &func)
2670#define wxMaximizeEventHandler(func) \
2671 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMaximizeEventFunction, &func)
2672#define wxNavigationKeyEventHandler(func) \
2673 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNavigationKeyEventFunction, &func)
2674#define wxPaletteChangedEventHandler(func) \
2675 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxPaletteChangedEventFunction, &func)
2676#define wxQueryNewPaletteEventHandler(func) \
2677 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxQueryNewPaletteEventFunction, &func)
2678#define wxWindowCreateEventHandler(func) \
2679 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxWindowCreateEventFunction, &func)
2680#define wxWindowDestroyEventHandler(func) \
2681 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxWindowDestroyEventFunction, &func)
2682#define wxSetCursorEventHandler(func) \
2683 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSetCursorEventFunction, &func)
2684#define wxNotifyEventHandler(func) \
2685 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNotifyEventFunction, &func)
2686#define wxHelpEventHandler(func) \
2687 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxHelpEventFunction, &func)
2688#define wxContextMenuEventHandler(func) \
2689 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxContextMenuEventFunction, &func)
2690#define wxMouseCaptureChangedEventHandler(func) \
2691 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseCaptureChangedEventFunction, &func)
2692#define wxMouseCaptureLostEventHandler(func) \
2693 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxMouseCaptureLostEventFunction, &func)
2694#define wxClipboardTextEventHandler(func) \
2695 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxClipboardTextEventFunction, &func)
2696
2697#endif // wxUSE_GUI
2698
2699// N.B. In GNU-WIN32, you *have* to take the address of a member function
2700// (use &) or the compiler crashes...
2701
2702#define DECLARE_EVENT_TABLE() \
2703 private: \
2704 static const wxEventTableEntry sm_eventTableEntries[]; \
2705 protected: \
2706 static const wxEventTable sm_eventTable; \
2707 virtual const wxEventTable* GetEventTable() const; \
2708 static wxEventHashTable sm_eventHashTable; \
2709 virtual wxEventHashTable& GetEventHashTable() const;
2710
2711// N.B.: when building DLL with Borland C++ 5.5 compiler, you must initialize
2712// sm_eventTable before using it in GetEventTable() or the compiler gives
2713// E2233 (see http://groups.google.com/groups?selm=397dcc8a%241_2%40dnews)
2714
2715#define BEGIN_EVENT_TABLE(theClass, baseClass) \
2716 const wxEventTable theClass::sm_eventTable = \
2717 { &baseClass::sm_eventTable, &theClass::sm_eventTableEntries[0] }; \
2718 const wxEventTable *theClass::GetEventTable() const \
2719 { return &theClass::sm_eventTable; } \
2720 wxEventHashTable theClass::sm_eventHashTable(theClass::sm_eventTable); \
2721 wxEventHashTable &theClass::GetEventHashTable() const \
2722 { return theClass::sm_eventHashTable; } \
2723 const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
2724
2725#define BEGIN_EVENT_TABLE_TEMPLATE1(theClass, baseClass, T1) \
2726 template<typename T1> \
2727 const wxEventTable theClass<T1>::sm_eventTable = \
2728 { &baseClass::sm_eventTable, &theClass<T1>::sm_eventTableEntries[0] }; \
2729 template<typename T1> \
2730 const wxEventTable *theClass<T1>::GetEventTable() const \
2731 { return &theClass<T1>::sm_eventTable; } \
2732 template<typename T1> \
2733 wxEventHashTable theClass<T1>::sm_eventHashTable(theClass<T1>::sm_eventTable); \
2734 template<typename T1> \
2735 wxEventHashTable &theClass<T1>::GetEventHashTable() const \
2736 { return theClass<T1>::sm_eventHashTable; } \
2737 template<typename T1> \
2738 const wxEventTableEntry theClass<T1>::sm_eventTableEntries[] = { \
2739
2740#define BEGIN_EVENT_TABLE_TEMPLATE2(theClass, baseClass, T1, T2) \
2741 template<typename T1, typename T2> \
2742 const wxEventTable theClass<T1, T2>::sm_eventTable = \
2743 { &baseClass::sm_eventTable, &theClass<T1, T2>::sm_eventTableEntries[0] }; \
2744 template<typename T1, typename T2> \
2745 const wxEventTable *theClass<T1, T2>::GetEventTable() const \
2746 { return &theClass<T1, T2>::sm_eventTable; } \
2747 template<typename T1, typename T2> \
2748 wxEventHashTable theClass<T1, T2>::sm_eventHashTable(theClass<T1, T2>::sm_eventTable); \
2749 template<typename T1, typename T2> \
2750 wxEventHashTable &theClass<T1, T2>::GetEventHashTable() const \
2751 { return theClass<T1, T2>::sm_eventHashTable; } \
2752 template<typename T1, typename T2> \
2753 const wxEventTableEntry theClass<T1, T2>::sm_eventTableEntries[] = { \
2754
2755#define BEGIN_EVENT_TABLE_TEMPLATE3(theClass, baseClass, T1, T2, T3) \
2756 template<typename T1, typename T2, typename T3> \
2757 const wxEventTable theClass<T1, T2, T3>::sm_eventTable = \
2758 { &baseClass::sm_eventTable, &theClass<T1, T2, T3>::sm_eventTableEntries[0] }; \
2759 template<typename T1, typename T2, typename T3> \
2760 const wxEventTable *theClass<T1, T2, T3>::GetEventTable() const \
2761 { return &theClass<T1, T2, T3>::sm_eventTable; } \
2762 template<typename T1, typename T2, typename T3> \
2763 wxEventHashTable theClass<T1, T2, T3>::sm_eventHashTable(theClass<T1, T2, T3>::sm_eventTable); \
2764 template<typename T1, typename T2, typename T3> \
2765 wxEventHashTable &theClass<T1, T2, T3>::GetEventHashTable() const \
2766 { return theClass<T1, T2, T3>::sm_eventHashTable; } \
2767 template<typename T1, typename T2, typename T3> \
2768 const wxEventTableEntry theClass<T1, T2, T3>::sm_eventTableEntries[] = { \
2769
2770#define BEGIN_EVENT_TABLE_TEMPLATE4(theClass, baseClass, T1, T2, T3, T4) \
2771 template<typename T1, typename T2, typename T3, typename T4> \
2772 const wxEventTable theClass<T1, T2, T3, T4>::sm_eventTable = \
2773 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4>::sm_eventTableEntries[0] }; \
2774 template<typename T1, typename T2, typename T3, typename T4> \
2775 const wxEventTable *theClass<T1, T2, T3, T4>::GetEventTable() const \
2776 { return &theClass<T1, T2, T3, T4>::sm_eventTable; } \
2777 template<typename T1, typename T2, typename T3, typename T4> \
2778 wxEventHashTable theClass<T1, T2, T3, T4>::sm_eventHashTable(theClass<T1, T2, T3, T4>::sm_eventTable); \
2779 template<typename T1, typename T2, typename T3, typename T4> \
2780 wxEventHashTable &theClass<T1, T2, T3, T4>::GetEventHashTable() const \
2781 { return theClass<T1, T2, T3, T4>::sm_eventHashTable; } \
2782 template<typename T1, typename T2, typename T3, typename T4> \
2783 const wxEventTableEntry theClass<T1, T2, T3, T4>::sm_eventTableEntries[] = { \
2784
2785#define BEGIN_EVENT_TABLE_TEMPLATE5(theClass, baseClass, T1, T2, T3, T4, T5) \
2786 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2787 const wxEventTable theClass<T1, T2, T3, T4, T5>::sm_eventTable = \
2788 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[0] }; \
2789 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2790 const wxEventTable *theClass<T1, T2, T3, T4, T5>::GetEventTable() const \
2791 { return &theClass<T1, T2, T3, T4, T5>::sm_eventTable; } \
2792 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2793 wxEventHashTable theClass<T1, T2, T3, T4, T5>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5>::sm_eventTable); \
2794 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2795 wxEventHashTable &theClass<T1, T2, T3, T4, T5>::GetEventHashTable() const \
2796 { return theClass<T1, T2, T3, T4, T5>::sm_eventHashTable; } \
2797 template<typename T1, typename T2, typename T3, typename T4, typename T5> \
2798 const wxEventTableEntry theClass<T1, T2, T3, T4, T5>::sm_eventTableEntries[] = { \
2799
2800#define BEGIN_EVENT_TABLE_TEMPLATE7(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7) \
2801 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2802 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable = \
2803 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[0] }; \
2804 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2805 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventTable() const \
2806 { return &theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable; } \
2807 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2808 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTable); \
2809 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2810 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7>::GetEventHashTable() const \
2811 { return theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventHashTable; } \
2812 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7> \
2813 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7>::sm_eventTableEntries[] = { \
2814
2815#define BEGIN_EVENT_TABLE_TEMPLATE8(theClass, baseClass, T1, T2, T3, T4, T5, T6, T7, T8) \
2816 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2817 const wxEventTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable = \
2818 { &baseClass::sm_eventTable, &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[0] }; \
2819 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2820 const wxEventTable *theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventTable() const \
2821 { return &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable; } \
2822 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2823 wxEventHashTable theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable(theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTable); \
2824 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2825 wxEventHashTable &theClass<T1, T2, T3, T4, T5, T6, T7, T8>::GetEventHashTable() const \
2826 { return theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventHashTable; } \
2827 template<typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7, typename T8> \
2828 const wxEventTableEntry theClass<T1, T2, T3, T4, T5, T6, T7, T8>::sm_eventTableEntries[] = { \
2829
2830#define END_EVENT_TABLE() DECLARE_EVENT_TABLE_ENTRY( wxEVT_NULL, 0, 0, 0, 0 ) };
2831
2832/*
2833 * Event table macros
2834 */
2835
2836// helpers for writing shorter code below: declare an event macro taking 2, 1
2837// or none ids (the missing ids default to wxID_ANY)
2838//
2839// macro arguments:
2840// - evt one of wxEVT_XXX constants
2841// - id1, id2 ids of the first/last id
2842// - fn the function (should be cast to the right type)
2843#define wx__DECLARE_EVT2(evt, id1, id2, fn) \
2844 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
2845#define wx__DECLARE_EVT1(evt, id, fn) \
2846 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
2847#define wx__DECLARE_EVT0(evt, fn) \
2848 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
2849
2850
2851// Generic events
2852#define EVT_CUSTOM(event, winid, func) \
2853 wx__DECLARE_EVT1(event, winid, wxEventHandler(func))
2854#define EVT_CUSTOM_RANGE(event, id1, id2, func) \
2855 wx__DECLARE_EVT2(event, id1, id2, wxEventHandler(func))
2856
2857// EVT_COMMAND
2858#define EVT_COMMAND(winid, event, func) \
2859 wx__DECLARE_EVT1(event, winid, wxCommandEventHandler(func))
2860#define EVT_COMMAND_RANGE(id1, id2, event, func) \
2861 wx__DECLARE_EVT2(event, id1, id2, wxCommandEventHandler(func))
2862
2863#define EVT_NOTIFY(event, winid, func) \
2864 wx__DECLARE_EVT1(event, winid, wxNotifyEventHandler(func))
2865#define EVT_NOTIFY_RANGE(event, id1, id2, func) \
2866 wx__DECLARE_EVT2(event, id1, id2, wxNotifyEventHandler(func))
2867
2868// Miscellaneous
2869#define EVT_SIZE(func) wx__DECLARE_EVT0(wxEVT_SIZE, wxSizeEventHandler(func))
2870#define EVT_SIZING(func) wx__DECLARE_EVT0(wxEVT_SIZING, wxSizeEventHandler(func))
2871#define EVT_MOVE(func) wx__DECLARE_EVT0(wxEVT_MOVE, wxMoveEventHandler(func))
2872#define EVT_MOVING(func) wx__DECLARE_EVT0(wxEVT_MOVING, wxMoveEventHandler(func))
2873#define EVT_CLOSE(func) wx__DECLARE_EVT0(wxEVT_CLOSE_WINDOW, wxCloseEventHandler(func))
2874#define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
2875#define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
2876#define EVT_PAINT(func) wx__DECLARE_EVT0(wxEVT_PAINT, wxPaintEventHandler(func))
2877#define EVT_NC_PAINT(func) wx__DECLARE_EVT0(wxEVT_NC_PAINT, wxNcPaintEventHandler(func))
2878#define EVT_ERASE_BACKGROUND(func) wx__DECLARE_EVT0(wxEVT_ERASE_BACKGROUND, wxEraseEventHandler(func))
2879#define EVT_CHAR(func) wx__DECLARE_EVT0(wxEVT_CHAR, wxCharEventHandler(func))
2880#define EVT_KEY_DOWN(func) wx__DECLARE_EVT0(wxEVT_KEY_DOWN, wxKeyEventHandler(func))
2881#define EVT_KEY_UP(func) wx__DECLARE_EVT0(wxEVT_KEY_UP, wxKeyEventHandler(func))
2882#if wxUSE_HOTKEY
2883#define EVT_HOTKEY(winid, func) wx__DECLARE_EVT1(wxEVT_HOTKEY, winid, wxCharEventHandler(func))
2884#endif
2885#define EVT_CHAR_HOOK(func) wx__DECLARE_EVT0(wxEVT_CHAR_HOOK, wxCharEventHandler(func))
2886#define EVT_MENU_OPEN(func) wx__DECLARE_EVT0(wxEVT_MENU_OPEN, wxMenuEventHandler(func))
2887#define EVT_MENU_CLOSE(func) wx__DECLARE_EVT0(wxEVT_MENU_CLOSE, wxMenuEventHandler(func))
2888#define EVT_MENU_HIGHLIGHT(winid, func) wx__DECLARE_EVT1(wxEVT_MENU_HIGHLIGHT, winid, wxMenuEventHandler(func))
2889#define EVT_MENU_HIGHLIGHT_ALL(func) wx__DECLARE_EVT0(wxEVT_MENU_HIGHLIGHT, wxMenuEventHandler(func))
2890#define EVT_SET_FOCUS(func) wx__DECLARE_EVT0(wxEVT_SET_FOCUS, wxFocusEventHandler(func))
2891#define EVT_KILL_FOCUS(func) wx__DECLARE_EVT0(wxEVT_KILL_FOCUS, wxFocusEventHandler(func))
2892#define EVT_CHILD_FOCUS(func) wx__DECLARE_EVT0(wxEVT_CHILD_FOCUS, wxChildFocusEventHandler(func))
2893#define EVT_ACTIVATE(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE, wxActivateEventHandler(func))
2894#define EVT_ACTIVATE_APP(func) wx__DECLARE_EVT0(wxEVT_ACTIVATE_APP, wxActivateEventHandler(func))
2895#define EVT_HIBERNATE(func) wx__DECLARE_EVT0(wxEVT_HIBERNATE, wxActivateEventHandler(func))
2896#define EVT_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_END_SESSION, wxCloseEventHandler(func))
2897#define EVT_QUERY_END_SESSION(func) wx__DECLARE_EVT0(wxEVT_QUERY_END_SESSION, wxCloseEventHandler(func))
2898#define EVT_DROP_FILES(func) wx__DECLARE_EVT0(wxEVT_DROP_FILES, wxDropFilesEventHandler(func))
2899#define EVT_INIT_DIALOG(func) wx__DECLARE_EVT0(wxEVT_INIT_DIALOG, wxInitDialogEventHandler(func))
2900#define EVT_SYS_COLOUR_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEventHandler(func))
2901#define EVT_DISPLAY_CHANGED(func) wx__DECLARE_EVT0(wxEVT_DISPLAY_CHANGED, wxDisplayChangedEventHandler(func))
2902#define EVT_SHOW(func) wx__DECLARE_EVT0(wxEVT_SHOW, wxShowEventHandler(func))
2903#define EVT_MAXIMIZE(func) wx__DECLARE_EVT0(wxEVT_MAXIMIZE, wxMaximizeEventHandler(func))
2904#define EVT_ICONIZE(func) wx__DECLARE_EVT0(wxEVT_ICONIZE, wxIconizeEventHandler(func))
2905#define EVT_NAVIGATION_KEY(func) wx__DECLARE_EVT0(wxEVT_NAVIGATION_KEY, wxNavigationKeyEventHandler(func))
2906#define EVT_PALETTE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_PALETTE_CHANGED, wxPaletteChangedEventHandler(func))
2907#define EVT_QUERY_NEW_PALETTE(func) wx__DECLARE_EVT0(wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEventHandler(func))
2908#define EVT_WINDOW_CREATE(func) wx__DECLARE_EVT0(wxEVT_CREATE, wxWindowCreateEventHandler(func))
2909#define EVT_WINDOW_DESTROY(func) wx__DECLARE_EVT0(wxEVT_DESTROY, wxWindowDestroyEventHandler(func))
2910#define EVT_SET_CURSOR(func) wx__DECLARE_EVT0(wxEVT_SET_CURSOR, wxSetCursorEventHandler(func))
2911#define EVT_MOUSE_CAPTURE_CHANGED(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEventHandler(func))
2912#define EVT_MOUSE_CAPTURE_LOST(func) wx__DECLARE_EVT0(wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEventHandler(func))
2913
2914// Mouse events
2915#define EVT_LEFT_DOWN(func) wx__DECLARE_EVT0(wxEVT_LEFT_DOWN, wxMouseEventHandler(func))
2916#define EVT_LEFT_UP(func) wx__DECLARE_EVT0(wxEVT_LEFT_UP, wxMouseEventHandler(func))
2917#define EVT_MIDDLE_DOWN(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DOWN, wxMouseEventHandler(func))
2918#define EVT_MIDDLE_UP(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_UP, wxMouseEventHandler(func))
2919#define EVT_RIGHT_DOWN(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DOWN, wxMouseEventHandler(func))
2920#define EVT_RIGHT_UP(func) wx__DECLARE_EVT0(wxEVT_RIGHT_UP, wxMouseEventHandler(func))
2921#define EVT_MOTION(func) wx__DECLARE_EVT0(wxEVT_MOTION, wxMouseEventHandler(func))
2922#define EVT_LEFT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_LEFT_DCLICK, wxMouseEventHandler(func))
2923#define EVT_MIDDLE_DCLICK(func) wx__DECLARE_EVT0(wxEVT_MIDDLE_DCLICK, wxMouseEventHandler(func))
2924#define EVT_RIGHT_DCLICK(func) wx__DECLARE_EVT0(wxEVT_RIGHT_DCLICK, wxMouseEventHandler(func))
2925#define EVT_LEAVE_WINDOW(func) wx__DECLARE_EVT0(wxEVT_LEAVE_WINDOW, wxMouseEventHandler(func))
2926#define EVT_ENTER_WINDOW(func) wx__DECLARE_EVT0(wxEVT_ENTER_WINDOW, wxMouseEventHandler(func))
2927#define EVT_MOUSEWHEEL(func) wx__DECLARE_EVT0(wxEVT_MOUSEWHEEL, wxMouseEventHandler(func))
2928
2929// All mouse events
2930#define EVT_MOUSE_EVENTS(func) \
2931 EVT_LEFT_DOWN(func) \
2932 EVT_LEFT_UP(func) \
2933 EVT_MIDDLE_DOWN(func) \
2934 EVT_MIDDLE_UP(func) \
2935 EVT_RIGHT_DOWN(func) \
2936 EVT_RIGHT_UP(func) \
2937 EVT_MOTION(func) \
2938 EVT_LEFT_DCLICK(func) \
2939 EVT_MIDDLE_DCLICK(func) \
2940 EVT_RIGHT_DCLICK(func) \
2941 EVT_LEAVE_WINDOW(func) \
2942 EVT_ENTER_WINDOW(func) \
2943 EVT_MOUSEWHEEL(func)
2944
2945// Scrolling from wxWindow (sent to wxScrolledWindow)
2946#define EVT_SCROLLWIN_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_TOP, wxScrollWinEventHandler(func))
2947#define EVT_SCROLLWIN_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEventHandler(func))
2948#define EVT_SCROLLWIN_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEUP, wxScrollWinEventHandler(func))
2949#define EVT_SCROLLWIN_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEventHandler(func))
2950#define EVT_SCROLLWIN_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEventHandler(func))
2951#define EVT_SCROLLWIN_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEventHandler(func))
2952#define EVT_SCROLLWIN_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEventHandler(func))
2953#define EVT_SCROLLWIN_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEventHandler(func))
2954
2955#define EVT_SCROLLWIN(func) \
2956 EVT_SCROLLWIN_TOP(func) \
2957 EVT_SCROLLWIN_BOTTOM(func) \
2958 EVT_SCROLLWIN_LINEUP(func) \
2959 EVT_SCROLLWIN_LINEDOWN(func) \
2960 EVT_SCROLLWIN_PAGEUP(func) \
2961 EVT_SCROLLWIN_PAGEDOWN(func) \
2962 EVT_SCROLLWIN_THUMBTRACK(func) \
2963 EVT_SCROLLWIN_THUMBRELEASE(func)
2964
2965// Scrolling from wxSlider and wxScrollBar
2966#define EVT_SCROLL_TOP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_TOP, wxScrollEventHandler(func))
2967#define EVT_SCROLL_BOTTOM(func) wx__DECLARE_EVT0(wxEVT_SCROLL_BOTTOM, wxScrollEventHandler(func))
2968#define EVT_SCROLL_LINEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEUP, wxScrollEventHandler(func))
2969#define EVT_SCROLL_LINEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_LINEDOWN, wxScrollEventHandler(func))
2970#define EVT_SCROLL_PAGEUP(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEUP, wxScrollEventHandler(func))
2971#define EVT_SCROLL_PAGEDOWN(func) wx__DECLARE_EVT0(wxEVT_SCROLL_PAGEDOWN, wxScrollEventHandler(func))
2972#define EVT_SCROLL_THUMBTRACK(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBTRACK, wxScrollEventHandler(func))
2973#define EVT_SCROLL_THUMBRELEASE(func) wx__DECLARE_EVT0(wxEVT_SCROLL_THUMBRELEASE, wxScrollEventHandler(func))
2974#define EVT_SCROLL_CHANGED(func) wx__DECLARE_EVT0(wxEVT_SCROLL_CHANGED, wxScrollEventHandler(func))
2975
2976#define EVT_SCROLL(func) \
2977 EVT_SCROLL_TOP(func) \
2978 EVT_SCROLL_BOTTOM(func) \
2979 EVT_SCROLL_LINEUP(func) \
2980 EVT_SCROLL_LINEDOWN(func) \
2981 EVT_SCROLL_PAGEUP(func) \
2982 EVT_SCROLL_PAGEDOWN(func) \
2983 EVT_SCROLL_THUMBTRACK(func) \
2984 EVT_SCROLL_THUMBRELEASE(func) \
2985 EVT_SCROLL_CHANGED(func)
2986
2987// Scrolling from wxSlider and wxScrollBar, with an id
2988#define EVT_COMMAND_SCROLL_TOP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_TOP, winid, wxScrollEventHandler(func))
2989#define EVT_COMMAND_SCROLL_BOTTOM(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_BOTTOM, winid, wxScrollEventHandler(func))
2990#define EVT_COMMAND_SCROLL_LINEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEUP, winid, wxScrollEventHandler(func))
2991#define EVT_COMMAND_SCROLL_LINEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_LINEDOWN, winid, wxScrollEventHandler(func))
2992#define EVT_COMMAND_SCROLL_PAGEUP(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEUP, winid, wxScrollEventHandler(func))
2993#define EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_PAGEDOWN, winid, wxScrollEventHandler(func))
2994#define EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBTRACK, winid, wxScrollEventHandler(func))
2995#define EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_THUMBRELEASE, winid, wxScrollEventHandler(func))
2996#define EVT_COMMAND_SCROLL_CHANGED(winid, func) wx__DECLARE_EVT1(wxEVT_SCROLL_CHANGED, winid, wxScrollEventHandler(func))
2997
2998#define EVT_COMMAND_SCROLL(winid, func) \
2999 EVT_COMMAND_SCROLL_TOP(winid, func) \
3000 EVT_COMMAND_SCROLL_BOTTOM(winid, func) \
3001 EVT_COMMAND_SCROLL_LINEUP(winid, func) \
3002 EVT_COMMAND_SCROLL_LINEDOWN(winid, func) \
3003 EVT_COMMAND_SCROLL_PAGEUP(winid, func) \
3004 EVT_COMMAND_SCROLL_PAGEDOWN(winid, func) \
3005 EVT_COMMAND_SCROLL_THUMBTRACK(winid, func) \
3006 EVT_COMMAND_SCROLL_THUMBRELEASE(winid, func) \
3007 EVT_COMMAND_SCROLL_CHANGED(winid, func)
3008
3009#if WXWIN_COMPATIBILITY_2_6
3010 // compatibility macros for the old name, deprecated in 2.8
3011 #define wxEVT_SCROLL_ENDSCROLL wxEVT_SCROLL_CHANGED
3012 #define EVT_COMMAND_SCROLL_ENDSCROLL EVT_COMMAND_SCROLL_CHANGED
3013 #define EVT_SCROLL_ENDSCROLL EVT_SCROLL_CHANGED
3014#endif // WXWIN_COMPATIBILITY_2_6
3015
3016// Convenience macros for commonly-used commands
3017#define EVT_CHECKBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKBOX_CLICKED, winid, wxCommandEventHandler(func))
3018#define EVT_CHOICE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHOICE_SELECTED, winid, wxCommandEventHandler(func))
3019#define EVT_LISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_SELECTED, winid, wxCommandEventHandler(func))
3020#define EVT_LISTBOX_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, winid, wxCommandEventHandler(func))
3021#define EVT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_MENU_SELECTED, winid, wxCommandEventHandler(func))
3022#define EVT_MENU_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_MENU_SELECTED, id1, id2, wxCommandEventHandler(func))
3023#if defined(__SMARTPHONE__)
3024# define EVT_BUTTON(winid, func) EVT_MENU(winid, func)
3025#else
3026# define EVT_BUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_BUTTON_CLICKED, winid, wxCommandEventHandler(func))
3027#endif
3028#define EVT_SLIDER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SLIDER_UPDATED, winid, wxCommandEventHandler(func))
3029#define EVT_RADIOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBOX_SELECTED, winid, wxCommandEventHandler(func))
3030#define EVT_RADIOBUTTON(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RADIOBUTTON_SELECTED, winid, wxCommandEventHandler(func))
3031// EVT_SCROLLBAR is now obsolete since we use EVT_COMMAND_SCROLL... events
3032#define EVT_SCROLLBAR(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SCROLLBAR_UPDATED, winid, wxCommandEventHandler(func))
3033#define EVT_VLBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_VLBOX_SELECTED, winid, wxCommandEventHandler(func))
3034#define EVT_COMBOBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_SELECTED, winid, wxCommandEventHandler(func))
3035#define EVT_TOOL(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_CLICKED, winid, wxCommandEventHandler(func))
3036#define EVT_TOOL_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_CLICKED, id1, id2, wxCommandEventHandler(func))
3037#define EVT_TOOL_RCLICKED(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_RCLICKED, winid, wxCommandEventHandler(func))
3038#define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
3039#define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
3040#define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
3041
3042// Generic command events
3043#define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
3044#define EVT_COMMAND_LEFT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_DCLICK, winid, wxCommandEventHandler(func))
3045#define EVT_COMMAND_RIGHT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_CLICK, winid, wxCommandEventHandler(func))
3046#define EVT_COMMAND_RIGHT_DCLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_RIGHT_DCLICK, winid, wxCommandEventHandler(func))
3047#define EVT_COMMAND_SET_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_SET_FOCUS, winid, wxCommandEventHandler(func))
3048#define EVT_COMMAND_KILL_FOCUS(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_KILL_FOCUS, winid, wxCommandEventHandler(func))
3049#define EVT_COMMAND_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_ENTER, winid, wxCommandEventHandler(func))
3050
3051// Joystick events
3052
3053#define EVT_JOY_BUTTON_DOWN(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_DOWN, wxJoystickEventHandler(func))
3054#define EVT_JOY_BUTTON_UP(func) wx__DECLARE_EVT0(wxEVT_JOY_BUTTON_UP, wxJoystickEventHandler(func))
3055#define EVT_JOY_MOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_MOVE, wxJoystickEventHandler(func))
3056#define EVT_JOY_ZMOVE(func) wx__DECLARE_EVT0(wxEVT_JOY_ZMOVE, wxJoystickEventHandler(func))
3057
3058// These are obsolete, see _BUTTON_ events
3059#if WXWIN_COMPATIBILITY_2_4
3060 #define EVT_JOY_DOWN(func) EVT_JOY_BUTTON_DOWN(func)
3061 #define EVT_JOY_UP(func) EVT_JOY_BUTTON_UP(func)
3062#endif // WXWIN_COMPATIBILITY_2_4
3063
3064// All joystick events
3065#define EVT_JOYSTICK_EVENTS(func) \
3066 EVT_JOY_BUTTON_DOWN(func) \
3067 EVT_JOY_BUTTON_UP(func) \
3068 EVT_JOY_MOVE(func) \
3069 EVT_JOY_ZMOVE(func)
3070
3071// Idle event
3072#define EVT_IDLE(func) wx__DECLARE_EVT0(wxEVT_IDLE, wxIdleEventHandler(func))
3073
3074// Update UI event
3075#define EVT_UPDATE_UI(winid, func) wx__DECLARE_EVT1(wxEVT_UPDATE_UI, winid, wxUpdateUIEventHandler(func))
3076#define EVT_UPDATE_UI_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_UPDATE_UI, id1, id2, wxUpdateUIEventHandler(func))
3077
3078// Help events
3079#define EVT_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_HELP, winid, wxHelpEventHandler(func))
3080#define EVT_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_HELP, id1, id2, wxHelpEventHandler(func))
3081#define EVT_DETAILED_HELP(winid, func) wx__DECLARE_EVT1(wxEVT_DETAILED_HELP, winid, wxHelpEventHandler(func))
3082#define EVT_DETAILED_HELP_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_DETAILED_HELP, id1, id2, wxHelpEventHandler(func))
3083
3084// Context Menu Events
3085#define EVT_CONTEXT_MENU(func) wx__DECLARE_EVT0(wxEVT_CONTEXT_MENU, wxContextMenuEventHandler(func))
3086#define EVT_COMMAND_CONTEXT_MENU(winid, func) wx__DECLARE_EVT1(wxEVT_CONTEXT_MENU, winid, wxContextMenuEventHandler(func))
3087
3088// Clipboard text Events
3089#define EVT_TEXT_CUT(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_CUT, winid, wxClipboardTextEventHandler(func))
3090#define EVT_TEXT_COPY(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_COPY, winid, wxClipboardTextEventHandler(func))
3091#define EVT_TEXT_PASTE(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_PASTE, winid, wxClipboardTextEventHandler(func))
3092
3093// ----------------------------------------------------------------------------
3094// Global data
3095// ----------------------------------------------------------------------------
3096
3097// for pending event processing - notice that there is intentionally no
3098// WXDLLEXPORT here
3099extern WXDLLIMPEXP_BASE wxList *wxPendingEvents;
3100#if wxUSE_THREADS
3101 extern WXDLLIMPEXP_BASE wxCriticalSection *wxPendingEventsLocker;
3102#endif
3103
3104// ----------------------------------------------------------------------------
3105// Helper functions
3106// ----------------------------------------------------------------------------
3107
3108#if wxUSE_GUI
3109
3110// Find a window with the focus, that is also a descendant of the given window.
3111// This is used to determine the window to initially send commands to.
3112WXDLLIMPEXP_CORE wxWindow* wxFindFocusDescendant(wxWindow* ancestor);
3113
3114#endif // wxUSE_GUI
3115
3116#endif // _WX_EVENT_H__