1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/event.cpp
3 // Purpose: Event classes
4 // Author: Julian Smart
7 // Copyright: (c) Julian Smart
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
11 // ============================================================================
13 // ============================================================================
15 // ----------------------------------------------------------------------------
17 // ----------------------------------------------------------------------------
19 // For compilers that support precompilation, includes "wx.h".
20 #include "wx/wxprec.h"
27 #include "wx/eventfilter.h"
28 #include "wx/evtloop.h"
35 #include "wx/stopwatch.h"
36 #include "wx/module.h"
39 #include "wx/window.h"
40 #include "wx/control.h"
42 #include "wx/spinbutt.h"
43 #include "wx/textctrl.h"
44 #include "wx/validate.h"
48 #include "wx/thread.h"
51 #include "wx/scopedptr.h"
53 wxDECLARE_SCOPED_PTR(wxEvent
, wxEventPtr
)
54 wxDEFINE_SCOPED_PTR(wxEvent
, wxEventPtr
)
57 // ----------------------------------------------------------------------------
59 // ----------------------------------------------------------------------------
62 IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler
, wxObject
)
63 IMPLEMENT_ABSTRACT_CLASS(wxEvent
, wxObject
)
64 IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent
, wxEvent
)
65 IMPLEMENT_DYNAMIC_CLASS(wxThreadEvent
, wxEvent
)
69 IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent
, wxEvent
)
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
)
109 const wxEventTable
*wxEvtHandler::GetEventTable() const
110 { return &wxEvtHandler::sm_eventTable
; }
112 const wxEventTable
wxEvtHandler::sm_eventTable
=
113 { (const wxEventTable
*)NULL
, &wxEvtHandler::sm_eventTableEntries
[0] };
115 wxEventHashTable
&wxEvtHandler::GetEventHashTable() const
116 { return wxEvtHandler::sm_eventHashTable
; }
118 wxEventHashTable
wxEvtHandler::sm_eventHashTable(wxEvtHandler::sm_eventTable
);
120 const wxEventTableEntry
wxEvtHandler::sm_eventTableEntries
[] =
121 { wxDECLARE_EVENT_TABLE_TERMINATOR() };
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
131 class wxEventTableEntryModule
: public wxModule
134 wxEventTableEntryModule() { }
135 virtual bool OnInit() { return true; }
136 virtual void OnExit() { wxEventHashTable::ClearAll(); }
138 DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule
)
141 IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule
, wxModule
)
143 #endif // wxUSE_MEMORY_TRACING
145 // ----------------------------------------------------------------------------
147 // ----------------------------------------------------------------------------
149 // common event types are defined here, other event types are defined by the
150 // components which use them
152 const wxEventType wxEVT_FIRST
= 10000;
153 const wxEventType wxEVT_USER_FIRST
= wxEVT_FIRST
+ 2000;
154 const wxEventType wxEVT_NULL
= wxNewEventType();
156 wxDEFINE_EVENT( wxEVT_IDLE
, wxIdleEvent
);
158 // Thread and asynchronous call events
159 wxDEFINE_EVENT( wxEVT_THREAD
, wxThreadEvent
);
160 wxDEFINE_EVENT( wxEVT_ASYNC_METHOD_CALL
, wxAsyncMethodCallEvent
);
166 wxDEFINE_EVENT( wxEVT_BUTTON
, wxCommandEvent
);
167 wxDEFINE_EVENT( wxEVT_CHECKBOX
, wxCommandEvent
);
168 wxDEFINE_EVENT( wxEVT_CHOICE
, wxCommandEvent
);
169 wxDEFINE_EVENT( wxEVT_LISTBOX
, wxCommandEvent
);
170 wxDEFINE_EVENT( wxEVT_LISTBOX_DCLICK
, wxCommandEvent
);
171 wxDEFINE_EVENT( wxEVT_CHECKLISTBOX
, wxCommandEvent
);
172 wxDEFINE_EVENT( wxEVT_MENU
, wxCommandEvent
);
173 wxDEFINE_EVENT( wxEVT_SLIDER
, wxCommandEvent
);
174 wxDEFINE_EVENT( wxEVT_RADIOBOX
, wxCommandEvent
);
175 wxDEFINE_EVENT( wxEVT_RADIOBUTTON
, wxCommandEvent
);
176 wxDEFINE_EVENT( wxEVT_SCROLLBAR
, wxCommandEvent
);
177 wxDEFINE_EVENT( wxEVT_VLBOX
, wxCommandEvent
);
178 wxDEFINE_EVENT( wxEVT_COMBOBOX
, wxCommandEvent
);
179 wxDEFINE_EVENT( wxEVT_TOOL_RCLICKED
, wxCommandEvent
);
180 wxDEFINE_EVENT( wxEVT_TOOL_ENTER
, wxCommandEvent
);
181 wxDEFINE_EVENT( wxEVT_SPINCTRL
, wxCommandEvent
);
182 wxDEFINE_EVENT( wxEVT_SPINCTRLDOUBLE
, wxCommandEvent
);
183 wxDEFINE_EVENT( wxEVT_TOOL_DROPDOWN
, wxCommandEvent
);
184 wxDEFINE_EVENT( wxEVT_COMBOBOX_DROPDOWN
, wxCommandEvent
);
185 wxDEFINE_EVENT( wxEVT_COMBOBOX_CLOSEUP
, wxCommandEvent
);
188 wxDEFINE_EVENT( wxEVT_LEFT_DOWN
, wxMouseEvent
);
189 wxDEFINE_EVENT( wxEVT_LEFT_UP
, wxMouseEvent
);
190 wxDEFINE_EVENT( wxEVT_MIDDLE_DOWN
, wxMouseEvent
);
191 wxDEFINE_EVENT( wxEVT_MIDDLE_UP
, wxMouseEvent
);
192 wxDEFINE_EVENT( wxEVT_RIGHT_DOWN
, wxMouseEvent
);
193 wxDEFINE_EVENT( wxEVT_RIGHT_UP
, wxMouseEvent
);
194 wxDEFINE_EVENT( wxEVT_MOTION
, wxMouseEvent
);
195 wxDEFINE_EVENT( wxEVT_ENTER_WINDOW
, wxMouseEvent
);
196 wxDEFINE_EVENT( wxEVT_LEAVE_WINDOW
, wxMouseEvent
);
197 wxDEFINE_EVENT( wxEVT_LEFT_DCLICK
, wxMouseEvent
);
198 wxDEFINE_EVENT( wxEVT_MIDDLE_DCLICK
, wxMouseEvent
);
199 wxDEFINE_EVENT( wxEVT_RIGHT_DCLICK
, wxMouseEvent
);
200 wxDEFINE_EVENT( wxEVT_SET_FOCUS
, wxFocusEvent
);
201 wxDEFINE_EVENT( wxEVT_KILL_FOCUS
, wxFocusEvent
);
202 wxDEFINE_EVENT( wxEVT_CHILD_FOCUS
, wxChildFocusEvent
);
203 wxDEFINE_EVENT( wxEVT_MOUSEWHEEL
, wxMouseEvent
);
204 wxDEFINE_EVENT( wxEVT_AUX1_DOWN
, wxMouseEvent
);
205 wxDEFINE_EVENT( wxEVT_AUX1_UP
, wxMouseEvent
);
206 wxDEFINE_EVENT( wxEVT_AUX1_DCLICK
, wxMouseEvent
);
207 wxDEFINE_EVENT( wxEVT_AUX2_DOWN
, wxMouseEvent
);
208 wxDEFINE_EVENT( wxEVT_AUX2_UP
, wxMouseEvent
);
209 wxDEFINE_EVENT( wxEVT_AUX2_DCLICK
, wxMouseEvent
);
211 // Character input event type
212 wxDEFINE_EVENT( wxEVT_CHAR
, wxKeyEvent
);
213 wxDEFINE_EVENT( wxEVT_AFTER_CHAR
, wxKeyEvent
);
214 wxDEFINE_EVENT( wxEVT_CHAR_HOOK
, wxKeyEvent
);
215 wxDEFINE_EVENT( wxEVT_NAVIGATION_KEY
, wxNavigationKeyEvent
);
216 wxDEFINE_EVENT( wxEVT_KEY_DOWN
, wxKeyEvent
);
217 wxDEFINE_EVENT( wxEVT_KEY_UP
, wxKeyEvent
);
219 wxDEFINE_EVENT( wxEVT_HOTKEY
, wxKeyEvent
);
223 wxDEFINE_EVENT( wxEVT_SET_CURSOR
, wxSetCursorEvent
);
225 // wxScrollbar and wxSlider event identifiers
226 wxDEFINE_EVENT( wxEVT_SCROLL_TOP
, wxScrollEvent
);
227 wxDEFINE_EVENT( wxEVT_SCROLL_BOTTOM
, wxScrollEvent
);
228 wxDEFINE_EVENT( wxEVT_SCROLL_LINEUP
, wxScrollEvent
);
229 wxDEFINE_EVENT( wxEVT_SCROLL_LINEDOWN
, wxScrollEvent
);
230 wxDEFINE_EVENT( wxEVT_SCROLL_PAGEUP
, wxScrollEvent
);
231 wxDEFINE_EVENT( wxEVT_SCROLL_PAGEDOWN
, wxScrollEvent
);
232 wxDEFINE_EVENT( wxEVT_SCROLL_THUMBTRACK
, wxScrollEvent
);
233 wxDEFINE_EVENT( wxEVT_SCROLL_THUMBRELEASE
, wxScrollEvent
);
234 wxDEFINE_EVENT( wxEVT_SCROLL_CHANGED
, wxScrollEvent
);
236 // Due to a bug in older wx versions, wxSpinEvents were being sent with type of
237 // wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But
238 // with the type-safe events in place, these event types are associated with
239 // wxScrollEvent. To allow handling of spin events, new event types have been
240 // defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility
241 // the spin event types are being initialized with the scroll event types.
245 wxDEFINE_EVENT_ALIAS( wxEVT_SPIN_UP
, wxSpinEvent
, wxEVT_SCROLL_LINEUP
);
246 wxDEFINE_EVENT_ALIAS( wxEVT_SPIN_DOWN
, wxSpinEvent
, wxEVT_SCROLL_LINEDOWN
);
247 wxDEFINE_EVENT_ALIAS( wxEVT_SPIN
, wxSpinEvent
, wxEVT_SCROLL_THUMBTRACK
);
249 #endif // wxUSE_SPINBTN
251 // Scroll events from wxWindow
252 wxDEFINE_EVENT( wxEVT_SCROLLWIN_TOP
, wxScrollWinEvent
);
253 wxDEFINE_EVENT( wxEVT_SCROLLWIN_BOTTOM
, wxScrollWinEvent
);
254 wxDEFINE_EVENT( wxEVT_SCROLLWIN_LINEUP
, wxScrollWinEvent
);
255 wxDEFINE_EVENT( wxEVT_SCROLLWIN_LINEDOWN
, wxScrollWinEvent
);
256 wxDEFINE_EVENT( wxEVT_SCROLLWIN_PAGEUP
, wxScrollWinEvent
);
257 wxDEFINE_EVENT( wxEVT_SCROLLWIN_PAGEDOWN
, wxScrollWinEvent
);
258 wxDEFINE_EVENT( wxEVT_SCROLLWIN_THUMBTRACK
, wxScrollWinEvent
);
259 wxDEFINE_EVENT( wxEVT_SCROLLWIN_THUMBRELEASE
, wxScrollWinEvent
);
262 wxDEFINE_EVENT( wxEVT_SIZE
, wxSizeEvent
);
263 wxDEFINE_EVENT( wxEVT_SIZING
, wxSizeEvent
);
264 wxDEFINE_EVENT( wxEVT_MOVE
, wxMoveEvent
);
265 wxDEFINE_EVENT( wxEVT_MOVING
, wxMoveEvent
);
266 wxDEFINE_EVENT( wxEVT_MOVE_START
, wxMoveEvent
);
267 wxDEFINE_EVENT( wxEVT_MOVE_END
, wxMoveEvent
);
268 wxDEFINE_EVENT( wxEVT_CLOSE_WINDOW
, wxCloseEvent
);
269 wxDEFINE_EVENT( wxEVT_END_SESSION
, wxCloseEvent
);
270 wxDEFINE_EVENT( wxEVT_QUERY_END_SESSION
, wxCloseEvent
);
271 wxDEFINE_EVENT( wxEVT_HIBERNATE
, wxActivateEvent
);
272 wxDEFINE_EVENT( wxEVT_ACTIVATE_APP
, wxActivateEvent
);
273 wxDEFINE_EVENT( wxEVT_ACTIVATE
, wxActivateEvent
);
274 wxDEFINE_EVENT( wxEVT_CREATE
, wxWindowCreateEvent
);
275 wxDEFINE_EVENT( wxEVT_DESTROY
, wxWindowDestroyEvent
);
276 wxDEFINE_EVENT( wxEVT_SHOW
, wxShowEvent
);
277 wxDEFINE_EVENT( wxEVT_ICONIZE
, wxIconizeEvent
);
278 wxDEFINE_EVENT( wxEVT_MAXIMIZE
, wxMaximizeEvent
);
279 wxDEFINE_EVENT( wxEVT_MOUSE_CAPTURE_CHANGED
, wxMouseCaptureChangedEvent
);
280 wxDEFINE_EVENT( wxEVT_MOUSE_CAPTURE_LOST
, wxMouseCaptureLostEvent
);
281 wxDEFINE_EVENT( wxEVT_PAINT
, wxPaintEvent
);
282 wxDEFINE_EVENT( wxEVT_ERASE_BACKGROUND
, wxEraseEvent
);
283 wxDEFINE_EVENT( wxEVT_NC_PAINT
, wxNcPaintEvent
);
284 wxDEFINE_EVENT( wxEVT_MENU_OPEN
, wxMenuEvent
);
285 wxDEFINE_EVENT( wxEVT_MENU_CLOSE
, wxMenuEvent
);
286 wxDEFINE_EVENT( wxEVT_MENU_HIGHLIGHT
, wxMenuEvent
);
287 wxDEFINE_EVENT( wxEVT_CONTEXT_MENU
, wxContextMenuEvent
);
288 wxDEFINE_EVENT( wxEVT_SYS_COLOUR_CHANGED
, wxSysColourChangedEvent
);
289 wxDEFINE_EVENT( wxEVT_DISPLAY_CHANGED
, wxDisplayChangedEvent
);
290 wxDEFINE_EVENT( wxEVT_QUERY_NEW_PALETTE
, wxQueryNewPaletteEvent
);
291 wxDEFINE_EVENT( wxEVT_PALETTE_CHANGED
, wxPaletteChangedEvent
);
292 wxDEFINE_EVENT( wxEVT_JOY_BUTTON_DOWN
, wxJoystickEvent
);
293 wxDEFINE_EVENT( wxEVT_JOY_BUTTON_UP
, wxJoystickEvent
);
294 wxDEFINE_EVENT( wxEVT_JOY_MOVE
, wxJoystickEvent
);
295 wxDEFINE_EVENT( wxEVT_JOY_ZMOVE
, wxJoystickEvent
);
296 wxDEFINE_EVENT( wxEVT_DROP_FILES
, wxDropFilesEvent
);
297 wxDEFINE_EVENT( wxEVT_INIT_DIALOG
, wxInitDialogEvent
);
298 wxDEFINE_EVENT( wxEVT_UPDATE_UI
, wxUpdateUIEvent
);
301 wxDEFINE_EVENT( wxEVT_TEXT_COPY
, wxClipboardTextEvent
);
302 wxDEFINE_EVENT( wxEVT_TEXT_CUT
, wxClipboardTextEvent
);
303 wxDEFINE_EVENT( wxEVT_TEXT_PASTE
, wxClipboardTextEvent
);
305 // Generic command events
306 // Note: a click is a higher-level event than button down/up
307 wxDEFINE_EVENT( wxEVT_COMMAND_LEFT_CLICK
, wxCommandEvent
);
308 wxDEFINE_EVENT( wxEVT_COMMAND_LEFT_DCLICK
, wxCommandEvent
);
309 wxDEFINE_EVENT( wxEVT_COMMAND_RIGHT_CLICK
, wxCommandEvent
);
310 wxDEFINE_EVENT( wxEVT_COMMAND_RIGHT_DCLICK
, wxCommandEvent
);
311 wxDEFINE_EVENT( wxEVT_COMMAND_SET_FOCUS
, wxCommandEvent
);
312 wxDEFINE_EVENT( wxEVT_COMMAND_KILL_FOCUS
, wxCommandEvent
);
313 wxDEFINE_EVENT( wxEVT_COMMAND_ENTER
, wxCommandEvent
);
316 wxDEFINE_EVENT( wxEVT_HELP
, wxHelpEvent
);
317 wxDEFINE_EVENT( wxEVT_DETAILED_HELP
, wxHelpEvent
);
323 wxIdleMode
wxIdleEvent::sm_idleMode
= wxIDLE_PROCESS_ALL
;
325 // ============================================================================
327 // ============================================================================
329 // ----------------------------------------------------------------------------
330 // event initialization
331 // ----------------------------------------------------------------------------
336 static int s_lastUsedEventType
= wxEVT_FIRST
;
338 return s_lastUsedEventType
++;
340 // ----------------------------------------------------------------------------
342 // ----------------------------------------------------------------------------
344 wxEventFunctor::~wxEventFunctor()
348 // ----------------------------------------------------------------------------
350 // ----------------------------------------------------------------------------
353 * General wxWidgets events, covering all interesting things that might happen
354 * (button clicking, resizing, setting text in widgets, etc.).
356 * For each completely new event type, derive a new event class.
360 wxEvent::wxEvent(int theId
, wxEventType commandType
)
362 m_eventType
= commandType
;
363 m_eventObject
= NULL
;
367 m_callbackUserData
= NULL
;
368 m_handlerToProcessOnlyIn
= NULL
;
369 m_isCommandEvent
= false;
370 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
371 m_propagatedFrom
= NULL
;
372 m_wasProcessed
= false;
373 m_willBeProcessedAgain
= false;
376 wxEvent::wxEvent(const wxEvent
& src
)
378 , m_eventObject(src
.m_eventObject
)
379 , m_eventType(src
.m_eventType
)
380 , m_timeStamp(src
.m_timeStamp
)
382 , m_callbackUserData(src
.m_callbackUserData
)
383 , m_handlerToProcessOnlyIn(NULL
)
384 , m_propagationLevel(src
.m_propagationLevel
)
385 , m_propagatedFrom(NULL
)
386 , m_skipped(src
.m_skipped
)
387 , m_isCommandEvent(src
.m_isCommandEvent
)
388 , m_wasProcessed(false)
389 , m_willBeProcessedAgain(false)
393 wxEvent
& wxEvent::operator=(const wxEvent
& src
)
395 wxObject::operator=(src
);
397 m_eventObject
= src
.m_eventObject
;
398 m_eventType
= src
.m_eventType
;
399 m_timeStamp
= src
.m_timeStamp
;
401 m_callbackUserData
= src
.m_callbackUserData
;
402 m_handlerToProcessOnlyIn
= NULL
;
403 m_propagationLevel
= src
.m_propagationLevel
;
404 m_propagatedFrom
= NULL
;
405 m_skipped
= src
.m_skipped
;
406 m_isCommandEvent
= src
.m_isCommandEvent
;
408 // don't change m_wasProcessed
410 // While the original again could be passed to another handler, this one
411 // isn't going to be processed anywhere else by default.
412 m_willBeProcessedAgain
= false;
421 // ----------------------------------------------------------------------------
423 // ----------------------------------------------------------------------------
425 wxCommandEvent::wxCommandEvent(wxEventType commandType
, int theId
)
426 : wxEvent(theId
, commandType
)
429 m_clientObject
= NULL
;
430 m_isCommandEvent
= true;
432 // the command events are propagated upwards by default
433 m_propagationLevel
= wxEVENT_PROPAGATE_MAX
;
436 wxString
wxCommandEvent::GetString() const
438 if (m_eventType
!= wxEVT_TEXT
|| !m_eventObject
)
445 wxTextCtrl
*txt
= wxDynamicCast(m_eventObject
, wxTextCtrl
);
447 return txt
->GetValue();
449 #endif // wxUSE_TEXTCTRL
454 // ----------------------------------------------------------------------------
456 // ----------------------------------------------------------------------------
459 wxLongLong
wxUpdateUIEvent::sm_lastUpdate
= 0;
462 long wxUpdateUIEvent::sm_updateInterval
= 0;
464 wxUpdateUIMode
wxUpdateUIEvent::sm_updateMode
= wxUPDATE_UI_PROCESS_ALL
;
467 bool wxUpdateUIEvent::CanUpdate(wxWindowBase
*win
)
469 // Don't update if we've switched global updating off
470 // and this window doesn't support updates.
472 (GetMode() == wxUPDATE_UI_PROCESS_SPECIFIED
&&
473 ((win
->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES
) == 0)))
476 // Don't update children of the hidden windows: this is useless as any
477 // change to their state won't be seen by the user anyhow. Notice that this
478 // argument doesn't apply to the hidden windows (with visible parent)
479 // themselves as they could be shown by their EVT_UPDATE_UI handler.
480 if ( win
->GetParent() && !win
->GetParent()->IsShownOnScreen() )
483 if (sm_updateInterval
== -1)
486 if (sm_updateInterval
== 0)
489 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
490 wxLongLong now
= wxGetLocalTimeMillis();
491 if (now
> (sm_lastUpdate
+ sm_updateInterval
))
498 // If we don't have wxStopWatch or wxLongLong, we
499 // should err on the safe side and update now anyway.
504 // Reset the update time to provide a delay until the next
505 // time we should update
506 void wxUpdateUIEvent::ResetUpdateTime()
508 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
509 if (sm_updateInterval
> 0)
511 wxLongLong now
= wxGetLocalTimeMillis();
512 if (now
> (sm_lastUpdate
+ sm_updateInterval
))
520 // ----------------------------------------------------------------------------
522 // ----------------------------------------------------------------------------
524 wxScrollEvent::wxScrollEvent(wxEventType commandType
,
528 : wxCommandEvent(commandType
, id
)
530 m_extraLong
= orient
;
534 // ----------------------------------------------------------------------------
536 // ----------------------------------------------------------------------------
538 wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType
,
542 m_eventType
= commandType
;
543 m_extraLong
= orient
;
547 // ----------------------------------------------------------------------------
549 // ----------------------------------------------------------------------------
551 wxMouseEvent::wxMouseEvent(wxEventType commandType
)
553 m_eventType
= commandType
;
559 m_middleDown
= false;
566 m_wheelAxis
= wxMOUSE_WHEEL_VERTICAL
;
569 m_linesPerAction
= 0;
570 m_columnsPerAction
= 0;
573 void wxMouseEvent::Assign(const wxMouseEvent
& event
)
575 wxEvent::operator=(event
);
577 // Borland C++ 5.82 doesn't compile an explicit call to an implicitly
578 // defined operator=() so need to do it this way:
579 *static_cast<wxMouseState
*>(this) = event
;
584 m_leftDown
= event
.m_leftDown
;
585 m_middleDown
= event
.m_middleDown
;
586 m_rightDown
= event
.m_rightDown
;
587 m_aux1Down
= event
.m_aux1Down
;
588 m_aux2Down
= event
.m_aux2Down
;
590 m_wheelRotation
= event
.m_wheelRotation
;
591 m_wheelDelta
= event
.m_wheelDelta
;
592 m_linesPerAction
= event
.m_linesPerAction
;
593 m_columnsPerAction
= event
.m_columnsPerAction
;
594 m_wheelAxis
= event
.m_wheelAxis
;
597 // return true if was a button dclick event
598 bool wxMouseEvent::ButtonDClick(int but
) const
603 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
606 case wxMOUSE_BTN_ANY
:
607 return (LeftDClick() || MiddleDClick() || RightDClick() ||
608 Aux1DClick() || Aux2DClick());
610 case wxMOUSE_BTN_LEFT
:
613 case wxMOUSE_BTN_MIDDLE
:
614 return MiddleDClick();
616 case wxMOUSE_BTN_RIGHT
:
617 return RightDClick();
619 case wxMOUSE_BTN_AUX1
:
622 case wxMOUSE_BTN_AUX2
:
627 // return true if was a button down event
628 bool wxMouseEvent::ButtonDown(int but
) const
633 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
636 case wxMOUSE_BTN_ANY
:
637 return (LeftDown() || MiddleDown() || RightDown() ||
638 Aux1Down() || Aux2Down());
640 case wxMOUSE_BTN_LEFT
:
643 case wxMOUSE_BTN_MIDDLE
:
646 case wxMOUSE_BTN_RIGHT
:
649 case wxMOUSE_BTN_AUX1
:
652 case wxMOUSE_BTN_AUX2
:
657 // return true if was a button up event
658 bool wxMouseEvent::ButtonUp(int but
) const
663 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
666 case wxMOUSE_BTN_ANY
:
667 return (LeftUp() || MiddleUp() || RightUp() ||
668 Aux1Up() || Aux2Up());
670 case wxMOUSE_BTN_LEFT
:
673 case wxMOUSE_BTN_MIDDLE
:
676 case wxMOUSE_BTN_RIGHT
:
679 case wxMOUSE_BTN_AUX1
:
682 case wxMOUSE_BTN_AUX2
:
687 // return true if the given button is currently changing state
688 bool wxMouseEvent::Button(int but
) const
693 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
696 case wxMOUSE_BTN_ANY
:
697 return ButtonUp(wxMOUSE_BTN_ANY
) ||
698 ButtonDown(wxMOUSE_BTN_ANY
) ||
699 ButtonDClick(wxMOUSE_BTN_ANY
);
701 case wxMOUSE_BTN_LEFT
:
702 return LeftDown() || LeftUp() || LeftDClick();
704 case wxMOUSE_BTN_MIDDLE
:
705 return MiddleDown() || MiddleUp() || MiddleDClick();
707 case wxMOUSE_BTN_RIGHT
:
708 return RightDown() || RightUp() || RightDClick();
710 case wxMOUSE_BTN_AUX1
:
711 return Aux1Down() || Aux1Up() || Aux1DClick();
713 case wxMOUSE_BTN_AUX2
:
714 return Aux2Down() || Aux2Up() || Aux2DClick();
718 int wxMouseEvent::GetButton() const
720 for ( int i
= 1; i
< wxMOUSE_BTN_MAX
; i
++ )
728 return wxMOUSE_BTN_NONE
;
731 // Find the logical position of the event given the DC
732 wxPoint
wxMouseEvent::GetLogicalPosition(const wxDC
& dc
) const
734 wxPoint
pt(dc
.DeviceToLogicalX(m_x
), dc
.DeviceToLogicalY(m_y
));
738 // ----------------------------------------------------------------------------
740 // ----------------------------------------------------------------------------
742 wxKeyEvent::wxKeyEvent(wxEventType type
)
745 m_keyCode
= WXK_NONE
;
747 m_uniChar
= WXK_NONE
;
751 m_y
= wxDefaultCoord
;
752 m_hasPosition
= false;
757 wxKeyEvent::wxKeyEvent(const wxKeyEvent
& evt
)
761 DoAssignMembers(evt
);
766 wxKeyEvent::wxKeyEvent(wxEventType eventType
, const wxKeyEvent
& evt
)
770 DoAssignMembers(evt
);
772 m_eventType
= eventType
;
777 void wxKeyEvent::InitPositionIfNecessary() const
782 // We're const because we're called from const Get[XY]() methods but we
783 // need to update the "cached" values.
784 wxKeyEvent
& self
= const_cast<wxKeyEvent
&>(*this);
785 self
.m_hasPosition
= true;
787 // The only position we can possibly associate with the keyboard event on
788 // the platforms where it doesn't carry it already is the mouse position.
789 wxGetMousePosition(&self
.m_x
, &self
.m_y
);
791 // If this event is associated with a window, the position should be in its
792 // client coordinates, but otherwise leave it in screen coordinates as what
794 wxWindow
* const win
= wxDynamicCast(GetEventObject(), wxWindow
);
796 win
->ScreenToClient(&self
.m_x
, &self
.m_y
);
799 wxCoord
wxKeyEvent::GetX() const
801 InitPositionIfNecessary();
806 wxCoord
wxKeyEvent::GetY() const
808 InitPositionIfNecessary();
813 bool wxKeyEvent::IsKeyInCategory(int category
) const
815 switch ( GetKeyCode() )
821 case WXK_NUMPAD_LEFT
:
822 case WXK_NUMPAD_RIGHT
:
824 case WXK_NUMPAD_DOWN
:
825 return (category
& WXK_CATEGORY_ARROW
) != 0;
829 case WXK_NUMPAD_PAGEUP
:
830 case WXK_NUMPAD_PAGEDOWN
:
831 return (category
& WXK_CATEGORY_PAGING
) != 0;
835 case WXK_NUMPAD_HOME
:
837 return (category
& WXK_CATEGORY_JUMP
) != 0;
841 return (category
& WXK_CATEGORY_TAB
) != 0;
845 case WXK_NUMPAD_DELETE
:
846 return (category
& WXK_CATEGORY_CUT
) != 0;
853 // ----------------------------------------------------------------------------
854 // wxWindowCreateEvent
855 // ----------------------------------------------------------------------------
857 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow
*win
)
859 SetEventType(wxEVT_CREATE
);
863 // ----------------------------------------------------------------------------
864 // wxWindowDestroyEvent
865 // ----------------------------------------------------------------------------
867 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow
*win
)
869 SetEventType(wxEVT_DESTROY
);
873 // ----------------------------------------------------------------------------
875 // ----------------------------------------------------------------------------
877 wxChildFocusEvent::wxChildFocusEvent(wxWindow
*win
)
878 : wxCommandEvent(wxEVT_CHILD_FOCUS
)
883 // ----------------------------------------------------------------------------
885 // ----------------------------------------------------------------------------
888 wxHelpEvent::Origin
wxHelpEvent::GuessOrigin(Origin origin
)
890 if ( origin
== Origin_Unknown
)
892 // assume that the event comes from the help button if it's not from
893 // keyboard and that pressing F1 always results in the help event
894 origin
= wxGetKeyState(WXK_F1
) ? Origin_Keyboard
: Origin_HelpButton
;
905 // ----------------------------------------------------------------------------
907 // ----------------------------------------------------------------------------
909 static const int EVENT_TYPE_TABLE_INIT_SIZE
= 31; // Not too big not too small...
911 wxEventHashTable
* wxEventHashTable::sm_first
= NULL
;
913 wxEventHashTable::wxEventHashTable(const wxEventTable
&table
)
917 AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE
);
921 m_next
->m_previous
= this;
925 wxEventHashTable::~wxEventHashTable()
928 m_next
->m_previous
= m_previous
;
930 m_previous
->m_next
= m_next
;
931 if (sm_first
== this)
937 void wxEventHashTable::Clear()
939 for ( size_t i
= 0; i
< m_size
; i
++ )
941 EventTypeTablePointer eTTnode
= m_eventTypeTable
[i
];
945 wxDELETEA(m_eventTypeTable
);
950 #if wxUSE_MEMORY_TRACING
953 void wxEventHashTable::ClearAll()
955 wxEventHashTable
* table
= sm_first
;
959 table
= table
->m_next
;
963 #endif // wxUSE_MEMORY_TRACING
965 bool wxEventHashTable::HandleEvent(wxEvent
&event
, wxEvtHandler
*self
)
970 m_rebuildHash
= false;
973 if (!m_eventTypeTable
)
976 // Find all entries for the given event type.
977 wxEventType eventType
= event
.GetEventType();
978 const EventTypeTablePointer eTTnode
= m_eventTypeTable
[eventType
% m_size
];
979 if (eTTnode
&& eTTnode
->eventType
== eventType
)
981 // Now start the search for an event handler
982 // that can handle an event with the given ID.
983 const wxEventTableEntryPointerArray
&
984 eventEntryTable
= eTTnode
->eventEntryTable
;
986 const size_t count
= eventEntryTable
.GetCount();
987 for (size_t n
= 0; n
< count
; n
++)
989 const wxEventTableEntry
& entry
= *eventEntryTable
[n
];
990 if ( wxEvtHandler::ProcessEventIfMatchesId(entry
, self
, event
) )
998 void wxEventHashTable::InitHashTable()
1000 // Loop over the event tables and all its base tables.
1001 const wxEventTable
*table
= &m_table
;
1004 // Retrieve all valid event handler entries
1005 const wxEventTableEntry
*entry
= table
->entries
;
1006 while (entry
->m_fn
!= 0)
1008 // Add the event entry in the Hash.
1014 table
= table
->baseTable
;
1017 // Let's free some memory.
1019 for(i
= 0; i
< m_size
; i
++)
1021 EventTypeTablePointer eTTnode
= m_eventTypeTable
[i
];
1024 eTTnode
->eventEntryTable
.Shrink();
1029 void wxEventHashTable::AddEntry(const wxEventTableEntry
&entry
)
1031 // This might happen 'accidentally' as the app is exiting
1032 if (!m_eventTypeTable
)
1035 EventTypeTablePointer
*peTTnode
= &m_eventTypeTable
[entry
.m_eventType
% m_size
];
1036 EventTypeTablePointer eTTnode
= *peTTnode
;
1040 if (eTTnode
->eventType
!= entry
.m_eventType
)
1042 // Resize the table!
1043 GrowEventTypeTable();
1044 // Try again to add it.
1051 eTTnode
= new EventTypeTable
;
1052 eTTnode
->eventType
= entry
.m_eventType
;
1053 *peTTnode
= eTTnode
;
1056 // Fill all hash entries between entry.m_id and entry.m_lastId...
1057 eTTnode
->eventEntryTable
.Add(&entry
);
1060 void wxEventHashTable::AllocEventTypeTable(size_t size
)
1062 m_eventTypeTable
= new EventTypeTablePointer
[size
];
1063 memset((void *)m_eventTypeTable
, 0, sizeof(EventTypeTablePointer
)*size
);
1067 void wxEventHashTable::GrowEventTypeTable()
1069 size_t oldSize
= m_size
;
1070 EventTypeTablePointer
*oldEventTypeTable
= m_eventTypeTable
;
1072 // TODO: Search the most optimal grow sequence
1073 AllocEventTypeTable(/* GetNextPrime(oldSize) */oldSize
*2+1);
1075 for ( size_t i
= 0; i
< oldSize
; /* */ )
1077 EventTypeTablePointer eTToldNode
= oldEventTypeTable
[i
];
1080 EventTypeTablePointer
*peTTnode
= &m_eventTypeTable
[eTToldNode
->eventType
% m_size
];
1081 EventTypeTablePointer eTTnode
= *peTTnode
;
1083 // Check for collision, we don't want any.
1086 GrowEventTypeTable();
1087 continue; // Don't increment the counter,
1088 // as we still need to add this element.
1092 // Get the old value and put it in the new table.
1093 *peTTnode
= oldEventTypeTable
[i
];
1100 delete[] oldEventTypeTable
;
1103 // ----------------------------------------------------------------------------
1105 // ----------------------------------------------------------------------------
1107 wxEvtHandler::wxEvtHandler()
1109 m_nextHandler
= NULL
;
1110 m_previousHandler
= NULL
;
1112 m_dynamicEvents
= NULL
;
1113 m_pendingEvents
= NULL
;
1115 // no client data (yet)
1116 m_clientData
= NULL
;
1117 m_clientDataType
= wxClientData_None
;
1120 wxEvtHandler::~wxEvtHandler()
1124 if (m_dynamicEvents
)
1126 for ( wxList::iterator it
= m_dynamicEvents
->begin(),
1127 end
= m_dynamicEvents
->end();
1131 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)*it
;
1133 // Remove ourselves from sink destructor notifications
1134 // (this has usually been done, in wxTrackable destructor)
1135 wxEvtHandler
*eventSink
= entry
->m_fn
->GetEvtHandler();
1138 wxEventConnectionRef
* const
1139 evtConnRef
= FindRefInTrackerList(eventSink
);
1142 eventSink
->RemoveNode(evtConnRef
);
1147 delete entry
->m_callbackUserData
;
1150 delete m_dynamicEvents
;
1153 // Remove us from the list of the pending events if necessary.
1155 wxTheApp
->RemovePendingEventHandler(this);
1157 DeletePendingEvents();
1159 // we only delete object data, not untyped
1160 if ( m_clientDataType
== wxClientData_Object
)
1161 delete m_clientObject
;
1164 void wxEvtHandler::Unlink()
1166 // this event handler must take itself out of the chain of handlers:
1168 if (m_previousHandler
)
1169 m_previousHandler
->SetNextHandler(m_nextHandler
);
1172 m_nextHandler
->SetPreviousHandler(m_previousHandler
);
1174 m_nextHandler
= NULL
;
1175 m_previousHandler
= NULL
;
1178 bool wxEvtHandler::IsUnlinked() const
1180 return m_previousHandler
== NULL
&&
1181 m_nextHandler
== NULL
;
1184 wxEventFilter
* wxEvtHandler::ms_filterList
= NULL
;
1186 /* static */ void wxEvtHandler::AddFilter(wxEventFilter
* filter
)
1188 wxCHECK_RET( filter
, "NULL filter" );
1190 filter
->m_next
= ms_filterList
;
1191 ms_filterList
= filter
;
1194 /* static */ void wxEvtHandler::RemoveFilter(wxEventFilter
* filter
)
1196 wxEventFilter
* prev
= NULL
;
1197 for ( wxEventFilter
* f
= ms_filterList
; f
; f
= f
->m_next
)
1201 // Set the previous list element or the list head to the next
1204 prev
->m_next
= f
->m_next
;
1206 ms_filterList
= f
->m_next
;
1208 // Also reset the next pointer in the filter itself just to avoid
1209 // having possibly dangling pointers, even though it's not strictly
1213 // Skip the assert below.
1220 wxFAIL_MSG( "Filter not found" );
1225 bool wxEvtHandler::ProcessThreadEvent(const wxEvent
& event
)
1227 // check that we are really in a child thread
1228 wxASSERT_MSG( !wxThread::IsMain(),
1229 wxT("use ProcessEvent() in main thread") );
1231 AddPendingEvent(event
);
1236 #endif // wxUSE_THREADS
1238 void wxEvtHandler::QueueEvent(wxEvent
*event
)
1240 wxCHECK_RET( event
, "NULL event can't be posted" );
1244 // we need an event loop which manages the list of event handlers with
1245 // pending events... cannot proceed without it!
1246 wxLogDebug("No application object! Cannot queue this event!");
1248 // anyway delete the given event to avoid memory leaks
1254 // 1) Add this event to our list of pending events
1255 wxENTER_CRIT_SECT( m_pendingEventsLock
);
1257 if ( !m_pendingEvents
)
1258 m_pendingEvents
= new wxList
;
1260 m_pendingEvents
->Append(event
);
1262 // 2) Add this event handler to list of event handlers that
1263 // have pending events.
1265 wxTheApp
->AppendPendingEventHandler(this);
1267 // only release m_pendingEventsLock now because otherwise there is a race
1268 // condition as described in the ticket #9093: we could process the event
1269 // just added to m_pendingEvents in our ProcessPendingEvents() below before
1270 // we had time to append this pointer to wxHandlersWithPendingEvents list; thus
1271 // breaking the invariant that a handler should be in the list iff it has
1272 // any pending events to process
1273 wxLEAVE_CRIT_SECT( m_pendingEventsLock
);
1275 // 3) Inform the system that new pending events are somewhere,
1276 // and that these should be processed in idle time.
1280 void wxEvtHandler::DeletePendingEvents()
1282 if (m_pendingEvents
)
1283 m_pendingEvents
->DeleteContents(true);
1284 wxDELETE(m_pendingEvents
);
1287 void wxEvtHandler::ProcessPendingEvents()
1291 // we need an event loop which manages the list of event handlers with
1292 // pending events... cannot proceed without it!
1293 wxLogDebug("No application object! Cannot process pending events!");
1297 // we need to process only a single pending event in this call because
1298 // each call to ProcessEvent() could result in the destruction of this
1299 // same event handler (see the comment at the end of this function)
1301 wxENTER_CRIT_SECT( m_pendingEventsLock
);
1303 // this method is only called by wxApp if this handler does have
1305 wxCHECK_RET( m_pendingEvents
&& !m_pendingEvents
->IsEmpty(),
1306 "should have pending events if called" );
1308 wxList::compatibility_iterator node
= m_pendingEvents
->GetFirst();
1309 wxEvent
* pEvent
= static_cast<wxEvent
*>(node
->GetData());
1311 // find the first event which can be processed now:
1312 wxEventLoopBase
* evtLoop
= wxEventLoopBase::GetActive();
1313 if (evtLoop
&& evtLoop
->IsYielding())
1315 while (node
&& pEvent
&& !evtLoop
->IsEventAllowedInsideYield(pEvent
->GetEventCategory()))
1317 node
= node
->GetNext();
1318 pEvent
= node
? static_cast<wxEvent
*>(node
->GetData()) : NULL
;
1323 // all our events are NOT processable now... signal this:
1324 wxTheApp
->DelayPendingEventHandler(this);
1326 // see the comment at the beginning of evtloop.h header for the
1327 // logic behind YieldFor() and behind DelayPendingEventHandler()
1329 wxLEAVE_CRIT_SECT( m_pendingEventsLock
);
1335 wxEventPtr
event(pEvent
);
1337 // it's important we remove event from list before processing it, else a
1338 // nested event loop, for example from a modal dialog, might process the
1339 // same event again.
1340 m_pendingEvents
->Erase(node
);
1342 if ( m_pendingEvents
->IsEmpty() )
1344 // if there are no more pending events left, we don't need to
1345 // stay in this list
1346 wxTheApp
->RemovePendingEventHandler(this);
1349 wxLEAVE_CRIT_SECT( m_pendingEventsLock
);
1351 ProcessEvent(*event
);
1353 // careful: this object could have been deleted by the event handler
1354 // executed by the above ProcessEvent() call, so we can't access any fields
1355 // of this object any more
1359 bool wxEvtHandler::ProcessEventIfMatchesId(const wxEventTableEntryBase
& entry
,
1360 wxEvtHandler
*handler
,
1363 int tableId1
= entry
.m_id
,
1364 tableId2
= entry
.m_lastId
;
1366 // match only if the event type is the same and the id is either -1 in
1367 // the event table (meaning "any") or the event id matches the id
1368 // specified in the event table either exactly or by falling into
1369 // range between first and last
1370 if ((tableId1
== wxID_ANY
) ||
1371 (tableId2
== wxID_ANY
&& tableId1
== event
.GetId()) ||
1372 (tableId2
!= wxID_ANY
&&
1373 (event
.GetId() >= tableId1
&& event
.GetId() <= tableId2
)))
1376 event
.m_callbackUserData
= entry
.m_callbackUserData
;
1378 #if wxUSE_EXCEPTIONS
1381 // call the handler via wxApp method which allows the user to catch
1382 // any exceptions which may be thrown by any handler in the program
1384 wxTheApp
->CallEventHandler(handler
, *entry
.m_fn
, event
);
1387 #endif // wxUSE_EXCEPTIONS
1389 (*entry
.m_fn
)(handler
, event
);
1392 if (!event
.GetSkipped())
1399 bool wxEvtHandler::DoTryApp(wxEvent
& event
)
1401 if ( wxTheApp
&& (this != wxTheApp
) )
1403 // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
1404 // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
1405 // processed appropriately via SearchEventTable.
1406 if ( event
.GetEventType() != wxEVT_IDLE
)
1408 if ( wxTheApp
->ProcessEvent(event
) )
1416 bool wxEvtHandler::TryBefore(wxEvent
& event
)
1418 #if WXWIN_COMPATIBILITY_2_8
1419 // call the old virtual function to keep the code overriding it working
1420 return TryValidator(event
);
1427 bool wxEvtHandler::TryAfter(wxEvent
& event
)
1429 // We only want to pass the window to the application object once even if
1430 // there are several chained handlers. Ensure that this is what happens by
1431 // only calling DoTryApp() if there is no next handler (which would do it).
1433 // Notice that, unlike simply calling TryAfter() on the last handler in the
1434 // chain only from ProcessEvent(), this also works with wxWindow object in
1435 // the middle of the chain: its overridden TryAfter() will still be called
1436 // and propagate the event upwards the window hierarchy even if it's not
1437 // the last one in the chain (which, admittedly, shouldn't happen often).
1438 if ( GetNextHandler() )
1439 return GetNextHandler()->TryAfter(event
);
1441 // If this event is going to be processed in another handler next, don't
1442 // pass it to wxTheApp now, it will be done from TryAfter() of this other
1444 if ( event
.WillBeProcessedAgain() )
1447 #if WXWIN_COMPATIBILITY_2_8
1448 // as above, call the old virtual function for compatibility
1449 return TryParent(event
);
1451 return DoTryApp(event
);
1455 bool wxEvtHandler::ProcessEvent(wxEvent
& event
)
1457 // The very first thing we do is to allow any registered filters to hook
1458 // into event processing in order to globally pre-process all events.
1460 // Note that we should only do it if we're the first event handler called
1461 // to avoid calling FilterEvent() multiple times as the event goes through
1462 // the event handler chain and possibly upwards the window hierarchy.
1463 if ( !event
.WasProcessed() )
1465 for ( wxEventFilter
* f
= ms_filterList
; f
; f
= f
->m_next
)
1467 int rc
= f
->FilterEvent(event
);
1468 if ( rc
!= wxEventFilter::Event_Skip
)
1470 wxASSERT_MSG( rc
== wxEventFilter::Event_Ignore
||
1471 rc
== wxEventFilter::Event_Processed
,
1472 "unexpected FilterEvent() return value" );
1474 return rc
!= wxEventFilter::Event_Ignore
;
1476 //else: proceed normally
1480 // Short circuit the event processing logic if we're requested to process
1481 // this event in this handler only, see DoTryChain() for more details.
1482 if ( event
.ShouldProcessOnlyIn(this) )
1483 return TryBeforeAndHere(event
);
1486 // Try to process the event in this handler itself.
1487 if ( ProcessEventLocally(event
) )
1489 // It is possible that DoTryChain() called from ProcessEventLocally()
1490 // returned true but the event was not really processed: this happens
1491 // if a custom handler ignores the request to process the event in this
1492 // handler only and in this case we should skip the post processing
1493 // done in TryAfter() but still return the correct value ourselves to
1494 // indicate whether we did or did not find a handler for this event.
1495 return !event
.GetSkipped();
1498 // If we still didn't find a handler, propagate the event upwards the
1499 // window chain and/or to the application object.
1500 if ( TryAfter(event
) )
1504 // No handler found anywhere, bail out.
1508 bool wxEvtHandler::ProcessEventLocally(wxEvent
& event
)
1510 // Try the hooks which should be called before our own handlers and this
1511 // handler itself first. Notice that we should not call ProcessEvent() on
1512 // this one as we're already called from it, which explains why we do it
1513 // here and not in DoTryChain()
1514 return TryBeforeAndHere(event
) || DoTryChain(event
);
1517 bool wxEvtHandler::DoTryChain(wxEvent
& event
)
1519 for ( wxEvtHandler
*h
= GetNextHandler(); h
; h
= h
->GetNextHandler() )
1521 // We need to process this event at the level of this handler only
1522 // right now, the pre-/post-processing was either already done by
1523 // ProcessEvent() from which we were called or will be done by it when
1526 // However we must call ProcessEvent() and not TryHereOnly() because the
1527 // existing code (including some in wxWidgets itself) expects the
1528 // overridden ProcessEvent() in its custom event handlers pushed on a
1529 // window to be called.
1531 // So we must call ProcessEvent() but it must not do what it usually
1532 // does. To resolve this paradox we set up a special flag inside the
1533 // object itself to let ProcessEvent() know that it shouldn't do any
1534 // pre/post-processing for this event if it gets it. Note that this
1535 // only applies to this handler, if the event is passed to another one
1536 // by explicitly calling its ProcessEvent(), pre/post-processing should
1537 // be done as usual.
1539 // Final complication is that if the implementation of ProcessEvent()
1540 // called wxEvent::DidntHonourProcessOnlyIn() (as the gross hack that
1541 // is wxScrollHelperEvtHandler::ProcessEvent() does) and ignored our
1542 // request to process event in this handler only, we have to compensate
1543 // for it by not processing the event further because this was already
1544 // done by that rogue event handler.
1545 wxEventProcessInHandlerOnly
processInHandlerOnly(event
, h
);
1546 if ( h
->ProcessEvent(event
) )
1548 // Make sure "skipped" flag is not set as the event was really
1549 // processed in this case. Normally it shouldn't be set anyhow but
1550 // make sure just in case the user code does something strange.
1556 if ( !event
.ShouldProcessOnlyIn(h
) )
1558 // Still return true to indicate that no further processing should
1559 // be undertaken but ensure that "skipped" flag is set so that the
1560 // caller knows that the event was not really processed.
1570 bool wxEvtHandler::TryHereOnly(wxEvent
& event
)
1572 // If the event handler is disabled it doesn't process any events
1573 if ( !GetEvtHandlerEnabled() )
1576 // Handle per-instance dynamic event tables first
1577 if ( m_dynamicEvents
&& SearchDynamicEventTable(event
) )
1580 // Then static per-class event tables
1581 if ( GetEventHashTable().HandleEvent(event
, this) )
1584 #ifdef wxHAS_CALL_AFTER
1585 // There is an implicit entry for async method calls processing in every
1587 if ( event
.GetEventType() == wxEVT_ASYNC_METHOD_CALL
&&
1588 event
.GetEventObject() == this )
1590 static_cast<wxAsyncMethodCallEvent
&>(event
).Execute();
1593 #endif // wxHAS_CALL_AFTER
1595 // We don't have a handler for this event.
1599 bool wxEvtHandler::SafelyProcessEvent(wxEvent
& event
)
1601 #if wxUSE_EXCEPTIONS
1605 return ProcessEvent(event
);
1606 #if wxUSE_EXCEPTIONS
1610 // notice that we do it in 2 steps to avoid warnings about possibly
1611 // uninitialized loop variable from some versions of g++ which are not
1612 // smart enough to figure out that GetActive() doesn't throw and so
1613 // that loop will always be initialized
1614 wxEventLoopBase
*loop
= NULL
;
1617 loop
= wxEventLoopBase::GetActive();
1619 if ( !wxTheApp
|| !wxTheApp
->OnExceptionInMainLoop() )
1624 //else: continue running current event loop
1630 // OnExceptionInMainLoop() threw, possibly rethrowing the same
1631 // exception again: very good, but we still need Exit() to
1638 #endif // wxUSE_EXCEPTIONS
1641 bool wxEvtHandler::SearchEventTable(wxEventTable
& table
, wxEvent
& event
)
1643 const wxEventType eventType
= event
.GetEventType();
1644 for ( int i
= 0; table
.entries
[i
].m_fn
!= 0; i
++ )
1646 const wxEventTableEntry
& entry
= table
.entries
[i
];
1647 if ( eventType
== entry
.m_eventType
)
1649 if ( ProcessEventIfMatchesId(entry
, this, event
) )
1657 void wxEvtHandler::DoBind(int id
,
1659 wxEventType eventType
,
1660 wxEventFunctor
*func
,
1663 wxDynamicEventTableEntry
*entry
=
1664 new wxDynamicEventTableEntry(eventType
, id
, lastId
, func
, userData
);
1666 if (!m_dynamicEvents
)
1667 m_dynamicEvents
= new wxList
;
1669 // Insert at the front of the list so most recent additions are found first
1670 m_dynamicEvents
->Insert( (wxObject
*) entry
);
1672 // Make sure we get to know when a sink is destroyed
1673 wxEvtHandler
*eventSink
= func
->GetEvtHandler();
1674 if ( eventSink
&& eventSink
!= this )
1676 wxEventConnectionRef
*evtConnRef
= FindRefInTrackerList(eventSink
);
1678 evtConnRef
->IncRef( );
1680 new wxEventConnectionRef(this, eventSink
);
1685 wxEvtHandler::DoUnbind(int id
,
1687 wxEventType eventType
,
1688 const wxEventFunctor
& func
,
1691 if (!m_dynamicEvents
)
1694 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1697 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1699 if ((entry
->m_id
== id
) &&
1700 ((entry
->m_lastId
== lastId
) || (lastId
== wxID_ANY
)) &&
1701 ((entry
->m_eventType
== eventType
) || (eventType
== wxEVT_NULL
)) &&
1702 entry
->m_fn
->IsMatching(func
) &&
1703 ((entry
->m_callbackUserData
== userData
) || !userData
))
1705 // Remove connection from tracker node (wxEventConnectionRef)
1706 wxEvtHandler
*eventSink
= entry
->m_fn
->GetEvtHandler();
1707 if ( eventSink
&& eventSink
!= this )
1709 wxEventConnectionRef
*evtConnRef
= FindRefInTrackerList(eventSink
);
1711 evtConnRef
->DecRef();
1714 delete entry
->m_callbackUserData
;
1715 m_dynamicEvents
->Erase( node
);
1719 node
= node
->GetNext();
1724 bool wxEvtHandler::SearchDynamicEventTable( wxEvent
& event
)
1726 wxCHECK_MSG( m_dynamicEvents
, false,
1727 wxT("caller should check that we have dynamic events") );
1729 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1732 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1734 // get next node before (maybe) calling the event handler as it could
1735 // call Disconnect() invalidating the current node
1736 node
= node
->GetNext();
1738 if ( event
.GetEventType() == entry
->m_eventType
)
1740 wxEvtHandler
*handler
= entry
->m_fn
->GetEvtHandler();
1743 if ( ProcessEventIfMatchesId(*entry
, handler
, event
) )
1751 void wxEvtHandler::DoSetClientObject( wxClientData
*data
)
1753 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1754 wxT("can't have both object and void client data") );
1756 if ( m_clientObject
)
1757 delete m_clientObject
;
1759 m_clientObject
= data
;
1760 m_clientDataType
= wxClientData_Object
;
1763 wxClientData
*wxEvtHandler::DoGetClientObject() const
1765 // it's not an error to call GetClientObject() on a window which doesn't
1766 // have client data at all - NULL will be returned
1767 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1768 wxT("this window doesn't have object client data") );
1770 return m_clientObject
;
1773 void wxEvtHandler::DoSetClientData( void *data
)
1775 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1776 wxT("can't have both object and void client data") );
1778 m_clientData
= data
;
1779 m_clientDataType
= wxClientData_Void
;
1782 void *wxEvtHandler::DoGetClientData() const
1784 // it's not an error to call GetClientData() on a window which doesn't have
1785 // client data at all - NULL will be returned
1786 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1787 wxT("this window doesn't have void client data") );
1789 return m_clientData
;
1792 // A helper to find an wxEventConnectionRef object
1793 wxEventConnectionRef
*
1794 wxEvtHandler::FindRefInTrackerList(wxEvtHandler
*eventSink
)
1796 for ( wxTrackerNode
*node
= eventSink
->GetFirst(); node
; node
= node
->m_nxt
)
1798 // we only want wxEventConnectionRef nodes here
1799 wxEventConnectionRef
*evtConnRef
= node
->ToEventConnection();
1800 if ( evtConnRef
&& evtConnRef
->m_src
== this )
1802 wxASSERT( evtConnRef
->m_sink
==eventSink
);
1810 void wxEvtHandler::OnSinkDestroyed( wxEvtHandler
*sink
)
1812 wxASSERT(m_dynamicEvents
);
1814 // remove all connections with this sink
1815 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst(), node_nxt
;
1818 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1819 node_nxt
= node
->GetNext();
1821 if ( entry
->m_fn
->GetEvtHandler() == sink
)
1823 delete entry
->m_callbackUserData
;
1824 m_dynamicEvents
->Erase( node
);
1831 #endif // wxUSE_BASE
1835 // Find a window with the focus, that is also a descendant of the given window.
1836 // This is used to determine the window to initially send commands to.
1837 wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
)
1839 // Process events starting with the window with the focus, if any.
1840 wxWindow
* focusWin
= wxWindow::FindFocus();
1841 wxWindow
* win
= focusWin
;
1843 // Check if this is a descendant of this frame.
1844 // If not, win will be set to NULL.
1847 if (win
== ancestor
)
1850 win
= win
->GetParent();
1858 // ----------------------------------------------------------------------------
1860 // ----------------------------------------------------------------------------
1862 wxEventBlocker::wxEventBlocker(wxWindow
*win
, wxEventType type
)
1864 wxCHECK_RET(win
, wxT("Null window given to wxEventBlocker"));
1869 m_window
->PushEventHandler(this);
1872 wxEventBlocker::~wxEventBlocker()
1874 wxEvtHandler
*popped
= m_window
->PopEventHandler(false);
1875 wxCHECK_RET(popped
== this,
1876 wxT("Don't push other event handlers into a window managed by wxEventBlocker!"));
1879 bool wxEventBlocker::ProcessEvent(wxEvent
& event
)
1881 // should this event be blocked?
1882 for ( size_t i
= 0; i
< m_eventsToBlock
.size(); i
++ )
1884 wxEventType t
= (wxEventType
)m_eventsToBlock
[i
];
1885 if ( t
== wxEVT_ANY
|| t
== event
.GetEventType() )
1886 return true; // yes, it should: mark this event as processed