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