]> git.saurik.com Git - wxWidgets.git/blob - src/common/event.cpp
projects / wxWidgets.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
fixing overrelease and out-of-bounds write, fixes #13725
[wxWidgets.git] / src / common / event.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/event.cpp
3 // Purpose: Event classes
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 01/02/97
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 // ============================================================================
13 // declarations
14 // ============================================================================
15
16 // ----------------------------------------------------------------------------
17 // headers
18 // ----------------------------------------------------------------------------
19
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
22
23 #ifdef __BORLANDC__
24 #pragma hdrstop
25 #endif
26
27 #include "wx/event.h"
28 #include "wx/eventfilter.h"
29 #include "wx/evtloop.h"
30
31 #ifndef WX_PRECOMP
32 #include "wx/list.h"
33 #include "wx/log.h"
34 #include "wx/app.h"
35 #include "wx/utils.h"
36 #include "wx/stopwatch.h"
37 #include "wx/module.h"
38
39 #if wxUSE_GUI
40 #include "wx/window.h"
41 #include "wx/control.h"
42 #include "wx/dc.h"
43 #include "wx/spinbutt.h"
44 #include "wx/textctrl.h"
45 #include "wx/validate.h"
46 #endif // wxUSE_GUI
47 #endif
48
49 #include "wx/thread.h"
50
51 #if wxUSE_BASE
52 #include "wx/scopedptr.h"
53
54 wxDECLARE_SCOPED_PTR(wxEvent, wxEventPtr)
55 wxDEFINE_SCOPED_PTR(wxEvent, wxEventPtr)
56 #endif // wxUSE_BASE
57
58 // ----------------------------------------------------------------------------
59 // wxWin macros
60 // ----------------------------------------------------------------------------
61
62 #if wxUSE_BASE
63 IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler, wxObject)
64 IMPLEMENT_ABSTRACT_CLASS(wxEvent, wxObject)
65 IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent)
66 IMPLEMENT_DYNAMIC_CLASS(wxThreadEvent, wxEvent)
67 #endif // wxUSE_BASE
68
69 #if wxUSE_GUI
70 IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent, wxEvent)
71 IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent, wxCommandEvent)
72 IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent, wxCommandEvent)
73 IMPLEMENT_DYNAMIC_CLASS(wxScrollWinEvent, wxEvent)
74 IMPLEMENT_DYNAMIC_CLASS(wxMouseEvent, wxEvent)
75 IMPLEMENT_DYNAMIC_CLASS(wxKeyEvent, wxEvent)
76 IMPLEMENT_DYNAMIC_CLASS(wxSizeEvent, wxEvent)
77 IMPLEMENT_DYNAMIC_CLASS(wxPaintEvent, wxEvent)
78 IMPLEMENT_DYNAMIC_CLASS(wxNcPaintEvent, wxEvent)
79 IMPLEMENT_DYNAMIC_CLASS(wxEraseEvent, wxEvent)
80 IMPLEMENT_DYNAMIC_CLASS(wxMoveEvent, wxEvent)
81 IMPLEMENT_DYNAMIC_CLASS(wxFocusEvent, wxEvent)
82 IMPLEMENT_DYNAMIC_CLASS(wxChildFocusEvent, wxCommandEvent)
83 IMPLEMENT_DYNAMIC_CLASS(wxCloseEvent, wxEvent)
84 IMPLEMENT_DYNAMIC_CLASS(wxShowEvent, wxEvent)
85 IMPLEMENT_DYNAMIC_CLASS(wxMaximizeEvent, wxEvent)
86 IMPLEMENT_DYNAMIC_CLASS(wxIconizeEvent, wxEvent)
87 IMPLEMENT_DYNAMIC_CLASS(wxMenuEvent, wxEvent)
88 IMPLEMENT_DYNAMIC_CLASS(wxJoystickEvent, wxEvent)
89 IMPLEMENT_DYNAMIC_CLASS(wxDropFilesEvent, wxEvent)
90 IMPLEMENT_DYNAMIC_CLASS(wxActivateEvent, wxEvent)
91 IMPLEMENT_DYNAMIC_CLASS(wxInitDialogEvent, wxEvent)
92 IMPLEMENT_DYNAMIC_CLASS(wxSetCursorEvent, wxEvent)
93 IMPLEMENT_DYNAMIC_CLASS(wxSysColourChangedEvent, wxEvent)
94 IMPLEMENT_DYNAMIC_CLASS(wxDisplayChangedEvent, wxEvent)
95 IMPLEMENT_DYNAMIC_CLASS(wxUpdateUIEvent, wxCommandEvent)
96 IMPLEMENT_DYNAMIC_CLASS(wxNavigationKeyEvent, wxEvent)
97 IMPLEMENT_DYNAMIC_CLASS(wxPaletteChangedEvent, wxEvent)
98 IMPLEMENT_DYNAMIC_CLASS(wxQueryNewPaletteEvent, wxEvent)
99 IMPLEMENT_DYNAMIC_CLASS(wxWindowCreateEvent, wxEvent)
100 IMPLEMENT_DYNAMIC_CLASS(wxWindowDestroyEvent, wxEvent)
101 IMPLEMENT_DYNAMIC_CLASS(wxHelpEvent, wxCommandEvent)
102 IMPLEMENT_DYNAMIC_CLASS(wxContextMenuEvent, wxCommandEvent)
103 IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureChangedEvent, wxEvent)
104 IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureLostEvent, wxEvent)
105 IMPLEMENT_DYNAMIC_CLASS(wxClipboardTextEvent, wxCommandEvent)
106 #endif // wxUSE_GUI
107
108 #if wxUSE_BASE
109
110 const wxEventTable *wxEvtHandler::GetEventTable() const
111 { return &wxEvtHandler::sm_eventTable; }
112
113 const wxEventTable wxEvtHandler::sm_eventTable =
114 { (const wxEventTable *)NULL, &wxEvtHandler::sm_eventTableEntries[0] };
115
116 wxEventHashTable &wxEvtHandler::GetEventHashTable() const
117 { return wxEvtHandler::sm_eventHashTable; }
118
119 wxEventHashTable wxEvtHandler::sm_eventHashTable(wxEvtHandler::sm_eventTable);
120
121 const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] =
122 { wxDECLARE_EVENT_TABLE_TERMINATOR() };
123
124
125 // wxUSE_MEMORY_TRACING considers memory freed from the static objects dtors
126 // leaked, so we need to manually clean up all event tables before checking for
127 // the memory leaks when using it, however this breaks re-initializing the
128 // library (i.e. repeated calls to wxInitialize/wxUninitialize) because the
129 // event tables won't be rebuilt the next time, so disable this by default
130 #if wxUSE_MEMORY_TRACING
131
132 class wxEventTableEntryModule: public wxModule
133 {
134 public:
135 wxEventTableEntryModule() { }
136 virtual bool OnInit() { return true; }
137 virtual void OnExit() { wxEventHashTable::ClearAll(); }
138
139 DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule)
140 };
141
142 IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule, wxModule)
143
144 #endif // wxUSE_MEMORY_TRACING
145
146 // ----------------------------------------------------------------------------
147 // global variables
148 // ----------------------------------------------------------------------------
149
150 // common event types are defined here, other event types are defined by the
151 // components which use them
152
153 const wxEventType wxEVT_FIRST = 10000;
154 const wxEventType wxEVT_USER_FIRST = wxEVT_FIRST + 2000;
155 const wxEventType wxEVT_NULL = wxNewEventType();
156
157 wxDEFINE_EVENT( wxEVT_IDLE, wxIdleEvent );
158
159 // Thread and asynchronous call events
160 wxDEFINE_EVENT( wxEVT_THREAD, wxThreadEvent );
161 wxDEFINE_EVENT( wxEVT_ASYNC_METHOD_CALL, wxAsyncMethodCallEvent );
162
163 #endif // wxUSE_BASE
164
165 #if wxUSE_GUI
166
167 wxDEFINE_EVENT( wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEvent );
168 wxDEFINE_EVENT( wxEVT_COMMAND_CHECKBOX_CLICKED, wxCommandEvent );
169 wxDEFINE_EVENT( wxEVT_COMMAND_CHOICE_SELECTED, wxCommandEvent );
170 wxDEFINE_EVENT( wxEVT_COMMAND_LISTBOX_SELECTED, wxCommandEvent );
171 wxDEFINE_EVENT( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, wxCommandEvent );
172 wxDEFINE_EVENT( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, wxCommandEvent );
173 wxDEFINE_EVENT( wxEVT_COMMAND_MENU_SELECTED, wxCommandEvent );
174 wxDEFINE_EVENT( wxEVT_COMMAND_SLIDER_UPDATED, wxCommandEvent );
175 wxDEFINE_EVENT( wxEVT_COMMAND_RADIOBOX_SELECTED, wxCommandEvent );
176 wxDEFINE_EVENT( wxEVT_COMMAND_RADIOBUTTON_SELECTED, wxCommandEvent );
177 wxDEFINE_EVENT( wxEVT_COMMAND_SCROLLBAR_UPDATED, wxCommandEvent );
178 wxDEFINE_EVENT( wxEVT_COMMAND_VLBOX_SELECTED, wxCommandEvent );
179 wxDEFINE_EVENT( wxEVT_COMMAND_COMBOBOX_SELECTED, wxCommandEvent );
180 wxDEFINE_EVENT( wxEVT_COMMAND_TOOL_RCLICKED, wxCommandEvent );
181 wxDEFINE_EVENT( wxEVT_COMMAND_TOOL_ENTER, wxCommandEvent );
182 wxDEFINE_EVENT( wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEvent );
183 wxDEFINE_EVENT( wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED, wxCommandEvent );
184 wxDEFINE_EVENT( wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, wxCommandEvent );
185 wxDEFINE_EVENT( wxEVT_COMMAND_COMBOBOX_DROPDOWN, wxCommandEvent);
186 wxDEFINE_EVENT( wxEVT_COMMAND_COMBOBOX_CLOSEUP, wxCommandEvent);
187
188 // Mouse event types
189 wxDEFINE_EVENT( wxEVT_LEFT_DOWN, wxMouseEvent );
190 wxDEFINE_EVENT( wxEVT_LEFT_UP, wxMouseEvent );
191 wxDEFINE_EVENT( wxEVT_MIDDLE_DOWN, wxMouseEvent );
192 wxDEFINE_EVENT( wxEVT_MIDDLE_UP, wxMouseEvent );
193 wxDEFINE_EVENT( wxEVT_RIGHT_DOWN, wxMouseEvent );
194 wxDEFINE_EVENT( wxEVT_RIGHT_UP, wxMouseEvent );
195 wxDEFINE_EVENT( wxEVT_MOTION, wxMouseEvent );
196 wxDEFINE_EVENT( wxEVT_ENTER_WINDOW, wxMouseEvent );
197 wxDEFINE_EVENT( wxEVT_LEAVE_WINDOW, wxMouseEvent );
198 wxDEFINE_EVENT( wxEVT_LEFT_DCLICK, wxMouseEvent );
199 wxDEFINE_EVENT( wxEVT_MIDDLE_DCLICK, wxMouseEvent );
200 wxDEFINE_EVENT( wxEVT_RIGHT_DCLICK, wxMouseEvent );
201 wxDEFINE_EVENT( wxEVT_SET_FOCUS, wxFocusEvent );
202 wxDEFINE_EVENT( wxEVT_KILL_FOCUS, wxFocusEvent );
203 wxDEFINE_EVENT( wxEVT_CHILD_FOCUS, wxChildFocusEvent );
204 wxDEFINE_EVENT( wxEVT_MOUSEWHEEL, wxMouseEvent );
205 wxDEFINE_EVENT( wxEVT_AUX1_DOWN, wxMouseEvent );
206 wxDEFINE_EVENT( wxEVT_AUX1_UP, wxMouseEvent );
207 wxDEFINE_EVENT( wxEVT_AUX1_DCLICK, wxMouseEvent );
208 wxDEFINE_EVENT( wxEVT_AUX2_DOWN, wxMouseEvent );
209 wxDEFINE_EVENT( wxEVT_AUX2_UP, wxMouseEvent );
210 wxDEFINE_EVENT( wxEVT_AUX2_DCLICK, wxMouseEvent );
211
212 // Character input event type
213 wxDEFINE_EVENT( wxEVT_CHAR, wxKeyEvent );
214 wxDEFINE_EVENT( wxEVT_AFTER_CHAR, wxKeyEvent );
215 wxDEFINE_EVENT( wxEVT_CHAR_HOOK, wxKeyEvent );
216 wxDEFINE_EVENT( wxEVT_NAVIGATION_KEY, wxNavigationKeyEvent );
217 wxDEFINE_EVENT( wxEVT_KEY_DOWN, wxKeyEvent );
218 wxDEFINE_EVENT( wxEVT_KEY_UP, wxKeyEvent );
219 #if wxUSE_HOTKEY
220 wxDEFINE_EVENT( wxEVT_HOTKEY, wxKeyEvent );
221 #endif
222
223 // Set cursor event
224 wxDEFINE_EVENT( wxEVT_SET_CURSOR, wxSetCursorEvent );
225
226 // wxScrollbar and wxSlider event identifiers
227 wxDEFINE_EVENT( wxEVT_SCROLL_TOP, wxScrollEvent );
228 wxDEFINE_EVENT( wxEVT_SCROLL_BOTTOM, wxScrollEvent );
229 wxDEFINE_EVENT( wxEVT_SCROLL_LINEUP, wxScrollEvent );
230 wxDEFINE_EVENT( wxEVT_SCROLL_LINEDOWN, wxScrollEvent );
231 wxDEFINE_EVENT( wxEVT_SCROLL_PAGEUP, wxScrollEvent );
232 wxDEFINE_EVENT( wxEVT_SCROLL_PAGEDOWN, wxScrollEvent );
233 wxDEFINE_EVENT( wxEVT_SCROLL_THUMBTRACK, wxScrollEvent );
234 wxDEFINE_EVENT( wxEVT_SCROLL_THUMBRELEASE, wxScrollEvent );
235 wxDEFINE_EVENT( wxEVT_SCROLL_CHANGED, wxScrollEvent );
236
237 // Due to a bug in older wx versions, wxSpinEvents were being sent with type of
238 // wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But
239 // with the type-safe events in place, these event types are associated with
240 // wxScrollEvent. To allow handling of spin events, new event types have been
241 // defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility
242 // the spin event types are being initialized with the scroll event types.
243
244 #if wxUSE_SPINBTN
245
246 wxDEFINE_EVENT_ALIAS( wxEVT_SPIN_UP, wxSpinEvent, wxEVT_SCROLL_LINEUP );
247 wxDEFINE_EVENT_ALIAS( wxEVT_SPIN_DOWN, wxSpinEvent, wxEVT_SCROLL_LINEDOWN );
248 wxDEFINE_EVENT_ALIAS( wxEVT_SPIN, wxSpinEvent, wxEVT_SCROLL_THUMBTRACK );
249
250 #endif // wxUSE_SPINBTN
251
252 // Scroll events from wxWindow
253 wxDEFINE_EVENT( wxEVT_SCROLLWIN_TOP, wxScrollWinEvent );
254 wxDEFINE_EVENT( wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEvent );
255 wxDEFINE_EVENT( wxEVT_SCROLLWIN_LINEUP, wxScrollWinEvent );
256 wxDEFINE_EVENT( wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEvent );
257 wxDEFINE_EVENT( wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEvent );
258 wxDEFINE_EVENT( wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEvent );
259 wxDEFINE_EVENT( wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEvent );
260 wxDEFINE_EVENT( wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEvent );
261
262 // System events
263 wxDEFINE_EVENT( wxEVT_SIZE, wxSizeEvent );
264 wxDEFINE_EVENT( wxEVT_SIZING, wxSizeEvent );
265 wxDEFINE_EVENT( wxEVT_MOVE, wxMoveEvent );
266 wxDEFINE_EVENT( wxEVT_MOVING, wxMoveEvent );
267 wxDEFINE_EVENT( wxEVT_MOVE_START, wxMoveEvent );
268 wxDEFINE_EVENT( wxEVT_MOVE_END, wxMoveEvent );
269 wxDEFINE_EVENT( wxEVT_CLOSE_WINDOW, wxCloseEvent );
270 wxDEFINE_EVENT( wxEVT_END_SESSION, wxCloseEvent );
271 wxDEFINE_EVENT( wxEVT_QUERY_END_SESSION, wxCloseEvent );
272 wxDEFINE_EVENT( wxEVT_HIBERNATE, wxActivateEvent );
273 wxDEFINE_EVENT( wxEVT_ACTIVATE_APP, wxActivateEvent );
274 wxDEFINE_EVENT( wxEVT_ACTIVATE, wxActivateEvent );
275 wxDEFINE_EVENT( wxEVT_CREATE, wxWindowCreateEvent );
276 wxDEFINE_EVENT( wxEVT_DESTROY, wxWindowDestroyEvent );
277 wxDEFINE_EVENT( wxEVT_SHOW, wxShowEvent );
278 wxDEFINE_EVENT( wxEVT_ICONIZE, wxIconizeEvent );
279 wxDEFINE_EVENT( wxEVT_MAXIMIZE, wxMaximizeEvent );
280 wxDEFINE_EVENT( wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEvent );
281 wxDEFINE_EVENT( wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEvent );
282 wxDEFINE_EVENT( wxEVT_PAINT, wxPaintEvent );
283 wxDEFINE_EVENT( wxEVT_ERASE_BACKGROUND, wxEraseEvent );
284 wxDEFINE_EVENT( wxEVT_NC_PAINT, wxNcPaintEvent );
285 wxDEFINE_EVENT( wxEVT_MENU_OPEN, wxMenuEvent );
286 wxDEFINE_EVENT( wxEVT_MENU_CLOSE, wxMenuEvent );
287 wxDEFINE_EVENT( wxEVT_MENU_HIGHLIGHT, wxMenuEvent );
288 wxDEFINE_EVENT( wxEVT_CONTEXT_MENU, wxContextMenuEvent );
289 wxDEFINE_EVENT( wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEvent );
290 wxDEFINE_EVENT( wxEVT_DISPLAY_CHANGED, wxDisplayChangedEvent );
291 wxDEFINE_EVENT( wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEvent );
292 wxDEFINE_EVENT( wxEVT_PALETTE_CHANGED, wxPaletteChangedEvent );
293 wxDEFINE_EVENT( wxEVT_JOY_BUTTON_DOWN, wxJoystickEvent );
294 wxDEFINE_EVENT( wxEVT_JOY_BUTTON_UP, wxJoystickEvent );
295 wxDEFINE_EVENT( wxEVT_JOY_MOVE, wxJoystickEvent );
296 wxDEFINE_EVENT( wxEVT_JOY_ZMOVE, wxJoystickEvent );
297 wxDEFINE_EVENT( wxEVT_DROP_FILES, wxDropFilesEvent );
298 wxDEFINE_EVENT( wxEVT_INIT_DIALOG, wxInitDialogEvent );
299 wxDEFINE_EVENT( wxEVT_UPDATE_UI, wxUpdateUIEvent );
300
301 // Clipboard events
302 wxDEFINE_EVENT( wxEVT_COMMAND_TEXT_COPY, wxClipboardTextEvent );
303 wxDEFINE_EVENT( wxEVT_COMMAND_TEXT_CUT, wxClipboardTextEvent );
304 wxDEFINE_EVENT( wxEVT_COMMAND_TEXT_PASTE, wxClipboardTextEvent );
305
306 // Generic command events
307 // Note: a click is a higher-level event than button down/up
308 wxDEFINE_EVENT( wxEVT_COMMAND_LEFT_CLICK, wxCommandEvent );
309 wxDEFINE_EVENT( wxEVT_COMMAND_LEFT_DCLICK, wxCommandEvent );
310 wxDEFINE_EVENT( wxEVT_COMMAND_RIGHT_CLICK, wxCommandEvent );
311 wxDEFINE_EVENT( wxEVT_COMMAND_RIGHT_DCLICK, wxCommandEvent );
312 wxDEFINE_EVENT( wxEVT_COMMAND_SET_FOCUS, wxCommandEvent );
313 wxDEFINE_EVENT( wxEVT_COMMAND_KILL_FOCUS, wxCommandEvent );
314 wxDEFINE_EVENT( wxEVT_COMMAND_ENTER, wxCommandEvent );
315
316 // Help events
317 wxDEFINE_EVENT( wxEVT_HELP, wxHelpEvent );
318 wxDEFINE_EVENT( wxEVT_DETAILED_HELP, wxHelpEvent );
319
320 #endif // wxUSE_GUI
321
322 #if wxUSE_BASE
323
324 wxIdleMode wxIdleEvent::sm_idleMode = wxIDLE_PROCESS_ALL;
325
326 // ============================================================================
327 // implementation
328 // ============================================================================
329
330 // ----------------------------------------------------------------------------
331 // event initialization
332 // ----------------------------------------------------------------------------
333
334 int wxNewEventType()
335 {
336 // MT-FIXME
337 static int s_lastUsedEventType = wxEVT_FIRST;
338
339 return s_lastUsedEventType++;
340 }
341 // ----------------------------------------------------------------------------
342 // wxEventFunctor
343 // ----------------------------------------------------------------------------
344
345 wxEventFunctor::~wxEventFunctor()
346 {
347 }
348
349 // ----------------------------------------------------------------------------
350 // wxEvent
351 // ----------------------------------------------------------------------------
352
353 /*
354 * General wxWidgets events, covering all interesting things that might happen
355 * (button clicking, resizing, setting text in widgets, etc.).
356 *
357 * For each completely new event type, derive a new event class.
358 *
359 */
360
361 wxEvent::wxEvent(int theId, wxEventType commandType)
362 {
363 m_eventType = commandType;
364 m_eventObject = NULL;
365 m_timeStamp = 0;
366 m_id = theId;
367 m_skipped = false;
368 m_callbackUserData = NULL;
369 m_handlerToProcessOnlyIn = NULL;
370 m_isCommandEvent = false;
371 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
372 m_wasProcessed = false;
373 }
374
375 wxEvent::wxEvent(const wxEvent& src)
376 : wxObject(src)
377 , m_eventObject(src.m_eventObject)
378 , m_eventType(src.m_eventType)
379 , m_timeStamp(src.m_timeStamp)
380 , m_id(src.m_id)
381 , m_callbackUserData(src.m_callbackUserData)
382 , m_handlerToProcessOnlyIn(NULL)
383 , m_propagationLevel(src.m_propagationLevel)
384 , m_skipped(src.m_skipped)
385 , m_isCommandEvent(src.m_isCommandEvent)
386 , m_wasProcessed(false)
387 {
388 }
389
390 wxEvent& wxEvent::operator=(const wxEvent& src)
391 {
392 wxObject::operator=(src);
393
394 m_eventObject = src.m_eventObject;
395 m_eventType = src.m_eventType;
396 m_timeStamp = src.m_timeStamp;
397 m_id = src.m_id;
398 m_callbackUserData = src.m_callbackUserData;
399 m_handlerToProcessOnlyIn = NULL;
400 m_propagationLevel = src.m_propagationLevel;
401 m_skipped = src.m_skipped;
402 m_isCommandEvent = src.m_isCommandEvent;
403
404 // don't change m_wasProcessed
405
406 return *this;
407 }
408
409 #endif // wxUSE_BASE
410
411 #if wxUSE_GUI
412
413 // ----------------------------------------------------------------------------
414 // wxCommandEvent
415 // ----------------------------------------------------------------------------
416
417 wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId)
418 : wxEvent(theId, commandType)
419 {
420 m_clientData = NULL;
421 m_clientObject = NULL;
422 m_isCommandEvent = true;
423
424 // the command events are propagated upwards by default
425 m_propagationLevel = wxEVENT_PROPAGATE_MAX;
426 }
427
428 wxString wxCommandEvent::GetString() const
429 {
430 if (m_eventType != wxEVT_COMMAND_TEXT_UPDATED || !m_eventObject)
431 {
432 return m_cmdString;
433 }
434 else
435 {
436 #if wxUSE_TEXTCTRL
437 wxTextCtrl *txt = wxDynamicCast(m_eventObject, wxTextCtrl);
438 if ( txt )
439 return txt->GetValue();
440 else
441 #endif // wxUSE_TEXTCTRL
442 return m_cmdString;
443 }
444 }
445
446 // ----------------------------------------------------------------------------
447 // wxUpdateUIEvent
448 // ----------------------------------------------------------------------------
449
450 #if wxUSE_LONGLONG
451 wxLongLong wxUpdateUIEvent::sm_lastUpdate = 0;
452 #endif
453
454 long wxUpdateUIEvent::sm_updateInterval = 0;
455
456 wxUpdateUIMode wxUpdateUIEvent::sm_updateMode = wxUPDATE_UI_PROCESS_ALL;
457
458 // Can we update?
459 bool wxUpdateUIEvent::CanUpdate(wxWindowBase *win)
460 {
461 // Don't update if we've switched global updating off
462 // and this window doesn't support updates.
463 if (win &&
464 (GetMode() == wxUPDATE_UI_PROCESS_SPECIFIED &&
465 ((win->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES) == 0)))
466 return false;
467
468 // Don't update children of the hidden windows: this is useless as any
469 // change to their state won't be seen by the user anyhow. Notice that this
470 // argument doesn't apply to the hidden windows (with visible parent)
471 // themselves as they could be shown by their EVT_UPDATE_UI handler.
472 if ( win->GetParent() && !win->GetParent()->IsShownOnScreen() )
473 return false;
474
475 if (sm_updateInterval == -1)
476 return false;
477
478 if (sm_updateInterval == 0)
479 return true;
480
481 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
482 wxLongLong now = wxGetLocalTimeMillis();
483 if (now > (sm_lastUpdate + sm_updateInterval))
484 {
485 return true;
486 }
487
488 return false;
489 #else
490 // If we don't have wxStopWatch or wxLongLong, we
491 // should err on the safe side and update now anyway.
492 return true;
493 #endif
494 }
495
496 // Reset the update time to provide a delay until the next
497 // time we should update
498 void wxUpdateUIEvent::ResetUpdateTime()
499 {
500 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
501 if (sm_updateInterval > 0)
502 {
503 wxLongLong now = wxGetLocalTimeMillis();
504 if (now > (sm_lastUpdate + sm_updateInterval))
505 {
506 sm_lastUpdate = now;
507 }
508 }
509 #endif
510 }
511
512 // ----------------------------------------------------------------------------
513 // wxScrollEvent
514 // ----------------------------------------------------------------------------
515
516 wxScrollEvent::wxScrollEvent(wxEventType commandType,
517 int id,
518 int pos,
519 int orient)
520 : wxCommandEvent(commandType, id)
521 {
522 m_extraLong = orient;
523 m_commandInt = pos;
524 }
525
526 // ----------------------------------------------------------------------------
527 // wxScrollWinEvent
528 // ----------------------------------------------------------------------------
529
530 wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType,
531 int pos,
532 int orient)
533 {
534 m_eventType = commandType;
535 m_extraLong = orient;
536 m_commandInt = pos;
537 }
538
539 // ----------------------------------------------------------------------------
540 // wxMouseEvent
541 // ----------------------------------------------------------------------------
542
543 wxMouseEvent::wxMouseEvent(wxEventType commandType)
544 {
545 m_eventType = commandType;
546
547 m_x = 0;
548 m_y = 0;
549
550 m_leftDown = false;
551 m_middleDown = false;
552 m_rightDown = false;
553 m_aux1Down = false;
554 m_aux2Down = false;
555
556 m_clickCount = -1;
557
558 m_wheelAxis = wxMOUSE_WHEEL_VERTICAL;
559 m_wheelRotation = 0;
560 m_wheelDelta = 0;
561 m_linesPerAction = 0;
562 }
563
564 void wxMouseEvent::Assign(const wxMouseEvent& event)
565 {
566 wxEvent::operator=(event);
567
568 // Borland C++ 5.82 doesn't compile an explicit call to an implicitly
569 // defined operator=() so need to do it this way:
570 *static_cast<wxMouseState *>(this) = event;
571
572 m_x = event.m_x;
573 m_y = event.m_y;
574
575 m_leftDown = event.m_leftDown;
576 m_middleDown = event.m_middleDown;
577 m_rightDown = event.m_rightDown;
578 m_aux1Down = event.m_aux1Down;
579 m_aux2Down = event.m_aux2Down;
580
581 m_wheelRotation = event.m_wheelRotation;
582 m_wheelDelta = event.m_wheelDelta;
583 m_linesPerAction = event.m_linesPerAction;
584 m_wheelAxis = event.m_wheelAxis;
585 }
586
587 // return true if was a button dclick event
588 bool wxMouseEvent::ButtonDClick(int but) const
589 {
590 switch (but)
591 {
592 default:
593 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
594 // fall through
595
596 case wxMOUSE_BTN_ANY:
597 return (LeftDClick() || MiddleDClick() || RightDClick() ||
598 Aux1DClick() || Aux2DClick());
599
600 case wxMOUSE_BTN_LEFT:
601 return LeftDClick();
602
603 case wxMOUSE_BTN_MIDDLE:
604 return MiddleDClick();
605
606 case wxMOUSE_BTN_RIGHT:
607 return RightDClick();
608
609 case wxMOUSE_BTN_AUX1:
610 return Aux1DClick();
611
612 case wxMOUSE_BTN_AUX2:
613 return Aux2DClick();
614 }
615 }
616
617 // return true if was a button down event
618 bool wxMouseEvent::ButtonDown(int but) const
619 {
620 switch (but)
621 {
622 default:
623 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
624 // fall through
625
626 case wxMOUSE_BTN_ANY:
627 return (LeftDown() || MiddleDown() || RightDown() ||
628 Aux1Down() || Aux2Down());
629
630 case wxMOUSE_BTN_LEFT:
631 return LeftDown();
632
633 case wxMOUSE_BTN_MIDDLE:
634 return MiddleDown();
635
636 case wxMOUSE_BTN_RIGHT:
637 return RightDown();
638
639 case wxMOUSE_BTN_AUX1:
640 return Aux1Down();
641
642 case wxMOUSE_BTN_AUX2:
643 return Aux2Down();
644 }
645 }
646
647 // return true if was a button up event
648 bool wxMouseEvent::ButtonUp(int but) const
649 {
650 switch (but)
651 {
652 default:
653 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
654 // fall through
655
656 case wxMOUSE_BTN_ANY:
657 return (LeftUp() || MiddleUp() || RightUp() ||
658 Aux1Up() || Aux2Up());
659
660 case wxMOUSE_BTN_LEFT:
661 return LeftUp();
662
663 case wxMOUSE_BTN_MIDDLE:
664 return MiddleUp();
665
666 case wxMOUSE_BTN_RIGHT:
667 return RightUp();
668
669 case wxMOUSE_BTN_AUX1:
670 return Aux1Up();
671
672 case wxMOUSE_BTN_AUX2:
673 return Aux2Up();
674 }
675 }
676
677 // return true if the given button is currently changing state
678 bool wxMouseEvent::Button(int but) const
679 {
680 switch (but)
681 {
682 default:
683 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
684 // fall through
685
686 case wxMOUSE_BTN_ANY:
687 return ButtonUp(wxMOUSE_BTN_ANY) ||
688 ButtonDown(wxMOUSE_BTN_ANY) ||
689 ButtonDClick(wxMOUSE_BTN_ANY);
690
691 case wxMOUSE_BTN_LEFT:
692 return LeftDown() || LeftUp() || LeftDClick();
693
694 case wxMOUSE_BTN_MIDDLE:
695 return MiddleDown() || MiddleUp() || MiddleDClick();
696
697 case wxMOUSE_BTN_RIGHT:
698 return RightDown() || RightUp() || RightDClick();
699
700 case wxMOUSE_BTN_AUX1:
701 return Aux1Down() || Aux1Up() || Aux1DClick();
702
703 case wxMOUSE_BTN_AUX2:
704 return Aux2Down() || Aux2Up() || Aux2DClick();
705 }
706 }
707
708 int wxMouseEvent::GetButton() const
709 {
710 for ( int i = 1; i < wxMOUSE_BTN_MAX; i++ )
711 {
712 if ( Button(i) )
713 {
714 return i;
715 }
716 }
717
718 return wxMOUSE_BTN_NONE;
719 }
720
721 // Find the logical position of the event given the DC
722 wxPoint wxMouseEvent::GetLogicalPosition(const wxDC& dc) const
723 {
724 wxPoint pt(dc.DeviceToLogicalX(m_x), dc.DeviceToLogicalY(m_y));
725 return pt;
726 }
727
728 // ----------------------------------------------------------------------------
729 // wxKeyEvent
730 // ----------------------------------------------------------------------------
731
732 wxKeyEvent::wxKeyEvent(wxEventType type)
733 {
734 m_eventType = type;
735 m_keyCode = WXK_NONE;
736 #if wxUSE_UNICODE
737 m_uniChar = WXK_NONE;
738 #endif
739
740 m_x =
741 m_y = wxDefaultCoord;
742 m_hasPosition = false;
743
744 InitPropagation();
745 }
746
747 wxKeyEvent::wxKeyEvent(const wxKeyEvent& evt)
748 : wxEvent(evt),
749 wxKeyboardState(evt)
750 {
751 DoAssignMembers(evt);
752
753 InitPropagation();
754 }
755
756 wxKeyEvent::wxKeyEvent(wxEventType eventType, const wxKeyEvent& evt)
757 : wxEvent(evt),
758 wxKeyboardState(evt)
759 {
760 DoAssignMembers(evt);
761
762 m_eventType = eventType;
763
764 InitPropagation();
765 }
766
767 void wxKeyEvent::InitPositionIfNecessary() const
768 {
769 if ( m_hasPosition )
770 return;
771
772 // We're const because we're called from const Get[XY]() methods but we
773 // need to update the "cached" values.
774 wxKeyEvent& self = const_cast<wxKeyEvent&>(*this);
775 self.m_hasPosition = true;
776
777 // The only position we can possibly associate with the keyboard event on
778 // the platforms where it doesn't carry it already is the mouse position.
779 wxGetMousePosition(&self.m_x, &self.m_y);
780
781 // If this event is associated with a window, the position should be in its
782 // client coordinates, but otherwise leave it in screen coordinates as what
783 // else can we use?
784 wxWindow* const win = wxDynamicCast(GetEventObject(), wxWindow);
785 if ( win )
786 win->ScreenToClient(&self.m_x, &self.m_y);
787 }
788
789 wxCoord wxKeyEvent::GetX() const
790 {
791 InitPositionIfNecessary();
792
793 return m_x;
794 }
795
796 wxCoord wxKeyEvent::GetY() const
797 {
798 InitPositionIfNecessary();
799
800 return m_y;
801 }
802
803 bool wxKeyEvent::IsKeyInCategory(int category) const
804 {
805 switch ( GetKeyCode() )
806 {
807 case WXK_LEFT:
808 case WXK_RIGHT:
809 case WXK_UP:
810 case WXK_DOWN:
811 case WXK_NUMPAD_LEFT:
812 case WXK_NUMPAD_RIGHT:
813 case WXK_NUMPAD_UP:
814 case WXK_NUMPAD_DOWN:
815 return (category & WXK_CATEGORY_ARROW) != 0;
816
817 case WXK_PAGEDOWN:
818 case WXK_END:
819 case WXK_NUMPAD_PAGEUP:
820 case WXK_NUMPAD_PAGEDOWN:
821 return (category & WXK_CATEGORY_PAGING) != 0;
822
823 case WXK_HOME:
824 case WXK_PAGEUP:
825 case WXK_NUMPAD_HOME:
826 case WXK_NUMPAD_END:
827 return (category & WXK_CATEGORY_JUMP) != 0;
828
829 case WXK_TAB:
830 case WXK_NUMPAD_TAB:
831 return (category & WXK_CATEGORY_TAB) != 0;
832
833 case WXK_BACK:
834 case WXK_DELETE:
835 case WXK_NUMPAD_DELETE:
836 return (category & WXK_CATEGORY_CUT) != 0;
837
838 default:
839 return false;
840 }
841 }
842
843 // ----------------------------------------------------------------------------
844 // wxWindowCreateEvent
845 // ----------------------------------------------------------------------------
846
847 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win)
848 {
849 SetEventType(wxEVT_CREATE);
850 SetEventObject(win);
851 }
852
853 // ----------------------------------------------------------------------------
854 // wxWindowDestroyEvent
855 // ----------------------------------------------------------------------------
856
857 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow *win)
858 {
859 SetEventType(wxEVT_DESTROY);
860 SetEventObject(win);
861 }
862
863 // ----------------------------------------------------------------------------
864 // wxChildFocusEvent
865 // ----------------------------------------------------------------------------
866
867 wxChildFocusEvent::wxChildFocusEvent(wxWindow *win)
868 : wxCommandEvent(wxEVT_CHILD_FOCUS)
869 {
870 SetEventObject(win);
871 }
872
873 // ----------------------------------------------------------------------------
874 // wxHelpEvent
875 // ----------------------------------------------------------------------------
876
877 /* static */
878 wxHelpEvent::Origin wxHelpEvent::GuessOrigin(Origin origin)
879 {
880 if ( origin == Origin_Unknown )
881 {
882 // assume that the event comes from the help button if it's not from
883 // keyboard and that pressing F1 always results in the help event
884 origin = wxGetKeyState(WXK_F1) ? Origin_Keyboard : Origin_HelpButton;
885 }
886
887 return origin;
888 }
889
890 #endif // wxUSE_GUI
891
892
893 #if wxUSE_BASE
894
895 // ----------------------------------------------------------------------------
896 // wxEventHashTable
897 // ----------------------------------------------------------------------------
898
899 static const int EVENT_TYPE_TABLE_INIT_SIZE = 31; // Not too big not too small...
900
901 wxEventHashTable* wxEventHashTable::sm_first = NULL;
902
903 wxEventHashTable::wxEventHashTable(const wxEventTable &table)
904 : m_table(table),
905 m_rebuildHash(true)
906 {
907 AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE);
908
909 m_next = sm_first;
910 if (m_next)
911 m_next->m_previous = this;
912 sm_first = this;
913 }
914
915 wxEventHashTable::~wxEventHashTable()
916 {
917 if (m_next)
918 m_next->m_previous = m_previous;
919 if (m_previous)
920 m_previous->m_next = m_next;
921 if (sm_first == this)
922 sm_first = m_next;
923
924 Clear();
925 }
926
927 void wxEventHashTable::Clear()
928 {
929 for ( size_t i = 0; i < m_size; i++ )
930 {
931 EventTypeTablePointer eTTnode = m_eventTypeTable[i];
932 delete eTTnode;
933 }
934
935 wxDELETEA(m_eventTypeTable);
936
937 m_size = 0;
938 }
939
940 #if wxUSE_MEMORY_TRACING
941
942 // Clear all tables
943 void wxEventHashTable::ClearAll()
944 {
945 wxEventHashTable* table = sm_first;
946 while (table)
947 {
948 table->Clear();
949 table = table->m_next;
950 }
951 }
952
953 #endif // wxUSE_MEMORY_TRACING
954
955 bool wxEventHashTable::HandleEvent(wxEvent &event, wxEvtHandler *self)
956 {
957 if (m_rebuildHash)
958 {
959 InitHashTable();
960 m_rebuildHash = false;
961 }
962
963 if (!m_eventTypeTable)
964 return false;
965
966 // Find all entries for the given event type.
967 wxEventType eventType = event.GetEventType();
968 const EventTypeTablePointer eTTnode = m_eventTypeTable[eventType % m_size];
969 if (eTTnode && eTTnode->eventType == eventType)
970 {
971 // Now start the search for an event handler
972 // that can handle an event with the given ID.
973 const wxEventTableEntryPointerArray&
974 eventEntryTable = eTTnode->eventEntryTable;
975
976 const size_t count = eventEntryTable.GetCount();
977 for (size_t n = 0; n < count; n++)
978 {
979 const wxEventTableEntry& entry = *eventEntryTable[n];
980 if ( wxEvtHandler::ProcessEventIfMatchesId(entry, self, event) )
981 return true;
982 }
983 }
984
985 return false;
986 }
987
988 void wxEventHashTable::InitHashTable()
989 {
990 // Loop over the event tables and all its base tables.
991 const wxEventTable *table = &m_table;
992 while (table)
993 {
994 // Retrieve all valid event handler entries
995 const wxEventTableEntry *entry = table->entries;
996 while (entry->m_fn != 0)
997 {
998 // Add the event entry in the Hash.
999 AddEntry(*entry);
1000
1001 entry++;
1002 }
1003
1004 table = table->baseTable;
1005 }
1006
1007 // Let's free some memory.
1008 size_t i;
1009 for(i = 0; i < m_size; i++)
1010 {
1011 EventTypeTablePointer eTTnode = m_eventTypeTable[i];
1012 if (eTTnode)
1013 {
1014 eTTnode->eventEntryTable.Shrink();
1015 }
1016 }
1017 }
1018
1019 void wxEventHashTable::AddEntry(const wxEventTableEntry &entry)
1020 {
1021 // This might happen 'accidentally' as the app is exiting
1022 if (!m_eventTypeTable)
1023 return;
1024
1025 EventTypeTablePointer *peTTnode = &m_eventTypeTable[entry.m_eventType % m_size];
1026 EventTypeTablePointer eTTnode = *peTTnode;
1027
1028 if (eTTnode)
1029 {
1030 if (eTTnode->eventType != entry.m_eventType)
1031 {
1032 // Resize the table!
1033 GrowEventTypeTable();
1034 // Try again to add it.
1035 AddEntry(entry);
1036 return;
1037 }
1038 }
1039 else
1040 {
1041 eTTnode = new EventTypeTable;
1042 eTTnode->eventType = entry.m_eventType;
1043 *peTTnode = eTTnode;
1044 }
1045
1046 // Fill all hash entries between entry.m_id and entry.m_lastId...
1047 eTTnode->eventEntryTable.Add(&entry);
1048 }
1049
1050 void wxEventHashTable::AllocEventTypeTable(size_t size)
1051 {
1052 m_eventTypeTable = new EventTypeTablePointer[size];
1053 memset((void *)m_eventTypeTable, 0, sizeof(EventTypeTablePointer)*size);
1054 m_size = size;
1055 }
1056
1057 void wxEventHashTable::GrowEventTypeTable()
1058 {
1059 size_t oldSize = m_size;
1060 EventTypeTablePointer *oldEventTypeTable = m_eventTypeTable;
1061
1062 // TODO: Search the most optimal grow sequence
1063 AllocEventTypeTable(/* GetNextPrime(oldSize) */oldSize*2+1);
1064
1065 for ( size_t i = 0; i < oldSize; /* */ )
1066 {
1067 EventTypeTablePointer eTToldNode = oldEventTypeTable[i];
1068 if (eTToldNode)
1069 {
1070 EventTypeTablePointer *peTTnode = &m_eventTypeTable[eTToldNode->eventType % m_size];
1071 EventTypeTablePointer eTTnode = *peTTnode;
1072
1073 // Check for collision, we don't want any.
1074 if (eTTnode)
1075 {
1076 GrowEventTypeTable();
1077 continue; // Don't increment the counter,
1078 // as we still need to add this element.
1079 }
1080 else
1081 {
1082 // Get the old value and put it in the new table.
1083 *peTTnode = oldEventTypeTable[i];
1084 }
1085 }
1086
1087 i++;
1088 }
1089
1090 delete[] oldEventTypeTable;
1091 }
1092
1093 // ----------------------------------------------------------------------------
1094 // wxEvtHandler
1095 // ----------------------------------------------------------------------------
1096
1097 wxEvtHandler::wxEvtHandler()
1098 {
1099 m_nextHandler = NULL;
1100 m_previousHandler = NULL;
1101 m_enabled = true;
1102 m_dynamicEvents = NULL;
1103 m_pendingEvents = NULL;
1104
1105 // no client data (yet)
1106 m_clientData = NULL;
1107 m_clientDataType = wxClientData_None;
1108 }
1109
1110 wxEvtHandler::~wxEvtHandler()
1111 {
1112 Unlink();
1113
1114 if (m_dynamicEvents)
1115 {
1116 for ( wxList::iterator it = m_dynamicEvents->begin(),
1117 end = m_dynamicEvents->end();
1118 it != end;
1119 ++it )
1120 {
1121 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)*it;
1122
1123 // Remove ourselves from sink destructor notifications
1124 // (this has usually been done, in wxTrackable destructor)
1125 wxEvtHandler *eventSink = entry->m_fn->GetEvtHandler();
1126 if ( eventSink )
1127 {
1128 wxEventConnectionRef * const
1129 evtConnRef = FindRefInTrackerList(eventSink);
1130 if ( evtConnRef )
1131 {
1132 eventSink->RemoveNode(evtConnRef);
1133 delete evtConnRef;
1134 }
1135 }
1136
1137 delete entry->m_callbackUserData;
1138 delete entry;
1139 }
1140 delete m_dynamicEvents;
1141 }
1142
1143 // Remove us from the list of the pending events if necessary.
1144 if (wxTheApp)
1145 wxTheApp->RemovePendingEventHandler(this);
1146
1147 DeletePendingEvents();
1148
1149 // we only delete object data, not untyped
1150 if ( m_clientDataType == wxClientData_Object )
1151 delete m_clientObject;
1152 }
1153
1154 void wxEvtHandler::Unlink()
1155 {
1156 // this event handler must take itself out of the chain of handlers:
1157
1158 if (m_previousHandler)
1159 m_previousHandler->SetNextHandler(m_nextHandler);
1160
1161 if (m_nextHandler)
1162 m_nextHandler->SetPreviousHandler(m_previousHandler);
1163
1164 m_nextHandler = NULL;
1165 m_previousHandler = NULL;
1166 }
1167
1168 bool wxEvtHandler::IsUnlinked() const
1169 {
1170 return m_previousHandler == NULL &&
1171 m_nextHandler == NULL;
1172 }
1173
1174 wxEventFilter* wxEvtHandler::ms_filterList = NULL;
1175
1176 /* static */ void wxEvtHandler::AddFilter(wxEventFilter* filter)
1177 {
1178 wxCHECK_RET( filter, "NULL filter" );
1179
1180 filter->m_next = ms_filterList;
1181 ms_filterList = filter;
1182 }
1183
1184 /* static */ void wxEvtHandler::RemoveFilter(wxEventFilter* filter)
1185 {
1186 wxEventFilter* prev = NULL;
1187 for ( wxEventFilter* f = ms_filterList; f; f = f->m_next )
1188 {
1189 if ( f == filter )
1190 {
1191 // Set the previous list element or the list head to the next
1192 // element.
1193 if ( prev )
1194 prev->m_next = f->m_next;
1195 else
1196 ms_filterList = f->m_next;
1197
1198 // Also reset the next pointer in the filter itself just to avoid
1199 // having possibly dangling pointers, even though it's not strictly
1200 // necessary.
1201 f->m_next = NULL;
1202
1203 // Skip the assert below.
1204 return;
1205 }
1206
1207 prev = f;
1208 }
1209
1210 wxFAIL_MSG( "Filter not found" );
1211 }
1212
1213 #if wxUSE_THREADS
1214
1215 bool wxEvtHandler::ProcessThreadEvent(const wxEvent& event)
1216 {
1217 // check that we are really in a child thread
1218 wxASSERT_MSG( !wxThread::IsMain(),
1219 wxT("use ProcessEvent() in main thread") );
1220
1221 AddPendingEvent(event);
1222
1223 return true;
1224 }
1225
1226 #endif // wxUSE_THREADS
1227
1228 void wxEvtHandler::QueueEvent(wxEvent *event)
1229 {
1230 wxCHECK_RET( event, "NULL event can't be posted" );
1231
1232 if (!wxTheApp)
1233 {
1234 // we need an event loop which manages the list of event handlers with
1235 // pending events... cannot proceed without it!
1236 wxLogDebug("No application object! Cannot queue this event!");
1237
1238 // anyway delete the given event to avoid memory leaks
1239 delete event;
1240
1241 return;
1242 }
1243
1244 // 1) Add this event to our list of pending events
1245 wxENTER_CRIT_SECT( m_pendingEventsLock );
1246
1247 if ( !m_pendingEvents )
1248 m_pendingEvents = new wxList;
1249
1250 m_pendingEvents->Append(event);
1251
1252 // 2) Add this event handler to list of event handlers that
1253 // have pending events.
1254
1255 wxTheApp->AppendPendingEventHandler(this);
1256
1257 // only release m_pendingEventsLock now because otherwise there is a race
1258 // condition as described in the ticket #9093: we could process the event
1259 // just added to m_pendingEvents in our ProcessPendingEvents() below before
1260 // we had time to append this pointer to wxHandlersWithPendingEvents list; thus
1261 // breaking the invariant that a handler should be in the list iff it has
1262 // any pending events to process
1263 wxLEAVE_CRIT_SECT( m_pendingEventsLock );
1264
1265 // 3) Inform the system that new pending events are somewhere,
1266 // and that these should be processed in idle time.
1267 wxWakeUpIdle();
1268 }
1269
1270 void wxEvtHandler::DeletePendingEvents()
1271 {
1272 if (m_pendingEvents)
1273 m_pendingEvents->DeleteContents(true);
1274 wxDELETE(m_pendingEvents);
1275 }
1276
1277 void wxEvtHandler::ProcessPendingEvents()
1278 {
1279 if (!wxTheApp)
1280 {
1281 // we need an event loop which manages the list of event handlers with
1282 // pending events... cannot proceed without it!
1283 wxLogDebug("No application object! Cannot process pending events!");
1284 return;
1285 }
1286
1287 // we need to process only a single pending event in this call because
1288 // each call to ProcessEvent() could result in the destruction of this
1289 // same event handler (see the comment at the end of this function)
1290
1291 wxENTER_CRIT_SECT( m_pendingEventsLock );
1292
1293 // this method is only called by wxApp if this handler does have
1294 // pending events
1295 wxCHECK_RET( m_pendingEvents && !m_pendingEvents->IsEmpty(),
1296 "should have pending events if called" );
1297
1298 wxList::compatibility_iterator node = m_pendingEvents->GetFirst();
1299 wxEvent* pEvent = static_cast<wxEvent *>(node->GetData());
1300
1301 // find the first event which can be processed now:
1302 wxEventLoopBase* evtLoop = wxEventLoopBase::GetActive();
1303 if (evtLoop && evtLoop->IsYielding())
1304 {
1305 while (node && pEvent && !evtLoop->IsEventAllowedInsideYield(pEvent->GetEventCategory()))
1306 {
1307 node = node->GetNext();
1308 pEvent = node ? static_cast<wxEvent *>(node->GetData()) : NULL;
1309 }
1310
1311 if (!node)
1312 {
1313 // all our events are NOT processable now... signal this:
1314 wxTheApp->DelayPendingEventHandler(this);
1315
1316 // see the comment at the beginning of evtloop.h header for the
1317 // logic behind YieldFor() and behind DelayPendingEventHandler()
1318
1319 wxLEAVE_CRIT_SECT( m_pendingEventsLock );
1320
1321 return;
1322 }
1323 }
1324
1325 wxEventPtr event(pEvent);
1326
1327 // it's important we remove event from list before processing it, else a
1328 // nested event loop, for example from a modal dialog, might process the
1329 // same event again.
1330 m_pendingEvents->Erase(node);
1331
1332 if ( m_pendingEvents->IsEmpty() )
1333 {
1334 // if there are no more pending events left, we don't need to
1335 // stay in this list
1336 wxTheApp->RemovePendingEventHandler(this);
1337 }
1338
1339 wxLEAVE_CRIT_SECT( m_pendingEventsLock );
1340
1341 ProcessEvent(*event);
1342
1343 // careful: this object could have been deleted by the event handler
1344 // executed by the above ProcessEvent() call, so we can't access any fields
1345 // of this object any more
1346 }
1347
1348 /* static */
1349 bool wxEvtHandler::ProcessEventIfMatchesId(const wxEventTableEntryBase& entry,
1350 wxEvtHandler *handler,
1351 wxEvent& event)
1352 {
1353 int tableId1 = entry.m_id,
1354 tableId2 = entry.m_lastId;
1355
1356 // match only if the event type is the same and the id is either -1 in
1357 // the event table (meaning "any") or the event id matches the id
1358 // specified in the event table either exactly or by falling into
1359 // range between first and last
1360 if ((tableId1 == wxID_ANY) ||
1361 (tableId2 == wxID_ANY && tableId1 == event.GetId()) ||
1362 (tableId2 != wxID_ANY &&
1363 (event.GetId() >= tableId1 && event.GetId() <= tableId2)))
1364 {
1365 event.Skip(false);
1366 event.m_callbackUserData = entry.m_callbackUserData;
1367
1368 #if wxUSE_EXCEPTIONS
1369 if ( wxTheApp )
1370 {
1371 // call the handler via wxApp method which allows the user to catch
1372 // any exceptions which may be thrown by any handler in the program
1373 // in one place
1374 wxTheApp->CallEventHandler(handler, *entry.m_fn, event);
1375 }
1376 else
1377 #endif // wxUSE_EXCEPTIONS
1378 {
1379 (*entry.m_fn)(handler, event);
1380 }
1381
1382 if (!event.GetSkipped())
1383 return true;
1384 }
1385
1386 return false;
1387 }
1388
1389 bool wxEvtHandler::DoTryApp(wxEvent& event)
1390 {
1391 if ( wxTheApp && (this != wxTheApp) )
1392 {
1393 // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
1394 // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
1395 // processed appropriately via SearchEventTable.
1396 if ( event.GetEventType() != wxEVT_IDLE )
1397 {
1398 if ( wxTheApp->ProcessEvent(event) )
1399 return true;
1400 }
1401 }
1402
1403 return false;
1404 }
1405
1406 bool wxEvtHandler::TryBefore(wxEvent& event)
1407 {
1408 #if WXWIN_COMPATIBILITY_2_8
1409 // call the old virtual function to keep the code overriding it working
1410 return TryValidator(event);
1411 #else
1412 wxUnusedVar(event);
1413 return false;
1414 #endif
1415 }
1416
1417 bool wxEvtHandler::TryAfter(wxEvent& event)
1418 {
1419 // We only want to pass the window to the application object once even if
1420 // there are several chained handlers. Ensure that this is what happens by
1421 // only calling DoTryApp() if there is no next handler (which would do it).
1422 //
1423 // Notice that, unlike simply calling TryAfter() on the last handler in the
1424 // chain only from ProcessEvent(), this also works with wxWindow object in
1425 // the middle of the chain: its overridden TryAfter() will still be called
1426 // and propagate the event upwards the window hierarchy even if it's not
1427 // the last one in the chain (which, admittedly, shouldn't happen often).
1428 if ( GetNextHandler() )
1429 return GetNextHandler()->TryAfter(event);
1430
1431 #if WXWIN_COMPATIBILITY_2_8
1432 // as above, call the old virtual function for compatibility
1433 return TryParent(event);
1434 #else
1435 return DoTryApp(event);
1436 #endif
1437 }
1438
1439 bool wxEvtHandler::ProcessEvent(wxEvent& event)
1440 {
1441 // The very first thing we do is to allow any registered filters to hook
1442 // into event processing in order to globally pre-process all events.
1443 //
1444 // Note that we should only do it if we're the first event handler called
1445 // to avoid calling FilterEvent() multiple times as the event goes through
1446 // the event handler chain and possibly upwards the window hierarchy.
1447 if ( !event.WasProcessed() )
1448 {
1449 for ( wxEventFilter* f = ms_filterList; f; f = f->m_next )
1450 {
1451 int rc = f->FilterEvent(event);
1452 if ( rc != wxEventFilter::Event_Skip )
1453 {
1454 wxASSERT_MSG( rc == wxEventFilter::Event_Ignore ||
1455 rc == wxEventFilter::Event_Processed,
1456 "unexpected FilterEvent() return value" );
1457
1458 return rc != wxEventFilter::Event_Ignore;
1459 }
1460 //else: proceed normally
1461 }
1462 }
1463
1464 // Short circuit the event processing logic if we're requested to process
1465 // this event in this handler only, see DoTryChain() for more details.
1466 if ( event.ShouldProcessOnlyIn(this) )
1467 return TryBeforeAndHere(event);
1468
1469
1470 // Try to process the event in this handler itself.
1471 if ( ProcessEventLocally(event) )
1472 {
1473 // It is possible that DoTryChain() called from ProcessEventLocally()
1474 // returned true but the event was not really processed: this happens
1475 // if a custom handler ignores the request to process the event in this
1476 // handler only and in this case we should skip the post processing
1477 // done in TryAfter() but still return the correct value ourselves to
1478 // indicate whether we did or did not find a handler for this event.
1479 return !event.GetSkipped();
1480 }
1481
1482 // If we still didn't find a handler, propagate the event upwards the
1483 // window chain and/or to the application object.
1484 if ( TryAfter(event) )
1485 return true;
1486
1487
1488 // No handler found anywhere, bail out.
1489 return false;
1490 }
1491
1492 bool wxEvtHandler::ProcessEventLocally(wxEvent& event)
1493 {
1494 // Try the hooks which should be called before our own handlers and this
1495 // handler itself first. Notice that we should not call ProcessEvent() on
1496 // this one as we're already called from it, which explains why we do it
1497 // here and not in DoTryChain()
1498 return TryBeforeAndHere(event) || DoTryChain(event);
1499 }
1500
1501 bool wxEvtHandler::DoTryChain(wxEvent& event)
1502 {
1503 for ( wxEvtHandler *h = GetNextHandler(); h; h = h->GetNextHandler() )
1504 {
1505 // We need to process this event at the level of this handler only
1506 // right now, the pre-/post-processing was either already done by
1507 // ProcessEvent() from which we were called or will be done by it when
1508 // we return.
1509 //
1510 // However we must call ProcessEvent() and not TryHereOnly() because the
1511 // existing code (including some in wxWidgets itself) expects the
1512 // overridden ProcessEvent() in its custom event handlers pushed on a
1513 // window to be called.
1514 //
1515 // So we must call ProcessEvent() but it must not do what it usually
1516 // does. To resolve this paradox we set up a special flag inside the
1517 // object itself to let ProcessEvent() know that it shouldn't do any
1518 // pre/post-processing for this event if it gets it. Note that this
1519 // only applies to this handler, if the event is passed to another one
1520 // by explicitly calling its ProcessEvent(), pre/post-processing should
1521 // be done as usual.
1522 //
1523 // Final complication is that if the implementation of ProcessEvent()
1524 // called wxEvent::DidntHonourProcessOnlyIn() (as the gross hack that
1525 // is wxScrollHelperEvtHandler::ProcessEvent() does) and ignored our
1526 // request to process event in this handler only, we have to compensate
1527 // for it by not processing the event further because this was already
1528 // done by that rogue event handler.
1529 wxEventProcessInHandlerOnly processInHandlerOnly(event, h);
1530 if ( h->ProcessEvent(event) )
1531 {
1532 // Make sure "skipped" flag is not set as the event was really
1533 // processed in this case. Normally it shouldn't be set anyhow but
1534 // make sure just in case the user code does something strange.
1535 event.Skip(false);
1536
1537 return true;
1538 }
1539
1540 if ( !event.ShouldProcessOnlyIn(h) )
1541 {
1542 // Still return true to indicate that no further processing should
1543 // be undertaken but ensure that "skipped" flag is set so that the
1544 // caller knows that the event was not really processed.
1545 event.Skip();
1546
1547 return true;
1548 }
1549 }
1550
1551 return false;
1552 }
1553
1554 bool wxEvtHandler::TryHereOnly(wxEvent& event)
1555 {
1556 // If the event handler is disabled it doesn't process any events
1557 if ( !GetEvtHandlerEnabled() )
1558 return false;
1559
1560 // Handle per-instance dynamic event tables first
1561 if ( m_dynamicEvents && SearchDynamicEventTable(event) )
1562 return true;
1563
1564 // Then static per-class event tables
1565 if ( GetEventHashTable().HandleEvent(event, this) )
1566 return true;
1567
1568 #ifdef wxHAS_CALL_AFTER
1569 // There is an implicit entry for async method calls processing in every
1570 // event handler:
1571 if ( event.GetEventType() == wxEVT_ASYNC_METHOD_CALL &&
1572 event.GetEventObject() == this )
1573 {
1574 static_cast<wxAsyncMethodCallEvent&>(event).Execute();
1575 return true;
1576 }
1577 #endif // wxHAS_CALL_AFTER
1578
1579 // We don't have a handler for this event.
1580 return false;
1581 }
1582
1583 bool wxEvtHandler::SafelyProcessEvent(wxEvent& event)
1584 {
1585 #if wxUSE_EXCEPTIONS
1586 try
1587 {
1588 #endif
1589 return ProcessEvent(event);
1590 #if wxUSE_EXCEPTIONS
1591 }
1592 catch ( ... )
1593 {
1594 // notice that we do it in 2 steps to avoid warnings about possibly
1595 // uninitialized loop variable from some versions of g++ which are not
1596 // smart enough to figure out that GetActive() doesn't throw and so
1597 // that loop will always be initialized
1598 wxEventLoopBase *loop = NULL;
1599 try
1600 {
1601 loop = wxEventLoopBase::GetActive();
1602
1603 if ( !wxTheApp || !wxTheApp->OnExceptionInMainLoop() )
1604 {
1605 if ( loop )
1606 loop->Exit();
1607 }
1608 //else: continue running current event loop
1609
1610 return false;
1611 }
1612 catch ( ... )
1613 {
1614 // OnExceptionInMainLoop() threw, possibly rethrowing the same
1615 // exception again: very good, but we still need Exit() to
1616 // be called
1617 if ( loop )
1618 loop->Exit();
1619 throw;
1620 }
1621 }
1622 #endif // wxUSE_EXCEPTIONS
1623 }
1624
1625 bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event)
1626 {
1627 const wxEventType eventType = event.GetEventType();
1628 for ( int i = 0; table.entries[i].m_fn != 0; i++ )
1629 {
1630 const wxEventTableEntry& entry = table.entries[i];
1631 if ( eventType == entry.m_eventType )
1632 {
1633 if ( ProcessEventIfMatchesId(entry, this, event) )
1634 return true;
1635 }
1636 }
1637
1638 return false;
1639 }
1640
1641 void wxEvtHandler::DoBind(int id,
1642 int lastId,
1643 wxEventType eventType,
1644 wxEventFunctor *func,
1645 wxObject *userData)
1646 {
1647 wxDynamicEventTableEntry *entry =
1648 new wxDynamicEventTableEntry(eventType, id, lastId, func, userData);
1649
1650 if (!m_dynamicEvents)
1651 m_dynamicEvents = new wxList;
1652
1653 // Insert at the front of the list so most recent additions are found first
1654 m_dynamicEvents->Insert( (wxObject*) entry );
1655
1656 // Make sure we get to know when a sink is destroyed
1657 wxEvtHandler *eventSink = func->GetEvtHandler();
1658 if ( eventSink && eventSink != this )
1659 {
1660 wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink);
1661 if ( evtConnRef )
1662 evtConnRef->IncRef( );
1663 else
1664 new wxEventConnectionRef(this, eventSink);
1665 }
1666 }
1667
1668 bool
1669 wxEvtHandler::DoUnbind(int id,
1670 int lastId,
1671 wxEventType eventType,
1672 const wxEventFunctor& func,
1673 wxObject *userData)
1674 {
1675 if (!m_dynamicEvents)
1676 return false;
1677
1678 wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();
1679 while (node)
1680 {
1681 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1682
1683 if ((entry->m_id == id) &&
1684 ((entry->m_lastId == lastId) || (lastId == wxID_ANY)) &&
1685 ((entry->m_eventType == eventType) || (eventType == wxEVT_NULL)) &&
1686 entry->m_fn->IsMatching(func) &&
1687 ((entry->m_callbackUserData == userData) || !userData))
1688 {
1689 // Remove connection from tracker node (wxEventConnectionRef)
1690 wxEvtHandler *eventSink = entry->m_fn->GetEvtHandler();
1691 if ( eventSink && eventSink != this )
1692 {
1693 wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink);
1694 if ( evtConnRef )
1695 evtConnRef->DecRef();
1696 }
1697
1698 delete entry->m_callbackUserData;
1699 m_dynamicEvents->Erase( node );
1700 delete entry;
1701 return true;
1702 }
1703 node = node->GetNext();
1704 }
1705 return false;
1706 }
1707
1708 bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event )
1709 {
1710 wxCHECK_MSG( m_dynamicEvents, false,
1711 wxT("caller should check that we have dynamic events") );
1712
1713 wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();
1714 while (node)
1715 {
1716 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1717
1718 // get next node before (maybe) calling the event handler as it could
1719 // call Disconnect() invalidating the current node
1720 node = node->GetNext();
1721
1722 if ( event.GetEventType() == entry->m_eventType )
1723 {
1724 wxEvtHandler *handler = entry->m_fn->GetEvtHandler();
1725 if ( !handler )
1726 handler = this;
1727 if ( ProcessEventIfMatchesId(*entry, handler, event) )
1728 return true;
1729 }
1730 }
1731
1732 return false;
1733 }
1734
1735 void wxEvtHandler::DoSetClientObject( wxClientData *data )
1736 {
1737 wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1738 wxT("can't have both object and void client data") );
1739
1740 if ( m_clientObject )
1741 delete m_clientObject;
1742
1743 m_clientObject = data;
1744 m_clientDataType = wxClientData_Object;
1745 }
1746
1747 wxClientData *wxEvtHandler::DoGetClientObject() const
1748 {
1749 // it's not an error to call GetClientObject() on a window which doesn't
1750 // have client data at all - NULL will be returned
1751 wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1752 wxT("this window doesn't have object client data") );
1753
1754 return m_clientObject;
1755 }
1756
1757 void wxEvtHandler::DoSetClientData( void *data )
1758 {
1759 wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1760 wxT("can't have both object and void client data") );
1761
1762 m_clientData = data;
1763 m_clientDataType = wxClientData_Void;
1764 }
1765
1766 void *wxEvtHandler::DoGetClientData() const
1767 {
1768 // it's not an error to call GetClientData() on a window which doesn't have
1769 // client data at all - NULL will be returned
1770 wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1771 wxT("this window doesn't have void client data") );
1772
1773 return m_clientData;
1774 }
1775
1776 // A helper to find an wxEventConnectionRef object
1777 wxEventConnectionRef *
1778 wxEvtHandler::FindRefInTrackerList(wxEvtHandler *eventSink)
1779 {
1780 for ( wxTrackerNode *node = eventSink->GetFirst(); node; node = node->m_nxt )
1781 {
1782 // we only want wxEventConnectionRef nodes here
1783 wxEventConnectionRef *evtConnRef = node->ToEventConnection();
1784 if ( evtConnRef && evtConnRef->m_src == this )
1785 {
1786 wxASSERT( evtConnRef->m_sink==eventSink );
1787 return evtConnRef;
1788 }
1789 }
1790
1791 return NULL;
1792 }
1793
1794 void wxEvtHandler::OnSinkDestroyed( wxEvtHandler *sink )
1795 {
1796 wxASSERT(m_dynamicEvents);
1797
1798 // remove all connections with this sink
1799 wxList::compatibility_iterator node = m_dynamicEvents->GetFirst(), node_nxt;
1800 while (node)
1801 {
1802 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1803 node_nxt = node->GetNext();
1804
1805 if ( entry->m_fn->GetEvtHandler() == sink )
1806 {
1807 delete entry->m_callbackUserData;
1808 m_dynamicEvents->Erase( node );
1809 delete entry;
1810 }
1811 node = node_nxt;
1812 }
1813 }
1814
1815 #endif // wxUSE_BASE
1816
1817 #if wxUSE_GUI
1818
1819 // Find a window with the focus, that is also a descendant of the given window.
1820 // This is used to determine the window to initially send commands to.
1821 wxWindow* wxFindFocusDescendant(wxWindow* ancestor)
1822 {
1823 // Process events starting with the window with the focus, if any.
1824 wxWindow* focusWin = wxWindow::FindFocus();
1825 wxWindow* win = focusWin;
1826
1827 // Check if this is a descendant of this frame.
1828 // If not, win will be set to NULL.
1829 while (win)
1830 {
1831 if (win == ancestor)
1832 break;
1833 else
1834 win = win->GetParent();
1835 }
1836 if (win == NULL)
1837 focusWin = NULL;
1838
1839 return focusWin;
1840 }
1841
1842 // ----------------------------------------------------------------------------
1843 // wxEventBlocker
1844 // ----------------------------------------------------------------------------
1845
1846 wxEventBlocker::wxEventBlocker(wxWindow *win, wxEventType type)
1847 {
1848 wxCHECK_RET(win, wxT("Null window given to wxEventBlocker"));
1849
1850 m_window = win;
1851
1852 Block(type);
1853 m_window->PushEventHandler(this);
1854 }
1855
1856 wxEventBlocker::~wxEventBlocker()
1857 {
1858 wxEvtHandler *popped = m_window->PopEventHandler(false);
1859 wxCHECK_RET(popped == this,
1860 wxT("Don't push other event handlers into a window managed by wxEventBlocker!"));
1861 }
1862
1863 bool wxEventBlocker::ProcessEvent(wxEvent& event)
1864 {
1865 // should this event be blocked?
1866 for ( size_t i = 0; i < m_eventsToBlock.size(); i++ )
1867 {
1868 wxEventType t = (wxEventType)m_eventsToBlock[i];
1869 if ( t == wxEVT_ANY || t == event.GetEventType() )
1870 return true; // yes, it should: mark this event as processed
1871 }
1872
1873 return false;
1874 }
1875
1876 #endif // wxUSE_GUI
1877
wxWidgets (Impactor)