projects / wxWidgets.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Add public wxDocManager::GetAnyUsableView().
[wxWidgets.git] / src / common / event.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/event.cpp
3 // Purpose: Event classes
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 01/02/97
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 // ============================================================================
13 // declarations
14 // ============================================================================
15
16 // ----------------------------------------------------------------------------
17 // headers
18 // ----------------------------------------------------------------------------
19
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
22
23 #ifdef __BORLANDC__
24 #pragma hdrstop
25 #endif
26
27 #include "wx/event.h"
28 #include "wx/eventfilter.h"
29 #include "wx/evtloop.h"
30
31 #ifndef WX_PRECOMP
32 #include "wx/list.h"
33 #include "wx/log.h"
34 #include "wx/app.h"
35 #include "wx/utils.h"
36 #include "wx/stopwatch.h"
37 #include "wx/module.h"
38
39 #if wxUSE_GUI
40 #include "wx/window.h"
41 #include "wx/control.h"
42 #include "wx/dc.h"
43 #include "wx/spinbutt.h"
44 #include "wx/textctrl.h"
45 #include "wx/validate.h"
46 #endif // wxUSE_GUI
47 #endif
48
49 #include "wx/thread.h"
50
51 #if wxUSE_BASE
52 #include "wx/scopedptr.h"
53
54 wxDECLARE_SCOPED_PTR(wxEvent, wxEventPtr)
55 wxDEFINE_SCOPED_PTR(wxEvent, wxEventPtr)
56 #endif // wxUSE_BASE
57
58 // ----------------------------------------------------------------------------
59 // wxWin macros
60 // ----------------------------------------------------------------------------
61
62 #if wxUSE_BASE
63 IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler, wxObject)
64 IMPLEMENT_ABSTRACT_CLASS(wxEvent, wxObject)
65 IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent)
66 IMPLEMENT_DYNAMIC_CLASS(wxThreadEvent, wxEvent)
67 #endif // wxUSE_BASE
68
69 #if wxUSE_GUI
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)
106 #endif // wxUSE_GUI
107
108 #if wxUSE_BASE
109
110 const wxEventTable *wxEvtHandler::GetEventTable() const
111 { return &wxEvtHandler::sm_eventTable; }
112
113 const wxEventTable wxEvtHandler::sm_eventTable =
114 { (const wxEventTable *)NULL, &wxEvtHandler::sm_eventTableEntries[0] };
115
116 wxEventHashTable &wxEvtHandler::GetEventHashTable() const
117 { return wxEvtHandler::sm_eventHashTable; }
118
119 wxEventHashTable wxEvtHandler::sm_eventHashTable(wxEvtHandler::sm_eventTable);
120
121 const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] =
122 { wxDECLARE_EVENT_TABLE_TERMINATOR() };
123
124
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
131
132 class wxEventTableEntryModule: public wxModule
133 {
134 public:
135 wxEventTableEntryModule() { }
136 virtual bool OnInit() { return true; }
137 virtual void OnExit() { wxEventHashTable::ClearAll(); }
138
139 DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule)
140 };
141
142 IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule, wxModule)
143
144 #endif // wxUSE_MEMORY_TRACING
145
146 // ----------------------------------------------------------------------------
147 // global variables
148 // ----------------------------------------------------------------------------
149
150 // common event types are defined here, other event types are defined by the
151 // components which use them
152
153 const wxEventType wxEVT_FIRST = 10000;
154 const wxEventType wxEVT_USER_FIRST = wxEVT_FIRST + 2000;
155 const wxEventType wxEVT_NULL = wxNewEventType();
156
157 wxDEFINE_EVENT( wxEVT_IDLE, wxIdleEvent );
158
159 // Thread and asynchronous call events
160 wxDEFINE_EVENT( wxEVT_THREAD, wxThreadEvent );
161 wxDEFINE_EVENT( wxEVT_ASYNC_METHOD_CALL, wxAsyncMethodCallEvent );
162
163 #endif // wxUSE_BASE
164
165 #if wxUSE_GUI
166
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);
187
188 // Mouse event types
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 );
211
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 );
219 #if wxUSE_HOTKEY
220 wxDEFINE_EVENT( wxEVT_HOTKEY, wxKeyEvent );
221 #endif
222
223 // Set cursor event
224 wxDEFINE_EVENT( wxEVT_SET_CURSOR, wxSetCursorEvent );
225
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 );
236
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.
243
244 #if wxUSE_SPINBTN
245
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 );
249
250 #endif // wxUSE_SPINBTN
251
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 );
261
262 // System events
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 );
300
301 // Clipboard events
302 wxDEFINE_EVENT( wxEVT_TEXT_COPY, wxClipboardTextEvent );
303 wxDEFINE_EVENT( wxEVT_TEXT_CUT, wxClipboardTextEvent );
304 wxDEFINE_EVENT( wxEVT_TEXT_PASTE, wxClipboardTextEvent );
305
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 );
315
316 // Help events
317 wxDEFINE_EVENT( wxEVT_HELP, wxHelpEvent );
318 wxDEFINE_EVENT( wxEVT_DETAILED_HELP, wxHelpEvent );
319
320 #endif // wxUSE_GUI
321
322 #if wxUSE_BASE
323
324 wxIdleMode wxIdleEvent::sm_idleMode = wxIDLE_PROCESS_ALL;
325
326 // ============================================================================
327 // implementation
328 // ============================================================================
329
330 // ----------------------------------------------------------------------------
331 // event initialization
332 // ----------------------------------------------------------------------------
333
334 int wxNewEventType()
335 {
336 // MT-FIXME
337 static int s_lastUsedEventType = wxEVT_FIRST;
338
339 return s_lastUsedEventType++;
340 }
341 // ----------------------------------------------------------------------------
342 // wxEventFunctor
343 // ----------------------------------------------------------------------------
344
345 wxEventFunctor::~wxEventFunctor()
346 {
347 }
348
349 // ----------------------------------------------------------------------------
350 // wxEvent
351 // ----------------------------------------------------------------------------
352
353 /*
354 * General wxWidgets events, covering all interesting things that might happen
355 * (button clicking, resizing, setting text in widgets, etc.).
356 *
357 * For each completely new event type, derive a new event class.
358 *
359 */
360
361 wxEvent::wxEvent(int theId, wxEventType commandType)
362 {
363 m_eventType = commandType;
364 m_eventObject = NULL;
365 m_timeStamp = 0;
366 m_id = theId;
367 m_skipped = false;
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;
374 }
375
376 wxEvent::wxEvent(const wxEvent& src)
377 : wxObject(src)
378 , m_eventObject(src.m_eventObject)
379 , m_eventType(src.m_eventType)
380 , m_timeStamp(src.m_timeStamp)
381 , m_id(src.m_id)
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)
389 {
390 }
391
392 wxEvent& wxEvent::operator=(const wxEvent& src)
393 {
394 wxObject::operator=(src);
395
396 m_eventObject = src.m_eventObject;
397 m_eventType = src.m_eventType;
398 m_timeStamp = src.m_timeStamp;
399 m_id = src.m_id;
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;
405
406 // don't change m_wasProcessed
407
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;
411
412 return *this;
413 }
414
415 #endif // wxUSE_BASE
416
417 #if wxUSE_GUI
418
419 // ----------------------------------------------------------------------------
420 // wxCommandEvent
421 // ----------------------------------------------------------------------------
422
423 wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId)
424 : wxEvent(theId, commandType)
425 {
426 m_clientData = NULL;
427 m_clientObject = NULL;
428 m_isCommandEvent = true;
429
430 // the command events are propagated upwards by default
431 m_propagationLevel = wxEVENT_PROPAGATE_MAX;
432 }
433
434 wxString wxCommandEvent::GetString() const
435 {
436 if (m_eventType != wxEVT_TEXT || !m_eventObject)
437 {
438 return m_cmdString;
439 }
440 else
441 {
442 #if wxUSE_TEXTCTRL
443 wxTextCtrl *txt = wxDynamicCast(m_eventObject, wxTextCtrl);
444 if ( txt )
445 return txt->GetValue();
446 else
447 #endif // wxUSE_TEXTCTRL
448 return m_cmdString;
449 }
450 }
451
452 // ----------------------------------------------------------------------------
453 // wxUpdateUIEvent
454 // ----------------------------------------------------------------------------
455
456 #if wxUSE_LONGLONG
457 wxLongLong wxUpdateUIEvent::sm_lastUpdate = 0;
458 #endif
459
460 long wxUpdateUIEvent::sm_updateInterval = 0;
461
462 wxUpdateUIMode wxUpdateUIEvent::sm_updateMode = wxUPDATE_UI_PROCESS_ALL;
463
464 // Can we update?
465 bool wxUpdateUIEvent::CanUpdate(wxWindowBase *win)
466 {
467 // Don't update if we've switched global updating off
468 // and this window doesn't support updates.
469 if (win &&
470 (GetMode() == wxUPDATE_UI_PROCESS_SPECIFIED &&
471 ((win->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES) == 0)))
472 return false;
473
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() )
479 return false;
480
481 if (sm_updateInterval == -1)
482 return false;
483
484 if (sm_updateInterval == 0)
485 return true;
486
487 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
488 wxLongLong now = wxGetLocalTimeMillis();
489 if (now > (sm_lastUpdate + sm_updateInterval))
490 {
491 return true;
492 }
493
494 return false;
495 #else
496 // If we don't have wxStopWatch or wxLongLong, we
497 // should err on the safe side and update now anyway.
498 return true;
499 #endif
500 }
501
502 // Reset the update time to provide a delay until the next
503 // time we should update
504 void wxUpdateUIEvent::ResetUpdateTime()
505 {
506 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
507 if (sm_updateInterval > 0)
508 {
509 wxLongLong now = wxGetLocalTimeMillis();
510 if (now > (sm_lastUpdate + sm_updateInterval))
511 {
512 sm_lastUpdate = now;
513 }
514 }
515 #endif
516 }
517
518 // ----------------------------------------------------------------------------
519 // wxScrollEvent
520 // ----------------------------------------------------------------------------
521
522 wxScrollEvent::wxScrollEvent(wxEventType commandType,
523 int id,
524 int pos,
525 int orient)
526 : wxCommandEvent(commandType, id)
527 {
528 m_extraLong = orient;
529 m_commandInt = pos;
530 }
531
532 // ----------------------------------------------------------------------------
533 // wxScrollWinEvent
534 // ----------------------------------------------------------------------------
535
536 wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType,
537 int pos,
538 int orient)
539 {
540 m_eventType = commandType;
541 m_extraLong = orient;
542 m_commandInt = pos;
543 }
544
545 // ----------------------------------------------------------------------------
546 // wxMouseEvent
547 // ----------------------------------------------------------------------------
548
549 wxMouseEvent::wxMouseEvent(wxEventType commandType)
550 {
551 m_eventType = commandType;
552
553 m_x = 0;
554 m_y = 0;
555
556 m_leftDown = false;
557 m_middleDown = false;
558 m_rightDown = false;
559 m_aux1Down = false;
560 m_aux2Down = false;
561
562 m_clickCount = -1;
563
564 m_wheelAxis = wxMOUSE_WHEEL_VERTICAL;
565 m_wheelRotation = 0;
566 m_wheelDelta = 0;
567 m_linesPerAction = 0;
568 }
569
570 void wxMouseEvent::Assign(const wxMouseEvent& event)
571 {
572 wxEvent::operator=(event);
573
574 // Borland C++ 5.82 doesn't compile an explicit call to an implicitly
575 // defined operator=() so need to do it this way:
576 *static_cast<wxMouseState *>(this) = event;
577
578 m_x = event.m_x;
579 m_y = event.m_y;
580
581 m_leftDown = event.m_leftDown;
582 m_middleDown = event.m_middleDown;
583 m_rightDown = event.m_rightDown;
584 m_aux1Down = event.m_aux1Down;
585 m_aux2Down = event.m_aux2Down;
586
587 m_wheelRotation = event.m_wheelRotation;
588 m_wheelDelta = event.m_wheelDelta;
589 m_linesPerAction = event.m_linesPerAction;
590 m_wheelAxis = event.m_wheelAxis;
591 }
592
593 // return true if was a button dclick event
594 bool wxMouseEvent::ButtonDClick(int but) const
595 {
596 switch (but)
597 {
598 default:
599 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
600 // fall through
601
602 case wxMOUSE_BTN_ANY:
603 return (LeftDClick() || MiddleDClick() || RightDClick() ||
604 Aux1DClick() || Aux2DClick());
605
606 case wxMOUSE_BTN_LEFT:
607 return LeftDClick();
608
609 case wxMOUSE_BTN_MIDDLE:
610 return MiddleDClick();
611
612 case wxMOUSE_BTN_RIGHT:
613 return RightDClick();
614
615 case wxMOUSE_BTN_AUX1:
616 return Aux1DClick();
617
618 case wxMOUSE_BTN_AUX2:
619 return Aux2DClick();
620 }
621 }
622
623 // return true if was a button down event
624 bool wxMouseEvent::ButtonDown(int but) const
625 {
626 switch (but)
627 {
628 default:
629 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
630 // fall through
631
632 case wxMOUSE_BTN_ANY:
633 return (LeftDown() || MiddleDown() || RightDown() ||
634 Aux1Down() || Aux2Down());
635
636 case wxMOUSE_BTN_LEFT:
637 return LeftDown();
638
639 case wxMOUSE_BTN_MIDDLE:
640 return MiddleDown();
641
642 case wxMOUSE_BTN_RIGHT:
643 return RightDown();
644
645 case wxMOUSE_BTN_AUX1:
646 return Aux1Down();
647
648 case wxMOUSE_BTN_AUX2:
649 return Aux2Down();
650 }
651 }
652
653 // return true if was a button up event
654 bool wxMouseEvent::ButtonUp(int but) const
655 {
656 switch (but)
657 {
658 default:
659 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
660 // fall through
661
662 case wxMOUSE_BTN_ANY:
663 return (LeftUp() || MiddleUp() || RightUp() ||
664 Aux1Up() || Aux2Up());
665
666 case wxMOUSE_BTN_LEFT:
667 return LeftUp();
668
669 case wxMOUSE_BTN_MIDDLE:
670 return MiddleUp();
671
672 case wxMOUSE_BTN_RIGHT:
673 return RightUp();
674
675 case wxMOUSE_BTN_AUX1:
676 return Aux1Up();
677
678 case wxMOUSE_BTN_AUX2:
679 return Aux2Up();
680 }
681 }
682
683 // return true if the given button is currently changing state
684 bool wxMouseEvent::Button(int but) const
685 {
686 switch (but)
687 {
688 default:
689 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
690 // fall through
691
692 case wxMOUSE_BTN_ANY:
693 return ButtonUp(wxMOUSE_BTN_ANY) ||
694 ButtonDown(wxMOUSE_BTN_ANY) ||
695 ButtonDClick(wxMOUSE_BTN_ANY);
696
697 case wxMOUSE_BTN_LEFT:
698 return LeftDown() || LeftUp() || LeftDClick();
699
700 case wxMOUSE_BTN_MIDDLE:
701 return MiddleDown() || MiddleUp() || MiddleDClick();
702
703 case wxMOUSE_BTN_RIGHT:
704 return RightDown() || RightUp() || RightDClick();
705
706 case wxMOUSE_BTN_AUX1:
707 return Aux1Down() || Aux1Up() || Aux1DClick();
708
709 case wxMOUSE_BTN_AUX2:
710 return Aux2Down() || Aux2Up() || Aux2DClick();
711 }
712 }
713
714 int wxMouseEvent::GetButton() const
715 {
716 for ( int i = 1; i < wxMOUSE_BTN_MAX; i++ )
717 {
718 if ( Button(i) )
719 {
720 return i;
721 }
722 }
723
724 return wxMOUSE_BTN_NONE;
725 }
726
727 // Find the logical position of the event given the DC
728 wxPoint wxMouseEvent::GetLogicalPosition(const wxDC& dc) const
729 {
730 wxPoint pt(dc.DeviceToLogicalX(m_x), dc.DeviceToLogicalY(m_y));
731 return pt;
732 }
733
734 // ----------------------------------------------------------------------------
735 // wxKeyEvent
736 // ----------------------------------------------------------------------------
737
738 wxKeyEvent::wxKeyEvent(wxEventType type)
739 {
740 m_eventType = type;
741 m_keyCode = WXK_NONE;
742 #if wxUSE_UNICODE
743 m_uniChar = WXK_NONE;
744 #endif
745
746 m_x =
747 m_y = wxDefaultCoord;
748 m_hasPosition = false;
749
750 InitPropagation();
751 }
752
753 wxKeyEvent::wxKeyEvent(const wxKeyEvent& evt)
754 : wxEvent(evt),
755 wxKeyboardState(evt)
756 {
757 DoAssignMembers(evt);
758
759 InitPropagation();
760 }
761
762 wxKeyEvent::wxKeyEvent(wxEventType eventType, const wxKeyEvent& evt)
763 : wxEvent(evt),
764 wxKeyboardState(evt)
765 {
766 DoAssignMembers(evt);
767
768 m_eventType = eventType;
769
770 InitPropagation();
771 }
772
773 void wxKeyEvent::InitPositionIfNecessary() const
774 {
775 if ( m_hasPosition )
776 return;
777
778 // We're const because we're called from const Get[XY]() methods but we
779 // need to update the "cached" values.
780 wxKeyEvent& self = const_cast<wxKeyEvent&>(*this);
781 self.m_hasPosition = true;
782
783 // The only position we can possibly associate with the keyboard event on
784 // the platforms where it doesn't carry it already is the mouse position.
785 wxGetMousePosition(&self.m_x, &self.m_y);
786
787 // If this event is associated with a window, the position should be in its
788 // client coordinates, but otherwise leave it in screen coordinates as what
789 // else can we use?
790 wxWindow* const win = wxDynamicCast(GetEventObject(), wxWindow);
791 if ( win )
792 win->ScreenToClient(&self.m_x, &self.m_y);
793 }
794
795 wxCoord wxKeyEvent::GetX() const
796 {
797 InitPositionIfNecessary();
798
799 return m_x;
800 }
801
802 wxCoord wxKeyEvent::GetY() const
803 {
804 InitPositionIfNecessary();
805
806 return m_y;
807 }
808
809 bool wxKeyEvent::IsKeyInCategory(int category) const
810 {
811 switch ( GetKeyCode() )
812 {
813 case WXK_LEFT:
814 case WXK_RIGHT:
815 case WXK_UP:
816 case WXK_DOWN:
817 case WXK_NUMPAD_LEFT:
818 case WXK_NUMPAD_RIGHT:
819 case WXK_NUMPAD_UP:
820 case WXK_NUMPAD_DOWN:
821 return (category & WXK_CATEGORY_ARROW) != 0;
822
823 case WXK_PAGEDOWN:
824 case WXK_END:
825 case WXK_NUMPAD_PAGEUP:
826 case WXK_NUMPAD_PAGEDOWN:
827 return (category & WXK_CATEGORY_PAGING) != 0;
828
829 case WXK_HOME:
830 case WXK_PAGEUP:
831 case WXK_NUMPAD_HOME:
832 case WXK_NUMPAD_END:
833 return (category & WXK_CATEGORY_JUMP) != 0;
834
835 case WXK_TAB:
836 case WXK_NUMPAD_TAB:
837 return (category & WXK_CATEGORY_TAB) != 0;
838
839 case WXK_BACK:
840 case WXK_DELETE:
841 case WXK_NUMPAD_DELETE:
842 return (category & WXK_CATEGORY_CUT) != 0;
843
844 default:
845 return false;
846 }
847 }
848
849 // ----------------------------------------------------------------------------
850 // wxWindowCreateEvent
851 // ----------------------------------------------------------------------------
852
853 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win)
854 {
855 SetEventType(wxEVT_CREATE);
856 SetEventObject(win);
857 }
858
859 // ----------------------------------------------------------------------------
860 // wxWindowDestroyEvent
861 // ----------------------------------------------------------------------------
862
863 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow *win)
864 {
865 SetEventType(wxEVT_DESTROY);
866 SetEventObject(win);
867 }
868
869 // ----------------------------------------------------------------------------
870 // wxChildFocusEvent
871 // ----------------------------------------------------------------------------
872
873 wxChildFocusEvent::wxChildFocusEvent(wxWindow *win)
874 : wxCommandEvent(wxEVT_CHILD_FOCUS)
875 {
876 SetEventObject(win);
877 }
878
879 // ----------------------------------------------------------------------------
880 // wxHelpEvent
881 // ----------------------------------------------------------------------------
882
883 /* static */
884 wxHelpEvent::Origin wxHelpEvent::GuessOrigin(Origin origin)
885 {
886 if ( origin == Origin_Unknown )
887 {
888 // assume that the event comes from the help button if it's not from
889 // keyboard and that pressing F1 always results in the help event
890 origin = wxGetKeyState(WXK_F1) ? Origin_Keyboard : Origin_HelpButton;
891 }
892
893 return origin;
894 }
895
896 #endif // wxUSE_GUI
897
898
899 #if wxUSE_BASE
900
901 // ----------------------------------------------------------------------------
902 // wxEventHashTable
903 // ----------------------------------------------------------------------------
904
905 static const int EVENT_TYPE_TABLE_INIT_SIZE = 31; // Not too big not too small...
906
907 wxEventHashTable* wxEventHashTable::sm_first = NULL;
908
909 wxEventHashTable::wxEventHashTable(const wxEventTable &table)
910 : m_table(table),
911 m_rebuildHash(true)
912 {
913 AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE);
914
915 m_next = sm_first;
916 if (m_next)
917 m_next->m_previous = this;
918 sm_first = this;
919 }
920
921 wxEventHashTable::~wxEventHashTable()
922 {
923 if (m_next)
924 m_next->m_previous = m_previous;
925 if (m_previous)
926 m_previous->m_next = m_next;
927 if (sm_first == this)
928 sm_first = m_next;
929
930 Clear();
931 }
932
933 void wxEventHashTable::Clear()
934 {
935 for ( size_t i = 0; i < m_size; i++ )
936 {
937 EventTypeTablePointer eTTnode = m_eventTypeTable[i];
938 delete eTTnode;
939 }
940
941 wxDELETEA(m_eventTypeTable);
942
943 m_size = 0;
944 }
945
946 #if wxUSE_MEMORY_TRACING
947
948 // Clear all tables
949 void wxEventHashTable::ClearAll()
950 {
951 wxEventHashTable* table = sm_first;
952 while (table)
953 {
954 table->Clear();
955 table = table->m_next;
956 }
957 }
958
959 #endif // wxUSE_MEMORY_TRACING
960
961 bool wxEventHashTable::HandleEvent(wxEvent &event, wxEvtHandler *self)
962 {
963 if (m_rebuildHash)
964 {
965 InitHashTable();
966 m_rebuildHash = false;
967 }
968
969 if (!m_eventTypeTable)
970 return false;
971
972 // Find all entries for the given event type.
973 wxEventType eventType = event.GetEventType();
974 const EventTypeTablePointer eTTnode = m_eventTypeTable[eventType % m_size];
975 if (eTTnode && eTTnode->eventType == eventType)
976 {
977 // Now start the search for an event handler
978 // that can handle an event with the given ID.
979 const wxEventTableEntryPointerArray&
980 eventEntryTable = eTTnode->eventEntryTable;
981
982 const size_t count = eventEntryTable.GetCount();
983 for (size_t n = 0; n < count; n++)
984 {
985 const wxEventTableEntry& entry = *eventEntryTable[n];
986 if ( wxEvtHandler::ProcessEventIfMatchesId(entry, self, event) )
987 return true;
988 }
989 }
990
991 return false;
992 }
993
994 void wxEventHashTable::InitHashTable()
995 {
996 // Loop over the event tables and all its base tables.
997 const wxEventTable *table = &m_table;
998 while (table)
999 {
1000 // Retrieve all valid event handler entries
1001 const wxEventTableEntry *entry = table->entries;
1002 while (entry->m_fn != 0)
1003 {
1004 // Add the event entry in the Hash.
1005 AddEntry(*entry);
1006
1007 entry++;
1008 }
1009
1010 table = table->baseTable;
1011 }
1012
1013 // Let's free some memory.
1014 size_t i;
1015 for(i = 0; i < m_size; i++)
1016 {
1017 EventTypeTablePointer eTTnode = m_eventTypeTable[i];
1018 if (eTTnode)
1019 {
1020 eTTnode->eventEntryTable.Shrink();
1021 }
1022 }
1023 }
1024
1025 void wxEventHashTable::AddEntry(const wxEventTableEntry &entry)
1026 {
1027 // This might happen 'accidentally' as the app is exiting
1028 if (!m_eventTypeTable)
1029 return;
1030
1031 EventTypeTablePointer *peTTnode = &m_eventTypeTable[entry.m_eventType % m_size];
1032 EventTypeTablePointer eTTnode = *peTTnode;
1033
1034 if (eTTnode)
1035 {
1036 if (eTTnode->eventType != entry.m_eventType)
1037 {
1038 // Resize the table!
1039 GrowEventTypeTable();
1040 // Try again to add it.
1041 AddEntry(entry);
1042 return;
1043 }
1044 }
1045 else
1046 {
1047 eTTnode = new EventTypeTable;
1048 eTTnode->eventType = entry.m_eventType;
1049 *peTTnode = eTTnode;
1050 }
1051
1052 // Fill all hash entries between entry.m_id and entry.m_lastId...
1053 eTTnode->eventEntryTable.Add(&entry);
1054 }
1055
1056 void wxEventHashTable::AllocEventTypeTable(size_t size)
1057 {
1058 m_eventTypeTable = new EventTypeTablePointer[size];
1059 memset((void *)m_eventTypeTable, 0, sizeof(EventTypeTablePointer)*size);
1060 m_size = size;
1061 }
1062
1063 void wxEventHashTable::GrowEventTypeTable()
1064 {
1065 size_t oldSize = m_size;
1066 EventTypeTablePointer *oldEventTypeTable = m_eventTypeTable;
1067
1068 // TODO: Search the most optimal grow sequence
1069 AllocEventTypeTable(/* GetNextPrime(oldSize) */oldSize*2+1);
1070
1071 for ( size_t i = 0; i < oldSize; /* */ )
1072 {
1073 EventTypeTablePointer eTToldNode = oldEventTypeTable[i];
1074 if (eTToldNode)
1075 {
1076 EventTypeTablePointer *peTTnode = &m_eventTypeTable[eTToldNode->eventType % m_size];
1077 EventTypeTablePointer eTTnode = *peTTnode;
1078
1079 // Check for collision, we don't want any.
1080 if (eTTnode)
1081 {
1082 GrowEventTypeTable();
1083 continue; // Don't increment the counter,
1084 // as we still need to add this element.
1085 }
1086 else
1087 {
1088 // Get the old value and put it in the new table.
1089 *peTTnode = oldEventTypeTable[i];
1090 }
1091 }
1092
1093 i++;
1094 }
1095
1096 delete[] oldEventTypeTable;
1097 }
1098
1099 // ----------------------------------------------------------------------------
1100 // wxEvtHandler
1101 // ----------------------------------------------------------------------------
1102
1103 wxEvtHandler::wxEvtHandler()
1104 {
1105 m_nextHandler = NULL;
1106 m_previousHandler = NULL;
1107 m_enabled = true;
1108 m_dynamicEvents = NULL;
1109 m_pendingEvents = NULL;
1110
1111 // no client data (yet)
1112 m_clientData = NULL;
1113 m_clientDataType = wxClientData_None;
1114 }
1115
1116 wxEvtHandler::~wxEvtHandler()
1117 {
1118 Unlink();
1119
1120 if (m_dynamicEvents)
1121 {
1122 for ( wxList::iterator it = m_dynamicEvents->begin(),
1123 end = m_dynamicEvents->end();
1124 it != end;
1125 ++it )
1126 {
1127 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)*it;
1128
1129 // Remove ourselves from sink destructor notifications
1130 // (this has usually been done, in wxTrackable destructor)
1131 wxEvtHandler *eventSink = entry->m_fn->GetEvtHandler();
1132 if ( eventSink )
1133 {
1134 wxEventConnectionRef * const
1135 evtConnRef = FindRefInTrackerList(eventSink);
1136 if ( evtConnRef )
1137 {
1138 eventSink->RemoveNode(evtConnRef);
1139 delete evtConnRef;
1140 }
1141 }
1142
1143 delete entry->m_callbackUserData;
1144 delete entry;
1145 }
1146 delete m_dynamicEvents;
1147 }
1148
1149 // Remove us from the list of the pending events if necessary.
1150 if (wxTheApp)
1151 wxTheApp->RemovePendingEventHandler(this);
1152
1153 DeletePendingEvents();
1154
1155 // we only delete object data, not untyped
1156 if ( m_clientDataType == wxClientData_Object )
1157 delete m_clientObject;
1158 }
1159
1160 void wxEvtHandler::Unlink()
1161 {
1162 // this event handler must take itself out of the chain of handlers:
1163
1164 if (m_previousHandler)
1165 m_previousHandler->SetNextHandler(m_nextHandler);
1166
1167 if (m_nextHandler)
1168 m_nextHandler->SetPreviousHandler(m_previousHandler);
1169
1170 m_nextHandler = NULL;
1171 m_previousHandler = NULL;
1172 }
1173
1174 bool wxEvtHandler::IsUnlinked() const
1175 {
1176 return m_previousHandler == NULL &&
1177 m_nextHandler == NULL;
1178 }
1179
1180 wxEventFilter* wxEvtHandler::ms_filterList = NULL;
1181
1182 /* static */ void wxEvtHandler::AddFilter(wxEventFilter* filter)
1183 {
1184 wxCHECK_RET( filter, "NULL filter" );
1185
1186 filter->m_next = ms_filterList;
1187 ms_filterList = filter;
1188 }
1189
1190 /* static */ void wxEvtHandler::RemoveFilter(wxEventFilter* filter)
1191 {
1192 wxEventFilter* prev = NULL;
1193 for ( wxEventFilter* f = ms_filterList; f; f = f->m_next )
1194 {
1195 if ( f == filter )
1196 {
1197 // Set the previous list element or the list head to the next
1198 // element.
1199 if ( prev )
1200 prev->m_next = f->m_next;
1201 else
1202 ms_filterList = f->m_next;
1203
1204 // Also reset the next pointer in the filter itself just to avoid
1205 // having possibly dangling pointers, even though it's not strictly
1206 // necessary.
1207 f->m_next = NULL;
1208
1209 // Skip the assert below.
1210 return;
1211 }
1212
1213 prev = f;
1214 }
1215
1216 wxFAIL_MSG( "Filter not found" );
1217 }
1218
1219 #if wxUSE_THREADS
1220
1221 bool wxEvtHandler::ProcessThreadEvent(const wxEvent& event)
1222 {
1223 // check that we are really in a child thread
1224 wxASSERT_MSG( !wxThread::IsMain(),
1225 wxT("use ProcessEvent() in main thread") );
1226
1227 AddPendingEvent(event);
1228
1229 return true;
1230 }
1231
1232 #endif // wxUSE_THREADS
1233
1234 void wxEvtHandler::QueueEvent(wxEvent *event)
1235 {
1236 wxCHECK_RET( event, "NULL event can't be posted" );
1237
1238 if (!wxTheApp)
1239 {
1240 // we need an event loop which manages the list of event handlers with
1241 // pending events... cannot proceed without it!
1242 wxLogDebug("No application object! Cannot queue this event!");
1243
1244 // anyway delete the given event to avoid memory leaks
1245 delete event;
1246
1247 return;
1248 }
1249
1250 // 1) Add this event to our list of pending events
1251 wxENTER_CRIT_SECT( m_pendingEventsLock );
1252
1253 if ( !m_pendingEvents )
1254 m_pendingEvents = new wxList;
1255
1256 m_pendingEvents->Append(event);
1257
1258 // 2) Add this event handler to list of event handlers that
1259 // have pending events.
1260
1261 wxTheApp->AppendPendingEventHandler(this);
1262
1263 // only release m_pendingEventsLock now because otherwise there is a race
1264 // condition as described in the ticket #9093: we could process the event
1265 // just added to m_pendingEvents in our ProcessPendingEvents() below before
1266 // we had time to append this pointer to wxHandlersWithPendingEvents list; thus
1267 // breaking the invariant that a handler should be in the list iff it has
1268 // any pending events to process
1269 wxLEAVE_CRIT_SECT( m_pendingEventsLock );
1270
1271 // 3) Inform the system that new pending events are somewhere,
1272 // and that these should be processed in idle time.
1273 wxWakeUpIdle();
1274 }
1275
1276 void wxEvtHandler::DeletePendingEvents()
1277 {
1278 if (m_pendingEvents)
1279 m_pendingEvents->DeleteContents(true);
1280 wxDELETE(m_pendingEvents);
1281 }
1282
1283 void wxEvtHandler::ProcessPendingEvents()
1284 {
1285 if (!wxTheApp)
1286 {
1287 // we need an event loop which manages the list of event handlers with
1288 // pending events... cannot proceed without it!
1289 wxLogDebug("No application object! Cannot process pending events!");
1290 return;
1291 }
1292
1293 // we need to process only a single pending event in this call because
1294 // each call to ProcessEvent() could result in the destruction of this
1295 // same event handler (see the comment at the end of this function)
1296
1297 wxENTER_CRIT_SECT( m_pendingEventsLock );
1298
1299 // this method is only called by wxApp if this handler does have
1300 // pending events
1301 wxCHECK_RET( m_pendingEvents && !m_pendingEvents->IsEmpty(),
1302 "should have pending events if called" );
1303
1304 wxList::compatibility_iterator node = m_pendingEvents->GetFirst();
1305 wxEvent* pEvent = static_cast<wxEvent *>(node->GetData());
1306
1307 // find the first event which can be processed now:
1308 wxEventLoopBase* evtLoop = wxEventLoopBase::GetActive();
1309 if (evtLoop && evtLoop->IsYielding())
1310 {
1311 while (node && pEvent && !evtLoop->IsEventAllowedInsideYield(pEvent->GetEventCategory()))
1312 {
1313 node = node->GetNext();
1314 pEvent = node ? static_cast<wxEvent *>(node->GetData()) : NULL;
1315 }
1316
1317 if (!node)
1318 {
1319 // all our events are NOT processable now... signal this:
1320 wxTheApp->DelayPendingEventHandler(this);
1321
1322 // see the comment at the beginning of evtloop.h header for the
1323 // logic behind YieldFor() and behind DelayPendingEventHandler()
1324
1325 wxLEAVE_CRIT_SECT( m_pendingEventsLock );
1326
1327 return;
1328 }
1329 }
1330
1331 wxEventPtr event(pEvent);
1332
1333 // it's important we remove event from list before processing it, else a
1334 // nested event loop, for example from a modal dialog, might process the
1335 // same event again.
1336 m_pendingEvents->Erase(node);
1337
1338 if ( m_pendingEvents->IsEmpty() )
1339 {
1340 // if there are no more pending events left, we don't need to
1341 // stay in this list
1342 wxTheApp->RemovePendingEventHandler(this);
1343 }
1344
1345 wxLEAVE_CRIT_SECT( m_pendingEventsLock );
1346
1347 ProcessEvent(*event);
1348
1349 // careful: this object could have been deleted by the event handler
1350 // executed by the above ProcessEvent() call, so we can't access any fields
1351 // of this object any more
1352 }
1353
1354 /* static */
1355 bool wxEvtHandler::ProcessEventIfMatchesId(const wxEventTableEntryBase& entry,
1356 wxEvtHandler *handler,
1357 wxEvent& event)
1358 {
1359 int tableId1 = entry.m_id,
1360 tableId2 = entry.m_lastId;
1361
1362 // match only if the event type is the same and the id is either -1 in
1363 // the event table (meaning "any") or the event id matches the id
1364 // specified in the event table either exactly or by falling into
1365 // range between first and last
1366 if ((tableId1 == wxID_ANY) ||
1367 (tableId2 == wxID_ANY && tableId1 == event.GetId()) ||
1368 (tableId2 != wxID_ANY &&
1369 (event.GetId() >= tableId1 && event.GetId() <= tableId2)))
1370 {
1371 event.Skip(false);
1372 event.m_callbackUserData = entry.m_callbackUserData;
1373
1374 #if wxUSE_EXCEPTIONS
1375 if ( wxTheApp )
1376 {
1377 // call the handler via wxApp method which allows the user to catch
1378 // any exceptions which may be thrown by any handler in the program
1379 // in one place
1380 wxTheApp->CallEventHandler(handler, *entry.m_fn, event);
1381 }
1382 else
1383 #endif // wxUSE_EXCEPTIONS
1384 {
1385 (*entry.m_fn)(handler, event);
1386 }
1387
1388 if (!event.GetSkipped())
1389 return true;
1390 }
1391
1392 return false;
1393 }
1394
1395 bool wxEvtHandler::DoTryApp(wxEvent& event)
1396 {
1397 if ( wxTheApp && (this != wxTheApp) )
1398 {
1399 // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
1400 // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
1401 // processed appropriately via SearchEventTable.
1402 if ( event.GetEventType() != wxEVT_IDLE )
1403 {
1404 if ( wxTheApp->ProcessEvent(event) )
1405 return true;
1406 }
1407 }
1408
1409 return false;
1410 }
1411
1412 bool wxEvtHandler::TryBefore(wxEvent& event)
1413 {
1414 #if WXWIN_COMPATIBILITY_2_8
1415 // call the old virtual function to keep the code overriding it working
1416 return TryValidator(event);
1417 #else
1418 wxUnusedVar(event);
1419 return false;
1420 #endif
1421 }
1422
1423 bool wxEvtHandler::TryAfter(wxEvent& event)
1424 {
1425 // We only want to pass the window to the application object once even if
1426 // there are several chained handlers. Ensure that this is what happens by
1427 // only calling DoTryApp() if there is no next handler (which would do it).
1428 //
1429 // Notice that, unlike simply calling TryAfter() on the last handler in the
1430 // chain only from ProcessEvent(), this also works with wxWindow object in
1431 // the middle of the chain: its overridden TryAfter() will still be called
1432 // and propagate the event upwards the window hierarchy even if it's not
1433 // the last one in the chain (which, admittedly, shouldn't happen often).
1434 if ( GetNextHandler() )
1435 return GetNextHandler()->TryAfter(event);
1436
1437 // If this event is going to be processed in another handler next, don't
1438 // pass it to wxTheApp now, it will be done from TryAfter() of this other
1439 // handler.
1440 if ( event.WillBeProcessedAgain() )
1441 return false;
1442
1443 #if WXWIN_COMPATIBILITY_2_8
1444 // as above, call the old virtual function for compatibility
1445 return TryParent(event);
1446 #else
1447 return DoTryApp(event);
1448 #endif
1449 }
1450
1451 bool wxEvtHandler::ProcessEvent(wxEvent& event)
1452 {
1453 // The very first thing we do is to allow any registered filters to hook
1454 // into event processing in order to globally pre-process all events.
1455 //
1456 // Note that we should only do it if we're the first event handler called
1457 // to avoid calling FilterEvent() multiple times as the event goes through
1458 // the event handler chain and possibly upwards the window hierarchy.
1459 if ( !event.WasProcessed() )
1460 {
1461 for ( wxEventFilter* f = ms_filterList; f; f = f->m_next )
1462 {
1463 int rc = f->FilterEvent(event);
1464 if ( rc != wxEventFilter::Event_Skip )
1465 {
1466 wxASSERT_MSG( rc == wxEventFilter::Event_Ignore ||
1467 rc == wxEventFilter::Event_Processed,
1468 "unexpected FilterEvent() return value" );
1469
1470 return rc != wxEventFilter::Event_Ignore;
1471 }
1472 //else: proceed normally
1473 }
1474 }
1475
1476 // Short circuit the event processing logic if we're requested to process
1477 // this event in this handler only, see DoTryChain() for more details.
1478 if ( event.ShouldProcessOnlyIn(this) )
1479 return TryBeforeAndHere(event);
1480
1481
1482 // Try to process the event in this handler itself.
1483 if ( ProcessEventLocally(event) )
1484 {
1485 // It is possible that DoTryChain() called from ProcessEventLocally()
1486 // returned true but the event was not really processed: this happens
1487 // if a custom handler ignores the request to process the event in this
1488 // handler only and in this case we should skip the post processing
1489 // done in TryAfter() but still return the correct value ourselves to
1490 // indicate whether we did or did not find a handler for this event.
1491 return !event.GetSkipped();
1492 }
1493
1494 // If we still didn't find a handler, propagate the event upwards the
1495 // window chain and/or to the application object.
1496 if ( TryAfter(event) )
1497 return true;
1498
1499
1500 // No handler found anywhere, bail out.
1501 return false;
1502 }
1503
1504 bool wxEvtHandler::ProcessEventLocally(wxEvent& event)
1505 {
1506 // Try the hooks which should be called before our own handlers and this
1507 // handler itself first. Notice that we should not call ProcessEvent() on
1508 // this one as we're already called from it, which explains why we do it
1509 // here and not in DoTryChain()
1510 return TryBeforeAndHere(event) || DoTryChain(event);
1511 }
1512
1513 bool wxEvtHandler::DoTryChain(wxEvent& event)
1514 {
1515 for ( wxEvtHandler *h = GetNextHandler(); h; h = h->GetNextHandler() )
1516 {
1517 // We need to process this event at the level of this handler only
1518 // right now, the pre-/post-processing was either already done by
1519 // ProcessEvent() from which we were called or will be done by it when
1520 // we return.
1521 //
1522 // However we must call ProcessEvent() and not TryHereOnly() because the
1523 // existing code (including some in wxWidgets itself) expects the
1524 // overridden ProcessEvent() in its custom event handlers pushed on a
1525 // window to be called.
1526 //
1527 // So we must call ProcessEvent() but it must not do what it usually
1528 // does. To resolve this paradox we set up a special flag inside the
1529 // object itself to let ProcessEvent() know that it shouldn't do any
1530 // pre/post-processing for this event if it gets it. Note that this
1531 // only applies to this handler, if the event is passed to another one
1532 // by explicitly calling its ProcessEvent(), pre/post-processing should
1533 // be done as usual.
1534 //
1535 // Final complication is that if the implementation of ProcessEvent()
1536 // called wxEvent::DidntHonourProcessOnlyIn() (as the gross hack that
1537 // is wxScrollHelperEvtHandler::ProcessEvent() does) and ignored our
1538 // request to process event in this handler only, we have to compensate
1539 // for it by not processing the event further because this was already
1540 // done by that rogue event handler.
1541 wxEventProcessInHandlerOnly processInHandlerOnly(event, h);
1542 if ( h->ProcessEvent(event) )
1543 {
1544 // Make sure "skipped" flag is not set as the event was really
1545 // processed in this case. Normally it shouldn't be set anyhow but
1546 // make sure just in case the user code does something strange.
1547 event.Skip(false);
1548
1549 return true;
1550 }
1551
1552 if ( !event.ShouldProcessOnlyIn(h) )
1553 {
1554 // Still return true to indicate that no further processing should
1555 // be undertaken but ensure that "skipped" flag is set so that the
1556 // caller knows that the event was not really processed.
1557 event.Skip();
1558
1559 return true;
1560 }
1561 }
1562
1563 return false;
1564 }
1565
1566 bool wxEvtHandler::TryHereOnly(wxEvent& event)
1567 {
1568 // If the event handler is disabled it doesn't process any events
1569 if ( !GetEvtHandlerEnabled() )
1570 return false;
1571
1572 // Handle per-instance dynamic event tables first
1573 if ( m_dynamicEvents && SearchDynamicEventTable(event) )
1574 return true;
1575
1576 // Then static per-class event tables
1577 if ( GetEventHashTable().HandleEvent(event, this) )
1578 return true;
1579
1580 #ifdef wxHAS_CALL_AFTER
1581 // There is an implicit entry for async method calls processing in every
1582 // event handler:
1583 if ( event.GetEventType() == wxEVT_ASYNC_METHOD_CALL &&
1584 event.GetEventObject() == this )
1585 {
1586 static_cast<wxAsyncMethodCallEvent&>(event).Execute();
1587 return true;
1588 }
1589 #endif // wxHAS_CALL_AFTER
1590
1591 // We don't have a handler for this event.
1592 return false;
1593 }
1594
1595 bool wxEvtHandler::SafelyProcessEvent(wxEvent& event)
1596 {
1597 #if wxUSE_EXCEPTIONS
1598 try
1599 {
1600 #endif
1601 return ProcessEvent(event);
1602 #if wxUSE_EXCEPTIONS
1603 }
1604 catch ( ... )
1605 {
1606 // notice that we do it in 2 steps to avoid warnings about possibly
1607 // uninitialized loop variable from some versions of g++ which are not
1608 // smart enough to figure out that GetActive() doesn't throw and so
1609 // that loop will always be initialized
1610 wxEventLoopBase *loop = NULL;
1611 try
1612 {
1613 loop = wxEventLoopBase::GetActive();
1614
1615 if ( !wxTheApp || !wxTheApp->OnExceptionInMainLoop() )
1616 {
1617 if ( loop )
1618 loop->Exit();
1619 }
1620 //else: continue running current event loop
1621
1622 return false;
1623 }
1624 catch ( ... )
1625 {
1626 // OnExceptionInMainLoop() threw, possibly rethrowing the same
1627 // exception again: very good, but we still need Exit() to
1628 // be called
1629 if ( loop )
1630 loop->Exit();
1631 throw;
1632 }
1633 }
1634 #endif // wxUSE_EXCEPTIONS
1635 }
1636
1637 bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event)
1638 {
1639 const wxEventType eventType = event.GetEventType();
1640 for ( int i = 0; table.entries[i].m_fn != 0; i++ )
1641 {
1642 const wxEventTableEntry& entry = table.entries[i];
1643 if ( eventType == entry.m_eventType )
1644 {
1645 if ( ProcessEventIfMatchesId(entry, this, event) )
1646 return true;
1647 }
1648 }
1649
1650 return false;
1651 }
1652
1653 void wxEvtHandler::DoBind(int id,
1654 int lastId,
1655 wxEventType eventType,
1656 wxEventFunctor *func,
1657 wxObject *userData)
1658 {
1659 wxDynamicEventTableEntry *entry =
1660 new wxDynamicEventTableEntry(eventType, id, lastId, func, userData);
1661
1662 if (!m_dynamicEvents)
1663 m_dynamicEvents = new wxList;
1664
1665 // Insert at the front of the list so most recent additions are found first
1666 m_dynamicEvents->Insert( (wxObject*) entry );
1667
1668 // Make sure we get to know when a sink is destroyed
1669 wxEvtHandler *eventSink = func->GetEvtHandler();
1670 if ( eventSink && eventSink != this )
1671 {
1672 wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink);
1673 if ( evtConnRef )
1674 evtConnRef->IncRef( );
1675 else
1676 new wxEventConnectionRef(this, eventSink);
1677 }
1678 }
1679
1680 bool
1681 wxEvtHandler::DoUnbind(int id,
1682 int lastId,
1683 wxEventType eventType,
1684 const wxEventFunctor& func,
1685 wxObject *userData)
1686 {
1687 if (!m_dynamicEvents)
1688 return false;
1689
1690 wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();
1691 while (node)
1692 {
1693 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1694
1695 if ((entry->m_id == id) &&
1696 ((entry->m_lastId == lastId) || (lastId == wxID_ANY)) &&
1697 ((entry->m_eventType == eventType) || (eventType == wxEVT_NULL)) &&
1698 entry->m_fn->IsMatching(func) &&
1699 ((entry->m_callbackUserData == userData) || !userData))
1700 {
1701 // Remove connection from tracker node (wxEventConnectionRef)
1702 wxEvtHandler *eventSink = entry->m_fn->GetEvtHandler();
1703 if ( eventSink && eventSink != this )
1704 {
1705 wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink);
1706 if ( evtConnRef )
1707 evtConnRef->DecRef();
1708 }
1709
1710 delete entry->m_callbackUserData;
1711 m_dynamicEvents->Erase( node );
1712 delete entry;
1713 return true;
1714 }
1715 node = node->GetNext();
1716 }
1717 return false;
1718 }
1719
1720 bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event )
1721 {
1722 wxCHECK_MSG( m_dynamicEvents, false,
1723 wxT("caller should check that we have dynamic events") );
1724
1725 wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();
1726 while (node)
1727 {
1728 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1729
1730 // get next node before (maybe) calling the event handler as it could
1731 // call Disconnect() invalidating the current node
1732 node = node->GetNext();
1733
1734 if ( event.GetEventType() == entry->m_eventType )
1735 {
1736 wxEvtHandler *handler = entry->m_fn->GetEvtHandler();
1737 if ( !handler )
1738 handler = this;
1739 if ( ProcessEventIfMatchesId(*entry, handler, event) )
1740 return true;
1741 }
1742 }
1743
1744 return false;
1745 }
1746
1747 void wxEvtHandler::DoSetClientObject( wxClientData *data )
1748 {
1749 wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1750 wxT("can't have both object and void client data") );
1751
1752 if ( m_clientObject )
1753 delete m_clientObject;
1754
1755 m_clientObject = data;
1756 m_clientDataType = wxClientData_Object;
1757 }
1758
1759 wxClientData *wxEvtHandler::DoGetClientObject() const
1760 {
1761 // it's not an error to call GetClientObject() on a window which doesn't
1762 // have client data at all - NULL will be returned
1763 wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1764 wxT("this window doesn't have object client data") );
1765
1766 return m_clientObject;
1767 }
1768
1769 void wxEvtHandler::DoSetClientData( void *data )
1770 {
1771 wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1772 wxT("can't have both object and void client data") );
1773
1774 m_clientData = data;
1775 m_clientDataType = wxClientData_Void;
1776 }
1777
1778 void *wxEvtHandler::DoGetClientData() const
1779 {
1780 // it's not an error to call GetClientData() on a window which doesn't have
1781 // client data at all - NULL will be returned
1782 wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1783 wxT("this window doesn't have void client data") );
1784
1785 return m_clientData;
1786 }
1787
1788 // A helper to find an wxEventConnectionRef object
1789 wxEventConnectionRef *
1790 wxEvtHandler::FindRefInTrackerList(wxEvtHandler *eventSink)
1791 {
1792 for ( wxTrackerNode *node = eventSink->GetFirst(); node; node = node->m_nxt )
1793 {
1794 // we only want wxEventConnectionRef nodes here
1795 wxEventConnectionRef *evtConnRef = node->ToEventConnection();
1796 if ( evtConnRef && evtConnRef->m_src == this )
1797 {
1798 wxASSERT( evtConnRef->m_sink==eventSink );
1799 return evtConnRef;
1800 }
1801 }
1802
1803 return NULL;
1804 }
1805
1806 void wxEvtHandler::OnSinkDestroyed( wxEvtHandler *sink )
1807 {
1808 wxASSERT(m_dynamicEvents);
1809
1810 // remove all connections with this sink
1811 wxList::compatibility_iterator node = m_dynamicEvents->GetFirst(), node_nxt;
1812 while (node)
1813 {
1814 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1815 node_nxt = node->GetNext();
1816
1817 if ( entry->m_fn->GetEvtHandler() == sink )
1818 {
1819 delete entry->m_callbackUserData;
1820 m_dynamicEvents->Erase( node );
1821 delete entry;
1822 }
1823 node = node_nxt;
1824 }
1825 }
1826
1827 #endif // wxUSE_BASE
1828
1829 #if wxUSE_GUI
1830
1831 // Find a window with the focus, that is also a descendant of the given window.
1832 // This is used to determine the window to initially send commands to.
1833 wxWindow* wxFindFocusDescendant(wxWindow* ancestor)
1834 {
1835 // Process events starting with the window with the focus, if any.
1836 wxWindow* focusWin = wxWindow::FindFocus();
1837 wxWindow* win = focusWin;
1838
1839 // Check if this is a descendant of this frame.
1840 // If not, win will be set to NULL.
1841 while (win)
1842 {
1843 if (win == ancestor)
1844 break;
1845 else
1846 win = win->GetParent();
1847 }
1848 if (win == NULL)
1849 focusWin = NULL;
1850
1851 return focusWin;
1852 }
1853
1854 // ----------------------------------------------------------------------------
1855 // wxEventBlocker
1856 // ----------------------------------------------------------------------------
1857
1858 wxEventBlocker::wxEventBlocker(wxWindow *win, wxEventType type)
1859 {
1860 wxCHECK_RET(win, wxT("Null window given to wxEventBlocker"));
1861
1862 m_window = win;
1863
1864 Block(type);
1865 m_window->PushEventHandler(this);
1866 }
1867
1868 wxEventBlocker::~wxEventBlocker()
1869 {
1870 wxEvtHandler *popped = m_window->PopEventHandler(false);
1871 wxCHECK_RET(popped == this,
1872 wxT("Don't push other event handlers into a window managed by wxEventBlocker!"));
1873 }
1874
1875 bool wxEventBlocker::ProcessEvent(wxEvent& event)
1876 {
1877 // should this event be blocked?
1878 for ( size_t i = 0; i < m_eventsToBlock.size(); i++ )
1879 {
1880 wxEventType t = (wxEventType)m_eventsToBlock[i];
1881 if ( t == wxEVT_ANY || t == event.GetEventType() )
1882 return true; // yes, it should: mark this event as processed
1883 }
1884
1885 return false;
1886 }
1887
1888 #endif // wxUSE_GUI
1889
wxWidgets (Impactor)