]> git.saurik.com Git - wxWidgets.git/blob - src/common/event.cpp
projects / wxWidgets.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
make methods available to all ports
[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 m_columnsPerAction = 0;
569 }
570
571 void wxMouseEvent::Assign(const wxMouseEvent& event)
572 {
573 wxEvent::operator=(event);
574
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;
578
579 m_x = event.m_x;
580 m_y = event.m_y;
581
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;
587
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;
593 }
594
595 // return true if was a button dclick event
596 bool wxMouseEvent::ButtonDClick(int but) const
597 {
598 switch (but)
599 {
600 default:
601 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
602 // fall through
603
604 case wxMOUSE_BTN_ANY:
605 return (LeftDClick() || MiddleDClick() || RightDClick() ||
606 Aux1DClick() || Aux2DClick());
607
608 case wxMOUSE_BTN_LEFT:
609 return LeftDClick();
610
611 case wxMOUSE_BTN_MIDDLE:
612 return MiddleDClick();
613
614 case wxMOUSE_BTN_RIGHT:
615 return RightDClick();
616
617 case wxMOUSE_BTN_AUX1:
618 return Aux1DClick();
619
620 case wxMOUSE_BTN_AUX2:
621 return Aux2DClick();
622 }
623 }
624
625 // return true if was a button down event
626 bool wxMouseEvent::ButtonDown(int but) const
627 {
628 switch (but)
629 {
630 default:
631 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
632 // fall through
633
634 case wxMOUSE_BTN_ANY:
635 return (LeftDown() || MiddleDown() || RightDown() ||
636 Aux1Down() || Aux2Down());
637
638 case wxMOUSE_BTN_LEFT:
639 return LeftDown();
640
641 case wxMOUSE_BTN_MIDDLE:
642 return MiddleDown();
643
644 case wxMOUSE_BTN_RIGHT:
645 return RightDown();
646
647 case wxMOUSE_BTN_AUX1:
648 return Aux1Down();
649
650 case wxMOUSE_BTN_AUX2:
651 return Aux2Down();
652 }
653 }
654
655 // return true if was a button up event
656 bool wxMouseEvent::ButtonUp(int but) const
657 {
658 switch (but)
659 {
660 default:
661 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
662 // fall through
663
664 case wxMOUSE_BTN_ANY:
665 return (LeftUp() || MiddleUp() || RightUp() ||
666 Aux1Up() || Aux2Up());
667
668 case wxMOUSE_BTN_LEFT:
669 return LeftUp();
670
671 case wxMOUSE_BTN_MIDDLE:
672 return MiddleUp();
673
674 case wxMOUSE_BTN_RIGHT:
675 return RightUp();
676
677 case wxMOUSE_BTN_AUX1:
678 return Aux1Up();
679
680 case wxMOUSE_BTN_AUX2:
681 return Aux2Up();
682 }
683 }
684
685 // return true if the given button is currently changing state
686 bool wxMouseEvent::Button(int but) const
687 {
688 switch (but)
689 {
690 default:
691 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
692 // fall through
693
694 case wxMOUSE_BTN_ANY:
695 return ButtonUp(wxMOUSE_BTN_ANY) ||
696 ButtonDown(wxMOUSE_BTN_ANY) ||
697 ButtonDClick(wxMOUSE_BTN_ANY);
698
699 case wxMOUSE_BTN_LEFT:
700 return LeftDown() || LeftUp() || LeftDClick();
701
702 case wxMOUSE_BTN_MIDDLE:
703 return MiddleDown() || MiddleUp() || MiddleDClick();
704
705 case wxMOUSE_BTN_RIGHT:
706 return RightDown() || RightUp() || RightDClick();
707
708 case wxMOUSE_BTN_AUX1:
709 return Aux1Down() || Aux1Up() || Aux1DClick();
710
711 case wxMOUSE_BTN_AUX2:
712 return Aux2Down() || Aux2Up() || Aux2DClick();
713 }
714 }
715
716 int wxMouseEvent::GetButton() const
717 {
718 for ( int i = 1; i < wxMOUSE_BTN_MAX; i++ )
719 {
720 if ( Button(i) )
721 {
722 return i;
723 }
724 }
725
726 return wxMOUSE_BTN_NONE;
727 }
728
729 // Find the logical position of the event given the DC
730 wxPoint wxMouseEvent::GetLogicalPosition(const wxDC& dc) const
731 {
732 wxPoint pt(dc.DeviceToLogicalX(m_x), dc.DeviceToLogicalY(m_y));
733 return pt;
734 }
735
736 // ----------------------------------------------------------------------------
737 // wxKeyEvent
738 // ----------------------------------------------------------------------------
739
740 wxKeyEvent::wxKeyEvent(wxEventType type)
741 {
742 m_eventType = type;
743 m_keyCode = WXK_NONE;
744 #if wxUSE_UNICODE
745 m_uniChar = WXK_NONE;
746 #endif
747
748 m_x =
749 m_y = wxDefaultCoord;
750 m_hasPosition = false;
751
752 InitPropagation();
753 }
754
755 wxKeyEvent::wxKeyEvent(const wxKeyEvent& evt)
756 : wxEvent(evt),
757 wxKeyboardState(evt)
758 {
759 DoAssignMembers(evt);
760
761 InitPropagation();
762 }
763
764 wxKeyEvent::wxKeyEvent(wxEventType eventType, const wxKeyEvent& evt)
765 : wxEvent(evt),
766 wxKeyboardState(evt)
767 {
768 DoAssignMembers(evt);
769
770 m_eventType = eventType;
771
772 InitPropagation();
773 }
774
775 void wxKeyEvent::InitPositionIfNecessary() const
776 {
777 if ( m_hasPosition )
778 return;
779
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;
784
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);
788
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
791 // else can we use?
792 wxWindow* const win = wxDynamicCast(GetEventObject(), wxWindow);
793 if ( win )
794 win->ScreenToClient(&self.m_x, &self.m_y);
795 }
796
797 wxCoord wxKeyEvent::GetX() const
798 {
799 InitPositionIfNecessary();
800
801 return m_x;
802 }
803
804 wxCoord wxKeyEvent::GetY() const
805 {
806 InitPositionIfNecessary();
807
808 return m_y;
809 }
810
811 bool wxKeyEvent::IsKeyInCategory(int category) const
812 {
813 switch ( GetKeyCode() )
814 {
815 case WXK_LEFT:
816 case WXK_RIGHT:
817 case WXK_UP:
818 case WXK_DOWN:
819 case WXK_NUMPAD_LEFT:
820 case WXK_NUMPAD_RIGHT:
821 case WXK_NUMPAD_UP:
822 case WXK_NUMPAD_DOWN:
823 return (category & WXK_CATEGORY_ARROW) != 0;
824
825 case WXK_PAGEDOWN:
826 case WXK_END:
827 case WXK_NUMPAD_PAGEUP:
828 case WXK_NUMPAD_PAGEDOWN:
829 return (category & WXK_CATEGORY_PAGING) != 0;
830
831 case WXK_HOME:
832 case WXK_PAGEUP:
833 case WXK_NUMPAD_HOME:
834 case WXK_NUMPAD_END:
835 return (category & WXK_CATEGORY_JUMP) != 0;
836
837 case WXK_TAB:
838 case WXK_NUMPAD_TAB:
839 return (category & WXK_CATEGORY_TAB) != 0;
840
841 case WXK_BACK:
842 case WXK_DELETE:
843 case WXK_NUMPAD_DELETE:
844 return (category & WXK_CATEGORY_CUT) != 0;
845
846 default:
847 return false;
848 }
849 }
850
851 // ----------------------------------------------------------------------------
852 // wxWindowCreateEvent
853 // ----------------------------------------------------------------------------
854
855 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win)
856 {
857 SetEventType(wxEVT_CREATE);
858 SetEventObject(win);
859 }
860
861 // ----------------------------------------------------------------------------
862 // wxWindowDestroyEvent
863 // ----------------------------------------------------------------------------
864
865 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow *win)
866 {
867 SetEventType(wxEVT_DESTROY);
868 SetEventObject(win);
869 }
870
871 // ----------------------------------------------------------------------------
872 // wxChildFocusEvent
873 // ----------------------------------------------------------------------------
874
875 wxChildFocusEvent::wxChildFocusEvent(wxWindow *win)
876 : wxCommandEvent(wxEVT_CHILD_FOCUS)
877 {
878 SetEventObject(win);
879 }
880
881 // ----------------------------------------------------------------------------
882 // wxHelpEvent
883 // ----------------------------------------------------------------------------
884
885 /* static */
886 wxHelpEvent::Origin wxHelpEvent::GuessOrigin(Origin origin)
887 {
888 if ( origin == Origin_Unknown )
889 {
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;
893 }
894
895 return origin;
896 }
897
898 #endif // wxUSE_GUI
899
900
901 #if wxUSE_BASE
902
903 // ----------------------------------------------------------------------------
904 // wxEventHashTable
905 // ----------------------------------------------------------------------------
906
907 static const int EVENT_TYPE_TABLE_INIT_SIZE = 31; // Not too big not too small...
908
909 wxEventHashTable* wxEventHashTable::sm_first = NULL;
910
911 wxEventHashTable::wxEventHashTable(const wxEventTable &table)
912 : m_table(table),
913 m_rebuildHash(true)
914 {
915 AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE);
916
917 m_next = sm_first;
918 if (m_next)
919 m_next->m_previous = this;
920 sm_first = this;
921 }
922
923 wxEventHashTable::~wxEventHashTable()
924 {
925 if (m_next)
926 m_next->m_previous = m_previous;
927 if (m_previous)
928 m_previous->m_next = m_next;
929 if (sm_first == this)
930 sm_first = m_next;
931
932 Clear();
933 }
934
935 void wxEventHashTable::Clear()
936 {
937 for ( size_t i = 0; i < m_size; i++ )
938 {
939 EventTypeTablePointer eTTnode = m_eventTypeTable[i];
940 delete eTTnode;
941 }
942
943 wxDELETEA(m_eventTypeTable);
944
945 m_size = 0;
946 }
947
948 #if wxUSE_MEMORY_TRACING
949
950 // Clear all tables
951 void wxEventHashTable::ClearAll()
952 {
953 wxEventHashTable* table = sm_first;
954 while (table)
955 {
956 table->Clear();
957 table = table->m_next;
958 }
959 }
960
961 #endif // wxUSE_MEMORY_TRACING
962
963 bool wxEventHashTable::HandleEvent(wxEvent &event, wxEvtHandler *self)
964 {
965 if (m_rebuildHash)
966 {
967 InitHashTable();
968 m_rebuildHash = false;
969 }
970
971 if (!m_eventTypeTable)
972 return false;
973
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)
978 {
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;
983
984 const size_t count = eventEntryTable.GetCount();
985 for (size_t n = 0; n < count; n++)
986 {
987 const wxEventTableEntry& entry = *eventEntryTable[n];
988 if ( wxEvtHandler::ProcessEventIfMatchesId(entry, self, event) )
989 return true;
990 }
991 }
992
993 return false;
994 }
995
996 void wxEventHashTable::InitHashTable()
997 {
998 // Loop over the event tables and all its base tables.
999 const wxEventTable *table = &m_table;
1000 while (table)
1001 {
1002 // Retrieve all valid event handler entries
1003 const wxEventTableEntry *entry = table->entries;
1004 while (entry->m_fn != 0)
1005 {
1006 // Add the event entry in the Hash.
1007 AddEntry(*entry);
1008
1009 entry++;
1010 }
1011
1012 table = table->baseTable;
1013 }
1014
1015 // Let's free some memory.
1016 size_t i;
1017 for(i = 0; i < m_size; i++)
1018 {
1019 EventTypeTablePointer eTTnode = m_eventTypeTable[i];
1020 if (eTTnode)
1021 {
1022 eTTnode->eventEntryTable.Shrink();
1023 }
1024 }
1025 }
1026
1027 void wxEventHashTable::AddEntry(const wxEventTableEntry &entry)
1028 {
1029 // This might happen 'accidentally' as the app is exiting
1030 if (!m_eventTypeTable)
1031 return;
1032
1033 EventTypeTablePointer *peTTnode = &m_eventTypeTable[entry.m_eventType % m_size];
1034 EventTypeTablePointer eTTnode = *peTTnode;
1035
1036 if (eTTnode)
1037 {
1038 if (eTTnode->eventType != entry.m_eventType)
1039 {
1040 // Resize the table!
1041 GrowEventTypeTable();
1042 // Try again to add it.
1043 AddEntry(entry);
1044 return;
1045 }
1046 }
1047 else
1048 {
1049 eTTnode = new EventTypeTable;
1050 eTTnode->eventType = entry.m_eventType;
1051 *peTTnode = eTTnode;
1052 }
1053
1054 // Fill all hash entries between entry.m_id and entry.m_lastId...
1055 eTTnode->eventEntryTable.Add(&entry);
1056 }
1057
1058 void wxEventHashTable::AllocEventTypeTable(size_t size)
1059 {
1060 m_eventTypeTable = new EventTypeTablePointer[size];
1061 memset((void *)m_eventTypeTable, 0, sizeof(EventTypeTablePointer)*size);
1062 m_size = size;
1063 }
1064
1065 void wxEventHashTable::GrowEventTypeTable()
1066 {
1067 size_t oldSize = m_size;
1068 EventTypeTablePointer *oldEventTypeTable = m_eventTypeTable;
1069
1070 // TODO: Search the most optimal grow sequence
1071 AllocEventTypeTable(/* GetNextPrime(oldSize) */oldSize*2+1);
1072
1073 for ( size_t i = 0; i < oldSize; /* */ )
1074 {
1075 EventTypeTablePointer eTToldNode = oldEventTypeTable[i];
1076 if (eTToldNode)
1077 {
1078 EventTypeTablePointer *peTTnode = &m_eventTypeTable[eTToldNode->eventType % m_size];
1079 EventTypeTablePointer eTTnode = *peTTnode;
1080
1081 // Check for collision, we don't want any.
1082 if (eTTnode)
1083 {
1084 GrowEventTypeTable();
1085 continue; // Don't increment the counter,
1086 // as we still need to add this element.
1087 }
1088 else
1089 {
1090 // Get the old value and put it in the new table.
1091 *peTTnode = oldEventTypeTable[i];
1092 }
1093 }
1094
1095 i++;
1096 }
1097
1098 delete[] oldEventTypeTable;
1099 }
1100
1101 // ----------------------------------------------------------------------------
1102 // wxEvtHandler
1103 // ----------------------------------------------------------------------------
1104
1105 wxEvtHandler::wxEvtHandler()
1106 {
1107 m_nextHandler = NULL;
1108 m_previousHandler = NULL;
1109 m_enabled = true;
1110 m_dynamicEvents = NULL;
1111 m_pendingEvents = NULL;
1112
1113 // no client data (yet)
1114 m_clientData = NULL;
1115 m_clientDataType = wxClientData_None;
1116 }
1117
1118 wxEvtHandler::~wxEvtHandler()
1119 {
1120 Unlink();
1121
1122 if (m_dynamicEvents)
1123 {
1124 for ( wxList::iterator it = m_dynamicEvents->begin(),
1125 end = m_dynamicEvents->end();
1126 it != end;
1127 ++it )
1128 {
1129 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)*it;
1130
1131 // Remove ourselves from sink destructor notifications
1132 // (this has usually been done, in wxTrackable destructor)
1133 wxEvtHandler *eventSink = entry->m_fn->GetEvtHandler();
1134 if ( eventSink )
1135 {
1136 wxEventConnectionRef * const
1137 evtConnRef = FindRefInTrackerList(eventSink);
1138 if ( evtConnRef )
1139 {
1140 eventSink->RemoveNode(evtConnRef);
1141 delete evtConnRef;
1142 }
1143 }
1144
1145 delete entry->m_callbackUserData;
1146 delete entry;
1147 }
1148 delete m_dynamicEvents;
1149 }
1150
1151 // Remove us from the list of the pending events if necessary.
1152 if (wxTheApp)
1153 wxTheApp->RemovePendingEventHandler(this);
1154
1155 DeletePendingEvents();
1156
1157 // we only delete object data, not untyped
1158 if ( m_clientDataType == wxClientData_Object )
1159 delete m_clientObject;
1160 }
1161
1162 void wxEvtHandler::Unlink()
1163 {
1164 // this event handler must take itself out of the chain of handlers:
1165
1166 if (m_previousHandler)
1167 m_previousHandler->SetNextHandler(m_nextHandler);
1168
1169 if (m_nextHandler)
1170 m_nextHandler->SetPreviousHandler(m_previousHandler);
1171
1172 m_nextHandler = NULL;
1173 m_previousHandler = NULL;
1174 }
1175
1176 bool wxEvtHandler::IsUnlinked() const
1177 {
1178 return m_previousHandler == NULL &&
1179 m_nextHandler == NULL;
1180 }
1181
1182 wxEventFilter* wxEvtHandler::ms_filterList = NULL;
1183
1184 /* static */ void wxEvtHandler::AddFilter(wxEventFilter* filter)
1185 {
1186 wxCHECK_RET( filter, "NULL filter" );
1187
1188 filter->m_next = ms_filterList;
1189 ms_filterList = filter;
1190 }
1191
1192 /* static */ void wxEvtHandler::RemoveFilter(wxEventFilter* filter)
1193 {
1194 wxEventFilter* prev = NULL;
1195 for ( wxEventFilter* f = ms_filterList; f; f = f->m_next )
1196 {
1197 if ( f == filter )
1198 {
1199 // Set the previous list element or the list head to the next
1200 // element.
1201 if ( prev )
1202 prev->m_next = f->m_next;
1203 else
1204 ms_filterList = f->m_next;
1205
1206 // Also reset the next pointer in the filter itself just to avoid
1207 // having possibly dangling pointers, even though it's not strictly
1208 // necessary.
1209 f->m_next = NULL;
1210
1211 // Skip the assert below.
1212 return;
1213 }
1214
1215 prev = f;
1216 }
1217
1218 wxFAIL_MSG( "Filter not found" );
1219 }
1220
1221 #if wxUSE_THREADS
1222
1223 bool wxEvtHandler::ProcessThreadEvent(const wxEvent& event)
1224 {
1225 // check that we are really in a child thread
1226 wxASSERT_MSG( !wxThread::IsMain(),
1227 wxT("use ProcessEvent() in main thread") );
1228
1229 AddPendingEvent(event);
1230
1231 return true;
1232 }
1233
1234 #endif // wxUSE_THREADS
1235
1236 void wxEvtHandler::QueueEvent(wxEvent *event)
1237 {
1238 wxCHECK_RET( event, "NULL event can't be posted" );
1239
1240 if (!wxTheApp)
1241 {
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!");
1245
1246 // anyway delete the given event to avoid memory leaks
1247 delete event;
1248
1249 return;
1250 }
1251
1252 // 1) Add this event to our list of pending events
1253 wxENTER_CRIT_SECT( m_pendingEventsLock );
1254
1255 if ( !m_pendingEvents )
1256 m_pendingEvents = new wxList;
1257
1258 m_pendingEvents->Append(event);
1259
1260 // 2) Add this event handler to list of event handlers that
1261 // have pending events.
1262
1263 wxTheApp->AppendPendingEventHandler(this);
1264
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 );
1272
1273 // 3) Inform the system that new pending events are somewhere,
1274 // and that these should be processed in idle time.
1275 wxWakeUpIdle();
1276 }
1277
1278 void wxEvtHandler::DeletePendingEvents()
1279 {
1280 if (m_pendingEvents)
1281 m_pendingEvents->DeleteContents(true);
1282 wxDELETE(m_pendingEvents);
1283 }
1284
1285 void wxEvtHandler::ProcessPendingEvents()
1286 {
1287 if (!wxTheApp)
1288 {
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!");
1292 return;
1293 }
1294
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)
1298
1299 wxENTER_CRIT_SECT( m_pendingEventsLock );
1300
1301 // this method is only called by wxApp if this handler does have
1302 // pending events
1303 wxCHECK_RET( m_pendingEvents && !m_pendingEvents->IsEmpty(),
1304 "should have pending events if called" );
1305
1306 wxList::compatibility_iterator node = m_pendingEvents->GetFirst();
1307 wxEvent* pEvent = static_cast<wxEvent *>(node->GetData());
1308
1309 // find the first event which can be processed now:
1310 wxEventLoopBase* evtLoop = wxEventLoopBase::GetActive();
1311 if (evtLoop && evtLoop->IsYielding())
1312 {
1313 while (node && pEvent && !evtLoop->IsEventAllowedInsideYield(pEvent->GetEventCategory()))
1314 {
1315 node = node->GetNext();
1316 pEvent = node ? static_cast<wxEvent *>(node->GetData()) : NULL;
1317 }
1318
1319 if (!node)
1320 {
1321 // all our events are NOT processable now... signal this:
1322 wxTheApp->DelayPendingEventHandler(this);
1323
1324 // see the comment at the beginning of evtloop.h header for the
1325 // logic behind YieldFor() and behind DelayPendingEventHandler()
1326
1327 wxLEAVE_CRIT_SECT( m_pendingEventsLock );
1328
1329 return;
1330 }
1331 }
1332
1333 wxEventPtr event(pEvent);
1334
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);
1339
1340 if ( m_pendingEvents->IsEmpty() )
1341 {
1342 // if there are no more pending events left, we don't need to
1343 // stay in this list
1344 wxTheApp->RemovePendingEventHandler(this);
1345 }
1346
1347 wxLEAVE_CRIT_SECT( m_pendingEventsLock );
1348
1349 ProcessEvent(*event);
1350
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
1354 }
1355
1356 /* static */
1357 bool wxEvtHandler::ProcessEventIfMatchesId(const wxEventTableEntryBase& entry,
1358 wxEvtHandler *handler,
1359 wxEvent& event)
1360 {
1361 int tableId1 = entry.m_id,
1362 tableId2 = entry.m_lastId;
1363
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)))
1372 {
1373 event.Skip(false);
1374 event.m_callbackUserData = entry.m_callbackUserData;
1375
1376 #if wxUSE_EXCEPTIONS
1377 if ( wxTheApp )
1378 {
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
1381 // in one place
1382 wxTheApp->CallEventHandler(handler, *entry.m_fn, event);
1383 }
1384 else
1385 #endif // wxUSE_EXCEPTIONS
1386 {
1387 (*entry.m_fn)(handler, event);
1388 }
1389
1390 if (!event.GetSkipped())
1391 return true;
1392 }
1393
1394 return false;
1395 }
1396
1397 bool wxEvtHandler::DoTryApp(wxEvent& event)
1398 {
1399 if ( wxTheApp && (this != wxTheApp) )
1400 {
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 )
1405 {
1406 if ( wxTheApp->ProcessEvent(event) )
1407 return true;
1408 }
1409 }
1410
1411 return false;
1412 }
1413
1414 bool wxEvtHandler::TryBefore(wxEvent& event)
1415 {
1416 #if WXWIN_COMPATIBILITY_2_8
1417 // call the old virtual function to keep the code overriding it working
1418 return TryValidator(event);
1419 #else
1420 wxUnusedVar(event);
1421 return false;
1422 #endif
1423 }
1424
1425 bool wxEvtHandler::TryAfter(wxEvent& event)
1426 {
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).
1430 //
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);
1438
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
1441 // handler.
1442 if ( event.WillBeProcessedAgain() )
1443 return false;
1444
1445 #if WXWIN_COMPATIBILITY_2_8
1446 // as above, call the old virtual function for compatibility
1447 return TryParent(event);
1448 #else
1449 return DoTryApp(event);
1450 #endif
1451 }
1452
1453 bool wxEvtHandler::ProcessEvent(wxEvent& event)
1454 {
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.
1457 //
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() )
1462 {
1463 for ( wxEventFilter* f = ms_filterList; f; f = f->m_next )
1464 {
1465 int rc = f->FilterEvent(event);
1466 if ( rc != wxEventFilter::Event_Skip )
1467 {
1468 wxASSERT_MSG( rc == wxEventFilter::Event_Ignore ||
1469 rc == wxEventFilter::Event_Processed,
1470 "unexpected FilterEvent() return value" );
1471
1472 return rc != wxEventFilter::Event_Ignore;
1473 }
1474 //else: proceed normally
1475 }
1476 }
1477
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);
1482
1483
1484 // Try to process the event in this handler itself.
1485 if ( ProcessEventLocally(event) )
1486 {
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();
1494 }
1495
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) )
1499 return true;
1500
1501
1502 // No handler found anywhere, bail out.
1503 return false;
1504 }
1505
1506 bool wxEvtHandler::ProcessEventLocally(wxEvent& event)
1507 {
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);
1513 }
1514
1515 bool wxEvtHandler::DoTryChain(wxEvent& event)
1516 {
1517 for ( wxEvtHandler *h = GetNextHandler(); h; h = h->GetNextHandler() )
1518 {
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
1522 // we return.
1523 //
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.
1528 //
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.
1536 //
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) )
1545 {
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.
1549 event.Skip(false);
1550
1551 return true;
1552 }
1553
1554 if ( !event.ShouldProcessOnlyIn(h) )
1555 {
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.
1559 event.Skip();
1560
1561 return true;
1562 }
1563 }
1564
1565 return false;
1566 }
1567
1568 bool wxEvtHandler::TryHereOnly(wxEvent& event)
1569 {
1570 // If the event handler is disabled it doesn't process any events
1571 if ( !GetEvtHandlerEnabled() )
1572 return false;
1573
1574 // Handle per-instance dynamic event tables first
1575 if ( m_dynamicEvents && SearchDynamicEventTable(event) )
1576 return true;
1577
1578 // Then static per-class event tables
1579 if ( GetEventHashTable().HandleEvent(event, this) )
1580 return true;
1581
1582 #ifdef wxHAS_CALL_AFTER
1583 // There is an implicit entry for async method calls processing in every
1584 // event handler:
1585 if ( event.GetEventType() == wxEVT_ASYNC_METHOD_CALL &&
1586 event.GetEventObject() == this )
1587 {
1588 static_cast<wxAsyncMethodCallEvent&>(event).Execute();
1589 return true;
1590 }
1591 #endif // wxHAS_CALL_AFTER
1592
1593 // We don't have a handler for this event.
1594 return false;
1595 }
1596
1597 bool wxEvtHandler::SafelyProcessEvent(wxEvent& event)
1598 {
1599 #if wxUSE_EXCEPTIONS
1600 try
1601 {
1602 #endif
1603 return ProcessEvent(event);
1604 #if wxUSE_EXCEPTIONS
1605 }
1606 catch ( ... )
1607 {
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;
1613 try
1614 {
1615 loop = wxEventLoopBase::GetActive();
1616
1617 if ( !wxTheApp || !wxTheApp->OnExceptionInMainLoop() )
1618 {
1619 if ( loop )
1620 loop->Exit();
1621 }
1622 //else: continue running current event loop
1623
1624 return false;
1625 }
1626 catch ( ... )
1627 {
1628 // OnExceptionInMainLoop() threw, possibly rethrowing the same
1629 // exception again: very good, but we still need Exit() to
1630 // be called
1631 if ( loop )
1632 loop->Exit();
1633 throw;
1634 }
1635 }
1636 #endif // wxUSE_EXCEPTIONS
1637 }
1638
1639 bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event)
1640 {
1641 const wxEventType eventType = event.GetEventType();
1642 for ( int i = 0; table.entries[i].m_fn != 0; i++ )
1643 {
1644 const wxEventTableEntry& entry = table.entries[i];
1645 if ( eventType == entry.m_eventType )
1646 {
1647 if ( ProcessEventIfMatchesId(entry, this, event) )
1648 return true;
1649 }
1650 }
1651
1652 return false;
1653 }
1654
1655 void wxEvtHandler::DoBind(int id,
1656 int lastId,
1657 wxEventType eventType,
1658 wxEventFunctor *func,
1659 wxObject *userData)
1660 {
1661 wxDynamicEventTableEntry *entry =
1662 new wxDynamicEventTableEntry(eventType, id, lastId, func, userData);
1663
1664 if (!m_dynamicEvents)
1665 m_dynamicEvents = new wxList;
1666
1667 // Insert at the front of the list so most recent additions are found first
1668 m_dynamicEvents->Insert( (wxObject*) entry );
1669
1670 // Make sure we get to know when a sink is destroyed
1671 wxEvtHandler *eventSink = func->GetEvtHandler();
1672 if ( eventSink && eventSink != this )
1673 {
1674 wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink);
1675 if ( evtConnRef )
1676 evtConnRef->IncRef( );
1677 else
1678 new wxEventConnectionRef(this, eventSink);
1679 }
1680 }
1681
1682 bool
1683 wxEvtHandler::DoUnbind(int id,
1684 int lastId,
1685 wxEventType eventType,
1686 const wxEventFunctor& func,
1687 wxObject *userData)
1688 {
1689 if (!m_dynamicEvents)
1690 return false;
1691
1692 wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();
1693 while (node)
1694 {
1695 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1696
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))
1702 {
1703 // Remove connection from tracker node (wxEventConnectionRef)
1704 wxEvtHandler *eventSink = entry->m_fn->GetEvtHandler();
1705 if ( eventSink && eventSink != this )
1706 {
1707 wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink);
1708 if ( evtConnRef )
1709 evtConnRef->DecRef();
1710 }
1711
1712 delete entry->m_callbackUserData;
1713 m_dynamicEvents->Erase( node );
1714 delete entry;
1715 return true;
1716 }
1717 node = node->GetNext();
1718 }
1719 return false;
1720 }
1721
1722 bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event )
1723 {
1724 wxCHECK_MSG( m_dynamicEvents, false,
1725 wxT("caller should check that we have dynamic events") );
1726
1727 wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();
1728 while (node)
1729 {
1730 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1731
1732 // get next node before (maybe) calling the event handler as it could
1733 // call Disconnect() invalidating the current node
1734 node = node->GetNext();
1735
1736 if ( event.GetEventType() == entry->m_eventType )
1737 {
1738 wxEvtHandler *handler = entry->m_fn->GetEvtHandler();
1739 if ( !handler )
1740 handler = this;
1741 if ( ProcessEventIfMatchesId(*entry, handler, event) )
1742 return true;
1743 }
1744 }
1745
1746 return false;
1747 }
1748
1749 void wxEvtHandler::DoSetClientObject( wxClientData *data )
1750 {
1751 wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1752 wxT("can't have both object and void client data") );
1753
1754 if ( m_clientObject )
1755 delete m_clientObject;
1756
1757 m_clientObject = data;
1758 m_clientDataType = wxClientData_Object;
1759 }
1760
1761 wxClientData *wxEvtHandler::DoGetClientObject() const
1762 {
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") );
1767
1768 return m_clientObject;
1769 }
1770
1771 void wxEvtHandler::DoSetClientData( void *data )
1772 {
1773 wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1774 wxT("can't have both object and void client data") );
1775
1776 m_clientData = data;
1777 m_clientDataType = wxClientData_Void;
1778 }
1779
1780 void *wxEvtHandler::DoGetClientData() const
1781 {
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") );
1786
1787 return m_clientData;
1788 }
1789
1790 // A helper to find an wxEventConnectionRef object
1791 wxEventConnectionRef *
1792 wxEvtHandler::FindRefInTrackerList(wxEvtHandler *eventSink)
1793 {
1794 for ( wxTrackerNode *node = eventSink->GetFirst(); node; node = node->m_nxt )
1795 {
1796 // we only want wxEventConnectionRef nodes here
1797 wxEventConnectionRef *evtConnRef = node->ToEventConnection();
1798 if ( evtConnRef && evtConnRef->m_src == this )
1799 {
1800 wxASSERT( evtConnRef->m_sink==eventSink );
1801 return evtConnRef;
1802 }
1803 }
1804
1805 return NULL;
1806 }
1807
1808 void wxEvtHandler::OnSinkDestroyed( wxEvtHandler *sink )
1809 {
1810 wxASSERT(m_dynamicEvents);
1811
1812 // remove all connections with this sink
1813 wxList::compatibility_iterator node = m_dynamicEvents->GetFirst(), node_nxt;
1814 while (node)
1815 {
1816 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1817 node_nxt = node->GetNext();
1818
1819 if ( entry->m_fn->GetEvtHandler() == sink )
1820 {
1821 delete entry->m_callbackUserData;
1822 m_dynamicEvents->Erase( node );
1823 delete entry;
1824 }
1825 node = node_nxt;
1826 }
1827 }
1828
1829 #endif // wxUSE_BASE
1830
1831 #if wxUSE_GUI
1832
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)
1836 {
1837 // Process events starting with the window with the focus, if any.
1838 wxWindow* focusWin = wxWindow::FindFocus();
1839 wxWindow* win = focusWin;
1840
1841 // Check if this is a descendant of this frame.
1842 // If not, win will be set to NULL.
1843 while (win)
1844 {
1845 if (win == ancestor)
1846 break;
1847 else
1848 win = win->GetParent();
1849 }
1850 if (win == NULL)
1851 focusWin = NULL;
1852
1853 return focusWin;
1854 }
1855
1856 // ----------------------------------------------------------------------------
1857 // wxEventBlocker
1858 // ----------------------------------------------------------------------------
1859
1860 wxEventBlocker::wxEventBlocker(wxWindow *win, wxEventType type)
1861 {
1862 wxCHECK_RET(win, wxT("Null window given to wxEventBlocker"));
1863
1864 m_window = win;
1865
1866 Block(type);
1867 m_window->PushEventHandler(this);
1868 }
1869
1870 wxEventBlocker::~wxEventBlocker()
1871 {
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!"));
1875 }
1876
1877 bool wxEventBlocker::ProcessEvent(wxEvent& event)
1878 {
1879 // should this event be blocked?
1880 for ( size_t i = 0; i < m_eventsToBlock.size(); i++ )
1881 {
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
1885 }
1886
1887 return false;
1888 }
1889
1890 #endif // wxUSE_GUI
1891
wxWidgets (Impactor)