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