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