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