projects / wxWidgets.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Refactor the event processing code to add ProcessEventLocally().
[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/evtloop.h"
29
30 #ifndef WX_PRECOMP
31 #include "wx/list.h"
32 #include "wx/log.h"
33 #include "wx/app.h"
34 #include "wx/utils.h"
35 #include "wx/stopwatch.h"
36 #include "wx/module.h"
37
38 #if wxUSE_GUI
39 #include "wx/window.h"
40 #include "wx/control.h"
41 #include "wx/dc.h"
42 #include "wx/spinbutt.h"
43 #include "wx/textctrl.h"
44 #include "wx/validate.h"
45 #endif // wxUSE_GUI
46 #endif
47
48 #include "wx/thread.h"
49
50 #if wxUSE_BASE
51 #include "wx/scopedptr.h"
52
53 wxDECLARE_SCOPED_PTR(wxEvent, wxEventPtr)
54 wxDEFINE_SCOPED_PTR(wxEvent, wxEventPtr)
55 #endif // wxUSE_BASE
56
57 // ----------------------------------------------------------------------------
58 // wxWin macros
59 // ----------------------------------------------------------------------------
60
61 #if wxUSE_BASE
62 IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler, wxObject)
63 IMPLEMENT_ABSTRACT_CLASS(wxEvent, wxObject)
64 IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent)
65 #endif // wxUSE_BASE
66
67 #if wxUSE_GUI
68 IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent, wxEvent)
69 IMPLEMENT_DYNAMIC_CLASS(wxThreadEvent, wxCommandEvent)
70 IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent, wxCommandEvent)
71 IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent, wxCommandEvent)
72 IMPLEMENT_DYNAMIC_CLASS(wxScrollWinEvent, wxEvent)
73 IMPLEMENT_DYNAMIC_CLASS(wxMouseEvent, wxEvent)
74 IMPLEMENT_DYNAMIC_CLASS(wxKeyEvent, wxEvent)
75 IMPLEMENT_DYNAMIC_CLASS(wxSizeEvent, wxEvent)
76 IMPLEMENT_DYNAMIC_CLASS(wxPaintEvent, wxEvent)
77 IMPLEMENT_DYNAMIC_CLASS(wxNcPaintEvent, wxEvent)
78 IMPLEMENT_DYNAMIC_CLASS(wxEraseEvent, wxEvent)
79 IMPLEMENT_DYNAMIC_CLASS(wxMoveEvent, wxEvent)
80 IMPLEMENT_DYNAMIC_CLASS(wxFocusEvent, wxEvent)
81 IMPLEMENT_DYNAMIC_CLASS(wxChildFocusEvent, wxCommandEvent)
82 IMPLEMENT_DYNAMIC_CLASS(wxCloseEvent, wxEvent)
83 IMPLEMENT_DYNAMIC_CLASS(wxShowEvent, wxEvent)
84 IMPLEMENT_DYNAMIC_CLASS(wxMaximizeEvent, wxEvent)
85 IMPLEMENT_DYNAMIC_CLASS(wxIconizeEvent, wxEvent)
86 IMPLEMENT_DYNAMIC_CLASS(wxMenuEvent, wxEvent)
87 IMPLEMENT_DYNAMIC_CLASS(wxJoystickEvent, wxEvent)
88 IMPLEMENT_DYNAMIC_CLASS(wxDropFilesEvent, wxEvent)
89 IMPLEMENT_DYNAMIC_CLASS(wxActivateEvent, wxEvent)
90 IMPLEMENT_DYNAMIC_CLASS(wxInitDialogEvent, wxEvent)
91 IMPLEMENT_DYNAMIC_CLASS(wxSetCursorEvent, wxEvent)
92 IMPLEMENT_DYNAMIC_CLASS(wxSysColourChangedEvent, wxEvent)
93 IMPLEMENT_DYNAMIC_CLASS(wxDisplayChangedEvent, wxEvent)
94 IMPLEMENT_DYNAMIC_CLASS(wxUpdateUIEvent, wxCommandEvent)
95 IMPLEMENT_DYNAMIC_CLASS(wxNavigationKeyEvent, wxEvent)
96 IMPLEMENT_DYNAMIC_CLASS(wxPaletteChangedEvent, wxEvent)
97 IMPLEMENT_DYNAMIC_CLASS(wxQueryNewPaletteEvent, wxEvent)
98 IMPLEMENT_DYNAMIC_CLASS(wxWindowCreateEvent, wxEvent)
99 IMPLEMENT_DYNAMIC_CLASS(wxWindowDestroyEvent, wxEvent)
100 IMPLEMENT_DYNAMIC_CLASS(wxHelpEvent, wxCommandEvent)
101 IMPLEMENT_DYNAMIC_CLASS(wxContextMenuEvent, wxCommandEvent)
102 IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureChangedEvent, wxEvent)
103 IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureLostEvent, wxEvent)
104 IMPLEMENT_DYNAMIC_CLASS(wxClipboardTextEvent, wxCommandEvent)
105 #endif // wxUSE_GUI
106
107 #if wxUSE_BASE
108
109 const wxEventTable *wxEvtHandler::GetEventTable() const
110 { return &wxEvtHandler::sm_eventTable; }
111
112 const wxEventTable wxEvtHandler::sm_eventTable =
113 { (const wxEventTable *)NULL, &wxEvtHandler::sm_eventTableEntries[0] };
114
115 wxEventHashTable &wxEvtHandler::GetEventHashTable() const
116 { return wxEvtHandler::sm_eventHashTable; }
117
118 wxEventHashTable wxEvtHandler::sm_eventHashTable(wxEvtHandler::sm_eventTable);
119
120 const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] =
121 { DECLARE_EVENT_TABLE_TERMINATOR() };
122
123
124 // wxUSE_MEMORY_TRACING considers memory freed from the static objects dtors
125 // leaked, so we need to manually clean up all event tables before checking for
126 // the memory leaks when using it, however this breaks re-initializing the
127 // library (i.e. repeated calls to wxInitialize/wxUninitialize) because the
128 // event tables won't be rebuilt the next time, so disable this by default
129 #if wxUSE_MEMORY_TRACING
130
131 class wxEventTableEntryModule: public wxModule
132 {
133 public:
134 wxEventTableEntryModule() { }
135 virtual bool OnInit() { return true; }
136 virtual void OnExit() { wxEventHashTable::ClearAll(); }
137
138 DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule)
139 };
140
141 IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule, wxModule)
142
143 #endif // wxUSE_MEMORY_TRACING
144
145 // ----------------------------------------------------------------------------
146 // global variables
147 // ----------------------------------------------------------------------------
148
149 // common event types are defined here, other event types are defined by the
150 // components which use them
151
152 const wxEventType wxEVT_FIRST = 10000;
153 const wxEventType wxEVT_USER_FIRST = wxEVT_FIRST + 2000;
154
155 DEFINE_EVENT_TYPE(wxEVT_NULL)
156 wxDEFINE_EVENT( wxEVT_IDLE, wxIdleEvent );
157
158 #endif // wxUSE_BASE
159
160 #if wxUSE_GUI
161
162 wxDEFINE_EVENT( wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEvent );
163 wxDEFINE_EVENT( wxEVT_COMMAND_CHECKBOX_CLICKED, wxCommandEvent );
164 wxDEFINE_EVENT( wxEVT_COMMAND_CHOICE_SELECTED, wxCommandEvent );
165 wxDEFINE_EVENT( wxEVT_COMMAND_LISTBOX_SELECTED, wxCommandEvent );
166 wxDEFINE_EVENT( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, wxCommandEvent );
167 wxDEFINE_EVENT( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, wxCommandEvent );
168 wxDEFINE_EVENT( wxEVT_COMMAND_MENU_SELECTED, wxCommandEvent );
169 wxDEFINE_EVENT( wxEVT_COMMAND_SLIDER_UPDATED, wxCommandEvent );
170 wxDEFINE_EVENT( wxEVT_COMMAND_RADIOBOX_SELECTED, wxCommandEvent );
171 wxDEFINE_EVENT( wxEVT_COMMAND_RADIOBUTTON_SELECTED, wxCommandEvent );
172 wxDEFINE_EVENT( wxEVT_COMMAND_SCROLLBAR_UPDATED, wxCommandEvent );
173 wxDEFINE_EVENT( wxEVT_COMMAND_VLBOX_SELECTED, wxCommandEvent );
174 wxDEFINE_EVENT( wxEVT_COMMAND_COMBOBOX_SELECTED, wxCommandEvent );
175 wxDEFINE_EVENT( wxEVT_COMMAND_TOOL_RCLICKED, wxCommandEvent );
176 wxDEFINE_EVENT( wxEVT_COMMAND_TOOL_ENTER, wxCommandEvent );
177 wxDEFINE_EVENT( wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEvent );
178 wxDEFINE_EVENT( wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED, wxCommandEvent );
179 wxDEFINE_EVENT( wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, wxCommandEvent );
180 wxDEFINE_EVENT( wxEVT_COMMAND_COMBOBOX_DROPDOWN, wxCommandEvent);
181 wxDEFINE_EVENT( wxEVT_COMMAND_COMBOBOX_CLOSEUP, wxCommandEvent);
182
183 // Mouse event types
184 wxDEFINE_EVENT( wxEVT_LEFT_DOWN, wxMouseEvent );
185 wxDEFINE_EVENT( wxEVT_LEFT_UP, wxMouseEvent );
186 wxDEFINE_EVENT( wxEVT_MIDDLE_DOWN, wxMouseEvent );
187 wxDEFINE_EVENT( wxEVT_MIDDLE_UP, wxMouseEvent );
188 wxDEFINE_EVENT( wxEVT_RIGHT_DOWN, wxMouseEvent );
189 wxDEFINE_EVENT( wxEVT_RIGHT_UP, wxMouseEvent );
190 wxDEFINE_EVENT( wxEVT_MOTION, wxMouseEvent );
191 wxDEFINE_EVENT( wxEVT_ENTER_WINDOW, wxMouseEvent );
192 wxDEFINE_EVENT( wxEVT_LEAVE_WINDOW, wxMouseEvent );
193 wxDEFINE_EVENT( wxEVT_LEFT_DCLICK, wxMouseEvent );
194 wxDEFINE_EVENT( wxEVT_MIDDLE_DCLICK, wxMouseEvent );
195 wxDEFINE_EVENT( wxEVT_RIGHT_DCLICK, wxMouseEvent );
196 wxDEFINE_EVENT( wxEVT_SET_FOCUS, wxFocusEvent );
197 wxDEFINE_EVENT( wxEVT_KILL_FOCUS, wxFocusEvent );
198 wxDEFINE_EVENT( wxEVT_CHILD_FOCUS, wxChildFocusEvent );
199 wxDEFINE_EVENT( wxEVT_MOUSEWHEEL, wxMouseEvent );
200 wxDEFINE_EVENT( wxEVT_AUX1_DOWN, wxMouseEvent );
201 wxDEFINE_EVENT( wxEVT_AUX1_UP, wxMouseEvent );
202 wxDEFINE_EVENT( wxEVT_AUX1_DCLICK, wxMouseEvent );
203 wxDEFINE_EVENT( wxEVT_AUX2_DOWN, wxMouseEvent );
204 wxDEFINE_EVENT( wxEVT_AUX2_UP, wxMouseEvent );
205 wxDEFINE_EVENT( wxEVT_AUX2_DCLICK, wxMouseEvent );
206
207 // Character input event type
208 wxDEFINE_EVENT( wxEVT_CHAR, wxKeyEvent );
209 wxDEFINE_EVENT( wxEVT_CHAR_HOOK, wxKeyEvent );
210 wxDEFINE_EVENT( wxEVT_NAVIGATION_KEY, wxNavigationKeyEvent );
211 wxDEFINE_EVENT( wxEVT_KEY_DOWN, wxKeyEvent );
212 wxDEFINE_EVENT( wxEVT_KEY_UP, wxKeyEvent );
213 #if wxUSE_HOTKEY
214 wxDEFINE_EVENT( wxEVT_HOTKEY, wxKeyEvent );
215 #endif
216
217 // Set cursor event
218 wxDEFINE_EVENT( wxEVT_SET_CURSOR, wxSetCursorEvent );
219
220 // wxScrollbar and wxSlider event identifiers
221 wxDEFINE_EVENT( wxEVT_SCROLL_TOP, wxScrollEvent );
222 wxDEFINE_EVENT( wxEVT_SCROLL_BOTTOM, wxScrollEvent );
223 wxDEFINE_EVENT( wxEVT_SCROLL_LINEUP, wxScrollEvent );
224 wxDEFINE_EVENT( wxEVT_SCROLL_LINEDOWN, wxScrollEvent );
225 wxDEFINE_EVENT( wxEVT_SCROLL_PAGEUP, wxScrollEvent );
226 wxDEFINE_EVENT( wxEVT_SCROLL_PAGEDOWN, wxScrollEvent );
227 wxDEFINE_EVENT( wxEVT_SCROLL_THUMBTRACK, wxScrollEvent );
228 wxDEFINE_EVENT( wxEVT_SCROLL_THUMBRELEASE, wxScrollEvent );
229 wxDEFINE_EVENT( wxEVT_SCROLL_CHANGED, wxScrollEvent );
230
231 // Due to a bug in older wx versions, wxSpinEvents were being sent with type of
232 // wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But
233 // with the type-safe events in place, these event types are associated with
234 // wxScrollEvent. To allow handling of spin events, new event types have been
235 // defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility
236 // the spin event types are being initialized with the scroll event types.
237
238 #if wxUSE_SPINBTN
239
240 wxDEFINE_EVENT_ALIAS( wxEVT_SPIN_UP, wxSpinEvent, wxEVT_SCROLL_LINEUP );
241 wxDEFINE_EVENT_ALIAS( wxEVT_SPIN_DOWN, wxSpinEvent, wxEVT_SCROLL_LINEDOWN );
242 wxDEFINE_EVENT_ALIAS( wxEVT_SPIN, wxSpinEvent, wxEVT_SCROLL_THUMBTRACK );
243
244 #endif // wxUSE_SPINBTN
245
246 // Scroll events from wxWindow
247 wxDEFINE_EVENT( wxEVT_SCROLLWIN_TOP, wxScrollWinEvent );
248 wxDEFINE_EVENT( wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEvent );
249 wxDEFINE_EVENT( wxEVT_SCROLLWIN_LINEUP, wxScrollWinEvent );
250 wxDEFINE_EVENT( wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEvent );
251 wxDEFINE_EVENT( wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEvent );
252 wxDEFINE_EVENT( wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEvent );
253 wxDEFINE_EVENT( wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEvent );
254 wxDEFINE_EVENT( wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEvent );
255
256 // System events
257 wxDEFINE_EVENT( wxEVT_SIZE, wxSizeEvent );
258 wxDEFINE_EVENT( wxEVT_SIZING, wxSizeEvent );
259 wxDEFINE_EVENT( wxEVT_MOVE, wxMoveEvent );
260 wxDEFINE_EVENT( wxEVT_MOVING, wxMoveEvent );
261 wxDEFINE_EVENT( wxEVT_MOVE_START, wxMoveEvent );
262 wxDEFINE_EVENT( wxEVT_MOVE_END, wxMoveEvent );
263 wxDEFINE_EVENT( wxEVT_CLOSE_WINDOW, wxCloseEvent );
264 wxDEFINE_EVENT( wxEVT_END_SESSION, wxCloseEvent );
265 wxDEFINE_EVENT( wxEVT_QUERY_END_SESSION, wxCloseEvent );
266 wxDEFINE_EVENT( wxEVT_HIBERNATE, wxActivateEvent );
267 wxDEFINE_EVENT( wxEVT_ACTIVATE_APP, wxActivateEvent );
268 wxDEFINE_EVENT( wxEVT_ACTIVATE, wxActivateEvent );
269 wxDEFINE_EVENT( wxEVT_CREATE, wxWindowCreateEvent );
270 wxDEFINE_EVENT( wxEVT_DESTROY, wxWindowDestroyEvent );
271 wxDEFINE_EVENT( wxEVT_SHOW, wxShowEvent );
272 wxDEFINE_EVENT( wxEVT_ICONIZE, wxIconizeEvent );
273 wxDEFINE_EVENT( wxEVT_MAXIMIZE, wxMaximizeEvent );
274 wxDEFINE_EVENT( wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEvent );
275 wxDEFINE_EVENT( wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEvent );
276 wxDEFINE_EVENT( wxEVT_PAINT, wxPaintEvent );
277 wxDEFINE_EVENT( wxEVT_ERASE_BACKGROUND, wxEraseEvent );
278 wxDEFINE_EVENT( wxEVT_NC_PAINT, wxNcPaintEvent );
279 wxDEFINE_EVENT( wxEVT_MENU_OPEN, wxMenuEvent );
280 wxDEFINE_EVENT( wxEVT_MENU_CLOSE, wxMenuEvent );
281 wxDEFINE_EVENT( wxEVT_MENU_HIGHLIGHT, wxMenuEvent );
282 wxDEFINE_EVENT( wxEVT_CONTEXT_MENU, wxContextMenuEvent );
283 wxDEFINE_EVENT( wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEvent );
284 wxDEFINE_EVENT( wxEVT_DISPLAY_CHANGED, wxDisplayChangedEvent );
285 wxDEFINE_EVENT( wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEvent );
286 wxDEFINE_EVENT( wxEVT_PALETTE_CHANGED, wxPaletteChangedEvent );
287 wxDEFINE_EVENT( wxEVT_JOY_BUTTON_DOWN, wxJoystickEvent );
288 wxDEFINE_EVENT( wxEVT_JOY_BUTTON_UP, wxJoystickEvent );
289 wxDEFINE_EVENT( wxEVT_JOY_MOVE, wxJoystickEvent );
290 wxDEFINE_EVENT( wxEVT_JOY_ZMOVE, wxJoystickEvent );
291 wxDEFINE_EVENT( wxEVT_DROP_FILES, wxDropFilesEvent );
292 wxDEFINE_EVENT( wxEVT_INIT_DIALOG, wxInitDialogEvent );
293 wxDEFINE_EVENT( wxEVT_UPDATE_UI, wxUpdateUIEvent );
294
295 // Clipboard events
296 wxDEFINE_EVENT( wxEVT_COMMAND_TEXT_COPY, wxClipboardTextEvent );
297 wxDEFINE_EVENT( wxEVT_COMMAND_TEXT_CUT, wxClipboardTextEvent );
298 wxDEFINE_EVENT( wxEVT_COMMAND_TEXT_PASTE, wxClipboardTextEvent );
299
300 // Generic command events
301 // Note: a click is a higher-level event than button down/up
302 wxDEFINE_EVENT( wxEVT_COMMAND_LEFT_CLICK, wxCommandEvent );
303 wxDEFINE_EVENT( wxEVT_COMMAND_LEFT_DCLICK, wxCommandEvent );
304 wxDEFINE_EVENT( wxEVT_COMMAND_RIGHT_CLICK, wxCommandEvent );
305 wxDEFINE_EVENT( wxEVT_COMMAND_RIGHT_DCLICK, wxCommandEvent );
306 wxDEFINE_EVENT( wxEVT_COMMAND_SET_FOCUS, wxCommandEvent );
307 wxDEFINE_EVENT( wxEVT_COMMAND_KILL_FOCUS, wxCommandEvent );
308 wxDEFINE_EVENT( wxEVT_COMMAND_ENTER, wxCommandEvent );
309
310 // Help events
311 wxDEFINE_EVENT( wxEVT_HELP, wxHelpEvent );
312 wxDEFINE_EVENT( wxEVT_DETAILED_HELP, wxHelpEvent );
313
314 // Thread event
315 wxDEFINE_EVENT( wxEVT_COMMAND_THREAD, wxThreadEvent );
316
317 #endif // wxUSE_GUI
318
319 #if wxUSE_BASE
320
321 wxIdleMode wxIdleEvent::sm_idleMode = wxIDLE_PROCESS_ALL;
322
323 // ============================================================================
324 // implementation
325 // ============================================================================
326
327 // ----------------------------------------------------------------------------
328 // event initialization
329 // ----------------------------------------------------------------------------
330
331 int wxNewEventType()
332 {
333 // MT-FIXME
334 static int s_lastUsedEventType = wxEVT_FIRST;
335
336 return s_lastUsedEventType++;
337 }
338 // ----------------------------------------------------------------------------
339 // wxEventFunctor
340 // ----------------------------------------------------------------------------
341
342 wxEventFunctor::~wxEventFunctor()
343 {
344 }
345
346 // ----------------------------------------------------------------------------
347 // wxEvent
348 // ----------------------------------------------------------------------------
349
350 /*
351 * General wxWidgets events, covering all interesting things that might happen
352 * (button clicking, resizing, setting text in widgets, etc.).
353 *
354 * For each completely new event type, derive a new event class.
355 *
356 */
357
358 wxEvent::wxEvent(int theId, wxEventType commandType)
359 {
360 m_eventType = commandType;
361 m_eventObject = NULL;
362 m_timeStamp = 0;
363 m_id = theId;
364 m_skipped = false;
365 m_callbackUserData = NULL;
366 m_isCommandEvent = false;
367 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
368 m_wasProcessed = false;
369 m_processHereOnly = false;
370 }
371
372 wxEvent::wxEvent(const wxEvent& src)
373 : wxObject(src)
374 , m_eventObject(src.m_eventObject)
375 , m_eventType(src.m_eventType)
376 , m_timeStamp(src.m_timeStamp)
377 , m_id(src.m_id)
378 , m_callbackUserData(src.m_callbackUserData)
379 , m_propagationLevel(src.m_propagationLevel)
380 , m_skipped(src.m_skipped)
381 , m_isCommandEvent(src.m_isCommandEvent)
382 , m_wasProcessed(false)
383 , m_processHereOnly(false)
384 {
385 }
386
387 wxEvent& wxEvent::operator=(const wxEvent& src)
388 {
389 wxObject::operator=(src);
390
391 m_eventObject = src.m_eventObject;
392 m_eventType = src.m_eventType;
393 m_timeStamp = src.m_timeStamp;
394 m_id = src.m_id;
395 m_callbackUserData = src.m_callbackUserData;
396 m_propagationLevel = src.m_propagationLevel;
397 m_skipped = src.m_skipped;
398 m_isCommandEvent = src.m_isCommandEvent;
399
400 // don't change m_wasProcessed nor m_processHereOnly
401
402 return *this;
403 }
404
405 #endif // wxUSE_BASE
406
407 #if wxUSE_GUI
408
409 // ----------------------------------------------------------------------------
410 // wxCommandEvent
411 // ----------------------------------------------------------------------------
412
413 #ifdef __VISUALC__
414 // 'this' : used in base member initializer list (for m_commandString)
415 #pragma warning(disable:4355)
416 #endif
417
418 wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId)
419 : wxEvent(theId, commandType)
420 {
421 m_clientData = NULL;
422 m_clientObject = NULL;
423 m_extraLong = 0;
424 m_commandInt = 0;
425 m_isCommandEvent = true;
426
427 // the command events are propagated upwards by default
428 m_propagationLevel = wxEVENT_PROPAGATE_MAX;
429 }
430
431 #ifdef __VISUALC__
432 #pragma warning(default:4355)
433 #endif
434
435 wxString wxCommandEvent::GetString() const
436 {
437 if (m_eventType != wxEVT_COMMAND_TEXT_UPDATED || !m_eventObject)
438 {
439 return m_cmdString;
440 }
441 else
442 {
443 #if wxUSE_TEXTCTRL
444 wxTextCtrl *txt = wxDynamicCast(m_eventObject, wxTextCtrl);
445 if ( txt )
446 return txt->GetValue();
447 else
448 #endif // wxUSE_TEXTCTRL
449 return m_cmdString;
450 }
451 }
452
453 // ----------------------------------------------------------------------------
454 // wxUpdateUIEvent
455 // ----------------------------------------------------------------------------
456
457 #if wxUSE_LONGLONG
458 wxLongLong wxUpdateUIEvent::sm_lastUpdate = 0;
459 #endif
460
461 long wxUpdateUIEvent::sm_updateInterval = 0;
462
463 wxUpdateUIMode wxUpdateUIEvent::sm_updateMode = wxUPDATE_UI_PROCESS_ALL;
464
465 // Can we update?
466 bool wxUpdateUIEvent::CanUpdate(wxWindowBase *win)
467 {
468 // Don't update if we've switched global updating off
469 // and this window doesn't support updates.
470 if (win &&
471 (GetMode() == wxUPDATE_UI_PROCESS_SPECIFIED &&
472 ((win->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES) == 0)))
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_wheelRotation = 0;
559 m_wheelDelta = 0;
560 m_linesPerAction = 0;
561 m_wheelAxis = 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 = 0;
736 #if wxUSE_UNICODE
737 m_uniChar = 0;
738 #endif
739 }
740
741 wxKeyEvent::wxKeyEvent(const wxKeyEvent& evt)
742 : wxEvent(evt),
743 wxKeyboardState(evt)
744 {
745 m_x = evt.m_x;
746 m_y = evt.m_y;
747
748 m_keyCode = evt.m_keyCode;
749 m_rawCode = evt.m_rawCode;
750 m_rawFlags = evt.m_rawFlags;
751
752 #if wxUSE_UNICODE
753 m_uniChar = evt.m_uniChar;
754 #endif
755 }
756
757 bool wxKeyEvent::IsKeyInCategory(int category) const
758 {
759 switch ( GetKeyCode() )
760 {
761 case WXK_LEFT:
762 case WXK_RIGHT:
763 case WXK_UP:
764 case WXK_DOWN:
765 case WXK_NUMPAD_LEFT:
766 case WXK_NUMPAD_RIGHT:
767 case WXK_NUMPAD_UP:
768 case WXK_NUMPAD_DOWN:
769 return (category & WXK_CATEGORY_ARROW) != 0;
770
771 case WXK_PAGEDOWN:
772 case WXK_END:
773 case WXK_NUMPAD_PAGEUP:
774 case WXK_NUMPAD_PAGEDOWN:
775 return (category & WXK_CATEGORY_PAGING) != 0;
776
777 case WXK_HOME:
778 case WXK_PAGEUP:
779 case WXK_NUMPAD_HOME:
780 case WXK_NUMPAD_END:
781 return (category & WXK_CATEGORY_JUMP) != 0;
782
783 case WXK_TAB:
784 case WXK_NUMPAD_TAB:
785 return (category & WXK_CATEGORY_TAB) != 0;
786
787 case WXK_BACK:
788 case WXK_DELETE:
789 case WXK_NUMPAD_DELETE:
790 return (category & WXK_CATEGORY_CUT) != 0;
791
792 default:
793 return false;
794 }
795 }
796
797 // ----------------------------------------------------------------------------
798 // wxWindowCreateEvent
799 // ----------------------------------------------------------------------------
800
801 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win)
802 {
803 SetEventType(wxEVT_CREATE);
804 SetEventObject(win);
805 }
806
807 // ----------------------------------------------------------------------------
808 // wxWindowDestroyEvent
809 // ----------------------------------------------------------------------------
810
811 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow *win)
812 {
813 SetEventType(wxEVT_DESTROY);
814 SetEventObject(win);
815 }
816
817 // ----------------------------------------------------------------------------
818 // wxChildFocusEvent
819 // ----------------------------------------------------------------------------
820
821 wxChildFocusEvent::wxChildFocusEvent(wxWindow *win)
822 : wxCommandEvent(wxEVT_CHILD_FOCUS)
823 {
824 SetEventObject(win);
825 }
826
827 // ----------------------------------------------------------------------------
828 // wxHelpEvent
829 // ----------------------------------------------------------------------------
830
831 /* static */
832 wxHelpEvent::Origin wxHelpEvent::GuessOrigin(Origin origin)
833 {
834 if ( origin == Origin_Unknown )
835 {
836 // assume that the event comes from the help button if it's not from
837 // keyboard and that pressing F1 always results in the help event
838 origin = wxGetKeyState(WXK_F1) ? Origin_Keyboard : Origin_HelpButton;
839 }
840
841 return origin;
842 }
843
844 #endif // wxUSE_GUI
845
846
847 #if wxUSE_BASE
848
849 // ----------------------------------------------------------------------------
850 // wxEventHashTable
851 // ----------------------------------------------------------------------------
852
853 static const int EVENT_TYPE_TABLE_INIT_SIZE = 31; // Not too big not too small...
854
855 wxEventHashTable* wxEventHashTable::sm_first = NULL;
856
857 wxEventHashTable::wxEventHashTable(const wxEventTable &table)
858 : m_table(table),
859 m_rebuildHash(true)
860 {
861 AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE);
862
863 m_next = sm_first;
864 if (m_next)
865 m_next->m_previous = this;
866 sm_first = this;
867 }
868
869 wxEventHashTable::~wxEventHashTable()
870 {
871 if (m_next)
872 m_next->m_previous = m_previous;
873 if (m_previous)
874 m_previous->m_next = m_next;
875 if (sm_first == this)
876 sm_first = m_next;
877
878 Clear();
879 }
880
881 void wxEventHashTable::Clear()
882 {
883 for ( size_t i = 0; i < m_size; i++ )
884 {
885 EventTypeTablePointer eTTnode = m_eventTypeTable[i];
886 delete eTTnode;
887 }
888
889 delete[] m_eventTypeTable;
890 m_eventTypeTable = NULL;
891
892 m_size = 0;
893 }
894
895 #if wxUSE_MEMORY_TRACING
896
897 // Clear all tables
898 void wxEventHashTable::ClearAll()
899 {
900 wxEventHashTable* table = sm_first;
901 while (table)
902 {
903 table->Clear();
904 table = table->m_next;
905 }
906 }
907
908 #endif // wxUSE_MEMORY_TRACING
909
910 bool wxEventHashTable::HandleEvent(wxEvent &event, wxEvtHandler *self)
911 {
912 if (m_rebuildHash)
913 {
914 InitHashTable();
915 m_rebuildHash = false;
916 }
917
918 if (!m_eventTypeTable)
919 return false;
920
921 // Find all entries for the given event type.
922 wxEventType eventType = event.GetEventType();
923 const EventTypeTablePointer eTTnode = m_eventTypeTable[eventType % m_size];
924 if (eTTnode && eTTnode->eventType == eventType)
925 {
926 // Now start the search for an event handler
927 // that can handle an event with the given ID.
928 const wxEventTableEntryPointerArray&
929 eventEntryTable = eTTnode->eventEntryTable;
930
931 const size_t count = eventEntryTable.GetCount();
932 for (size_t n = 0; n < count; n++)
933 {
934 const wxEventTableEntry& entry = *eventEntryTable[n];
935 if ( wxEvtHandler::ProcessEventIfMatchesId(entry, self, event) )
936 return true;
937 }
938 }
939
940 return false;
941 }
942
943 void wxEventHashTable::InitHashTable()
944 {
945 // Loop over the event tables and all its base tables.
946 const wxEventTable *table = &m_table;
947 while (table)
948 {
949 // Retrieve all valid event handler entries
950 const wxEventTableEntry *entry = table->entries;
951 while (entry->m_fn != 0)
952 {
953 // Add the event entry in the Hash.
954 AddEntry(*entry);
955
956 entry++;
957 }
958
959 table = table->baseTable;
960 }
961
962 // Lets free some memory.
963 size_t i;
964 for(i = 0; i < m_size; i++)
965 {
966 EventTypeTablePointer eTTnode = m_eventTypeTable[i];
967 if (eTTnode)
968 {
969 eTTnode->eventEntryTable.Shrink();
970 }
971 }
972 }
973
974 void wxEventHashTable::AddEntry(const wxEventTableEntry &entry)
975 {
976 // This might happen 'accidentally' as the app is exiting
977 if (!m_eventTypeTable)
978 return;
979
980 EventTypeTablePointer *peTTnode = &m_eventTypeTable[entry.m_eventType % m_size];
981 EventTypeTablePointer eTTnode = *peTTnode;
982
983 if (eTTnode)
984 {
985 if (eTTnode->eventType != entry.m_eventType)
986 {
987 // Resize the table!
988 GrowEventTypeTable();
989 // Try again to add it.
990 AddEntry(entry);
991 return;
992 }
993 }
994 else
995 {
996 eTTnode = new EventTypeTable;
997 eTTnode->eventType = entry.m_eventType;
998 *peTTnode = eTTnode;
999 }
1000
1001 // Fill all hash entries between entry.m_id and entry.m_lastId...
1002 eTTnode->eventEntryTable.Add(&entry);
1003 }
1004
1005 void wxEventHashTable::AllocEventTypeTable(size_t size)
1006 {
1007 m_eventTypeTable = new EventTypeTablePointer[size];
1008 memset((void *)m_eventTypeTable, 0, sizeof(EventTypeTablePointer)*size);
1009 m_size = size;
1010 }
1011
1012 void wxEventHashTable::GrowEventTypeTable()
1013 {
1014 size_t oldSize = m_size;
1015 EventTypeTablePointer *oldEventTypeTable = m_eventTypeTable;
1016
1017 // TODO: Search the most optimal grow sequence
1018 AllocEventTypeTable(/* GetNextPrime(oldSize) */oldSize*2+1);
1019
1020 for ( size_t i = 0; i < oldSize; /* */ )
1021 {
1022 EventTypeTablePointer eTToldNode = oldEventTypeTable[i];
1023 if (eTToldNode)
1024 {
1025 EventTypeTablePointer *peTTnode = &m_eventTypeTable[eTToldNode->eventType % m_size];
1026 EventTypeTablePointer eTTnode = *peTTnode;
1027
1028 // Check for collision, we don't want any.
1029 if (eTTnode)
1030 {
1031 GrowEventTypeTable();
1032 continue; // Don't increment the counter,
1033 // as we still need to add this element.
1034 }
1035 else
1036 {
1037 // Get the old value and put it in the new table.
1038 *peTTnode = oldEventTypeTable[i];
1039 }
1040 }
1041
1042 i++;
1043 }
1044
1045 delete[] oldEventTypeTable;
1046 }
1047
1048 // ----------------------------------------------------------------------------
1049 // wxEvtHandler
1050 // ----------------------------------------------------------------------------
1051
1052 wxEvtHandler::wxEvtHandler()
1053 {
1054 m_nextHandler = NULL;
1055 m_previousHandler = NULL;
1056 m_enabled = true;
1057 m_dynamicEvents = NULL;
1058 m_pendingEvents = NULL;
1059
1060 // no client data (yet)
1061 m_clientData = NULL;
1062 m_clientDataType = wxClientData_None;
1063 }
1064
1065 wxEvtHandler::~wxEvtHandler()
1066 {
1067 Unlink();
1068
1069 if (m_dynamicEvents)
1070 {
1071 for ( wxList::iterator it = m_dynamicEvents->begin(),
1072 end = m_dynamicEvents->end();
1073 it != end;
1074 ++it )
1075 {
1076 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)*it;
1077
1078 // Remove ourselves from sink destructor notifications
1079 // (this has usually been done, in wxTrackable destructor)
1080 wxEvtHandler *eventSink = entry->m_fn->GetEvtHandler();
1081 if ( eventSink )
1082 {
1083 wxEventConnectionRef * const
1084 evtConnRef = FindRefInTrackerList(eventSink);
1085 if ( evtConnRef )
1086 {
1087 eventSink->RemoveNode(evtConnRef);
1088 delete evtConnRef;
1089 }
1090 }
1091
1092 delete entry->m_callbackUserData;
1093 delete entry;
1094 }
1095 delete m_dynamicEvents;
1096 }
1097
1098 // Remove us from the list of the pending events if necessary.
1099 if (wxTheApp)
1100 wxTheApp->RemovePendingEventHandler(this);
1101
1102 DeletePendingEvents();
1103
1104 // we only delete object data, not untyped
1105 if ( m_clientDataType == wxClientData_Object )
1106 delete m_clientObject;
1107 }
1108
1109 void wxEvtHandler::Unlink()
1110 {
1111 // this event handler must take itself out of the chain of handlers:
1112
1113 if (m_previousHandler)
1114 m_previousHandler->SetNextHandler(m_nextHandler);
1115
1116 if (m_nextHandler)
1117 m_nextHandler->SetPreviousHandler(m_previousHandler);
1118
1119 m_nextHandler = NULL;
1120 m_previousHandler = NULL;
1121 }
1122
1123 bool wxEvtHandler::IsUnlinked() const
1124 {
1125 return m_previousHandler == NULL &&
1126 m_nextHandler == NULL;
1127 }
1128
1129 #if wxUSE_THREADS
1130
1131 bool wxEvtHandler::ProcessThreadEvent(const wxEvent& event)
1132 {
1133 // check that we are really in a child thread
1134 wxASSERT_MSG( !wxThread::IsMain(),
1135 wxT("use ProcessEvent() in main thread") );
1136
1137 AddPendingEvent(event);
1138
1139 return true;
1140 }
1141
1142 #endif // wxUSE_THREADS
1143
1144 void wxEvtHandler::QueueEvent(wxEvent *event)
1145 {
1146 wxCHECK_RET( event, "NULL event can't be posted" );
1147
1148 if (!wxTheApp)
1149 {
1150 // we need an event loop which manages the list of event handlers with
1151 // pending events... cannot proceed without it!
1152 wxLogDebug("No application object! Cannot queue this event!");
1153
1154 // anyway delete the given event to avoid memory leaks
1155 delete event;
1156
1157 return;
1158 }
1159
1160 // 1) Add this event to our list of pending events
1161 wxENTER_CRIT_SECT( m_pendingEventsLock );
1162
1163 if ( !m_pendingEvents )
1164 m_pendingEvents = new wxList;
1165
1166 m_pendingEvents->Append(event);
1167
1168 // 2) Add this event handler to list of event handlers that
1169 // have pending events.
1170
1171 wxTheApp->AppendPendingEventHandler(this);
1172
1173 // only release m_pendingEventsLock now because otherwise there is a race
1174 // condition as described in the ticket #9093: we could process the event
1175 // just added to m_pendingEvents in our ProcessPendingEvents() below before
1176 // we had time to append this pointer to wxHandlersWithPendingEvents list; thus
1177 // breaking the invariant that a handler should be in the list iff it has
1178 // any pending events to process
1179 wxLEAVE_CRIT_SECT( m_pendingEventsLock );
1180
1181 // 3) Inform the system that new pending events are somewhere,
1182 // and that these should be processed in idle time.
1183 wxWakeUpIdle();
1184 }
1185
1186 void wxEvtHandler::DeletePendingEvents()
1187 {
1188 if (m_pendingEvents)
1189 m_pendingEvents->DeleteContents(true);
1190 wxDELETE(m_pendingEvents);
1191 }
1192
1193 void wxEvtHandler::ProcessPendingEvents()
1194 {
1195 if (!wxTheApp)
1196 {
1197 // we need an event loop which manages the list of event handlers with
1198 // pending events... cannot proceed without it!
1199 wxLogDebug("No application object! Cannot process pending events!");
1200 return;
1201 }
1202
1203 // we need to process only a single pending event in this call because
1204 // each call to ProcessEvent() could result in the destruction of this
1205 // same event handler (see the comment at the end of this function)
1206
1207 wxENTER_CRIT_SECT( m_pendingEventsLock );
1208
1209 // this method is only called by wxApp if this handler does have
1210 // pending events
1211 wxCHECK_RET( m_pendingEvents && !m_pendingEvents->IsEmpty(),
1212 "should have pending events if called" );
1213
1214 wxList::compatibility_iterator node = m_pendingEvents->GetFirst();
1215 wxEvent* pEvent = static_cast<wxEvent *>(node->GetData());
1216
1217 // find the first event which can be processed now:
1218 wxEventLoopBase* evtLoop = wxEventLoopBase::GetActive();
1219 if (evtLoop && evtLoop->IsYielding())
1220 {
1221 while (node && pEvent && !evtLoop->IsEventAllowedInsideYield(pEvent->GetEventCategory()))
1222 {
1223 node = node->GetNext();
1224 pEvent = node ? static_cast<wxEvent *>(node->GetData()) : NULL;
1225 }
1226
1227 if (!node)
1228 {
1229 // all our events are NOT processable now... signal this:
1230 wxTheApp->DelayPendingEventHandler(this);
1231
1232 // see the comment at the beginning of evtloop.h header for the
1233 // logic behind YieldFor() and behind DelayPendingEventHandler()
1234
1235 wxLEAVE_CRIT_SECT( m_pendingEventsLock );
1236
1237 return;
1238 }
1239 }
1240
1241 wxEventPtr event(pEvent);
1242
1243 // it's important we remove event from list before processing it, else a
1244 // nested event loop, for example from a modal dialog, might process the
1245 // same event again.
1246 m_pendingEvents->Erase(node);
1247
1248 if ( m_pendingEvents->IsEmpty() )
1249 {
1250 // if there are no more pending events left, we don't need to
1251 // stay in this list
1252 wxTheApp->RemovePendingEventHandler(this);
1253 }
1254
1255 wxLEAVE_CRIT_SECT( m_pendingEventsLock );
1256
1257 ProcessEvent(*event);
1258
1259 // careful: this object could have been deleted by the event handler
1260 // executed by the above ProcessEvent() call, so we can't access any fields
1261 // of this object any more
1262 }
1263
1264 /* static */
1265 bool wxEvtHandler::ProcessEventIfMatchesId(const wxEventTableEntryBase& entry,
1266 wxEvtHandler *handler,
1267 wxEvent& event)
1268 {
1269 int tableId1 = entry.m_id,
1270 tableId2 = entry.m_lastId;
1271
1272 // match only if the event type is the same and the id is either -1 in
1273 // the event table (meaning "any") or the event id matches the id
1274 // specified in the event table either exactly or by falling into
1275 // range between first and last
1276 if ((tableId1 == wxID_ANY) ||
1277 (tableId2 == wxID_ANY && tableId1 == event.GetId()) ||
1278 (tableId2 != wxID_ANY &&
1279 (event.GetId() >= tableId1 && event.GetId() <= tableId2)))
1280 {
1281 event.Skip(false);
1282 event.m_callbackUserData = entry.m_callbackUserData;
1283
1284 #if wxUSE_EXCEPTIONS
1285 if ( wxTheApp )
1286 {
1287 // call the handler via wxApp method which allows the user to catch
1288 // any exceptions which may be thrown by any handler in the program
1289 // in one place
1290 wxTheApp->CallEventHandler(handler, *entry.m_fn, event);
1291 }
1292 else
1293 #endif // wxUSE_EXCEPTIONS
1294 {
1295 (*entry.m_fn)(handler, event);
1296 }
1297
1298 if (!event.GetSkipped())
1299 return true;
1300 }
1301
1302 return false;
1303 }
1304
1305 bool wxEvtHandler::DoTryApp(wxEvent& event)
1306 {
1307 if ( wxTheApp && (this != wxTheApp) )
1308 {
1309 // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
1310 // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
1311 // processed appropriately via SearchEventTable.
1312 if ( event.GetEventType() != wxEVT_IDLE )
1313 {
1314 if ( wxTheApp->ProcessEvent(event) )
1315 return true;
1316 }
1317 }
1318
1319 return false;
1320 }
1321
1322 bool wxEvtHandler::TryBefore(wxEvent& event)
1323 {
1324 #if WXWIN_COMPATIBILITY_2_8
1325 // call the old virtual function to keep the code overriding it working
1326 return TryValidator(event);
1327 #else
1328 wxUnusedVar(event);
1329 return false;
1330 #endif
1331 }
1332
1333 bool wxEvtHandler::TryAfter(wxEvent& event)
1334 {
1335 // We only want to pass the window to the application object once even if
1336 // there are several chained handlers. Ensure that this is what happens by
1337 // only calling DoTryApp() if there is no next handler (which would do it).
1338 //
1339 // Notice that, unlike simply calling TryAfter() on the last handler in the
1340 // chain only from ProcessEvent(), this also works with wxWindow object in
1341 // the middle of the chain: its overridden TryAfter() will still be called
1342 // and propagate the event upwards the window hierarchy even if it's not
1343 // the last one in the chain (which, admittedly, shouldn't happen often).
1344 if ( GetNextHandler() )
1345 return GetNextHandler()->TryAfter(event);
1346
1347 #if WXWIN_COMPATIBILITY_2_8
1348 // as above, call the old virtual function for compatibility
1349 return TryParent(event);
1350 #else
1351 return DoTryApp(event);
1352 #endif
1353 }
1354
1355 bool wxEvtHandler::ProcessEvent(wxEvent& event)
1356 {
1357 // The very first thing we do is to allow the application to hook into
1358 // event processing in order to globally pre-process all events.
1359 //
1360 // Note that we should only do it if we're the first event handler called
1361 // to avoid calling FilterEvent() multiple times as the event goes through
1362 // the event handler chain and possibly upwards the window hierarchy.
1363 if ( !event.WasProcessed() )
1364 {
1365 if ( wxTheApp )
1366 {
1367 int rc = wxTheApp->FilterEvent(event);
1368 if ( rc != -1 )
1369 {
1370 wxASSERT_MSG( rc == 1 || rc == 0,
1371 "unexpected wxApp::FilterEvent return value" );
1372
1373 return rc != 0;
1374 }
1375 //else: proceed normally
1376 }
1377 }
1378
1379 // Short circuit the event processing logic if we're requested to process
1380 // this event in this handler only, see DoTryChain() for more details.
1381 if ( event.ShouldProcessHereOnly() )
1382 return ProcessEventHere(event);
1383
1384
1385 // Try to process the event in this handler itself.
1386 if ( ProcessEventLocally(event) )
1387 return true;
1388
1389 // If we still didn't find a handler, propagate the event upwards the
1390 // window chain and/or to the application object.
1391 if ( TryAfter(event) )
1392 return true;
1393
1394
1395 // No handler found anywhere, bail out.
1396 return false;
1397 }
1398
1399 bool wxEvtHandler::ProcessEventLocally(wxEvent& event)
1400 {
1401 // First try the hooks which should be called before our own handlers
1402 if ( TryBefore(event) )
1403 return true;
1404
1405 // Then try this handler itself, notice that we should not call
1406 // ProcessEvent() on this one as we're already called from it, which
1407 // explains why we do it here and not in DoTryChain()
1408 if ( ProcessEventHere(event) )
1409 return true;
1410
1411 // Finally try the event handlers chained to this one,
1412 if ( DoTryChain(event) )
1413 return true;
1414
1415 // And return false to indicate that we didn't find any handler at this
1416 // level.
1417 return false;
1418 }
1419
1420 bool wxEvtHandler::DoTryChain(wxEvent& event)
1421 {
1422 for ( wxEvtHandler *h = GetNextHandler(); h; h = h->GetNextHandler() )
1423 {
1424 // We need to process this event at the level of this handler only
1425 // right now, the pre-/post-processing was either already done by
1426 // ProcessEvent() from which we were called or will be done by it when
1427 // we return.
1428 //
1429 // However we must call ProcessEvent() and not ProcessEventHere()
1430 // because the existing code (including some in wxWidgets itself)
1431 // expects the overridden ProcessEvent() in its custom event handlers
1432 // pushed on a window to be called.
1433 //
1434 // So we must call ProcessEvent() but it must not do what it usually
1435 // does. To resolve this paradox we pass a special "process here only"
1436 // flag to ProcessEvent() via the event object itself. This ensures
1437 // that if our own, base class, version is called, it will just call
1438 // ProcessEventHere() and won't do anything else, just as we want it to.
1439 wxEventProcessHereOnly processHereOnly(event);
1440 if ( h->ProcessEvent(event) )
1441 return true;
1442 }
1443
1444 return false;
1445 }
1446
1447 bool wxEvtHandler::ProcessEventHere(wxEvent& event)
1448 {
1449 // If the event handler is disabled it doesn't process any events
1450 if ( !GetEvtHandlerEnabled() )
1451 return false;
1452
1453 // Handle per-instance dynamic event tables first
1454 if ( m_dynamicEvents && SearchDynamicEventTable(event) )
1455 return true;
1456
1457 // Then static per-class event tables
1458 if ( GetEventHashTable().HandleEvent(event, this) )
1459 return true;
1460
1461 // We don't have a handler for this event.
1462 return false;
1463 }
1464
1465 bool wxEvtHandler::SafelyProcessEvent(wxEvent& event)
1466 {
1467 #if wxUSE_EXCEPTIONS
1468 try
1469 {
1470 #endif
1471 return ProcessEvent(event);
1472 #if wxUSE_EXCEPTIONS
1473 }
1474 catch ( ... )
1475 {
1476 // notice that we do it in 2 steps to avoid warnings about possibly
1477 // uninitialized loop variable from some versions of g++ which are not
1478 // smart enough to figure out that GetActive() doesn't throw and so
1479 // that loop will always be initialized
1480 wxEventLoopBase *loop = NULL;
1481 try
1482 {
1483 loop = wxEventLoopBase::GetActive();
1484
1485 if ( !wxTheApp || !wxTheApp->OnExceptionInMainLoop() )
1486 {
1487 if ( loop )
1488 loop->Exit();
1489 }
1490 //else: continue running current event loop
1491
1492 return false;
1493 }
1494 catch ( ... )
1495 {
1496 // OnExceptionInMainLoop() threw, possibly rethrowing the same
1497 // exception again: very good, but we still need Exit() to
1498 // be called
1499 if ( loop )
1500 loop->Exit();
1501 throw;
1502 }
1503 }
1504 #endif // wxUSE_EXCEPTIONS
1505 }
1506
1507 bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event)
1508 {
1509 const wxEventType eventType = event.GetEventType();
1510 for ( int i = 0; table.entries[i].m_fn != 0; i++ )
1511 {
1512 const wxEventTableEntry& entry = table.entries[i];
1513 if ( eventType == entry.m_eventType )
1514 {
1515 if ( ProcessEventIfMatchesId(entry, this, event) )
1516 return true;
1517 }
1518 }
1519
1520 return false;
1521 }
1522
1523 void wxEvtHandler::DoBind(int id,
1524 int lastId,
1525 wxEventType eventType,
1526 wxEventFunctor *func,
1527 wxObject *userData)
1528 {
1529 wxDynamicEventTableEntry *entry =
1530 new wxDynamicEventTableEntry(eventType, id, lastId, func, userData);
1531
1532 if (!m_dynamicEvents)
1533 m_dynamicEvents = new wxList;
1534
1535 // Insert at the front of the list so most recent additions are found first
1536 m_dynamicEvents->Insert( (wxObject*) entry );
1537
1538 // Make sure we get to know when a sink is destroyed
1539 wxEvtHandler *eventSink = func->GetEvtHandler();
1540 if ( eventSink && eventSink != this )
1541 {
1542 wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink);
1543 if ( evtConnRef )
1544 evtConnRef->IncRef( );
1545 else
1546 new wxEventConnectionRef(this, eventSink);
1547 }
1548 }
1549
1550 bool
1551 wxEvtHandler::DoUnbind(int id,
1552 int lastId,
1553 wxEventType eventType,
1554 const wxEventFunctor& func,
1555 wxObject *userData)
1556 {
1557 if (!m_dynamicEvents)
1558 return false;
1559
1560 // Remove connection from tracker node (wxEventConnectionRef)
1561 wxEvtHandler *eventSink = func.GetEvtHandler();
1562 if ( eventSink && eventSink != this )
1563 {
1564 wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink);
1565 if ( evtConnRef )
1566 evtConnRef->DecRef();
1567 }
1568
1569 wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();
1570 while (node)
1571 {
1572 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1573
1574 if ((entry->m_id == id) &&
1575 ((entry->m_lastId == lastId) || (lastId == wxID_ANY)) &&
1576 ((entry->m_eventType == eventType) || (eventType == wxEVT_NULL)) &&
1577 entry->m_fn->IsMatching(func) &&
1578 ((entry->m_callbackUserData == userData) || !userData))
1579 {
1580 delete entry->m_callbackUserData;
1581 m_dynamicEvents->Erase( node );
1582 delete entry;
1583 return true;
1584 }
1585 node = node->GetNext();
1586 }
1587 return false;
1588 }
1589
1590 bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event )
1591 {
1592 wxCHECK_MSG( m_dynamicEvents, false,
1593 wxT("caller should check that we have dynamic events") );
1594
1595 wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();
1596 while (node)
1597 {
1598 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1599
1600 // get next node before (maybe) calling the event handler as it could
1601 // call Disconnect() invalidating the current node
1602 node = node->GetNext();
1603
1604 if ( event.GetEventType() == entry->m_eventType )
1605 {
1606 wxEvtHandler *handler = entry->m_fn->GetEvtHandler();
1607 if ( !handler )
1608 handler = this;
1609 if ( ProcessEventIfMatchesId(*entry, handler, event) )
1610 return true;
1611 }
1612 }
1613
1614 return false;
1615 }
1616
1617 void wxEvtHandler::DoSetClientObject( wxClientData *data )
1618 {
1619 wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1620 wxT("can't have both object and void client data") );
1621
1622 if ( m_clientObject )
1623 delete m_clientObject;
1624
1625 m_clientObject = data;
1626 m_clientDataType = wxClientData_Object;
1627 }
1628
1629 wxClientData *wxEvtHandler::DoGetClientObject() const
1630 {
1631 // it's not an error to call GetClientObject() on a window which doesn't
1632 // have client data at all - NULL will be returned
1633 wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1634 wxT("this window doesn't have object client data") );
1635
1636 return m_clientObject;
1637 }
1638
1639 void wxEvtHandler::DoSetClientData( void *data )
1640 {
1641 wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1642 wxT("can't have both object and void client data") );
1643
1644 m_clientData = data;
1645 m_clientDataType = wxClientData_Void;
1646 }
1647
1648 void *wxEvtHandler::DoGetClientData() const
1649 {
1650 // it's not an error to call GetClientData() on a window which doesn't have
1651 // client data at all - NULL will be returned
1652 wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1653 wxT("this window doesn't have void client data") );
1654
1655 return m_clientData;
1656 }
1657
1658 // A helper to find an wxEventConnectionRef object
1659 wxEventConnectionRef *
1660 wxEvtHandler::FindRefInTrackerList(wxEvtHandler *eventSink)
1661 {
1662 for ( wxTrackerNode *node = eventSink->GetFirst(); node; node = node->m_nxt )
1663 {
1664 // we only want wxEventConnectionRef nodes here
1665 wxEventConnectionRef *evtConnRef = node->ToEventConnection();
1666 if ( evtConnRef && evtConnRef->m_src == this )
1667 {
1668 wxASSERT( evtConnRef->m_sink==eventSink );
1669 return evtConnRef;
1670 }
1671 }
1672
1673 return NULL;
1674 }
1675
1676 void wxEvtHandler::OnSinkDestroyed( wxEvtHandler *sink )
1677 {
1678 wxASSERT(m_dynamicEvents);
1679
1680 // remove all connections with this sink
1681 wxList::compatibility_iterator node = m_dynamicEvents->GetFirst(), node_nxt;
1682 while (node)
1683 {
1684 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1685 node_nxt = node->GetNext();
1686
1687 if ( entry->m_fn->GetEvtHandler() == sink )
1688 {
1689 delete entry->m_callbackUserData;
1690 m_dynamicEvents->Erase( node );
1691 delete entry;
1692 }
1693 node = node_nxt;
1694 }
1695 }
1696
1697 #endif // wxUSE_BASE
1698
1699 #if wxUSE_GUI
1700
1701 // Find a window with the focus, that is also a descendant of the given window.
1702 // This is used to determine the window to initially send commands to.
1703 wxWindow* wxFindFocusDescendant(wxWindow* ancestor)
1704 {
1705 // Process events starting with the window with the focus, if any.
1706 wxWindow* focusWin = wxWindow::FindFocus();
1707 wxWindow* win = focusWin;
1708
1709 // Check if this is a descendant of this frame.
1710 // If not, win will be set to NULL.
1711 while (win)
1712 {
1713 if (win == ancestor)
1714 break;
1715 else
1716 win = win->GetParent();
1717 }
1718 if (win == NULL)
1719 focusWin = NULL;
1720
1721 return focusWin;
1722 }
1723
1724 // ----------------------------------------------------------------------------
1725 // wxEventBlocker
1726 // ----------------------------------------------------------------------------
1727
1728 wxEventBlocker::wxEventBlocker(wxWindow *win, wxEventType type)
1729 {
1730 wxCHECK_RET(win, wxT("Null window given to wxEventBlocker"));
1731
1732 m_window = win;
1733
1734 Block(type);
1735 m_window->PushEventHandler(this);
1736 }
1737
1738 wxEventBlocker::~wxEventBlocker()
1739 {
1740 wxEvtHandler *popped = m_window->PopEventHandler(false);
1741 wxCHECK_RET(popped == this,
1742 wxT("Don't push other event handlers into a window managed by wxEventBlocker!"));
1743 }
1744
1745 bool wxEventBlocker::ProcessEvent(wxEvent& event)
1746 {
1747 // should this event be blocked?
1748 for ( size_t i = 0; i < m_eventsToBlock.size(); i++ )
1749 {
1750 wxEventType t = (wxEventType)m_eventsToBlock[i];
1751 if ( t == wxEVT_ANY || t == event.GetEventType() )
1752 return true; // yes, it should: mark this event as processed
1753 }
1754
1755 return false;
1756 }
1757
1758 #endif // wxUSE_GUI
1759
wxWidgets (Impactor)