removed WXWIN_COMPATIBILITY_2_4 from common and wxMSW files (patch 1675546)
[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
29 #ifndef WX_PRECOMP
30 #include "wx/list.h"
31 #include "wx/app.h"
32 #include "wx/utils.h"
33 #include "wx/stopwatch.h"
34 #include "wx/module.h"
35
36 #if wxUSE_GUI
37 #include "wx/control.h"
38 #include "wx/dc.h"
39 #include "wx/textctrl.h"
40 #include "wx/validate.h"
41 #endif // wxUSE_GUI
42 #endif
43
44 // ----------------------------------------------------------------------------
45 // wxWin macros
46 // ----------------------------------------------------------------------------
47
48 #if wxUSE_BASE
49 IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler, wxObject)
50 IMPLEMENT_ABSTRACT_CLASS(wxEvent, wxObject)
51 #endif // wxUSE_BASE
52
53 #if wxUSE_GUI
54 IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent)
55 IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent, wxEvent)
56 IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent, wxCommandEvent)
57 IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent, wxCommandEvent)
58 IMPLEMENT_DYNAMIC_CLASS(wxScrollWinEvent, wxEvent)
59 IMPLEMENT_DYNAMIC_CLASS(wxMouseEvent, wxEvent)
60 IMPLEMENT_DYNAMIC_CLASS(wxKeyEvent, wxEvent)
61 IMPLEMENT_DYNAMIC_CLASS(wxSizeEvent, wxEvent)
62 IMPLEMENT_DYNAMIC_CLASS(wxPaintEvent, wxEvent)
63 IMPLEMENT_DYNAMIC_CLASS(wxNcPaintEvent, wxEvent)
64 IMPLEMENT_DYNAMIC_CLASS(wxEraseEvent, wxEvent)
65 IMPLEMENT_DYNAMIC_CLASS(wxMoveEvent, wxEvent)
66 IMPLEMENT_DYNAMIC_CLASS(wxFocusEvent, wxEvent)
67 IMPLEMENT_DYNAMIC_CLASS(wxChildFocusEvent, wxCommandEvent)
68 IMPLEMENT_DYNAMIC_CLASS(wxCloseEvent, wxEvent)
69 IMPLEMENT_DYNAMIC_CLASS(wxShowEvent, wxEvent)
70 IMPLEMENT_DYNAMIC_CLASS(wxMaximizeEvent, wxEvent)
71 IMPLEMENT_DYNAMIC_CLASS(wxIconizeEvent, wxEvent)
72 IMPLEMENT_DYNAMIC_CLASS(wxMenuEvent, wxEvent)
73 IMPLEMENT_DYNAMIC_CLASS(wxJoystickEvent, wxEvent)
74 IMPLEMENT_DYNAMIC_CLASS(wxDropFilesEvent, wxEvent)
75 IMPLEMENT_DYNAMIC_CLASS(wxActivateEvent, wxEvent)
76 IMPLEMENT_DYNAMIC_CLASS(wxInitDialogEvent, wxEvent)
77 IMPLEMENT_DYNAMIC_CLASS(wxSetCursorEvent, wxEvent)
78 IMPLEMENT_DYNAMIC_CLASS(wxSysColourChangedEvent, wxEvent)
79 IMPLEMENT_DYNAMIC_CLASS(wxDisplayChangedEvent, wxEvent)
80 IMPLEMENT_DYNAMIC_CLASS(wxUpdateUIEvent, wxCommandEvent)
81 IMPLEMENT_DYNAMIC_CLASS(wxNavigationKeyEvent, wxEvent)
82 IMPLEMENT_DYNAMIC_CLASS(wxPaletteChangedEvent, wxEvent)
83 IMPLEMENT_DYNAMIC_CLASS(wxQueryNewPaletteEvent, wxEvent)
84 IMPLEMENT_DYNAMIC_CLASS(wxWindowCreateEvent, wxEvent)
85 IMPLEMENT_DYNAMIC_CLASS(wxWindowDestroyEvent, wxEvent)
86 IMPLEMENT_DYNAMIC_CLASS(wxHelpEvent, wxCommandEvent)
87 IMPLEMENT_DYNAMIC_CLASS(wxContextMenuEvent, wxCommandEvent)
88 IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureChangedEvent, wxEvent)
89 IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureLostEvent, wxEvent)
90 IMPLEMENT_DYNAMIC_CLASS(wxClipboardTextEvent, wxCommandEvent)
91 #endif // wxUSE_GUI
92
93 #if wxUSE_BASE
94
95 const wxEventTable *wxEvtHandler::GetEventTable() const
96 { return &wxEvtHandler::sm_eventTable; }
97
98 const wxEventTable wxEvtHandler::sm_eventTable =
99 { (const wxEventTable *)NULL, &wxEvtHandler::sm_eventTableEntries[0] };
100
101 wxEventHashTable &wxEvtHandler::GetEventHashTable() const
102 { return wxEvtHandler::sm_eventHashTable; }
103
104 wxEventHashTable wxEvtHandler::sm_eventHashTable(wxEvtHandler::sm_eventTable);
105
106 const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] =
107 { DECLARE_EVENT_TABLE_ENTRY(wxEVT_NULL, 0, 0, (wxObjectEventFunction)NULL, NULL) };
108
109
110 #ifdef __WXDEBUG__
111 // Clear up event hash table contents or we can get problems
112 // when C++ is cleaning up the static object
113 class wxEventTableEntryModule: public wxModule
114 {
115 DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule)
116 public:
117 wxEventTableEntryModule() {}
118 bool OnInit() { return true; }
119 void OnExit()
120 {
121 wxEventHashTable::ClearAll();
122 }
123 };
124 IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule, wxModule)
125 #endif
126
127 // ----------------------------------------------------------------------------
128 // global variables
129 // ----------------------------------------------------------------------------
130
131 // To put pending event handlers
132 wxList *wxPendingEvents = (wxList *)NULL;
133
134 #if wxUSE_THREADS
135 // protects wxPendingEvents list
136 wxCriticalSection *wxPendingEventsLocker = (wxCriticalSection *)NULL;
137 #endif
138
139 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
140
141 // common event types are defined here, other event types are defined by the
142 // components which use them
143
144 const wxEventType wxEVT_FIRST = 10000;
145 const wxEventType wxEVT_USER_FIRST = wxEVT_FIRST + 2000;
146
147 DEFINE_EVENT_TYPE(wxEVT_NULL)
148 DEFINE_EVENT_TYPE(wxEVT_IDLE)
149 DEFINE_EVENT_TYPE(wxEVT_SOCKET)
150
151 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
152
153 #endif // wxUSE_BASE
154
155 #if wxUSE_GUI
156
157 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
158
159 DEFINE_EVENT_TYPE(wxEVT_COMMAND_BUTTON_CLICKED)
160 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKBOX_CLICKED)
161 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHOICE_SELECTED)
162 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_SELECTED)
163 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED)
164 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED)
165 DEFINE_EVENT_TYPE(wxEVT_COMMAND_MENU_SELECTED)
166 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SLIDER_UPDATED)
167 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBOX_SELECTED)
168 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBUTTON_SELECTED)
169 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SCROLLBAR_UPDATED)
170 DEFINE_EVENT_TYPE(wxEVT_COMMAND_VLBOX_SELECTED)
171 DEFINE_EVENT_TYPE(wxEVT_COMMAND_COMBOBOX_SELECTED)
172 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED)
173 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER)
174 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED)
175
176 // Sockets and timers send events, too
177 DEFINE_EVENT_TYPE(wxEVT_TIMER)
178
179 // Mouse event types
180 DEFINE_EVENT_TYPE(wxEVT_LEFT_DOWN)
181 DEFINE_EVENT_TYPE(wxEVT_LEFT_UP)
182 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DOWN)
183 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_UP)
184 DEFINE_EVENT_TYPE(wxEVT_RIGHT_DOWN)
185 DEFINE_EVENT_TYPE(wxEVT_RIGHT_UP)
186 DEFINE_EVENT_TYPE(wxEVT_MOTION)
187 DEFINE_EVENT_TYPE(wxEVT_ENTER_WINDOW)
188 DEFINE_EVENT_TYPE(wxEVT_LEAVE_WINDOW)
189 DEFINE_EVENT_TYPE(wxEVT_LEFT_DCLICK)
190 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DCLICK)
191 DEFINE_EVENT_TYPE(wxEVT_RIGHT_DCLICK)
192 DEFINE_EVENT_TYPE(wxEVT_SET_FOCUS)
193 DEFINE_EVENT_TYPE(wxEVT_KILL_FOCUS)
194 DEFINE_EVENT_TYPE(wxEVT_CHILD_FOCUS)
195 DEFINE_EVENT_TYPE(wxEVT_MOUSEWHEEL)
196
197 // Non-client mouse events
198 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN)
199 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_UP)
200 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DOWN)
201 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_UP)
202 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DOWN)
203 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_UP)
204 DEFINE_EVENT_TYPE(wxEVT_NC_MOTION)
205 DEFINE_EVENT_TYPE(wxEVT_NC_ENTER_WINDOW)
206 DEFINE_EVENT_TYPE(wxEVT_NC_LEAVE_WINDOW)
207 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DCLICK)
208 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DCLICK)
209 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DCLICK)
210
211 // Character input event type
212 DEFINE_EVENT_TYPE(wxEVT_CHAR)
213 DEFINE_EVENT_TYPE(wxEVT_CHAR_HOOK)
214 DEFINE_EVENT_TYPE(wxEVT_NAVIGATION_KEY)
215 DEFINE_EVENT_TYPE(wxEVT_KEY_DOWN)
216 DEFINE_EVENT_TYPE(wxEVT_KEY_UP)
217 #if wxUSE_HOTKEY
218 DEFINE_EVENT_TYPE(wxEVT_HOTKEY)
219 #endif
220
221 // Set cursor event
222 DEFINE_EVENT_TYPE(wxEVT_SET_CURSOR)
223
224 // wxScrollbar and wxSlider event identifiers
225 DEFINE_EVENT_TYPE(wxEVT_SCROLL_TOP)
226 DEFINE_EVENT_TYPE(wxEVT_SCROLL_BOTTOM)
227 DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEUP)
228 DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEDOWN)
229 DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEUP)
230 DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN)
231 DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK)
232 DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE)
233 DEFINE_EVENT_TYPE(wxEVT_SCROLL_CHANGED)
234
235 // Scroll events from wxWindow
236 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP)
237 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_BOTTOM)
238 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEUP)
239 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEDOWN)
240 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEUP)
241 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEDOWN)
242 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBTRACK)
243 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBRELEASE)
244
245 // System events
246 DEFINE_EVENT_TYPE(wxEVT_SIZE)
247 DEFINE_EVENT_TYPE(wxEVT_SIZING)
248 DEFINE_EVENT_TYPE(wxEVT_MOVE)
249 DEFINE_EVENT_TYPE(wxEVT_MOVING)
250 DEFINE_EVENT_TYPE(wxEVT_CLOSE_WINDOW)
251 DEFINE_EVENT_TYPE(wxEVT_END_SESSION)
252 DEFINE_EVENT_TYPE(wxEVT_QUERY_END_SESSION)
253 DEFINE_EVENT_TYPE(wxEVT_HIBERNATE)
254 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE_APP)
255 DEFINE_EVENT_TYPE(wxEVT_POWER)
256 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE)
257 DEFINE_EVENT_TYPE(wxEVT_CREATE)
258 DEFINE_EVENT_TYPE(wxEVT_DESTROY)
259 DEFINE_EVENT_TYPE(wxEVT_SHOW)
260 DEFINE_EVENT_TYPE(wxEVT_ICONIZE)
261 DEFINE_EVENT_TYPE(wxEVT_MAXIMIZE)
262 DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED)
263 DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_LOST)
264 DEFINE_EVENT_TYPE(wxEVT_PAINT)
265 DEFINE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND)
266 DEFINE_EVENT_TYPE(wxEVT_NC_PAINT)
267 DEFINE_EVENT_TYPE(wxEVT_PAINT_ICON)
268 DEFINE_EVENT_TYPE(wxEVT_MENU_OPEN)
269 DEFINE_EVENT_TYPE(wxEVT_MENU_CLOSE)
270 DEFINE_EVENT_TYPE(wxEVT_MENU_HIGHLIGHT)
271 DEFINE_EVENT_TYPE(wxEVT_CONTEXT_MENU)
272 DEFINE_EVENT_TYPE(wxEVT_SYS_COLOUR_CHANGED)
273 DEFINE_EVENT_TYPE(wxEVT_DISPLAY_CHANGED)
274 DEFINE_EVENT_TYPE(wxEVT_SETTING_CHANGED)
275 DEFINE_EVENT_TYPE(wxEVT_QUERY_NEW_PALETTE)
276 DEFINE_EVENT_TYPE(wxEVT_PALETTE_CHANGED)
277 DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_DOWN)
278 DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_UP)
279 DEFINE_EVENT_TYPE(wxEVT_JOY_MOVE)
280 DEFINE_EVENT_TYPE(wxEVT_JOY_ZMOVE)
281 DEFINE_EVENT_TYPE(wxEVT_DROP_FILES)
282 DEFINE_EVENT_TYPE(wxEVT_DRAW_ITEM)
283 DEFINE_EVENT_TYPE(wxEVT_MEASURE_ITEM)
284 DEFINE_EVENT_TYPE(wxEVT_COMPARE_ITEM)
285 DEFINE_EVENT_TYPE(wxEVT_INIT_DIALOG)
286 DEFINE_EVENT_TYPE(wxEVT_UPDATE_UI)
287
288 // Clipboard events
289 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_COPY)
290 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_CUT)
291 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_PASTE)
292
293 // Generic command events
294 // Note: a click is a higher-level event than button down/up
295 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK)
296 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_DCLICK)
297 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_CLICK)
298 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_DCLICK)
299 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SET_FOCUS)
300 DEFINE_EVENT_TYPE(wxEVT_COMMAND_KILL_FOCUS)
301 DEFINE_EVENT_TYPE(wxEVT_COMMAND_ENTER)
302
303 // Help events
304 DEFINE_EVENT_TYPE(wxEVT_HELP)
305 DEFINE_EVENT_TYPE(wxEVT_DETAILED_HELP)
306
307 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
308
309 #endif // wxUSE_GUI
310
311 #if wxUSE_BASE
312
313 // ============================================================================
314 // implementation
315 // ============================================================================
316
317 // ----------------------------------------------------------------------------
318 // event initialization
319 // ----------------------------------------------------------------------------
320
321 int wxNewEventType()
322 {
323 // MT-FIXME
324 static int s_lastUsedEventType = wxEVT_FIRST;
325
326 return s_lastUsedEventType++;
327 }
328
329 // ----------------------------------------------------------------------------
330 // wxEvent
331 // ----------------------------------------------------------------------------
332
333 /*
334 * General wxWidgets events, covering
335 * all interesting things that might happen (button clicking, resizing,
336 * setting text in widgets, etc.).
337 *
338 * For each completely new event type, derive a new event class.
339 *
340 */
341
342 wxEvent::wxEvent(int theId, wxEventType commandType )
343 {
344 m_eventType = commandType;
345 m_eventObject = (wxObject *) NULL;
346 m_timeStamp = 0;
347 m_id = theId;
348 m_skipped = false;
349 m_callbackUserData = (wxObject *) NULL;
350 m_isCommandEvent = false;
351 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
352 }
353
354 wxEvent::wxEvent(const wxEvent &src)
355 : wxObject(src)
356 , m_eventObject(src.m_eventObject)
357 , m_eventType(src.m_eventType)
358 , m_timeStamp(src.m_timeStamp)
359 , m_id(src.m_id)
360 , m_callbackUserData(src.m_callbackUserData)
361 , m_propagationLevel(src.m_propagationLevel)
362 , m_skipped(src.m_skipped)
363 , m_isCommandEvent(src.m_isCommandEvent)
364 {
365 }
366
367 #endif // wxUSE_BASE
368
369 #if wxUSE_GUI
370
371 /*
372 * Command events
373 *
374 */
375
376 #ifdef __VISUALC__
377 // 'this' : used in base member initializer list (for m_commandString)
378 #pragma warning(disable:4355)
379 #endif
380
381 wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId)
382 : wxEvent(theId, commandType)
383 {
384 m_clientData = (char *) NULL;
385 m_clientObject = (wxClientData *) NULL;
386 m_extraLong = 0;
387 m_commandInt = 0;
388 m_isCommandEvent = true;
389
390 // the command events are propagated upwards by default
391 m_propagationLevel = wxEVENT_PROPAGATE_MAX;
392 }
393
394 #ifdef __VISUALC__
395 #pragma warning(default:4355)
396 #endif
397
398 wxString wxCommandEvent::GetString() const
399 {
400 if(m_eventType != wxEVT_COMMAND_TEXT_UPDATED || !m_eventObject)
401 return m_cmdString;
402 else
403 {
404 #if wxUSE_TEXTCTRL
405 wxTextCtrl *txt = wxDynamicCast(m_eventObject, wxTextCtrl);
406 if(txt)
407 return txt->GetValue();
408 else
409 #endif // wxUSE_TEXTCTRL
410 return m_cmdString;
411 }
412 }
413
414 /*
415 * UI update events
416 */
417
418 #if wxUSE_LONGLONG
419 wxLongLong wxUpdateUIEvent::sm_lastUpdate = 0;
420 #endif
421
422 long wxUpdateUIEvent::sm_updateInterval = 0;
423
424 wxUpdateUIMode wxUpdateUIEvent::sm_updateMode = wxUPDATE_UI_PROCESS_ALL;
425
426 // Can we update?
427 bool wxUpdateUIEvent::CanUpdate(wxWindowBase *win)
428 {
429 // Don't update if we've switched global updating off
430 // and this window doesn't support updates.
431 if (win &&
432 (GetMode() == wxUPDATE_UI_PROCESS_SPECIFIED &&
433 ((win->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES) == 0)))
434 return false;
435
436 if (sm_updateInterval == -1)
437 return false;
438
439 if (sm_updateInterval == 0)
440 return true;
441
442 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
443 wxLongLong now = wxGetLocalTimeMillis();
444 if (now > (sm_lastUpdate + sm_updateInterval))
445 {
446 return true;
447 }
448
449 return false;
450 #else
451 // If we don't have wxStopWatch or wxLongLong, we
452 // should err on the safe side and update now anyway.
453 return true;
454 #endif
455 }
456
457 // Reset the update time to provide a delay until the next
458 // time we should update
459 void wxUpdateUIEvent::ResetUpdateTime()
460 {
461 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
462 if (sm_updateInterval > 0)
463 {
464 wxLongLong now = wxGetLocalTimeMillis();
465 if (now > (sm_lastUpdate + sm_updateInterval))
466 {
467 sm_lastUpdate = now;
468 }
469 }
470 #endif
471 }
472
473 /*
474 * Idle events
475 */
476
477 wxIdleMode wxIdleEvent::sm_idleMode = wxIDLE_PROCESS_ALL;
478
479 // Can we send an idle event?
480 bool wxIdleEvent::CanSend(wxWindow* win)
481 {
482 // Don't update if we've switched global updating off
483 // and this window doesn't support updates.
484 if (win &&
485 (GetMode() == wxIDLE_PROCESS_SPECIFIED &&
486 ((win->GetExtraStyle() & wxWS_EX_PROCESS_IDLE) == 0)))
487 return false;
488
489 return true;
490 }
491
492 /*
493 * Scroll events
494 */
495
496 wxScrollEvent::wxScrollEvent(wxEventType commandType,
497 int id,
498 int pos,
499 int orient)
500 : wxCommandEvent(commandType, id)
501 {
502 m_extraLong = orient;
503 m_commandInt = pos;
504 }
505
506 /*
507 * ScrollWin events
508 */
509
510 wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType,
511 int pos,
512 int orient)
513 {
514 m_eventType = commandType;
515 m_extraLong = orient;
516 m_commandInt = pos;
517 }
518
519 /*
520 * Mouse events
521 *
522 */
523
524 wxMouseEvent::wxMouseEvent(wxEventType commandType)
525 {
526 m_eventType = commandType;
527 m_metaDown = false;
528 m_altDown = false;
529 m_controlDown = false;
530 m_shiftDown = false;
531 m_leftDown = false;
532 m_rightDown = false;
533 m_middleDown = false;
534 m_x = 0;
535 m_y = 0;
536 m_wheelRotation = 0;
537 m_wheelDelta = 0;
538 m_linesPerAction = 0;
539 m_wheelAxis = 0;
540 }
541
542 void wxMouseEvent::Assign(const wxMouseEvent& event)
543 {
544 m_eventType = event.m_eventType;
545
546 m_x = event.m_x;
547 m_y = event.m_y;
548
549 m_leftDown = event.m_leftDown;
550 m_middleDown = event.m_middleDown;
551 m_rightDown = event.m_rightDown;
552
553 m_controlDown = event.m_controlDown;
554 m_shiftDown = event.m_shiftDown;
555 m_altDown = event.m_altDown;
556 m_metaDown = event.m_metaDown;
557
558 m_wheelRotation = event.m_wheelRotation;
559 m_wheelDelta = event.m_wheelDelta;
560 m_linesPerAction = event.m_linesPerAction;
561 m_wheelAxis = event.m_wheelAxis;
562 }
563
564 // return true if was a button dclick event
565 bool wxMouseEvent::ButtonDClick(int but) const
566 {
567 switch (but)
568 {
569 default:
570 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
571 // fall through
572
573 case wxMOUSE_BTN_ANY:
574 return (LeftDClick() || MiddleDClick() || RightDClick());
575
576 case wxMOUSE_BTN_LEFT:
577 return LeftDClick();
578
579 case wxMOUSE_BTN_MIDDLE:
580 return MiddleDClick();
581
582 case wxMOUSE_BTN_RIGHT:
583 return RightDClick();
584 }
585 }
586
587 // return true if was a button down event
588 bool wxMouseEvent::ButtonDown(int but) const
589 {
590 switch (but)
591 {
592 default:
593 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
594 // fall through
595
596 case wxMOUSE_BTN_ANY:
597 return (LeftDown() || MiddleDown() || RightDown());
598
599 case wxMOUSE_BTN_LEFT:
600 return LeftDown();
601
602 case wxMOUSE_BTN_MIDDLE:
603 return MiddleDown();
604
605 case wxMOUSE_BTN_RIGHT:
606 return RightDown();
607 }
608 }
609
610 // return true if was a button up event
611 bool wxMouseEvent::ButtonUp(int but) const
612 {
613 switch (but)
614 {
615 default:
616 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
617 // fall through
618
619 case wxMOUSE_BTN_ANY:
620 return (LeftUp() || MiddleUp() || RightUp());
621
622 case wxMOUSE_BTN_LEFT:
623 return LeftUp();
624
625 case wxMOUSE_BTN_MIDDLE:
626 return MiddleUp();
627
628 case wxMOUSE_BTN_RIGHT:
629 return RightUp();
630 }
631 }
632
633 // return true if the given button is currently changing state
634 bool wxMouseEvent::Button(int but) const
635 {
636 switch (but)
637 {
638 default:
639 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
640 // fall through
641
642 case wxMOUSE_BTN_ANY:
643 return ButtonUp(wxMOUSE_BTN_ANY) ||
644 ButtonDown(wxMOUSE_BTN_ANY) ||
645 ButtonDClick(wxMOUSE_BTN_ANY);
646
647 case wxMOUSE_BTN_LEFT:
648 return LeftDown() || LeftUp() || LeftDClick();
649
650 case wxMOUSE_BTN_MIDDLE:
651 return MiddleDown() || MiddleUp() || MiddleDClick();
652
653 case wxMOUSE_BTN_RIGHT:
654 return RightDown() || RightUp() || RightDClick();
655 }
656 }
657
658 bool wxMouseEvent::ButtonIsDown(int but) const
659 {
660 switch (but)
661 {
662 default:
663 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonIsDown"));
664 // fall through
665
666 case wxMOUSE_BTN_ANY:
667 return LeftIsDown() || MiddleIsDown() || RightIsDown();
668
669 case wxMOUSE_BTN_LEFT:
670 return LeftIsDown();
671
672 case wxMOUSE_BTN_MIDDLE:
673 return MiddleIsDown();
674
675 case wxMOUSE_BTN_RIGHT:
676 return RightIsDown();
677 }
678 }
679
680 int wxMouseEvent::GetButton() const
681 {
682 for ( int i = 1; i <= 3; i++ )
683 {
684 if ( Button(i) )
685 {
686 return i;
687 }
688 }
689
690 return wxMOUSE_BTN_NONE;
691 }
692
693 // Find the logical position of the event given the DC
694 wxPoint wxMouseEvent::GetLogicalPosition(const wxDC& dc) const
695 {
696 wxPoint pt(dc.DeviceToLogicalX(m_x), dc.DeviceToLogicalY(m_y));
697 return pt;
698 }
699
700
701 /*
702 * Keyboard event
703 *
704 */
705
706 wxKeyEvent::wxKeyEvent(wxEventType type)
707 {
708 m_eventType = type;
709 m_shiftDown = false;
710 m_controlDown = false;
711 m_metaDown = false;
712 m_altDown = false;
713 m_keyCode = 0;
714 m_scanCode = 0;
715 #if wxUSE_UNICODE
716 m_uniChar = 0;
717 #endif
718 }
719
720 wxKeyEvent::wxKeyEvent(const wxKeyEvent& evt)
721 : wxEvent(evt)
722 {
723 m_x = evt.m_x;
724 m_y = evt.m_y;
725
726 m_keyCode = evt.m_keyCode;
727
728 m_controlDown = evt.m_controlDown;
729 m_shiftDown = evt.m_shiftDown;
730 m_altDown = evt.m_altDown;
731 m_metaDown = evt.m_metaDown;
732 m_scanCode = evt.m_scanCode;
733 m_rawCode = evt.m_rawCode;
734 m_rawFlags = evt.m_rawFlags;
735
736 #if wxUSE_UNICODE
737 m_uniChar = evt.m_uniChar;
738 #endif
739 }
740
741 #if WXWIN_COMPATIBILITY_2_6
742 long wxKeyEvent::KeyCode() const
743 {
744 return m_keyCode;
745 }
746 #endif // WXWIN_COMPATIBILITY_2_6
747
748 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win)
749 {
750 SetEventType(wxEVT_CREATE);
751 SetEventObject(win);
752 }
753
754 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow *win)
755 {
756 SetEventType(wxEVT_DESTROY);
757 SetEventObject(win);
758 }
759
760 wxChildFocusEvent::wxChildFocusEvent(wxWindow *win)
761 : wxCommandEvent(wxEVT_CHILD_FOCUS)
762 {
763 SetEventObject(win);
764 }
765
766 // ----------------------------------------------------------------------------
767 // wxHelpEvent
768 // ----------------------------------------------------------------------------
769
770 /* static */
771 wxHelpEvent::Origin wxHelpEvent::GuessOrigin(Origin origin)
772 {
773 if ( origin == Origin_Unknown )
774 {
775 // assume that the event comes from the help button if it's not from
776 // keyboard and that pressing F1 always results in the help event
777 origin = wxGetKeyState(WXK_F1) ? Origin_Keyboard : Origin_HelpButton;
778 }
779
780 return origin;
781 }
782
783 #endif // wxUSE_GUI
784
785
786 #if wxUSE_BASE
787
788 // ----------------------------------------------------------------------------
789 // wxEventHashTable
790 // ----------------------------------------------------------------------------
791
792 static const int EVENT_TYPE_TABLE_INIT_SIZE = 31; // Not too big not too small...
793
794 wxEventHashTable* wxEventHashTable::sm_first = NULL;
795
796 wxEventHashTable::wxEventHashTable(const wxEventTable &table)
797 : m_table(table),
798 m_rebuildHash(true)
799 {
800 AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE);
801
802 m_next = sm_first;
803 if (m_next)
804 m_next->m_previous = this;
805 sm_first = this;
806 }
807
808 wxEventHashTable::~wxEventHashTable()
809 {
810 if (m_next)
811 m_next->m_previous = m_previous;
812 if (m_previous)
813 m_previous->m_next = m_next;
814 if (sm_first == this)
815 sm_first = m_next;
816
817 Clear();
818 }
819
820 void wxEventHashTable::Clear()
821 {
822 size_t i;
823 for(i = 0; i < m_size; i++)
824 {
825 EventTypeTablePointer eTTnode = m_eventTypeTable[i];
826 if (eTTnode)
827 {
828 delete eTTnode;
829 }
830 }
831
832 // Necessary in order to not invoke the
833 // overloaded delete operator when statics are cleaned up
834 if (m_eventTypeTable)
835 delete[] m_eventTypeTable;
836
837 m_eventTypeTable = NULL;
838 m_size = 0;
839 }
840
841 // Clear all tables
842 void wxEventHashTable::ClearAll()
843 {
844 wxEventHashTable* table = sm_first;
845 while (table)
846 {
847 table->Clear();
848 table = table->m_next;
849 }
850 }
851
852 bool wxEventHashTable::HandleEvent(wxEvent &event, wxEvtHandler *self)
853 {
854 if (m_rebuildHash)
855 {
856 InitHashTable();
857 m_rebuildHash = false;
858 }
859
860 if (!m_eventTypeTable)
861 return false;
862
863 // Find all entries for the given event type.
864 wxEventType eventType = event.GetEventType();
865 const EventTypeTablePointer eTTnode = m_eventTypeTable[eventType % m_size];
866 if (eTTnode && eTTnode->eventType == eventType)
867 {
868 // Now start the search for an event handler
869 // that can handle an event with the given ID.
870 const wxEventTableEntryPointerArray&
871 eventEntryTable = eTTnode->eventEntryTable;
872
873 const size_t count = eventEntryTable.GetCount();
874 for (size_t n = 0; n < count; n++)
875 {
876 if ( wxEvtHandler::
877 ProcessEventIfMatches(*eventEntryTable[n], self, event) )
878 {
879 return true;
880 }
881 }
882 }
883
884 return false;
885 }
886
887 void wxEventHashTable::InitHashTable()
888 {
889 // Loop over the event tables and all its base tables.
890 const wxEventTable *table = &m_table;
891 while (table)
892 {
893 // Retrieve all valid event handler entries
894 const wxEventTableEntry *entry = table->entries;
895 while (entry->m_fn != 0)
896 {
897 // Add the event entry in the Hash.
898 AddEntry(*entry);
899
900 entry++;
901 }
902
903 table = table->baseTable;
904 }
905
906 // Lets free some memory.
907 size_t i;
908 for(i = 0; i < m_size; i++)
909 {
910 EventTypeTablePointer eTTnode = m_eventTypeTable[i];
911 if (eTTnode)
912 {
913 eTTnode->eventEntryTable.Shrink();
914 }
915 }
916 }
917
918 void wxEventHashTable::AddEntry(const wxEventTableEntry &entry)
919 {
920 // This might happen 'accidentally' as the app is exiting
921 if (!m_eventTypeTable)
922 return;
923
924 EventTypeTablePointer *peTTnode = &m_eventTypeTable[entry.m_eventType % m_size];
925 EventTypeTablePointer eTTnode = *peTTnode;
926
927 if (eTTnode)
928 {
929 if (eTTnode->eventType != entry.m_eventType)
930 {
931 // Resize the table!
932 GrowEventTypeTable();
933 // Try again to add it.
934 AddEntry(entry);
935 return;
936 }
937 }
938 else
939 {
940 eTTnode = new EventTypeTable;
941 eTTnode->eventType = entry.m_eventType;
942 *peTTnode = eTTnode;
943 }
944
945 // Fill all hash entries between entry.m_id and entry.m_lastId...
946 eTTnode->eventEntryTable.Add(&entry);
947 }
948
949 void wxEventHashTable::AllocEventTypeTable(size_t size)
950 {
951 m_eventTypeTable = new EventTypeTablePointer[size];
952 memset((void *)m_eventTypeTable, 0, sizeof(EventTypeTablePointer)*size);
953 m_size = size;
954 }
955
956 void wxEventHashTable::GrowEventTypeTable()
957 {
958 size_t oldSize = m_size;
959 EventTypeTablePointer *oldEventTypeTable = m_eventTypeTable;
960
961 // TODO: Search the most optimal grow sequence
962 AllocEventTypeTable(/* GetNextPrime(oldSize) */oldSize*2+1);
963
964 for ( size_t i = 0; i < oldSize; /* */ )
965 {
966 EventTypeTablePointer eTToldNode = oldEventTypeTable[i];
967 if (eTToldNode)
968 {
969 EventTypeTablePointer *peTTnode = &m_eventTypeTable[eTToldNode->eventType % m_size];
970 EventTypeTablePointer eTTnode = *peTTnode;
971
972 // Check for collision, we don't want any.
973 if (eTTnode)
974 {
975 GrowEventTypeTable();
976 continue; // Don't increment the counter,
977 // as we still need to add this element.
978 }
979 else
980 {
981 // Get the old value and put it in the new table.
982 *peTTnode = oldEventTypeTable[i];
983 }
984 }
985
986 i++;
987 }
988
989 delete[] oldEventTypeTable;
990 }
991
992
993 // ----------------------------------------------------------------------------
994 // wxEvtHandler
995 // ----------------------------------------------------------------------------
996
997 /*
998 * Event handler
999 */
1000
1001 wxEvtHandler::wxEvtHandler()
1002 {
1003 m_nextHandler = (wxEvtHandler *) NULL;
1004 m_previousHandler = (wxEvtHandler *) NULL;
1005 m_enabled = true;
1006 m_dynamicEvents = (wxList *) NULL;
1007 m_pendingEvents = (wxList *) NULL;
1008 #if wxUSE_THREADS
1009 # if !defined(__VISAGECPP__)
1010 m_eventsLocker = new wxCriticalSection;
1011 # endif
1012 #endif
1013
1014 // no client data (yet)
1015 m_clientData = NULL;
1016 m_clientDataType = wxClientData_None;
1017 }
1018
1019 wxEvtHandler::~wxEvtHandler()
1020 {
1021 // Takes itself out of the list of handlers
1022 if (m_previousHandler)
1023 m_previousHandler->m_nextHandler = m_nextHandler;
1024
1025 if (m_nextHandler)
1026 m_nextHandler->m_previousHandler = m_previousHandler;
1027
1028 if (m_dynamicEvents)
1029 {
1030 wxList::iterator it = m_dynamicEvents->begin(),
1031 en = m_dynamicEvents->end();
1032 for (;it != en; ++it)
1033 {
1034 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1035 wxEventTableEntry *entry = (wxEventTableEntry*)*it;
1036 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1037 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)*it;
1038 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1039
1040 if (entry->m_callbackUserData)
1041 delete entry->m_callbackUserData;
1042 delete entry;
1043 }
1044 delete m_dynamicEvents;
1045 };
1046
1047 if (m_pendingEvents)
1048 m_pendingEvents->DeleteContents(true);
1049 delete m_pendingEvents;
1050
1051 #if wxUSE_THREADS
1052 # if !defined(__VISAGECPP__)
1053 delete m_eventsLocker;
1054 # endif
1055
1056 // Remove us from wxPendingEvents if necessary.
1057 if(wxPendingEventsLocker)
1058 wxENTER_CRIT_SECT(*wxPendingEventsLocker);
1059 if ( wxPendingEvents )
1060 {
1061 // Delete all occurences of this from the list of pending events
1062 while (wxPendingEvents->DeleteObject(this)) { } // Do nothing
1063 }
1064 if(wxPendingEventsLocker)
1065 wxLEAVE_CRIT_SECT(*wxPendingEventsLocker);
1066 #endif
1067
1068 // we only delete object data, not untyped
1069 if ( m_clientDataType == wxClientData_Object )
1070 delete m_clientObject;
1071 }
1072
1073 #if wxUSE_THREADS
1074
1075 bool wxEvtHandler::ProcessThreadEvent(wxEvent& event)
1076 {
1077 // check that we are really in a child thread
1078 wxASSERT_MSG( !wxThread::IsMain(),
1079 wxT("use ProcessEvent() in main thread") );
1080
1081 AddPendingEvent(event);
1082
1083 return true;
1084 }
1085
1086 void wxEvtHandler::ClearEventLocker()
1087 {
1088 #if !defined(__VISAGECPP__)
1089 delete m_eventsLocker;
1090 m_eventsLocker = NULL;
1091 #endif
1092 }
1093
1094 #endif // wxUSE_THREADS
1095
1096 void wxEvtHandler::AddPendingEvent(wxEvent& event)
1097 {
1098 // 1) Add event to list of pending events of this event handler
1099
1100 wxEvent *eventCopy = event.Clone();
1101
1102 // we must be able to copy the events here so the event class must
1103 // implement Clone() properly instead of just providing a NULL stab for it
1104 wxCHECK_RET( eventCopy,
1105 _T("events of this type aren't supposed to be posted") );
1106
1107 wxENTER_CRIT_SECT( Lock() );
1108
1109 if ( !m_pendingEvents )
1110 m_pendingEvents = new wxList;
1111
1112 m_pendingEvents->Append(eventCopy);
1113
1114 wxLEAVE_CRIT_SECT( Lock() );
1115
1116 // 2) Add this event handler to list of event handlers that
1117 // have pending events.
1118
1119 wxENTER_CRIT_SECT(*wxPendingEventsLocker);
1120
1121 if ( !wxPendingEvents )
1122 wxPendingEvents = new wxList;
1123 wxPendingEvents->Append(this);
1124
1125 wxLEAVE_CRIT_SECT(*wxPendingEventsLocker);
1126
1127 // 3) Inform the system that new pending events are somewhere,
1128 // and that these should be processed in idle time.
1129 wxWakeUpIdle();
1130 }
1131
1132 void wxEvtHandler::ProcessPendingEvents()
1133 {
1134 // this method is only called by wxApp if this handler does have
1135 // pending events
1136 wxCHECK_RET( m_pendingEvents,
1137 wxT("Please call wxApp::ProcessPendingEvents() instead") );
1138
1139 wxENTER_CRIT_SECT( Lock() );
1140
1141 // we leave the loop once we have processed all events that were present at
1142 // the start of ProcessPendingEvents because otherwise we could get into
1143 // infinite loop if the pending event handler execution resulted in another
1144 // event being posted
1145 size_t n = m_pendingEvents->size();
1146 for ( wxList::compatibility_iterator node = m_pendingEvents->GetFirst();
1147 node;
1148 node = m_pendingEvents->GetFirst() )
1149 {
1150 wxEvent *event = (wxEvent *)node->GetData();
1151
1152 // It's importan we remove event from list before processing it.
1153 // Else a nested event loop, for example from a modal dialog, might
1154 // process the same event again.
1155
1156 m_pendingEvents->Erase(node);
1157
1158 wxLEAVE_CRIT_SECT( Lock() );
1159
1160 ProcessEvent(*event);
1161
1162 delete event;
1163
1164 wxENTER_CRIT_SECT( Lock() );
1165
1166 if ( --n == 0 )
1167 break;
1168 }
1169
1170 wxLEAVE_CRIT_SECT( Lock() );
1171 }
1172
1173 /*
1174 * Event table stuff
1175 */
1176 /* static */ bool
1177 wxEvtHandler::ProcessEventIfMatches(const wxEventTableEntryBase& entry,
1178 wxEvtHandler *handler,
1179 wxEvent& event)
1180 {
1181 int tableId1 = entry.m_id,
1182 tableId2 = entry.m_lastId;
1183
1184 // match only if the event type is the same and the id is either -1 in
1185 // the event table (meaning "any") or the event id matches the id
1186 // specified in the event table either exactly or by falling into
1187 // range between first and last
1188 if ((tableId1 == wxID_ANY) ||
1189 (tableId2 == wxID_ANY && tableId1 == event.GetId()) ||
1190 (tableId2 != wxID_ANY &&
1191 (event.GetId() >= tableId1 && event.GetId() <= tableId2)))
1192 {
1193 event.Skip(false);
1194 event.m_callbackUserData = entry.m_callbackUserData;
1195
1196 #if wxUSE_EXCEPTIONS
1197 if ( wxTheApp )
1198 {
1199 // call the handler via wxApp method which allows the user to catch
1200 // any exceptions which may be thrown by any handler in the program
1201 // in one place
1202 wxTheApp->HandleEvent(handler, (wxEventFunction)entry.m_fn, event);
1203 }
1204 else
1205 #endif // wxUSE_EXCEPTIONS
1206 {
1207 // no need for an extra virtual function call
1208 (handler->*((wxEventFunction) (entry.m_fn)))(event);
1209 }
1210
1211 if (!event.GetSkipped())
1212 return true;
1213 }
1214
1215 return false;
1216 }
1217
1218 bool wxEvtHandler::TryParent(wxEvent& event)
1219 {
1220 if ( wxTheApp && (this != wxTheApp) )
1221 {
1222 // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
1223 // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
1224 // processed appropriately via SearchEventTable.
1225 if ( event.GetEventType() != wxEVT_IDLE )
1226 {
1227 if ( wxTheApp->ProcessEvent(event) )
1228 return true;
1229 }
1230 }
1231
1232 return false;
1233 }
1234
1235 bool wxEvtHandler::ProcessEvent(wxEvent& event)
1236 {
1237 // allow the application to hook into event processing
1238 if ( wxTheApp )
1239 {
1240 int rc = wxTheApp->FilterEvent(event);
1241 if ( rc != -1 )
1242 {
1243 wxASSERT_MSG( rc == 1 || rc == 0,
1244 _T("unexpected wxApp::FilterEvent return value") );
1245
1246 return rc != 0;
1247 }
1248 //else: proceed normally
1249 }
1250
1251 // An event handler can be enabled or disabled
1252 if ( GetEvtHandlerEnabled() )
1253 {
1254 // if we have a validator, it has higher priority than our own event
1255 // table
1256 if ( TryValidator(event) )
1257 return true;
1258
1259 // Handle per-instance dynamic event tables first
1260 if ( m_dynamicEvents && SearchDynamicEventTable(event) )
1261 return true;
1262
1263 // Then static per-class event tables
1264 if ( GetEventHashTable().HandleEvent(event, this) )
1265 return true;
1266 }
1267
1268 // Try going down the event handler chain
1269 if ( GetNextHandler() )
1270 {
1271 if ( GetNextHandler()->ProcessEvent(event) )
1272 return true;
1273 }
1274
1275 // Finally propagate the event upwards the window chain and/or to the
1276 // application object as necessary
1277 return TryParent(event);
1278 }
1279
1280
1281 bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event)
1282 {
1283 const wxEventType eventType = event.GetEventType();
1284 for ( int i = 0; table.entries[i].m_fn != 0; i++ )
1285 {
1286 const wxEventTableEntry& entry = table.entries[i];
1287 if ( eventType == entry.m_eventType )
1288 {
1289 if ( ProcessEventIfMatches(entry, this, event) )
1290 return true;
1291 }
1292 }
1293
1294 return false;
1295 }
1296
1297 void wxEvtHandler::Connect( int id, int lastId,
1298 int eventType,
1299 wxObjectEventFunction func,
1300 wxObject *userData,
1301 wxEvtHandler* eventSink )
1302 {
1303 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1304 wxEventTableEntry *entry = new wxEventTableEntry;
1305 entry->m_eventType = eventType;
1306 entry->m_id = id;
1307 entry->m_lastId = lastId;
1308 entry->m_fn = func;
1309 entry->m_callbackUserData = userData;
1310 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1311 wxDynamicEventTableEntry *entry =
1312 new wxDynamicEventTableEntry(eventType, id, lastId, func, userData, eventSink);
1313 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1314
1315 if (!m_dynamicEvents)
1316 m_dynamicEvents = new wxList;
1317
1318 // Insert at the front of the list so most recent additions are found first
1319 m_dynamicEvents->Insert( (wxObject*) entry );
1320 }
1321
1322 bool wxEvtHandler::Disconnect( int id, int lastId, wxEventType eventType,
1323 wxObjectEventFunction func,
1324 wxObject *userData,
1325 wxEvtHandler* eventSink )
1326 {
1327 if (!m_dynamicEvents)
1328 return false;
1329
1330 wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();
1331 while (node)
1332 {
1333 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1334 wxEventTableEntry *entry = (wxEventTableEntry*)node->GetData();
1335 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1336 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1337 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1338
1339 if ((entry->m_id == id) &&
1340 ((entry->m_lastId == lastId) || (lastId == wxID_ANY)) &&
1341 ((entry->m_eventType == eventType) || (eventType == wxEVT_NULL)) &&
1342 ((entry->m_fn == func) || (func == (wxObjectEventFunction)NULL)) &&
1343 ((entry->m_eventSink == eventSink) || (eventSink == (wxEvtHandler*)NULL)) &&
1344 ((entry->m_callbackUserData == userData) || (userData == (wxObject*)NULL)))
1345 {
1346 if (entry->m_callbackUserData)
1347 delete entry->m_callbackUserData;
1348 m_dynamicEvents->Erase( node );
1349 delete entry;
1350 return true;
1351 }
1352 node = node->GetNext();
1353 }
1354 return false;
1355 }
1356
1357 bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event )
1358 {
1359 wxCHECK_MSG( m_dynamicEvents, false,
1360 wxT("caller should check that we have dynamic events") );
1361
1362 wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();
1363 while (node)
1364 {
1365 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1366 wxEventTableEntry *entry = (wxEventTableEntry*)node->GetData();
1367 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1368 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1369 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1370
1371 // get next node before (maybe) calling the event handler as it could
1372 // call Disconnect() invalidating the current node
1373 node = node->GetNext();
1374
1375 if ((event.GetEventType() == entry->m_eventType) && (entry->m_fn != 0))
1376 {
1377 wxEvtHandler *handler =
1378 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
1379 entry->m_eventSink ? entry->m_eventSink
1380 :
1381 #endif
1382 this;
1383
1384 if ( ProcessEventIfMatches(*entry, handler, event) )
1385 {
1386 return true;
1387 }
1388 }
1389 }
1390
1391 return false;
1392 }
1393
1394 void wxEvtHandler::DoSetClientObject( wxClientData *data )
1395 {
1396 wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1397 wxT("can't have both object and void client data") );
1398
1399 if ( m_clientObject )
1400 delete m_clientObject;
1401
1402 m_clientObject = data;
1403 m_clientDataType = wxClientData_Object;
1404 }
1405
1406 wxClientData *wxEvtHandler::DoGetClientObject() const
1407 {
1408 // it's not an error to call GetClientObject() on a window which doesn't
1409 // have client data at all - NULL will be returned
1410 wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1411 wxT("this window doesn't have object client data") );
1412
1413 return m_clientObject;
1414 }
1415
1416 void wxEvtHandler::DoSetClientData( void *data )
1417 {
1418 wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1419 wxT("can't have both object and void client data") );
1420
1421 m_clientData = data;
1422 m_clientDataType = wxClientData_Void;
1423 }
1424
1425 void *wxEvtHandler::DoGetClientData() const
1426 {
1427 // it's not an error to call GetClientData() on a window which doesn't have
1428 // client data at all - NULL will be returned
1429 wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1430 wxT("this window doesn't have void client data") );
1431
1432 return m_clientData;
1433 }
1434
1435 #endif // wxUSE_BASE
1436
1437 #if wxUSE_GUI
1438
1439 // Find a window with the focus, that is also a descendant of the given window.
1440 // This is used to determine the window to initially send commands to.
1441 wxWindow* wxFindFocusDescendant(wxWindow* ancestor)
1442 {
1443 // Process events starting with the window with the focus, if any.
1444 wxWindow* focusWin = wxWindow::FindFocus();
1445 wxWindow* win = focusWin;
1446
1447 // Check if this is a descendant of this frame.
1448 // If not, win will be set to NULL.
1449 while (win)
1450 {
1451 if (win == ancestor)
1452 break;
1453 else
1454 win = win->GetParent();
1455 }
1456 if (win == (wxWindow*) NULL)
1457 focusWin = (wxWindow*) NULL;
1458
1459 return focusWin;
1460 }
1461
1462 // ----------------------------------------------------------------------------
1463 // wxEventBlocker
1464 // ----------------------------------------------------------------------------
1465
1466 wxEventBlocker::wxEventBlocker(wxWindow *win, wxEventType type)
1467 {
1468 wxCHECK_RET(win, wxT("Null window given to wxEventBlocker"));
1469
1470 m_window = win;
1471
1472 Block(type);
1473 m_window->PushEventHandler(this);
1474 }
1475
1476 wxEventBlocker::~wxEventBlocker()
1477 {
1478 wxEvtHandler *popped = m_window->PopEventHandler(false);
1479 wxCHECK_RET(popped == this,
1480 wxT("Don't push other event handlers into a window managed by wxEventBlocker!"));
1481 }
1482
1483 bool wxEventBlocker::ProcessEvent(wxEvent& event)
1484 {
1485 // should this event be blocked?
1486 for ( size_t i = 0; i < m_eventsToBlock.size(); i++ )
1487 {
1488 wxEventType t = (wxEventType)m_eventsToBlock[i];
1489 if ( t == wxEVT_ANY || t == event.GetEventType() )
1490 return true; // yes, it should: mark this event as processed
1491 }
1492
1493 return false;
1494 }
1495
1496 #endif // wxUSE_GUI