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_BUTTON
, wxCommandEvent
);
168 wxDEFINE_EVENT( wxEVT_CHECKBOX
, wxCommandEvent
);
169 wxDEFINE_EVENT( wxEVT_CHOICE
, wxCommandEvent
);
170 wxDEFINE_EVENT( wxEVT_LISTBOX
, wxCommandEvent
);
171 wxDEFINE_EVENT( wxEVT_LISTBOX_DCLICK
, wxCommandEvent
);
172 wxDEFINE_EVENT( wxEVT_CHECKLISTBOX
, wxCommandEvent
);
173 wxDEFINE_EVENT( wxEVT_MENU
, wxCommandEvent
);
174 wxDEFINE_EVENT( wxEVT_SLIDER
, wxCommandEvent
);
175 wxDEFINE_EVENT( wxEVT_RADIOBOX
, wxCommandEvent
);
176 wxDEFINE_EVENT( wxEVT_RADIOBUTTON
, wxCommandEvent
);
177 wxDEFINE_EVENT( wxEVT_SCROLLBAR
, wxCommandEvent
);
178 wxDEFINE_EVENT( wxEVT_VLBOX
, wxCommandEvent
);
179 wxDEFINE_EVENT( wxEVT_COMBOBOX
, wxCommandEvent
);
180 wxDEFINE_EVENT( wxEVT_TOOL_RCLICKED
, wxCommandEvent
);
181 wxDEFINE_EVENT( wxEVT_TOOL_ENTER
, wxCommandEvent
);
182 wxDEFINE_EVENT( wxEVT_SPINCTRL
, wxCommandEvent
);
183 wxDEFINE_EVENT( wxEVT_SPINCTRLDOUBLE
, wxCommandEvent
);
184 wxDEFINE_EVENT( wxEVT_TOOL_DROPDOWN
, wxCommandEvent
);
185 wxDEFINE_EVENT( wxEVT_COMBOBOX_DROPDOWN
, wxCommandEvent
);
186 wxDEFINE_EVENT( wxEVT_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_TEXT_COPY
, wxClipboardTextEvent
);
303 wxDEFINE_EVENT( wxEVT_TEXT_CUT
, wxClipboardTextEvent
);
304 wxDEFINE_EVENT( wxEVT_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;
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_skipped(src
.m_skipped
)
386 , m_isCommandEvent(src
.m_isCommandEvent
)
387 , m_wasProcessed(false)
388 , m_willBeProcessedAgain(false)
392 wxEvent
& wxEvent::operator=(const wxEvent
& src
)
394 wxObject::operator=(src
);
396 m_eventObject
= src
.m_eventObject
;
397 m_eventType
= src
.m_eventType
;
398 m_timeStamp
= src
.m_timeStamp
;
400 m_callbackUserData
= src
.m_callbackUserData
;
401 m_handlerToProcessOnlyIn
= NULL
;
402 m_propagationLevel
= src
.m_propagationLevel
;
403 m_skipped
= src
.m_skipped
;
404 m_isCommandEvent
= src
.m_isCommandEvent
;
406 // don't change m_wasProcessed
408 // While the original again could be passed to another handler, this one
409 // isn't going to be processed anywhere else by default.
410 m_willBeProcessedAgain
= false;
419 // ----------------------------------------------------------------------------
421 // ----------------------------------------------------------------------------
423 wxCommandEvent::wxCommandEvent(wxEventType commandType
, int theId
)
424 : wxEvent(theId
, commandType
)
427 m_clientObject
= NULL
;
428 m_isCommandEvent
= true;
430 // the command events are propagated upwards by default
431 m_propagationLevel
= wxEVENT_PROPAGATE_MAX
;
434 wxString
wxCommandEvent::GetString() const
436 if (m_eventType
!= wxEVT_TEXT
|| !m_eventObject
)
443 wxTextCtrl
*txt
= wxDynamicCast(m_eventObject
, wxTextCtrl
);
445 return txt
->GetValue();
447 #endif // wxUSE_TEXTCTRL
452 // ----------------------------------------------------------------------------
454 // ----------------------------------------------------------------------------
457 wxLongLong
wxUpdateUIEvent::sm_lastUpdate
= 0;
460 long wxUpdateUIEvent::sm_updateInterval
= 0;
462 wxUpdateUIMode
wxUpdateUIEvent::sm_updateMode
= wxUPDATE_UI_PROCESS_ALL
;
465 bool wxUpdateUIEvent::CanUpdate(wxWindowBase
*win
)
467 // Don't update if we've switched global updating off
468 // and this window doesn't support updates.
470 (GetMode() == wxUPDATE_UI_PROCESS_SPECIFIED
&&
471 ((win
->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES
) == 0)))
474 // Don't update children of the hidden windows: this is useless as any
475 // change to their state won't be seen by the user anyhow. Notice that this
476 // argument doesn't apply to the hidden windows (with visible parent)
477 // themselves as they could be shown by their EVT_UPDATE_UI handler.
478 if ( win
->GetParent() && !win
->GetParent()->IsShownOnScreen() )
481 if (sm_updateInterval
== -1)
484 if (sm_updateInterval
== 0)
487 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
488 wxLongLong now
= wxGetLocalTimeMillis();
489 if (now
> (sm_lastUpdate
+ sm_updateInterval
))
496 // If we don't have wxStopWatch or wxLongLong, we
497 // should err on the safe side and update now anyway.
502 // Reset the update time to provide a delay until the next
503 // time we should update
504 void wxUpdateUIEvent::ResetUpdateTime()
506 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
507 if (sm_updateInterval
> 0)
509 wxLongLong now
= wxGetLocalTimeMillis();
510 if (now
> (sm_lastUpdate
+ sm_updateInterval
))
518 // ----------------------------------------------------------------------------
520 // ----------------------------------------------------------------------------
522 wxScrollEvent::wxScrollEvent(wxEventType commandType
,
526 : wxCommandEvent(commandType
, id
)
528 m_extraLong
= orient
;
532 // ----------------------------------------------------------------------------
534 // ----------------------------------------------------------------------------
536 wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType
,
540 m_eventType
= commandType
;
541 m_extraLong
= orient
;
545 // ----------------------------------------------------------------------------
547 // ----------------------------------------------------------------------------
549 wxMouseEvent::wxMouseEvent(wxEventType commandType
)
551 m_eventType
= commandType
;
557 m_middleDown
= false;
564 m_wheelAxis
= wxMOUSE_WHEEL_VERTICAL
;
567 m_linesPerAction
= 0;
568 m_columnsPerAction
= 0;
571 void wxMouseEvent::Assign(const wxMouseEvent
& event
)
573 wxEvent::operator=(event
);
575 // Borland C++ 5.82 doesn't compile an explicit call to an implicitly
576 // defined operator=() so need to do it this way:
577 *static_cast<wxMouseState
*>(this) = event
;
582 m_leftDown
= event
.m_leftDown
;
583 m_middleDown
= event
.m_middleDown
;
584 m_rightDown
= event
.m_rightDown
;
585 m_aux1Down
= event
.m_aux1Down
;
586 m_aux2Down
= event
.m_aux2Down
;
588 m_wheelRotation
= event
.m_wheelRotation
;
589 m_wheelDelta
= event
.m_wheelDelta
;
590 m_linesPerAction
= event
.m_linesPerAction
;
591 m_columnsPerAction
= event
.m_columnsPerAction
;
592 m_wheelAxis
= event
.m_wheelAxis
;
595 // return true if was a button dclick event
596 bool wxMouseEvent::ButtonDClick(int but
) const
601 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
604 case wxMOUSE_BTN_ANY
:
605 return (LeftDClick() || MiddleDClick() || RightDClick() ||
606 Aux1DClick() || Aux2DClick());
608 case wxMOUSE_BTN_LEFT
:
611 case wxMOUSE_BTN_MIDDLE
:
612 return MiddleDClick();
614 case wxMOUSE_BTN_RIGHT
:
615 return RightDClick();
617 case wxMOUSE_BTN_AUX1
:
620 case wxMOUSE_BTN_AUX2
:
625 // return true if was a button down event
626 bool wxMouseEvent::ButtonDown(int but
) const
631 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
634 case wxMOUSE_BTN_ANY
:
635 return (LeftDown() || MiddleDown() || RightDown() ||
636 Aux1Down() || Aux2Down());
638 case wxMOUSE_BTN_LEFT
:
641 case wxMOUSE_BTN_MIDDLE
:
644 case wxMOUSE_BTN_RIGHT
:
647 case wxMOUSE_BTN_AUX1
:
650 case wxMOUSE_BTN_AUX2
:
655 // return true if was a button up event
656 bool wxMouseEvent::ButtonUp(int but
) const
661 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
664 case wxMOUSE_BTN_ANY
:
665 return (LeftUp() || MiddleUp() || RightUp() ||
666 Aux1Up() || Aux2Up());
668 case wxMOUSE_BTN_LEFT
:
671 case wxMOUSE_BTN_MIDDLE
:
674 case wxMOUSE_BTN_RIGHT
:
677 case wxMOUSE_BTN_AUX1
:
680 case wxMOUSE_BTN_AUX2
:
685 // return true if the given button is currently changing state
686 bool wxMouseEvent::Button(int but
) const
691 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
694 case wxMOUSE_BTN_ANY
:
695 return ButtonUp(wxMOUSE_BTN_ANY
) ||
696 ButtonDown(wxMOUSE_BTN_ANY
) ||
697 ButtonDClick(wxMOUSE_BTN_ANY
);
699 case wxMOUSE_BTN_LEFT
:
700 return LeftDown() || LeftUp() || LeftDClick();
702 case wxMOUSE_BTN_MIDDLE
:
703 return MiddleDown() || MiddleUp() || MiddleDClick();
705 case wxMOUSE_BTN_RIGHT
:
706 return RightDown() || RightUp() || RightDClick();
708 case wxMOUSE_BTN_AUX1
:
709 return Aux1Down() || Aux1Up() || Aux1DClick();
711 case wxMOUSE_BTN_AUX2
:
712 return Aux2Down() || Aux2Up() || Aux2DClick();
716 int wxMouseEvent::GetButton() const
718 for ( int i
= 1; i
< wxMOUSE_BTN_MAX
; i
++ )
726 return wxMOUSE_BTN_NONE
;
729 // Find the logical position of the event given the DC
730 wxPoint
wxMouseEvent::GetLogicalPosition(const wxDC
& dc
) const
732 wxPoint
pt(dc
.DeviceToLogicalX(m_x
), dc
.DeviceToLogicalY(m_y
));
736 // ----------------------------------------------------------------------------
738 // ----------------------------------------------------------------------------
740 wxKeyEvent::wxKeyEvent(wxEventType type
)
743 m_keyCode
= WXK_NONE
;
745 m_uniChar
= WXK_NONE
;
749 m_y
= wxDefaultCoord
;
750 m_hasPosition
= false;
755 wxKeyEvent::wxKeyEvent(const wxKeyEvent
& evt
)
759 DoAssignMembers(evt
);
764 wxKeyEvent::wxKeyEvent(wxEventType eventType
, const wxKeyEvent
& evt
)
768 DoAssignMembers(evt
);
770 m_eventType
= eventType
;
775 void wxKeyEvent::InitPositionIfNecessary() const
780 // We're const because we're called from const Get[XY]() methods but we
781 // need to update the "cached" values.
782 wxKeyEvent
& self
= const_cast<wxKeyEvent
&>(*this);
783 self
.m_hasPosition
= true;
785 // The only position we can possibly associate with the keyboard event on
786 // the platforms where it doesn't carry it already is the mouse position.
787 wxGetMousePosition(&self
.m_x
, &self
.m_y
);
789 // If this event is associated with a window, the position should be in its
790 // client coordinates, but otherwise leave it in screen coordinates as what
792 wxWindow
* const win
= wxDynamicCast(GetEventObject(), wxWindow
);
794 win
->ScreenToClient(&self
.m_x
, &self
.m_y
);
797 wxCoord
wxKeyEvent::GetX() const
799 InitPositionIfNecessary();
804 wxCoord
wxKeyEvent::GetY() const
806 InitPositionIfNecessary();
811 bool wxKeyEvent::IsKeyInCategory(int category
) const
813 switch ( GetKeyCode() )
819 case WXK_NUMPAD_LEFT
:
820 case WXK_NUMPAD_RIGHT
:
822 case WXK_NUMPAD_DOWN
:
823 return (category
& WXK_CATEGORY_ARROW
) != 0;
827 case WXK_NUMPAD_PAGEUP
:
828 case WXK_NUMPAD_PAGEDOWN
:
829 return (category
& WXK_CATEGORY_PAGING
) != 0;
833 case WXK_NUMPAD_HOME
:
835 return (category
& WXK_CATEGORY_JUMP
) != 0;
839 return (category
& WXK_CATEGORY_TAB
) != 0;
843 case WXK_NUMPAD_DELETE
:
844 return (category
& WXK_CATEGORY_CUT
) != 0;
851 // ----------------------------------------------------------------------------
852 // wxWindowCreateEvent
853 // ----------------------------------------------------------------------------
855 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow
*win
)
857 SetEventType(wxEVT_CREATE
);
861 // ----------------------------------------------------------------------------
862 // wxWindowDestroyEvent
863 // ----------------------------------------------------------------------------
865 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow
*win
)
867 SetEventType(wxEVT_DESTROY
);
871 // ----------------------------------------------------------------------------
873 // ----------------------------------------------------------------------------
875 wxChildFocusEvent::wxChildFocusEvent(wxWindow
*win
)
876 : wxCommandEvent(wxEVT_CHILD_FOCUS
)
881 // ----------------------------------------------------------------------------
883 // ----------------------------------------------------------------------------
886 wxHelpEvent::Origin
wxHelpEvent::GuessOrigin(Origin origin
)
888 if ( origin
== Origin_Unknown
)
890 // assume that the event comes from the help button if it's not from
891 // keyboard and that pressing F1 always results in the help event
892 origin
= wxGetKeyState(WXK_F1
) ? Origin_Keyboard
: Origin_HelpButton
;
903 // ----------------------------------------------------------------------------
905 // ----------------------------------------------------------------------------
907 static const int EVENT_TYPE_TABLE_INIT_SIZE
= 31; // Not too big not too small...
909 wxEventHashTable
* wxEventHashTable::sm_first
= NULL
;
911 wxEventHashTable::wxEventHashTable(const wxEventTable
&table
)
915 AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE
);
919 m_next
->m_previous
= this;
923 wxEventHashTable::~wxEventHashTable()
926 m_next
->m_previous
= m_previous
;
928 m_previous
->m_next
= m_next
;
929 if (sm_first
== this)
935 void wxEventHashTable::Clear()
937 for ( size_t i
= 0; i
< m_size
; i
++ )
939 EventTypeTablePointer eTTnode
= m_eventTypeTable
[i
];
943 wxDELETEA(m_eventTypeTable
);
948 #if wxUSE_MEMORY_TRACING
951 void wxEventHashTable::ClearAll()
953 wxEventHashTable
* table
= sm_first
;
957 table
= table
->m_next
;
961 #endif // wxUSE_MEMORY_TRACING
963 bool wxEventHashTable::HandleEvent(wxEvent
&event
, wxEvtHandler
*self
)
968 m_rebuildHash
= false;
971 if (!m_eventTypeTable
)
974 // Find all entries for the given event type.
975 wxEventType eventType
= event
.GetEventType();
976 const EventTypeTablePointer eTTnode
= m_eventTypeTable
[eventType
% m_size
];
977 if (eTTnode
&& eTTnode
->eventType
== eventType
)
979 // Now start the search for an event handler
980 // that can handle an event with the given ID.
981 const wxEventTableEntryPointerArray
&
982 eventEntryTable
= eTTnode
->eventEntryTable
;
984 const size_t count
= eventEntryTable
.GetCount();
985 for (size_t n
= 0; n
< count
; n
++)
987 const wxEventTableEntry
& entry
= *eventEntryTable
[n
];
988 if ( wxEvtHandler::ProcessEventIfMatchesId(entry
, self
, event
) )
996 void wxEventHashTable::InitHashTable()
998 // Loop over the event tables and all its base tables.
999 const wxEventTable
*table
= &m_table
;
1002 // Retrieve all valid event handler entries
1003 const wxEventTableEntry
*entry
= table
->entries
;
1004 while (entry
->m_fn
!= 0)
1006 // Add the event entry in the Hash.
1012 table
= table
->baseTable
;
1015 // Let's free some memory.
1017 for(i
= 0; i
< m_size
; i
++)
1019 EventTypeTablePointer eTTnode
= m_eventTypeTable
[i
];
1022 eTTnode
->eventEntryTable
.Shrink();
1027 void wxEventHashTable::AddEntry(const wxEventTableEntry
&entry
)
1029 // This might happen 'accidentally' as the app is exiting
1030 if (!m_eventTypeTable
)
1033 EventTypeTablePointer
*peTTnode
= &m_eventTypeTable
[entry
.m_eventType
% m_size
];
1034 EventTypeTablePointer eTTnode
= *peTTnode
;
1038 if (eTTnode
->eventType
!= entry
.m_eventType
)
1040 // Resize the table!
1041 GrowEventTypeTable();
1042 // Try again to add it.
1049 eTTnode
= new EventTypeTable
;
1050 eTTnode
->eventType
= entry
.m_eventType
;
1051 *peTTnode
= eTTnode
;
1054 // Fill all hash entries between entry.m_id and entry.m_lastId...
1055 eTTnode
->eventEntryTable
.Add(&entry
);
1058 void wxEventHashTable::AllocEventTypeTable(size_t size
)
1060 m_eventTypeTable
= new EventTypeTablePointer
[size
];
1061 memset((void *)m_eventTypeTable
, 0, sizeof(EventTypeTablePointer
)*size
);
1065 void wxEventHashTable::GrowEventTypeTable()
1067 size_t oldSize
= m_size
;
1068 EventTypeTablePointer
*oldEventTypeTable
= m_eventTypeTable
;
1070 // TODO: Search the most optimal grow sequence
1071 AllocEventTypeTable(/* GetNextPrime(oldSize) */oldSize
*2+1);
1073 for ( size_t i
= 0; i
< oldSize
; /* */ )
1075 EventTypeTablePointer eTToldNode
= oldEventTypeTable
[i
];
1078 EventTypeTablePointer
*peTTnode
= &m_eventTypeTable
[eTToldNode
->eventType
% m_size
];
1079 EventTypeTablePointer eTTnode
= *peTTnode
;
1081 // Check for collision, we don't want any.
1084 GrowEventTypeTable();
1085 continue; // Don't increment the counter,
1086 // as we still need to add this element.
1090 // Get the old value and put it in the new table.
1091 *peTTnode
= oldEventTypeTable
[i
];
1098 delete[] oldEventTypeTable
;
1101 // ----------------------------------------------------------------------------
1103 // ----------------------------------------------------------------------------
1105 wxEvtHandler::wxEvtHandler()
1107 m_nextHandler
= NULL
;
1108 m_previousHandler
= NULL
;
1110 m_dynamicEvents
= NULL
;
1111 m_pendingEvents
= NULL
;
1113 // no client data (yet)
1114 m_clientData
= NULL
;
1115 m_clientDataType
= wxClientData_None
;
1118 wxEvtHandler::~wxEvtHandler()
1122 if (m_dynamicEvents
)
1124 for ( wxList::iterator it
= m_dynamicEvents
->begin(),
1125 end
= m_dynamicEvents
->end();
1129 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)*it
;
1131 // Remove ourselves from sink destructor notifications
1132 // (this has usually been done, in wxTrackable destructor)
1133 wxEvtHandler
*eventSink
= entry
->m_fn
->GetEvtHandler();
1136 wxEventConnectionRef
* const
1137 evtConnRef
= FindRefInTrackerList(eventSink
);
1140 eventSink
->RemoveNode(evtConnRef
);
1145 delete entry
->m_callbackUserData
;
1148 delete m_dynamicEvents
;
1151 // Remove us from the list of the pending events if necessary.
1153 wxTheApp
->RemovePendingEventHandler(this);
1155 DeletePendingEvents();
1157 // we only delete object data, not untyped
1158 if ( m_clientDataType
== wxClientData_Object
)
1159 delete m_clientObject
;
1162 void wxEvtHandler::Unlink()
1164 // this event handler must take itself out of the chain of handlers:
1166 if (m_previousHandler
)
1167 m_previousHandler
->SetNextHandler(m_nextHandler
);
1170 m_nextHandler
->SetPreviousHandler(m_previousHandler
);
1172 m_nextHandler
= NULL
;
1173 m_previousHandler
= NULL
;
1176 bool wxEvtHandler::IsUnlinked() const
1178 return m_previousHandler
== NULL
&&
1179 m_nextHandler
== NULL
;
1182 wxEventFilter
* wxEvtHandler::ms_filterList
= NULL
;
1184 /* static */ void wxEvtHandler::AddFilter(wxEventFilter
* filter
)
1186 wxCHECK_RET( filter
, "NULL filter" );
1188 filter
->m_next
= ms_filterList
;
1189 ms_filterList
= filter
;
1192 /* static */ void wxEvtHandler::RemoveFilter(wxEventFilter
* filter
)
1194 wxEventFilter
* prev
= NULL
;
1195 for ( wxEventFilter
* f
= ms_filterList
; f
; f
= f
->m_next
)
1199 // Set the previous list element or the list head to the next
1202 prev
->m_next
= f
->m_next
;
1204 ms_filterList
= f
->m_next
;
1206 // Also reset the next pointer in the filter itself just to avoid
1207 // having possibly dangling pointers, even though it's not strictly
1211 // Skip the assert below.
1218 wxFAIL_MSG( "Filter not found" );
1223 bool wxEvtHandler::ProcessThreadEvent(const wxEvent
& event
)
1225 // check that we are really in a child thread
1226 wxASSERT_MSG( !wxThread::IsMain(),
1227 wxT("use ProcessEvent() in main thread") );
1229 AddPendingEvent(event
);
1234 #endif // wxUSE_THREADS
1236 void wxEvtHandler::QueueEvent(wxEvent
*event
)
1238 wxCHECK_RET( event
, "NULL event can't be posted" );
1242 // we need an event loop which manages the list of event handlers with
1243 // pending events... cannot proceed without it!
1244 wxLogDebug("No application object! Cannot queue this event!");
1246 // anyway delete the given event to avoid memory leaks
1252 // 1) Add this event to our list of pending events
1253 wxENTER_CRIT_SECT( m_pendingEventsLock
);
1255 if ( !m_pendingEvents
)
1256 m_pendingEvents
= new wxList
;
1258 m_pendingEvents
->Append(event
);
1260 // 2) Add this event handler to list of event handlers that
1261 // have pending events.
1263 wxTheApp
->AppendPendingEventHandler(this);
1265 // only release m_pendingEventsLock now because otherwise there is a race
1266 // condition as described in the ticket #9093: we could process the event
1267 // just added to m_pendingEvents in our ProcessPendingEvents() below before
1268 // we had time to append this pointer to wxHandlersWithPendingEvents list; thus
1269 // breaking the invariant that a handler should be in the list iff it has
1270 // any pending events to process
1271 wxLEAVE_CRIT_SECT( m_pendingEventsLock
);
1273 // 3) Inform the system that new pending events are somewhere,
1274 // and that these should be processed in idle time.
1278 void wxEvtHandler::DeletePendingEvents()
1280 if (m_pendingEvents
)
1281 m_pendingEvents
->DeleteContents(true);
1282 wxDELETE(m_pendingEvents
);
1285 void wxEvtHandler::ProcessPendingEvents()
1289 // we need an event loop which manages the list of event handlers with
1290 // pending events... cannot proceed without it!
1291 wxLogDebug("No application object! Cannot process pending events!");
1295 // we need to process only a single pending event in this call because
1296 // each call to ProcessEvent() could result in the destruction of this
1297 // same event handler (see the comment at the end of this function)
1299 wxENTER_CRIT_SECT( m_pendingEventsLock
);
1301 // this method is only called by wxApp if this handler does have
1303 wxCHECK_RET( m_pendingEvents
&& !m_pendingEvents
->IsEmpty(),
1304 "should have pending events if called" );
1306 wxList::compatibility_iterator node
= m_pendingEvents
->GetFirst();
1307 wxEvent
* pEvent
= static_cast<wxEvent
*>(node
->GetData());
1309 // find the first event which can be processed now:
1310 wxEventLoopBase
* evtLoop
= wxEventLoopBase::GetActive();
1311 if (evtLoop
&& evtLoop
->IsYielding())
1313 while (node
&& pEvent
&& !evtLoop
->IsEventAllowedInsideYield(pEvent
->GetEventCategory()))
1315 node
= node
->GetNext();
1316 pEvent
= node
? static_cast<wxEvent
*>(node
->GetData()) : NULL
;
1321 // all our events are NOT processable now... signal this:
1322 wxTheApp
->DelayPendingEventHandler(this);
1324 // see the comment at the beginning of evtloop.h header for the
1325 // logic behind YieldFor() and behind DelayPendingEventHandler()
1327 wxLEAVE_CRIT_SECT( m_pendingEventsLock
);
1333 wxEventPtr
event(pEvent
);
1335 // it's important we remove event from list before processing it, else a
1336 // nested event loop, for example from a modal dialog, might process the
1337 // same event again.
1338 m_pendingEvents
->Erase(node
);
1340 if ( m_pendingEvents
->IsEmpty() )
1342 // if there are no more pending events left, we don't need to
1343 // stay in this list
1344 wxTheApp
->RemovePendingEventHandler(this);
1347 wxLEAVE_CRIT_SECT( m_pendingEventsLock
);
1349 ProcessEvent(*event
);
1351 // careful: this object could have been deleted by the event handler
1352 // executed by the above ProcessEvent() call, so we can't access any fields
1353 // of this object any more
1357 bool wxEvtHandler::ProcessEventIfMatchesId(const wxEventTableEntryBase
& entry
,
1358 wxEvtHandler
*handler
,
1361 int tableId1
= entry
.m_id
,
1362 tableId2
= entry
.m_lastId
;
1364 // match only if the event type is the same and the id is either -1 in
1365 // the event table (meaning "any") or the event id matches the id
1366 // specified in the event table either exactly or by falling into
1367 // range between first and last
1368 if ((tableId1
== wxID_ANY
) ||
1369 (tableId2
== wxID_ANY
&& tableId1
== event
.GetId()) ||
1370 (tableId2
!= wxID_ANY
&&
1371 (event
.GetId() >= tableId1
&& event
.GetId() <= tableId2
)))
1374 event
.m_callbackUserData
= entry
.m_callbackUserData
;
1376 #if wxUSE_EXCEPTIONS
1379 // call the handler via wxApp method which allows the user to catch
1380 // any exceptions which may be thrown by any handler in the program
1382 wxTheApp
->CallEventHandler(handler
, *entry
.m_fn
, event
);
1385 #endif // wxUSE_EXCEPTIONS
1387 (*entry
.m_fn
)(handler
, event
);
1390 if (!event
.GetSkipped())
1397 bool wxEvtHandler::DoTryApp(wxEvent
& event
)
1399 if ( wxTheApp
&& (this != wxTheApp
) )
1401 // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
1402 // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
1403 // processed appropriately via SearchEventTable.
1404 if ( event
.GetEventType() != wxEVT_IDLE
)
1406 if ( wxTheApp
->ProcessEvent(event
) )
1414 bool wxEvtHandler::TryBefore(wxEvent
& event
)
1416 #if WXWIN_COMPATIBILITY_2_8
1417 // call the old virtual function to keep the code overriding it working
1418 return TryValidator(event
);
1425 bool wxEvtHandler::TryAfter(wxEvent
& event
)
1427 // We only want to pass the window to the application object once even if
1428 // there are several chained handlers. Ensure that this is what happens by
1429 // only calling DoTryApp() if there is no next handler (which would do it).
1431 // Notice that, unlike simply calling TryAfter() on the last handler in the
1432 // chain only from ProcessEvent(), this also works with wxWindow object in
1433 // the middle of the chain: its overridden TryAfter() will still be called
1434 // and propagate the event upwards the window hierarchy even if it's not
1435 // the last one in the chain (which, admittedly, shouldn't happen often).
1436 if ( GetNextHandler() )
1437 return GetNextHandler()->TryAfter(event
);
1439 // If this event is going to be processed in another handler next, don't
1440 // pass it to wxTheApp now, it will be done from TryAfter() of this other
1442 if ( event
.WillBeProcessedAgain() )
1445 #if WXWIN_COMPATIBILITY_2_8
1446 // as above, call the old virtual function for compatibility
1447 return TryParent(event
);
1449 return DoTryApp(event
);
1453 bool wxEvtHandler::ProcessEvent(wxEvent
& event
)
1455 // The very first thing we do is to allow any registered filters to hook
1456 // into event processing in order to globally pre-process all events.
1458 // Note that we should only do it if we're the first event handler called
1459 // to avoid calling FilterEvent() multiple times as the event goes through
1460 // the event handler chain and possibly upwards the window hierarchy.
1461 if ( !event
.WasProcessed() )
1463 for ( wxEventFilter
* f
= ms_filterList
; f
; f
= f
->m_next
)
1465 int rc
= f
->FilterEvent(event
);
1466 if ( rc
!= wxEventFilter::Event_Skip
)
1468 wxASSERT_MSG( rc
== wxEventFilter::Event_Ignore
||
1469 rc
== wxEventFilter::Event_Processed
,
1470 "unexpected FilterEvent() return value" );
1472 return rc
!= wxEventFilter::Event_Ignore
;
1474 //else: proceed normally
1478 // Short circuit the event processing logic if we're requested to process
1479 // this event in this handler only, see DoTryChain() for more details.
1480 if ( event
.ShouldProcessOnlyIn(this) )
1481 return TryBeforeAndHere(event
);
1484 // Try to process the event in this handler itself.
1485 if ( ProcessEventLocally(event
) )
1487 // It is possible that DoTryChain() called from ProcessEventLocally()
1488 // returned true but the event was not really processed: this happens
1489 // if a custom handler ignores the request to process the event in this
1490 // handler only and in this case we should skip the post processing
1491 // done in TryAfter() but still return the correct value ourselves to
1492 // indicate whether we did or did not find a handler for this event.
1493 return !event
.GetSkipped();
1496 // If we still didn't find a handler, propagate the event upwards the
1497 // window chain and/or to the application object.
1498 if ( TryAfter(event
) )
1502 // No handler found anywhere, bail out.
1506 bool wxEvtHandler::ProcessEventLocally(wxEvent
& event
)
1508 // Try the hooks which should be called before our own handlers and this
1509 // handler itself first. Notice that we should not call ProcessEvent() on
1510 // this one as we're already called from it, which explains why we do it
1511 // here and not in DoTryChain()
1512 return TryBeforeAndHere(event
) || DoTryChain(event
);
1515 bool wxEvtHandler::DoTryChain(wxEvent
& event
)
1517 for ( wxEvtHandler
*h
= GetNextHandler(); h
; h
= h
->GetNextHandler() )
1519 // We need to process this event at the level of this handler only
1520 // right now, the pre-/post-processing was either already done by
1521 // ProcessEvent() from which we were called or will be done by it when
1524 // However we must call ProcessEvent() and not TryHereOnly() because the
1525 // existing code (including some in wxWidgets itself) expects the
1526 // overridden ProcessEvent() in its custom event handlers pushed on a
1527 // window to be called.
1529 // So we must call ProcessEvent() but it must not do what it usually
1530 // does. To resolve this paradox we set up a special flag inside the
1531 // object itself to let ProcessEvent() know that it shouldn't do any
1532 // pre/post-processing for this event if it gets it. Note that this
1533 // only applies to this handler, if the event is passed to another one
1534 // by explicitly calling its ProcessEvent(), pre/post-processing should
1535 // be done as usual.
1537 // Final complication is that if the implementation of ProcessEvent()
1538 // called wxEvent::DidntHonourProcessOnlyIn() (as the gross hack that
1539 // is wxScrollHelperEvtHandler::ProcessEvent() does) and ignored our
1540 // request to process event in this handler only, we have to compensate
1541 // for it by not processing the event further because this was already
1542 // done by that rogue event handler.
1543 wxEventProcessInHandlerOnly
processInHandlerOnly(event
, h
);
1544 if ( h
->ProcessEvent(event
) )
1546 // Make sure "skipped" flag is not set as the event was really
1547 // processed in this case. Normally it shouldn't be set anyhow but
1548 // make sure just in case the user code does something strange.
1554 if ( !event
.ShouldProcessOnlyIn(h
) )
1556 // Still return true to indicate that no further processing should
1557 // be undertaken but ensure that "skipped" flag is set so that the
1558 // caller knows that the event was not really processed.
1568 bool wxEvtHandler::TryHereOnly(wxEvent
& event
)
1570 // If the event handler is disabled it doesn't process any events
1571 if ( !GetEvtHandlerEnabled() )
1574 // Handle per-instance dynamic event tables first
1575 if ( m_dynamicEvents
&& SearchDynamicEventTable(event
) )
1578 // Then static per-class event tables
1579 if ( GetEventHashTable().HandleEvent(event
, this) )
1582 #ifdef wxHAS_CALL_AFTER
1583 // There is an implicit entry for async method calls processing in every
1585 if ( event
.GetEventType() == wxEVT_ASYNC_METHOD_CALL
&&
1586 event
.GetEventObject() == this )
1588 static_cast<wxAsyncMethodCallEvent
&>(event
).Execute();
1591 #endif // wxHAS_CALL_AFTER
1593 // We don't have a handler for this event.
1597 bool wxEvtHandler::SafelyProcessEvent(wxEvent
& event
)
1599 #if wxUSE_EXCEPTIONS
1603 return ProcessEvent(event
);
1604 #if wxUSE_EXCEPTIONS
1608 // notice that we do it in 2 steps to avoid warnings about possibly
1609 // uninitialized loop variable from some versions of g++ which are not
1610 // smart enough to figure out that GetActive() doesn't throw and so
1611 // that loop will always be initialized
1612 wxEventLoopBase
*loop
= NULL
;
1615 loop
= wxEventLoopBase::GetActive();
1617 if ( !wxTheApp
|| !wxTheApp
->OnExceptionInMainLoop() )
1622 //else: continue running current event loop
1628 // OnExceptionInMainLoop() threw, possibly rethrowing the same
1629 // exception again: very good, but we still need Exit() to
1636 #endif // wxUSE_EXCEPTIONS
1639 bool wxEvtHandler::SearchEventTable(wxEventTable
& table
, wxEvent
& event
)
1641 const wxEventType eventType
= event
.GetEventType();
1642 for ( int i
= 0; table
.entries
[i
].m_fn
!= 0; i
++ )
1644 const wxEventTableEntry
& entry
= table
.entries
[i
];
1645 if ( eventType
== entry
.m_eventType
)
1647 if ( ProcessEventIfMatchesId(entry
, this, event
) )
1655 void wxEvtHandler::DoBind(int id
,
1657 wxEventType eventType
,
1658 wxEventFunctor
*func
,
1661 wxDynamicEventTableEntry
*entry
=
1662 new wxDynamicEventTableEntry(eventType
, id
, lastId
, func
, userData
);
1664 if (!m_dynamicEvents
)
1665 m_dynamicEvents
= new wxList
;
1667 // Insert at the front of the list so most recent additions are found first
1668 m_dynamicEvents
->Insert( (wxObject
*) entry
);
1670 // Make sure we get to know when a sink is destroyed
1671 wxEvtHandler
*eventSink
= func
->GetEvtHandler();
1672 if ( eventSink
&& eventSink
!= this )
1674 wxEventConnectionRef
*evtConnRef
= FindRefInTrackerList(eventSink
);
1676 evtConnRef
->IncRef( );
1678 new wxEventConnectionRef(this, eventSink
);
1683 wxEvtHandler::DoUnbind(int id
,
1685 wxEventType eventType
,
1686 const wxEventFunctor
& func
,
1689 if (!m_dynamicEvents
)
1692 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1695 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1697 if ((entry
->m_id
== id
) &&
1698 ((entry
->m_lastId
== lastId
) || (lastId
== wxID_ANY
)) &&
1699 ((entry
->m_eventType
== eventType
) || (eventType
== wxEVT_NULL
)) &&
1700 entry
->m_fn
->IsMatching(func
) &&
1701 ((entry
->m_callbackUserData
== userData
) || !userData
))
1703 // Remove connection from tracker node (wxEventConnectionRef)
1704 wxEvtHandler
*eventSink
= entry
->m_fn
->GetEvtHandler();
1705 if ( eventSink
&& eventSink
!= this )
1707 wxEventConnectionRef
*evtConnRef
= FindRefInTrackerList(eventSink
);
1709 evtConnRef
->DecRef();
1712 delete entry
->m_callbackUserData
;
1713 m_dynamicEvents
->Erase( node
);
1717 node
= node
->GetNext();
1722 bool wxEvtHandler::SearchDynamicEventTable( wxEvent
& event
)
1724 wxCHECK_MSG( m_dynamicEvents
, false,
1725 wxT("caller should check that we have dynamic events") );
1727 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1730 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1732 // get next node before (maybe) calling the event handler as it could
1733 // call Disconnect() invalidating the current node
1734 node
= node
->GetNext();
1736 if ( event
.GetEventType() == entry
->m_eventType
)
1738 wxEvtHandler
*handler
= entry
->m_fn
->GetEvtHandler();
1741 if ( ProcessEventIfMatchesId(*entry
, handler
, event
) )
1749 void wxEvtHandler::DoSetClientObject( wxClientData
*data
)
1751 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1752 wxT("can't have both object and void client data") );
1754 if ( m_clientObject
)
1755 delete m_clientObject
;
1757 m_clientObject
= data
;
1758 m_clientDataType
= wxClientData_Object
;
1761 wxClientData
*wxEvtHandler::DoGetClientObject() const
1763 // it's not an error to call GetClientObject() on a window which doesn't
1764 // have client data at all - NULL will be returned
1765 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1766 wxT("this window doesn't have object client data") );
1768 return m_clientObject
;
1771 void wxEvtHandler::DoSetClientData( void *data
)
1773 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1774 wxT("can't have both object and void client data") );
1776 m_clientData
= data
;
1777 m_clientDataType
= wxClientData_Void
;
1780 void *wxEvtHandler::DoGetClientData() const
1782 // it's not an error to call GetClientData() on a window which doesn't have
1783 // client data at all - NULL will be returned
1784 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1785 wxT("this window doesn't have void client data") );
1787 return m_clientData
;
1790 // A helper to find an wxEventConnectionRef object
1791 wxEventConnectionRef
*
1792 wxEvtHandler::FindRefInTrackerList(wxEvtHandler
*eventSink
)
1794 for ( wxTrackerNode
*node
= eventSink
->GetFirst(); node
; node
= node
->m_nxt
)
1796 // we only want wxEventConnectionRef nodes here
1797 wxEventConnectionRef
*evtConnRef
= node
->ToEventConnection();
1798 if ( evtConnRef
&& evtConnRef
->m_src
== this )
1800 wxASSERT( evtConnRef
->m_sink
==eventSink
);
1808 void wxEvtHandler::OnSinkDestroyed( wxEvtHandler
*sink
)
1810 wxASSERT(m_dynamicEvents
);
1812 // remove all connections with this sink
1813 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst(), node_nxt
;
1816 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1817 node_nxt
= node
->GetNext();
1819 if ( entry
->m_fn
->GetEvtHandler() == sink
)
1821 delete entry
->m_callbackUserData
;
1822 m_dynamicEvents
->Erase( node
);
1829 #endif // wxUSE_BASE
1833 // Find a window with the focus, that is also a descendant of the given window.
1834 // This is used to determine the window to initially send commands to.
1835 wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
)
1837 // Process events starting with the window with the focus, if any.
1838 wxWindow
* focusWin
= wxWindow::FindFocus();
1839 wxWindow
* win
= focusWin
;
1841 // Check if this is a descendant of this frame.
1842 // If not, win will be set to NULL.
1845 if (win
== ancestor
)
1848 win
= win
->GetParent();
1856 // ----------------------------------------------------------------------------
1858 // ----------------------------------------------------------------------------
1860 wxEventBlocker::wxEventBlocker(wxWindow
*win
, wxEventType type
)
1862 wxCHECK_RET(win
, wxT("Null window given to wxEventBlocker"));
1867 m_window
->PushEventHandler(this);
1870 wxEventBlocker::~wxEventBlocker()
1872 wxEvtHandler
*popped
= m_window
->PopEventHandler(false);
1873 wxCHECK_RET(popped
== this,
1874 wxT("Don't push other event handlers into a window managed by wxEventBlocker!"));
1877 bool wxEventBlocker::ProcessEvent(wxEvent
& event
)
1879 // should this event be blocked?
1880 for ( size_t i
= 0; i
< m_eventsToBlock
.size(); i
++ )
1882 wxEventType t
= (wxEventType
)m_eventsToBlock
[i
];
1883 if ( t
== wxEVT_ANY
|| t
== event
.GetEventType() )
1884 return true; // yes, it should: mark this event as processed