1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/event.cpp
3 // Purpose: Event classes
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
28 #include "wx/eventfilter.h"
29 #include "wx/evtloop.h"
36 #include "wx/stopwatch.h"
37 #include "wx/module.h"
40 #include "wx/window.h"
41 #include "wx/control.h"
43 #include "wx/spinbutt.h"
44 #include "wx/textctrl.h"
45 #include "wx/validate.h"
49 #include "wx/thread.h"
52 #include "wx/scopedptr.h"
54 wxDECLARE_SCOPED_PTR(wxEvent
, wxEventPtr
)
55 wxDEFINE_SCOPED_PTR(wxEvent
, wxEventPtr
)
58 // ----------------------------------------------------------------------------
60 // ----------------------------------------------------------------------------
63 IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler
, wxObject
)
64 IMPLEMENT_ABSTRACT_CLASS(wxEvent
, wxObject
)
65 IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent
, wxEvent
)
66 IMPLEMENT_DYNAMIC_CLASS(wxThreadEvent
, wxEvent
)
70 IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent
, wxEvent
)
71 IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent
, wxCommandEvent
)
72 IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent
, wxCommandEvent
)
73 IMPLEMENT_DYNAMIC_CLASS(wxScrollWinEvent
, wxEvent
)
74 IMPLEMENT_DYNAMIC_CLASS(wxMouseEvent
, wxEvent
)
75 IMPLEMENT_DYNAMIC_CLASS(wxKeyEvent
, wxEvent
)
76 IMPLEMENT_DYNAMIC_CLASS(wxSizeEvent
, wxEvent
)
77 IMPLEMENT_DYNAMIC_CLASS(wxPaintEvent
, wxEvent
)
78 IMPLEMENT_DYNAMIC_CLASS(wxNcPaintEvent
, wxEvent
)
79 IMPLEMENT_DYNAMIC_CLASS(wxEraseEvent
, wxEvent
)
80 IMPLEMENT_DYNAMIC_CLASS(wxMoveEvent
, wxEvent
)
81 IMPLEMENT_DYNAMIC_CLASS(wxFocusEvent
, wxEvent
)
82 IMPLEMENT_DYNAMIC_CLASS(wxChildFocusEvent
, wxCommandEvent
)
83 IMPLEMENT_DYNAMIC_CLASS(wxCloseEvent
, wxEvent
)
84 IMPLEMENT_DYNAMIC_CLASS(wxShowEvent
, wxEvent
)
85 IMPLEMENT_DYNAMIC_CLASS(wxMaximizeEvent
, wxEvent
)
86 IMPLEMENT_DYNAMIC_CLASS(wxIconizeEvent
, wxEvent
)
87 IMPLEMENT_DYNAMIC_CLASS(wxMenuEvent
, wxEvent
)
88 IMPLEMENT_DYNAMIC_CLASS(wxJoystickEvent
, wxEvent
)
89 IMPLEMENT_DYNAMIC_CLASS(wxDropFilesEvent
, wxEvent
)
90 IMPLEMENT_DYNAMIC_CLASS(wxActivateEvent
, wxEvent
)
91 IMPLEMENT_DYNAMIC_CLASS(wxInitDialogEvent
, wxEvent
)
92 IMPLEMENT_DYNAMIC_CLASS(wxSetCursorEvent
, wxEvent
)
93 IMPLEMENT_DYNAMIC_CLASS(wxSysColourChangedEvent
, wxEvent
)
94 IMPLEMENT_DYNAMIC_CLASS(wxDisplayChangedEvent
, wxEvent
)
95 IMPLEMENT_DYNAMIC_CLASS(wxUpdateUIEvent
, wxCommandEvent
)
96 IMPLEMENT_DYNAMIC_CLASS(wxNavigationKeyEvent
, wxEvent
)
97 IMPLEMENT_DYNAMIC_CLASS(wxPaletteChangedEvent
, wxEvent
)
98 IMPLEMENT_DYNAMIC_CLASS(wxQueryNewPaletteEvent
, wxEvent
)
99 IMPLEMENT_DYNAMIC_CLASS(wxWindowCreateEvent
, wxEvent
)
100 IMPLEMENT_DYNAMIC_CLASS(wxWindowDestroyEvent
, wxEvent
)
101 IMPLEMENT_DYNAMIC_CLASS(wxHelpEvent
, wxCommandEvent
)
102 IMPLEMENT_DYNAMIC_CLASS(wxContextMenuEvent
, wxCommandEvent
)
103 IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureChangedEvent
, wxEvent
)
104 IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureLostEvent
, wxEvent
)
105 IMPLEMENT_DYNAMIC_CLASS(wxClipboardTextEvent
, wxCommandEvent
)
110 const wxEventTable
*wxEvtHandler::GetEventTable() const
111 { return &wxEvtHandler::sm_eventTable
; }
113 const wxEventTable
wxEvtHandler::sm_eventTable
=
114 { (const wxEventTable
*)NULL
, &wxEvtHandler::sm_eventTableEntries
[0] };
116 wxEventHashTable
&wxEvtHandler::GetEventHashTable() const
117 { return wxEvtHandler::sm_eventHashTable
; }
119 wxEventHashTable
wxEvtHandler::sm_eventHashTable(wxEvtHandler::sm_eventTable
);
121 const wxEventTableEntry
wxEvtHandler::sm_eventTableEntries
[] =
122 { wxDECLARE_EVENT_TABLE_TERMINATOR() };
125 // wxUSE_MEMORY_TRACING considers memory freed from the static objects dtors
126 // leaked, so we need to manually clean up all event tables before checking for
127 // the memory leaks when using it, however this breaks re-initializing the
128 // library (i.e. repeated calls to wxInitialize/wxUninitialize) because the
129 // event tables won't be rebuilt the next time, so disable this by default
130 #if wxUSE_MEMORY_TRACING
132 class wxEventTableEntryModule
: public wxModule
135 wxEventTableEntryModule() { }
136 virtual bool OnInit() { return true; }
137 virtual void OnExit() { wxEventHashTable::ClearAll(); }
139 DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule
)
142 IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule
, wxModule
)
144 #endif // wxUSE_MEMORY_TRACING
146 // ----------------------------------------------------------------------------
148 // ----------------------------------------------------------------------------
150 // common event types are defined here, other event types are defined by the
151 // components which use them
153 const wxEventType wxEVT_FIRST
= 10000;
154 const wxEventType wxEVT_USER_FIRST
= wxEVT_FIRST
+ 2000;
155 const wxEventType wxEVT_NULL
= wxNewEventType();
157 wxDEFINE_EVENT( wxEVT_IDLE
, wxIdleEvent
);
159 // Thread and asynchronous call events
160 wxDEFINE_EVENT( wxEVT_THREAD
, wxThreadEvent
);
161 wxDEFINE_EVENT( wxEVT_ASYNC_METHOD_CALL
, wxAsyncMethodCallEvent
);
167 wxDEFINE_EVENT( wxEVT_COMMAND_BUTTON_CLICKED
, wxCommandEvent
);
168 wxDEFINE_EVENT( wxEVT_COMMAND_CHECKBOX_CLICKED
, wxCommandEvent
);
169 wxDEFINE_EVENT( wxEVT_COMMAND_CHOICE_SELECTED
, wxCommandEvent
);
170 wxDEFINE_EVENT( wxEVT_COMMAND_LISTBOX_SELECTED
, wxCommandEvent
);
171 wxDEFINE_EVENT( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, wxCommandEvent
);
172 wxDEFINE_EVENT( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, wxCommandEvent
);
173 wxDEFINE_EVENT( wxEVT_COMMAND_MENU_SELECTED
, wxCommandEvent
);
174 wxDEFINE_EVENT( wxEVT_COMMAND_SLIDER_UPDATED
, wxCommandEvent
);
175 wxDEFINE_EVENT( wxEVT_COMMAND_RADIOBOX_SELECTED
, wxCommandEvent
);
176 wxDEFINE_EVENT( wxEVT_COMMAND_RADIOBUTTON_SELECTED
, wxCommandEvent
);
177 wxDEFINE_EVENT( wxEVT_COMMAND_SCROLLBAR_UPDATED
, wxCommandEvent
);
178 wxDEFINE_EVENT( wxEVT_COMMAND_VLBOX_SELECTED
, wxCommandEvent
);
179 wxDEFINE_EVENT( wxEVT_COMMAND_COMBOBOX_SELECTED
, wxCommandEvent
);
180 wxDEFINE_EVENT( wxEVT_COMMAND_TOOL_RCLICKED
, wxCommandEvent
);
181 wxDEFINE_EVENT( wxEVT_COMMAND_TOOL_ENTER
, wxCommandEvent
);
182 wxDEFINE_EVENT( wxEVT_COMMAND_SPINCTRL_UPDATED
, wxCommandEvent
);
183 wxDEFINE_EVENT( wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED
, wxCommandEvent
);
184 wxDEFINE_EVENT( wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED
, wxCommandEvent
);
185 wxDEFINE_EVENT( wxEVT_COMMAND_COMBOBOX_DROPDOWN
, wxCommandEvent
);
186 wxDEFINE_EVENT( wxEVT_COMMAND_COMBOBOX_CLOSEUP
, wxCommandEvent
);
189 wxDEFINE_EVENT( wxEVT_LEFT_DOWN
, wxMouseEvent
);
190 wxDEFINE_EVENT( wxEVT_LEFT_UP
, wxMouseEvent
);
191 wxDEFINE_EVENT( wxEVT_MIDDLE_DOWN
, wxMouseEvent
);
192 wxDEFINE_EVENT( wxEVT_MIDDLE_UP
, wxMouseEvent
);
193 wxDEFINE_EVENT( wxEVT_RIGHT_DOWN
, wxMouseEvent
);
194 wxDEFINE_EVENT( wxEVT_RIGHT_UP
, wxMouseEvent
);
195 wxDEFINE_EVENT( wxEVT_MOTION
, wxMouseEvent
);
196 wxDEFINE_EVENT( wxEVT_ENTER_WINDOW
, wxMouseEvent
);
197 wxDEFINE_EVENT( wxEVT_LEAVE_WINDOW
, wxMouseEvent
);
198 wxDEFINE_EVENT( wxEVT_LEFT_DCLICK
, wxMouseEvent
);
199 wxDEFINE_EVENT( wxEVT_MIDDLE_DCLICK
, wxMouseEvent
);
200 wxDEFINE_EVENT( wxEVT_RIGHT_DCLICK
, wxMouseEvent
);
201 wxDEFINE_EVENT( wxEVT_SET_FOCUS
, wxFocusEvent
);
202 wxDEFINE_EVENT( wxEVT_KILL_FOCUS
, wxFocusEvent
);
203 wxDEFINE_EVENT( wxEVT_CHILD_FOCUS
, wxChildFocusEvent
);
204 wxDEFINE_EVENT( wxEVT_MOUSEWHEEL
, wxMouseEvent
);
205 wxDEFINE_EVENT( wxEVT_AUX1_DOWN
, wxMouseEvent
);
206 wxDEFINE_EVENT( wxEVT_AUX1_UP
, wxMouseEvent
);
207 wxDEFINE_EVENT( wxEVT_AUX1_DCLICK
, wxMouseEvent
);
208 wxDEFINE_EVENT( wxEVT_AUX2_DOWN
, wxMouseEvent
);
209 wxDEFINE_EVENT( wxEVT_AUX2_UP
, wxMouseEvent
);
210 wxDEFINE_EVENT( wxEVT_AUX2_DCLICK
, wxMouseEvent
);
212 // Character input event type
213 wxDEFINE_EVENT( wxEVT_CHAR
, wxKeyEvent
);
214 wxDEFINE_EVENT( wxEVT_AFTER_CHAR
, wxKeyEvent
);
215 wxDEFINE_EVENT( wxEVT_CHAR_HOOK
, wxKeyEvent
);
216 wxDEFINE_EVENT( wxEVT_NAVIGATION_KEY
, wxNavigationKeyEvent
);
217 wxDEFINE_EVENT( wxEVT_KEY_DOWN
, wxKeyEvent
);
218 wxDEFINE_EVENT( wxEVT_KEY_UP
, wxKeyEvent
);
220 wxDEFINE_EVENT( wxEVT_HOTKEY
, wxKeyEvent
);
224 wxDEFINE_EVENT( wxEVT_SET_CURSOR
, wxSetCursorEvent
);
226 // wxScrollbar and wxSlider event identifiers
227 wxDEFINE_EVENT( wxEVT_SCROLL_TOP
, wxScrollEvent
);
228 wxDEFINE_EVENT( wxEVT_SCROLL_BOTTOM
, wxScrollEvent
);
229 wxDEFINE_EVENT( wxEVT_SCROLL_LINEUP
, wxScrollEvent
);
230 wxDEFINE_EVENT( wxEVT_SCROLL_LINEDOWN
, wxScrollEvent
);
231 wxDEFINE_EVENT( wxEVT_SCROLL_PAGEUP
, wxScrollEvent
);
232 wxDEFINE_EVENT( wxEVT_SCROLL_PAGEDOWN
, wxScrollEvent
);
233 wxDEFINE_EVENT( wxEVT_SCROLL_THUMBTRACK
, wxScrollEvent
);
234 wxDEFINE_EVENT( wxEVT_SCROLL_THUMBRELEASE
, wxScrollEvent
);
235 wxDEFINE_EVENT( wxEVT_SCROLL_CHANGED
, wxScrollEvent
);
237 // Due to a bug in older wx versions, wxSpinEvents were being sent with type of
238 // wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But
239 // with the type-safe events in place, these event types are associated with
240 // wxScrollEvent. To allow handling of spin events, new event types have been
241 // defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility
242 // the spin event types are being initialized with the scroll event types.
246 wxDEFINE_EVENT_ALIAS( wxEVT_SPIN_UP
, wxSpinEvent
, wxEVT_SCROLL_LINEUP
);
247 wxDEFINE_EVENT_ALIAS( wxEVT_SPIN_DOWN
, wxSpinEvent
, wxEVT_SCROLL_LINEDOWN
);
248 wxDEFINE_EVENT_ALIAS( wxEVT_SPIN
, wxSpinEvent
, wxEVT_SCROLL_THUMBTRACK
);
250 #endif // wxUSE_SPINBTN
252 // Scroll events from wxWindow
253 wxDEFINE_EVENT( wxEVT_SCROLLWIN_TOP
, wxScrollWinEvent
);
254 wxDEFINE_EVENT( wxEVT_SCROLLWIN_BOTTOM
, wxScrollWinEvent
);
255 wxDEFINE_EVENT( wxEVT_SCROLLWIN_LINEUP
, wxScrollWinEvent
);
256 wxDEFINE_EVENT( wxEVT_SCROLLWIN_LINEDOWN
, wxScrollWinEvent
);
257 wxDEFINE_EVENT( wxEVT_SCROLLWIN_PAGEUP
, wxScrollWinEvent
);
258 wxDEFINE_EVENT( wxEVT_SCROLLWIN_PAGEDOWN
, wxScrollWinEvent
);
259 wxDEFINE_EVENT( wxEVT_SCROLLWIN_THUMBTRACK
, wxScrollWinEvent
);
260 wxDEFINE_EVENT( wxEVT_SCROLLWIN_THUMBRELEASE
, wxScrollWinEvent
);
263 wxDEFINE_EVENT( wxEVT_SIZE
, wxSizeEvent
);
264 wxDEFINE_EVENT( wxEVT_SIZING
, wxSizeEvent
);
265 wxDEFINE_EVENT( wxEVT_MOVE
, wxMoveEvent
);
266 wxDEFINE_EVENT( wxEVT_MOVING
, wxMoveEvent
);
267 wxDEFINE_EVENT( wxEVT_MOVE_START
, wxMoveEvent
);
268 wxDEFINE_EVENT( wxEVT_MOVE_END
, wxMoveEvent
);
269 wxDEFINE_EVENT( wxEVT_CLOSE_WINDOW
, wxCloseEvent
);
270 wxDEFINE_EVENT( wxEVT_END_SESSION
, wxCloseEvent
);
271 wxDEFINE_EVENT( wxEVT_QUERY_END_SESSION
, wxCloseEvent
);
272 wxDEFINE_EVENT( wxEVT_HIBERNATE
, wxActivateEvent
);
273 wxDEFINE_EVENT( wxEVT_ACTIVATE_APP
, wxActivateEvent
);
274 wxDEFINE_EVENT( wxEVT_ACTIVATE
, wxActivateEvent
);
275 wxDEFINE_EVENT( wxEVT_CREATE
, wxWindowCreateEvent
);
276 wxDEFINE_EVENT( wxEVT_DESTROY
, wxWindowDestroyEvent
);
277 wxDEFINE_EVENT( wxEVT_SHOW
, wxShowEvent
);
278 wxDEFINE_EVENT( wxEVT_ICONIZE
, wxIconizeEvent
);
279 wxDEFINE_EVENT( wxEVT_MAXIMIZE
, wxMaximizeEvent
);
280 wxDEFINE_EVENT( wxEVT_MOUSE_CAPTURE_CHANGED
, wxMouseCaptureChangedEvent
);
281 wxDEFINE_EVENT( wxEVT_MOUSE_CAPTURE_LOST
, wxMouseCaptureLostEvent
);
282 wxDEFINE_EVENT( wxEVT_PAINT
, wxPaintEvent
);
283 wxDEFINE_EVENT( wxEVT_ERASE_BACKGROUND
, wxEraseEvent
);
284 wxDEFINE_EVENT( wxEVT_NC_PAINT
, wxNcPaintEvent
);
285 wxDEFINE_EVENT( wxEVT_MENU_OPEN
, wxMenuEvent
);
286 wxDEFINE_EVENT( wxEVT_MENU_CLOSE
, wxMenuEvent
);
287 wxDEFINE_EVENT( wxEVT_MENU_HIGHLIGHT
, wxMenuEvent
);
288 wxDEFINE_EVENT( wxEVT_CONTEXT_MENU
, wxContextMenuEvent
);
289 wxDEFINE_EVENT( wxEVT_SYS_COLOUR_CHANGED
, wxSysColourChangedEvent
);
290 wxDEFINE_EVENT( wxEVT_DISPLAY_CHANGED
, wxDisplayChangedEvent
);
291 wxDEFINE_EVENT( wxEVT_QUERY_NEW_PALETTE
, wxQueryNewPaletteEvent
);
292 wxDEFINE_EVENT( wxEVT_PALETTE_CHANGED
, wxPaletteChangedEvent
);
293 wxDEFINE_EVENT( wxEVT_JOY_BUTTON_DOWN
, wxJoystickEvent
);
294 wxDEFINE_EVENT( wxEVT_JOY_BUTTON_UP
, wxJoystickEvent
);
295 wxDEFINE_EVENT( wxEVT_JOY_MOVE
, wxJoystickEvent
);
296 wxDEFINE_EVENT( wxEVT_JOY_ZMOVE
, wxJoystickEvent
);
297 wxDEFINE_EVENT( wxEVT_DROP_FILES
, wxDropFilesEvent
);
298 wxDEFINE_EVENT( wxEVT_INIT_DIALOG
, wxInitDialogEvent
);
299 wxDEFINE_EVENT( wxEVT_UPDATE_UI
, wxUpdateUIEvent
);
302 wxDEFINE_EVENT( wxEVT_COMMAND_TEXT_COPY
, wxClipboardTextEvent
);
303 wxDEFINE_EVENT( wxEVT_COMMAND_TEXT_CUT
, wxClipboardTextEvent
);
304 wxDEFINE_EVENT( wxEVT_COMMAND_TEXT_PASTE
, wxClipboardTextEvent
);
306 // Generic command events
307 // Note: a click is a higher-level event than button down/up
308 wxDEFINE_EVENT( wxEVT_COMMAND_LEFT_CLICK
, wxCommandEvent
);
309 wxDEFINE_EVENT( wxEVT_COMMAND_LEFT_DCLICK
, wxCommandEvent
);
310 wxDEFINE_EVENT( wxEVT_COMMAND_RIGHT_CLICK
, wxCommandEvent
);
311 wxDEFINE_EVENT( wxEVT_COMMAND_RIGHT_DCLICK
, wxCommandEvent
);
312 wxDEFINE_EVENT( wxEVT_COMMAND_SET_FOCUS
, wxCommandEvent
);
313 wxDEFINE_EVENT( wxEVT_COMMAND_KILL_FOCUS
, wxCommandEvent
);
314 wxDEFINE_EVENT( wxEVT_COMMAND_ENTER
, wxCommandEvent
);
317 wxDEFINE_EVENT( wxEVT_HELP
, wxHelpEvent
);
318 wxDEFINE_EVENT( wxEVT_DETAILED_HELP
, wxHelpEvent
);
324 wxIdleMode
wxIdleEvent::sm_idleMode
= wxIDLE_PROCESS_ALL
;
326 // ============================================================================
328 // ============================================================================
330 // ----------------------------------------------------------------------------
331 // event initialization
332 // ----------------------------------------------------------------------------
337 static int s_lastUsedEventType
= wxEVT_FIRST
;
339 return s_lastUsedEventType
++;
341 // ----------------------------------------------------------------------------
343 // ----------------------------------------------------------------------------
345 wxEventFunctor::~wxEventFunctor()
349 // ----------------------------------------------------------------------------
351 // ----------------------------------------------------------------------------
354 * General wxWidgets events, covering all interesting things that might happen
355 * (button clicking, resizing, setting text in widgets, etc.).
357 * For each completely new event type, derive a new event class.
361 wxEvent::wxEvent(int theId
, wxEventType commandType
)
363 m_eventType
= commandType
;
364 m_eventObject
= NULL
;
368 m_callbackUserData
= NULL
;
369 m_handlerToProcessOnlyIn
= NULL
;
370 m_isCommandEvent
= false;
371 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
372 m_wasProcessed
= false;
375 wxEvent::wxEvent(const wxEvent
& src
)
377 , m_eventObject(src
.m_eventObject
)
378 , m_eventType(src
.m_eventType
)
379 , m_timeStamp(src
.m_timeStamp
)
381 , m_callbackUserData(src
.m_callbackUserData
)
382 , m_handlerToProcessOnlyIn(NULL
)
383 , m_propagationLevel(src
.m_propagationLevel
)
384 , m_skipped(src
.m_skipped
)
385 , m_isCommandEvent(src
.m_isCommandEvent
)
386 , m_wasProcessed(false)
390 wxEvent
& wxEvent::operator=(const wxEvent
& src
)
392 wxObject::operator=(src
);
394 m_eventObject
= src
.m_eventObject
;
395 m_eventType
= src
.m_eventType
;
396 m_timeStamp
= src
.m_timeStamp
;
398 m_callbackUserData
= src
.m_callbackUserData
;
399 m_handlerToProcessOnlyIn
= NULL
;
400 m_propagationLevel
= src
.m_propagationLevel
;
401 m_skipped
= src
.m_skipped
;
402 m_isCommandEvent
= src
.m_isCommandEvent
;
404 // don't change m_wasProcessed
413 // ----------------------------------------------------------------------------
415 // ----------------------------------------------------------------------------
417 wxCommandEvent::wxCommandEvent(wxEventType commandType
, int theId
)
418 : wxEvent(theId
, commandType
)
421 m_clientObject
= NULL
;
422 m_isCommandEvent
= true;
424 // the command events are propagated upwards by default
425 m_propagationLevel
= wxEVENT_PROPAGATE_MAX
;
428 wxString
wxCommandEvent::GetString() const
430 if (m_eventType
!= wxEVT_COMMAND_TEXT_UPDATED
|| !m_eventObject
)
437 wxTextCtrl
*txt
= wxDynamicCast(m_eventObject
, wxTextCtrl
);
439 return txt
->GetValue();
441 #endif // wxUSE_TEXTCTRL
446 // ----------------------------------------------------------------------------
448 // ----------------------------------------------------------------------------
451 wxLongLong
wxUpdateUIEvent::sm_lastUpdate
= 0;
454 long wxUpdateUIEvent::sm_updateInterval
= 0;
456 wxUpdateUIMode
wxUpdateUIEvent::sm_updateMode
= wxUPDATE_UI_PROCESS_ALL
;
459 bool wxUpdateUIEvent::CanUpdate(wxWindowBase
*win
)
461 // Don't update if we've switched global updating off
462 // and this window doesn't support updates.
464 (GetMode() == wxUPDATE_UI_PROCESS_SPECIFIED
&&
465 ((win
->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES
) == 0)))
468 // Don't update children of the hidden windows: this is useless as any
469 // change to their state won't be seen by the user anyhow. Notice that this
470 // argument doesn't apply to the hidden windows (with visible parent)
471 // themselves as they could be shown by their EVT_UPDATE_UI handler.
472 if ( win
->GetParent() && !win
->GetParent()->IsShownOnScreen() )
475 if (sm_updateInterval
== -1)
478 if (sm_updateInterval
== 0)
481 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
482 wxLongLong now
= wxGetLocalTimeMillis();
483 if (now
> (sm_lastUpdate
+ sm_updateInterval
))
490 // If we don't have wxStopWatch or wxLongLong, we
491 // should err on the safe side and update now anyway.
496 // Reset the update time to provide a delay until the next
497 // time we should update
498 void wxUpdateUIEvent::ResetUpdateTime()
500 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
501 if (sm_updateInterval
> 0)
503 wxLongLong now
= wxGetLocalTimeMillis();
504 if (now
> (sm_lastUpdate
+ sm_updateInterval
))
512 // ----------------------------------------------------------------------------
514 // ----------------------------------------------------------------------------
516 wxScrollEvent::wxScrollEvent(wxEventType commandType
,
520 : wxCommandEvent(commandType
, id
)
522 m_extraLong
= orient
;
526 // ----------------------------------------------------------------------------
528 // ----------------------------------------------------------------------------
530 wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType
,
534 m_eventType
= commandType
;
535 m_extraLong
= orient
;
539 // ----------------------------------------------------------------------------
541 // ----------------------------------------------------------------------------
543 wxMouseEvent::wxMouseEvent(wxEventType commandType
)
545 m_eventType
= commandType
;
551 m_middleDown
= false;
558 m_wheelAxis
= wxMOUSE_WHEEL_VERTICAL
;
561 m_linesPerAction
= 0;
564 void wxMouseEvent::Assign(const wxMouseEvent
& event
)
566 wxEvent::operator=(event
);
568 // Borland C++ 5.82 doesn't compile an explicit call to an implicitly
569 // defined operator=() so need to do it this way:
570 *static_cast<wxMouseState
*>(this) = event
;
575 m_leftDown
= event
.m_leftDown
;
576 m_middleDown
= event
.m_middleDown
;
577 m_rightDown
= event
.m_rightDown
;
578 m_aux1Down
= event
.m_aux1Down
;
579 m_aux2Down
= event
.m_aux2Down
;
581 m_wheelRotation
= event
.m_wheelRotation
;
582 m_wheelDelta
= event
.m_wheelDelta
;
583 m_linesPerAction
= event
.m_linesPerAction
;
584 m_wheelAxis
= event
.m_wheelAxis
;
587 // return true if was a button dclick event
588 bool wxMouseEvent::ButtonDClick(int but
) const
593 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
596 case wxMOUSE_BTN_ANY
:
597 return (LeftDClick() || MiddleDClick() || RightDClick() ||
598 Aux1DClick() || Aux2DClick());
600 case wxMOUSE_BTN_LEFT
:
603 case wxMOUSE_BTN_MIDDLE
:
604 return MiddleDClick();
606 case wxMOUSE_BTN_RIGHT
:
607 return RightDClick();
609 case wxMOUSE_BTN_AUX1
:
612 case wxMOUSE_BTN_AUX2
:
617 // return true if was a button down event
618 bool wxMouseEvent::ButtonDown(int but
) const
623 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
626 case wxMOUSE_BTN_ANY
:
627 return (LeftDown() || MiddleDown() || RightDown() ||
628 Aux1Down() || Aux2Down());
630 case wxMOUSE_BTN_LEFT
:
633 case wxMOUSE_BTN_MIDDLE
:
636 case wxMOUSE_BTN_RIGHT
:
639 case wxMOUSE_BTN_AUX1
:
642 case wxMOUSE_BTN_AUX2
:
647 // return true if was a button up event
648 bool wxMouseEvent::ButtonUp(int but
) const
653 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
656 case wxMOUSE_BTN_ANY
:
657 return (LeftUp() || MiddleUp() || RightUp() ||
658 Aux1Up() || Aux2Up());
660 case wxMOUSE_BTN_LEFT
:
663 case wxMOUSE_BTN_MIDDLE
:
666 case wxMOUSE_BTN_RIGHT
:
669 case wxMOUSE_BTN_AUX1
:
672 case wxMOUSE_BTN_AUX2
:
677 // return true if the given button is currently changing state
678 bool wxMouseEvent::Button(int but
) const
683 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
686 case wxMOUSE_BTN_ANY
:
687 return ButtonUp(wxMOUSE_BTN_ANY
) ||
688 ButtonDown(wxMOUSE_BTN_ANY
) ||
689 ButtonDClick(wxMOUSE_BTN_ANY
);
691 case wxMOUSE_BTN_LEFT
:
692 return LeftDown() || LeftUp() || LeftDClick();
694 case wxMOUSE_BTN_MIDDLE
:
695 return MiddleDown() || MiddleUp() || MiddleDClick();
697 case wxMOUSE_BTN_RIGHT
:
698 return RightDown() || RightUp() || RightDClick();
700 case wxMOUSE_BTN_AUX1
:
701 return Aux1Down() || Aux1Up() || Aux1DClick();
703 case wxMOUSE_BTN_AUX2
:
704 return Aux2Down() || Aux2Up() || Aux2DClick();
708 int wxMouseEvent::GetButton() const
710 for ( int i
= 1; i
< wxMOUSE_BTN_MAX
; i
++ )
718 return wxMOUSE_BTN_NONE
;
721 // Find the logical position of the event given the DC
722 wxPoint
wxMouseEvent::GetLogicalPosition(const wxDC
& dc
) const
724 wxPoint
pt(dc
.DeviceToLogicalX(m_x
), dc
.DeviceToLogicalY(m_y
));
728 // ----------------------------------------------------------------------------
730 // ----------------------------------------------------------------------------
732 wxKeyEvent::wxKeyEvent(wxEventType type
)
735 m_keyCode
= WXK_NONE
;
737 m_uniChar
= WXK_NONE
;
741 m_y
= wxDefaultCoord
;
742 m_hasPosition
= false;
747 wxKeyEvent::wxKeyEvent(const wxKeyEvent
& evt
)
751 DoAssignMembers(evt
);
756 wxKeyEvent::wxKeyEvent(wxEventType eventType
, const wxKeyEvent
& evt
)
760 DoAssignMembers(evt
);
762 m_eventType
= eventType
;
767 void wxKeyEvent::InitPositionIfNecessary() const
772 // We're const because we're called from const Get[XY]() methods but we
773 // need to update the "cached" values.
774 wxKeyEvent
& self
= const_cast<wxKeyEvent
&>(*this);
775 self
.m_hasPosition
= true;
777 // The only position we can possibly associate with the keyboard event on
778 // the platforms where it doesn't carry it already is the mouse position.
779 wxGetMousePosition(&self
.m_x
, &self
.m_y
);
781 // If this event is associated with a window, the position should be in its
782 // client coordinates, but otherwise leave it in screen coordinates as what
784 wxWindow
* const win
= wxDynamicCast(GetEventObject(), wxWindow
);
786 win
->ScreenToClient(&self
.m_x
, &self
.m_y
);
789 wxCoord
wxKeyEvent::GetX() const
791 InitPositionIfNecessary();
796 wxCoord
wxKeyEvent::GetY() const
798 InitPositionIfNecessary();
803 bool wxKeyEvent::IsKeyInCategory(int category
) const
805 switch ( GetKeyCode() )
811 case WXK_NUMPAD_LEFT
:
812 case WXK_NUMPAD_RIGHT
:
814 case WXK_NUMPAD_DOWN
:
815 return (category
& WXK_CATEGORY_ARROW
) != 0;
819 case WXK_NUMPAD_PAGEUP
:
820 case WXK_NUMPAD_PAGEDOWN
:
821 return (category
& WXK_CATEGORY_PAGING
) != 0;
825 case WXK_NUMPAD_HOME
:
827 return (category
& WXK_CATEGORY_JUMP
) != 0;
831 return (category
& WXK_CATEGORY_TAB
) != 0;
835 case WXK_NUMPAD_DELETE
:
836 return (category
& WXK_CATEGORY_CUT
) != 0;
843 // ----------------------------------------------------------------------------
844 // wxWindowCreateEvent
845 // ----------------------------------------------------------------------------
847 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow
*win
)
849 SetEventType(wxEVT_CREATE
);
853 // ----------------------------------------------------------------------------
854 // wxWindowDestroyEvent
855 // ----------------------------------------------------------------------------
857 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow
*win
)
859 SetEventType(wxEVT_DESTROY
);
863 // ----------------------------------------------------------------------------
865 // ----------------------------------------------------------------------------
867 wxChildFocusEvent::wxChildFocusEvent(wxWindow
*win
)
868 : wxCommandEvent(wxEVT_CHILD_FOCUS
)
873 // ----------------------------------------------------------------------------
875 // ----------------------------------------------------------------------------
878 wxHelpEvent::Origin
wxHelpEvent::GuessOrigin(Origin origin
)
880 if ( origin
== Origin_Unknown
)
882 // assume that the event comes from the help button if it's not from
883 // keyboard and that pressing F1 always results in the help event
884 origin
= wxGetKeyState(WXK_F1
) ? Origin_Keyboard
: Origin_HelpButton
;
895 // ----------------------------------------------------------------------------
897 // ----------------------------------------------------------------------------
899 static const int EVENT_TYPE_TABLE_INIT_SIZE
= 31; // Not too big not too small...
901 wxEventHashTable
* wxEventHashTable::sm_first
= NULL
;
903 wxEventHashTable::wxEventHashTable(const wxEventTable
&table
)
907 AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE
);
911 m_next
->m_previous
= this;
915 wxEventHashTable::~wxEventHashTable()
918 m_next
->m_previous
= m_previous
;
920 m_previous
->m_next
= m_next
;
921 if (sm_first
== this)
927 void wxEventHashTable::Clear()
929 for ( size_t i
= 0; i
< m_size
; i
++ )
931 EventTypeTablePointer eTTnode
= m_eventTypeTable
[i
];
935 wxDELETEA(m_eventTypeTable
);
940 #if wxUSE_MEMORY_TRACING
943 void wxEventHashTable::ClearAll()
945 wxEventHashTable
* table
= sm_first
;
949 table
= table
->m_next
;
953 #endif // wxUSE_MEMORY_TRACING
955 bool wxEventHashTable::HandleEvent(wxEvent
&event
, wxEvtHandler
*self
)
960 m_rebuildHash
= false;
963 if (!m_eventTypeTable
)
966 // Find all entries for the given event type.
967 wxEventType eventType
= event
.GetEventType();
968 const EventTypeTablePointer eTTnode
= m_eventTypeTable
[eventType
% m_size
];
969 if (eTTnode
&& eTTnode
->eventType
== eventType
)
971 // Now start the search for an event handler
972 // that can handle an event with the given ID.
973 const wxEventTableEntryPointerArray
&
974 eventEntryTable
= eTTnode
->eventEntryTable
;
976 const size_t count
= eventEntryTable
.GetCount();
977 for (size_t n
= 0; n
< count
; n
++)
979 const wxEventTableEntry
& entry
= *eventEntryTable
[n
];
980 if ( wxEvtHandler::ProcessEventIfMatchesId(entry
, self
, event
) )
988 void wxEventHashTable::InitHashTable()
990 // Loop over the event tables and all its base tables.
991 const wxEventTable
*table
= &m_table
;
994 // Retrieve all valid event handler entries
995 const wxEventTableEntry
*entry
= table
->entries
;
996 while (entry
->m_fn
!= 0)
998 // Add the event entry in the Hash.
1004 table
= table
->baseTable
;
1007 // Let's free some memory.
1009 for(i
= 0; i
< m_size
; i
++)
1011 EventTypeTablePointer eTTnode
= m_eventTypeTable
[i
];
1014 eTTnode
->eventEntryTable
.Shrink();
1019 void wxEventHashTable::AddEntry(const wxEventTableEntry
&entry
)
1021 // This might happen 'accidentally' as the app is exiting
1022 if (!m_eventTypeTable
)
1025 EventTypeTablePointer
*peTTnode
= &m_eventTypeTable
[entry
.m_eventType
% m_size
];
1026 EventTypeTablePointer eTTnode
= *peTTnode
;
1030 if (eTTnode
->eventType
!= entry
.m_eventType
)
1032 // Resize the table!
1033 GrowEventTypeTable();
1034 // Try again to add it.
1041 eTTnode
= new EventTypeTable
;
1042 eTTnode
->eventType
= entry
.m_eventType
;
1043 *peTTnode
= eTTnode
;
1046 // Fill all hash entries between entry.m_id and entry.m_lastId...
1047 eTTnode
->eventEntryTable
.Add(&entry
);
1050 void wxEventHashTable::AllocEventTypeTable(size_t size
)
1052 m_eventTypeTable
= new EventTypeTablePointer
[size
];
1053 memset((void *)m_eventTypeTable
, 0, sizeof(EventTypeTablePointer
)*size
);
1057 void wxEventHashTable::GrowEventTypeTable()
1059 size_t oldSize
= m_size
;
1060 EventTypeTablePointer
*oldEventTypeTable
= m_eventTypeTable
;
1062 // TODO: Search the most optimal grow sequence
1063 AllocEventTypeTable(/* GetNextPrime(oldSize) */oldSize
*2+1);
1065 for ( size_t i
= 0; i
< oldSize
; /* */ )
1067 EventTypeTablePointer eTToldNode
= oldEventTypeTable
[i
];
1070 EventTypeTablePointer
*peTTnode
= &m_eventTypeTable
[eTToldNode
->eventType
% m_size
];
1071 EventTypeTablePointer eTTnode
= *peTTnode
;
1073 // Check for collision, we don't want any.
1076 GrowEventTypeTable();
1077 continue; // Don't increment the counter,
1078 // as we still need to add this element.
1082 // Get the old value and put it in the new table.
1083 *peTTnode
= oldEventTypeTable
[i
];
1090 delete[] oldEventTypeTable
;
1093 // ----------------------------------------------------------------------------
1095 // ----------------------------------------------------------------------------
1097 wxEvtHandler::wxEvtHandler()
1099 m_nextHandler
= NULL
;
1100 m_previousHandler
= NULL
;
1102 m_dynamicEvents
= NULL
;
1103 m_pendingEvents
= NULL
;
1105 // no client data (yet)
1106 m_clientData
= NULL
;
1107 m_clientDataType
= wxClientData_None
;
1110 wxEvtHandler::~wxEvtHandler()
1114 if (m_dynamicEvents
)
1116 for ( wxList::iterator it
= m_dynamicEvents
->begin(),
1117 end
= m_dynamicEvents
->end();
1121 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)*it
;
1123 // Remove ourselves from sink destructor notifications
1124 // (this has usually been done, in wxTrackable destructor)
1125 wxEvtHandler
*eventSink
= entry
->m_fn
->GetEvtHandler();
1128 wxEventConnectionRef
* const
1129 evtConnRef
= FindRefInTrackerList(eventSink
);
1132 eventSink
->RemoveNode(evtConnRef
);
1137 delete entry
->m_callbackUserData
;
1140 delete m_dynamicEvents
;
1143 // Remove us from the list of the pending events if necessary.
1145 wxTheApp
->RemovePendingEventHandler(this);
1147 DeletePendingEvents();
1149 // we only delete object data, not untyped
1150 if ( m_clientDataType
== wxClientData_Object
)
1151 delete m_clientObject
;
1154 void wxEvtHandler::Unlink()
1156 // this event handler must take itself out of the chain of handlers:
1158 if (m_previousHandler
)
1159 m_previousHandler
->SetNextHandler(m_nextHandler
);
1162 m_nextHandler
->SetPreviousHandler(m_previousHandler
);
1164 m_nextHandler
= NULL
;
1165 m_previousHandler
= NULL
;
1168 bool wxEvtHandler::IsUnlinked() const
1170 return m_previousHandler
== NULL
&&
1171 m_nextHandler
== NULL
;
1174 wxEventFilter
* wxEvtHandler::ms_filterList
= NULL
;
1176 /* static */ void wxEvtHandler::AddFilter(wxEventFilter
* filter
)
1178 wxCHECK_RET( filter
, "NULL filter" );
1180 filter
->m_next
= ms_filterList
;
1181 ms_filterList
= filter
;
1184 /* static */ void wxEvtHandler::RemoveFilter(wxEventFilter
* filter
)
1186 wxEventFilter
* prev
= NULL
;
1187 for ( wxEventFilter
* f
= ms_filterList
; f
; f
= f
->m_next
)
1191 // Set the previous list element or the list head to the next
1194 prev
->m_next
= f
->m_next
;
1196 ms_filterList
= f
->m_next
;
1198 // Also reset the next pointer in the filter itself just to avoid
1199 // having possibly dangling pointers, even though it's not strictly
1203 // Skip the assert below.
1210 wxFAIL_MSG( "Filter not found" );
1215 bool wxEvtHandler::ProcessThreadEvent(const wxEvent
& event
)
1217 // check that we are really in a child thread
1218 wxASSERT_MSG( !wxThread::IsMain(),
1219 wxT("use ProcessEvent() in main thread") );
1221 AddPendingEvent(event
);
1226 #endif // wxUSE_THREADS
1228 void wxEvtHandler::QueueEvent(wxEvent
*event
)
1230 wxCHECK_RET( event
, "NULL event can't be posted" );
1234 // we need an event loop which manages the list of event handlers with
1235 // pending events... cannot proceed without it!
1236 wxLogDebug("No application object! Cannot queue this event!");
1238 // anyway delete the given event to avoid memory leaks
1244 // 1) Add this event to our list of pending events
1245 wxENTER_CRIT_SECT( m_pendingEventsLock
);
1247 if ( !m_pendingEvents
)
1248 m_pendingEvents
= new wxList
;
1250 m_pendingEvents
->Append(event
);
1252 // 2) Add this event handler to list of event handlers that
1253 // have pending events.
1255 wxTheApp
->AppendPendingEventHandler(this);
1257 // only release m_pendingEventsLock now because otherwise there is a race
1258 // condition as described in the ticket #9093: we could process the event
1259 // just added to m_pendingEvents in our ProcessPendingEvents() below before
1260 // we had time to append this pointer to wxHandlersWithPendingEvents list; thus
1261 // breaking the invariant that a handler should be in the list iff it has
1262 // any pending events to process
1263 wxLEAVE_CRIT_SECT( m_pendingEventsLock
);
1265 // 3) Inform the system that new pending events are somewhere,
1266 // and that these should be processed in idle time.
1270 void wxEvtHandler::DeletePendingEvents()
1272 if (m_pendingEvents
)
1273 m_pendingEvents
->DeleteContents(true);
1274 wxDELETE(m_pendingEvents
);
1277 void wxEvtHandler::ProcessPendingEvents()
1281 // we need an event loop which manages the list of event handlers with
1282 // pending events... cannot proceed without it!
1283 wxLogDebug("No application object! Cannot process pending events!");
1287 // we need to process only a single pending event in this call because
1288 // each call to ProcessEvent() could result in the destruction of this
1289 // same event handler (see the comment at the end of this function)
1291 wxENTER_CRIT_SECT( m_pendingEventsLock
);
1293 // this method is only called by wxApp if this handler does have
1295 wxCHECK_RET( m_pendingEvents
&& !m_pendingEvents
->IsEmpty(),
1296 "should have pending events if called" );
1298 wxList::compatibility_iterator node
= m_pendingEvents
->GetFirst();
1299 wxEvent
* pEvent
= static_cast<wxEvent
*>(node
->GetData());
1301 // find the first event which can be processed now:
1302 wxEventLoopBase
* evtLoop
= wxEventLoopBase::GetActive();
1303 if (evtLoop
&& evtLoop
->IsYielding())
1305 while (node
&& pEvent
&& !evtLoop
->IsEventAllowedInsideYield(pEvent
->GetEventCategory()))
1307 node
= node
->GetNext();
1308 pEvent
= node
? static_cast<wxEvent
*>(node
->GetData()) : NULL
;
1313 // all our events are NOT processable now... signal this:
1314 wxTheApp
->DelayPendingEventHandler(this);
1316 // see the comment at the beginning of evtloop.h header for the
1317 // logic behind YieldFor() and behind DelayPendingEventHandler()
1319 wxLEAVE_CRIT_SECT( m_pendingEventsLock
);
1325 wxEventPtr
event(pEvent
);
1327 // it's important we remove event from list before processing it, else a
1328 // nested event loop, for example from a modal dialog, might process the
1329 // same event again.
1330 m_pendingEvents
->Erase(node
);
1332 if ( m_pendingEvents
->IsEmpty() )
1334 // if there are no more pending events left, we don't need to
1335 // stay in this list
1336 wxTheApp
->RemovePendingEventHandler(this);
1339 wxLEAVE_CRIT_SECT( m_pendingEventsLock
);
1341 ProcessEvent(*event
);
1343 // careful: this object could have been deleted by the event handler
1344 // executed by the above ProcessEvent() call, so we can't access any fields
1345 // of this object any more
1349 bool wxEvtHandler::ProcessEventIfMatchesId(const wxEventTableEntryBase
& entry
,
1350 wxEvtHandler
*handler
,
1353 int tableId1
= entry
.m_id
,
1354 tableId2
= entry
.m_lastId
;
1356 // match only if the event type is the same and the id is either -1 in
1357 // the event table (meaning "any") or the event id matches the id
1358 // specified in the event table either exactly or by falling into
1359 // range between first and last
1360 if ((tableId1
== wxID_ANY
) ||
1361 (tableId2
== wxID_ANY
&& tableId1
== event
.GetId()) ||
1362 (tableId2
!= wxID_ANY
&&
1363 (event
.GetId() >= tableId1
&& event
.GetId() <= tableId2
)))
1366 event
.m_callbackUserData
= entry
.m_callbackUserData
;
1368 #if wxUSE_EXCEPTIONS
1371 // call the handler via wxApp method which allows the user to catch
1372 // any exceptions which may be thrown by any handler in the program
1374 wxTheApp
->CallEventHandler(handler
, *entry
.m_fn
, event
);
1377 #endif // wxUSE_EXCEPTIONS
1379 (*entry
.m_fn
)(handler
, event
);
1382 if (!event
.GetSkipped())
1389 bool wxEvtHandler::DoTryApp(wxEvent
& event
)
1391 if ( wxTheApp
&& (this != wxTheApp
) )
1393 // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
1394 // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
1395 // processed appropriately via SearchEventTable.
1396 if ( event
.GetEventType() != wxEVT_IDLE
)
1398 if ( wxTheApp
->ProcessEvent(event
) )
1406 bool wxEvtHandler::TryBefore(wxEvent
& event
)
1408 #if WXWIN_COMPATIBILITY_2_8
1409 // call the old virtual function to keep the code overriding it working
1410 return TryValidator(event
);
1417 bool wxEvtHandler::TryAfter(wxEvent
& event
)
1419 // We only want to pass the window to the application object once even if
1420 // there are several chained handlers. Ensure that this is what happens by
1421 // only calling DoTryApp() if there is no next handler (which would do it).
1423 // Notice that, unlike simply calling TryAfter() on the last handler in the
1424 // chain only from ProcessEvent(), this also works with wxWindow object in
1425 // the middle of the chain: its overridden TryAfter() will still be called
1426 // and propagate the event upwards the window hierarchy even if it's not
1427 // the last one in the chain (which, admittedly, shouldn't happen often).
1428 if ( GetNextHandler() )
1429 return GetNextHandler()->TryAfter(event
);
1431 #if WXWIN_COMPATIBILITY_2_8
1432 // as above, call the old virtual function for compatibility
1433 return TryParent(event
);
1435 return DoTryApp(event
);
1439 bool wxEvtHandler::ProcessEvent(wxEvent
& event
)
1441 // The very first thing we do is to allow any registered filters to hook
1442 // into event processing in order to globally pre-process all events.
1444 // Note that we should only do it if we're the first event handler called
1445 // to avoid calling FilterEvent() multiple times as the event goes through
1446 // the event handler chain and possibly upwards the window hierarchy.
1447 if ( !event
.WasProcessed() )
1449 for ( wxEventFilter
* f
= ms_filterList
; f
; f
= f
->m_next
)
1451 int rc
= f
->FilterEvent(event
);
1452 if ( rc
!= wxEventFilter::Event_Skip
)
1454 wxASSERT_MSG( rc
== wxEventFilter::Event_Ignore
||
1455 rc
== wxEventFilter::Event_Processed
,
1456 "unexpected FilterEvent() return value" );
1458 return rc
!= wxEventFilter::Event_Ignore
;
1460 //else: proceed normally
1464 // Short circuit the event processing logic if we're requested to process
1465 // this event in this handler only, see DoTryChain() for more details.
1466 if ( event
.ShouldProcessOnlyIn(this) )
1467 return TryBeforeAndHere(event
);
1470 // Try to process the event in this handler itself.
1471 if ( ProcessEventLocally(event
) )
1473 // It is possible that DoTryChain() called from ProcessEventLocally()
1474 // returned true but the event was not really processed: this happens
1475 // if a custom handler ignores the request to process the event in this
1476 // handler only and in this case we should skip the post processing
1477 // done in TryAfter() but still return the correct value ourselves to
1478 // indicate whether we did or did not find a handler for this event.
1479 return !event
.GetSkipped();
1482 // If we still didn't find a handler, propagate the event upwards the
1483 // window chain and/or to the application object.
1484 if ( TryAfter(event
) )
1488 // No handler found anywhere, bail out.
1492 bool wxEvtHandler::ProcessEventLocally(wxEvent
& event
)
1494 // Try the hooks which should be called before our own handlers and this
1495 // handler itself first. Notice that we should not call ProcessEvent() on
1496 // this one as we're already called from it, which explains why we do it
1497 // here and not in DoTryChain()
1498 return TryBeforeAndHere(event
) || DoTryChain(event
);
1501 bool wxEvtHandler::DoTryChain(wxEvent
& event
)
1503 for ( wxEvtHandler
*h
= GetNextHandler(); h
; h
= h
->GetNextHandler() )
1505 // We need to process this event at the level of this handler only
1506 // right now, the pre-/post-processing was either already done by
1507 // ProcessEvent() from which we were called or will be done by it when
1510 // However we must call ProcessEvent() and not TryHereOnly() because the
1511 // existing code (including some in wxWidgets itself) expects the
1512 // overridden ProcessEvent() in its custom event handlers pushed on a
1513 // window to be called.
1515 // So we must call ProcessEvent() but it must not do what it usually
1516 // does. To resolve this paradox we set up a special flag inside the
1517 // object itself to let ProcessEvent() know that it shouldn't do any
1518 // pre/post-processing for this event if it gets it. Note that this
1519 // only applies to this handler, if the event is passed to another one
1520 // by explicitly calling its ProcessEvent(), pre/post-processing should
1521 // be done as usual.
1523 // Final complication is that if the implementation of ProcessEvent()
1524 // called wxEvent::DidntHonourProcessOnlyIn() (as the gross hack that
1525 // is wxScrollHelperEvtHandler::ProcessEvent() does) and ignored our
1526 // request to process event in this handler only, we have to compensate
1527 // for it by not processing the event further because this was already
1528 // done by that rogue event handler.
1529 wxEventProcessInHandlerOnly
processInHandlerOnly(event
, h
);
1530 if ( h
->ProcessEvent(event
) )
1532 // Make sure "skipped" flag is not set as the event was really
1533 // processed in this case. Normally it shouldn't be set anyhow but
1534 // make sure just in case the user code does something strange.
1540 if ( !event
.ShouldProcessOnlyIn(h
) )
1542 // Still return true to indicate that no further processing should
1543 // be undertaken but ensure that "skipped" flag is set so that the
1544 // caller knows that the event was not really processed.
1554 bool wxEvtHandler::TryHereOnly(wxEvent
& event
)
1556 // If the event handler is disabled it doesn't process any events
1557 if ( !GetEvtHandlerEnabled() )
1560 // Handle per-instance dynamic event tables first
1561 if ( m_dynamicEvents
&& SearchDynamicEventTable(event
) )
1564 // Then static per-class event tables
1565 if ( GetEventHashTable().HandleEvent(event
, this) )
1568 // There is an implicit entry for async method calls processing in every
1570 if ( event
.GetEventType() == wxEVT_ASYNC_METHOD_CALL
&&
1571 event
.GetEventObject() == this )
1573 static_cast<wxAsyncMethodCallEvent
&>(event
).Execute();
1577 // We don't have a handler for this event.
1581 bool wxEvtHandler::SafelyProcessEvent(wxEvent
& event
)
1583 #if wxUSE_EXCEPTIONS
1587 return ProcessEvent(event
);
1588 #if wxUSE_EXCEPTIONS
1592 // notice that we do it in 2 steps to avoid warnings about possibly
1593 // uninitialized loop variable from some versions of g++ which are not
1594 // smart enough to figure out that GetActive() doesn't throw and so
1595 // that loop will always be initialized
1596 wxEventLoopBase
*loop
= NULL
;
1599 loop
= wxEventLoopBase::GetActive();
1601 if ( !wxTheApp
|| !wxTheApp
->OnExceptionInMainLoop() )
1606 //else: continue running current event loop
1612 // OnExceptionInMainLoop() threw, possibly rethrowing the same
1613 // exception again: very good, but we still need Exit() to
1620 #endif // wxUSE_EXCEPTIONS
1623 bool wxEvtHandler::SearchEventTable(wxEventTable
& table
, wxEvent
& event
)
1625 const wxEventType eventType
= event
.GetEventType();
1626 for ( int i
= 0; table
.entries
[i
].m_fn
!= 0; i
++ )
1628 const wxEventTableEntry
& entry
= table
.entries
[i
];
1629 if ( eventType
== entry
.m_eventType
)
1631 if ( ProcessEventIfMatchesId(entry
, this, event
) )
1639 void wxEvtHandler::DoBind(int id
,
1641 wxEventType eventType
,
1642 wxEventFunctor
*func
,
1645 wxDynamicEventTableEntry
*entry
=
1646 new wxDynamicEventTableEntry(eventType
, id
, lastId
, func
, userData
);
1648 if (!m_dynamicEvents
)
1649 m_dynamicEvents
= new wxList
;
1651 // Insert at the front of the list so most recent additions are found first
1652 m_dynamicEvents
->Insert( (wxObject
*) entry
);
1654 // Make sure we get to know when a sink is destroyed
1655 wxEvtHandler
*eventSink
= func
->GetEvtHandler();
1656 if ( eventSink
&& eventSink
!= this )
1658 wxEventConnectionRef
*evtConnRef
= FindRefInTrackerList(eventSink
);
1660 evtConnRef
->IncRef( );
1662 new wxEventConnectionRef(this, eventSink
);
1667 wxEvtHandler::DoUnbind(int id
,
1669 wxEventType eventType
,
1670 const wxEventFunctor
& func
,
1673 if (!m_dynamicEvents
)
1676 // Remove connection from tracker node (wxEventConnectionRef)
1677 wxEvtHandler
*eventSink
= func
.GetEvtHandler();
1678 if ( eventSink
&& eventSink
!= this )
1680 wxEventConnectionRef
*evtConnRef
= FindRefInTrackerList(eventSink
);
1682 evtConnRef
->DecRef();
1685 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1688 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1690 if ((entry
->m_id
== id
) &&
1691 ((entry
->m_lastId
== lastId
) || (lastId
== wxID_ANY
)) &&
1692 ((entry
->m_eventType
== eventType
) || (eventType
== wxEVT_NULL
)) &&
1693 entry
->m_fn
->IsMatching(func
) &&
1694 ((entry
->m_callbackUserData
== userData
) || !userData
))
1696 delete entry
->m_callbackUserData
;
1697 m_dynamicEvents
->Erase( node
);
1701 node
= node
->GetNext();
1706 bool wxEvtHandler::SearchDynamicEventTable( wxEvent
& event
)
1708 wxCHECK_MSG( m_dynamicEvents
, false,
1709 wxT("caller should check that we have dynamic events") );
1711 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1714 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1716 // get next node before (maybe) calling the event handler as it could
1717 // call Disconnect() invalidating the current node
1718 node
= node
->GetNext();
1720 if ( event
.GetEventType() == entry
->m_eventType
)
1722 wxEvtHandler
*handler
= entry
->m_fn
->GetEvtHandler();
1725 if ( ProcessEventIfMatchesId(*entry
, handler
, event
) )
1733 void wxEvtHandler::DoSetClientObject( wxClientData
*data
)
1735 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1736 wxT("can't have both object and void client data") );
1738 if ( m_clientObject
)
1739 delete m_clientObject
;
1741 m_clientObject
= data
;
1742 m_clientDataType
= wxClientData_Object
;
1745 wxClientData
*wxEvtHandler::DoGetClientObject() const
1747 // it's not an error to call GetClientObject() on a window which doesn't
1748 // have client data at all - NULL will be returned
1749 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1750 wxT("this window doesn't have object client data") );
1752 return m_clientObject
;
1755 void wxEvtHandler::DoSetClientData( void *data
)
1757 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1758 wxT("can't have both object and void client data") );
1760 m_clientData
= data
;
1761 m_clientDataType
= wxClientData_Void
;
1764 void *wxEvtHandler::DoGetClientData() const
1766 // it's not an error to call GetClientData() on a window which doesn't have
1767 // client data at all - NULL will be returned
1768 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1769 wxT("this window doesn't have void client data") );
1771 return m_clientData
;
1774 // A helper to find an wxEventConnectionRef object
1775 wxEventConnectionRef
*
1776 wxEvtHandler::FindRefInTrackerList(wxEvtHandler
*eventSink
)
1778 for ( wxTrackerNode
*node
= eventSink
->GetFirst(); node
; node
= node
->m_nxt
)
1780 // we only want wxEventConnectionRef nodes here
1781 wxEventConnectionRef
*evtConnRef
= node
->ToEventConnection();
1782 if ( evtConnRef
&& evtConnRef
->m_src
== this )
1784 wxASSERT( evtConnRef
->m_sink
==eventSink
);
1792 void wxEvtHandler::OnSinkDestroyed( wxEvtHandler
*sink
)
1794 wxASSERT(m_dynamicEvents
);
1796 // remove all connections with this sink
1797 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst(), node_nxt
;
1800 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1801 node_nxt
= node
->GetNext();
1803 if ( entry
->m_fn
->GetEvtHandler() == sink
)
1805 delete entry
->m_callbackUserData
;
1806 m_dynamicEvents
->Erase( node
);
1813 #endif // wxUSE_BASE
1817 // Find a window with the focus, that is also a descendant of the given window.
1818 // This is used to determine the window to initially send commands to.
1819 wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
)
1821 // Process events starting with the window with the focus, if any.
1822 wxWindow
* focusWin
= wxWindow::FindFocus();
1823 wxWindow
* win
= focusWin
;
1825 // Check if this is a descendant of this frame.
1826 // If not, win will be set to NULL.
1829 if (win
== ancestor
)
1832 win
= win
->GetParent();
1840 // ----------------------------------------------------------------------------
1842 // ----------------------------------------------------------------------------
1844 wxEventBlocker::wxEventBlocker(wxWindow
*win
, wxEventType type
)
1846 wxCHECK_RET(win
, wxT("Null window given to wxEventBlocker"));
1851 m_window
->PushEventHandler(this);
1854 wxEventBlocker::~wxEventBlocker()
1856 wxEvtHandler
*popped
= m_window
->PopEventHandler(false);
1857 wxCHECK_RET(popped
== this,
1858 wxT("Don't push other event handlers into a window managed by wxEventBlocker!"));
1861 bool wxEventBlocker::ProcessEvent(wxEvent
& event
)
1863 // should this event be blocked?
1864 for ( size_t i
= 0; i
< m_eventsToBlock
.size(); i
++ )
1866 wxEventType t
= (wxEventType
)m_eventsToBlock
[i
];
1867 if ( t
== wxEVT_ANY
|| t
== event
.GetEventType() )
1868 return true; // yes, it should: mark this event as processed