projects / wxWidgets.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
remove comment erroneously committed in r58654
[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/evtloop.h"
29
30 #ifndef WX_PRECOMP
31 #include "wx/list.h"
32 #include "wx/log.h"
33 #include "wx/app.h"
34 #include "wx/utils.h"
35 #include "wx/stopwatch.h"
36 #include "wx/module.h"
37
38 #if wxUSE_GUI
39 #include "wx/window.h"
40 #include "wx/control.h"
41 #include "wx/dc.h"
42 #include "wx/spinbutt.h"
43 #include "wx/textctrl.h"
44 #include "wx/validate.h"
45 #endif // wxUSE_GUI
46 #endif
47
48 #include "wx/thread.h"
49
50 #if wxUSE_BASE
51 #include "wx/scopedptr.h"
52
53 wxDECLARE_SCOPED_PTR(wxEvent, wxEventPtr)
54 wxDEFINE_SCOPED_PTR(wxEvent, wxEventPtr)
55 #endif // wxUSE_BASE
56
57 // ----------------------------------------------------------------------------
58 // wxWin macros
59 // ----------------------------------------------------------------------------
60
61 #if wxUSE_BASE
62 IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler, wxObject)
63 IMPLEMENT_ABSTRACT_CLASS(wxEvent, wxObject)
64 IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent)
65 #endif // wxUSE_BASE
66
67 #if wxUSE_GUI
68 IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent, wxEvent)
69 IMPLEMENT_DYNAMIC_CLASS(wxThreadEvent, wxCommandEvent)
70 IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent, wxCommandEvent)
71 IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent, wxCommandEvent)
72 IMPLEMENT_DYNAMIC_CLASS(wxScrollWinEvent, wxEvent)
73 IMPLEMENT_DYNAMIC_CLASS(wxMouseEvent, wxEvent)
74 IMPLEMENT_DYNAMIC_CLASS(wxKeyEvent, wxEvent)
75 IMPLEMENT_DYNAMIC_CLASS(wxSizeEvent, wxEvent)
76 IMPLEMENT_DYNAMIC_CLASS(wxPaintEvent, wxEvent)
77 IMPLEMENT_DYNAMIC_CLASS(wxNcPaintEvent, wxEvent)
78 IMPLEMENT_DYNAMIC_CLASS(wxEraseEvent, wxEvent)
79 IMPLEMENT_DYNAMIC_CLASS(wxMoveEvent, wxEvent)
80 IMPLEMENT_DYNAMIC_CLASS(wxFocusEvent, wxEvent)
81 IMPLEMENT_DYNAMIC_CLASS(wxChildFocusEvent, wxCommandEvent)
82 IMPLEMENT_DYNAMIC_CLASS(wxCloseEvent, wxEvent)
83 IMPLEMENT_DYNAMIC_CLASS(wxShowEvent, wxEvent)
84 IMPLEMENT_DYNAMIC_CLASS(wxMaximizeEvent, wxEvent)
85 IMPLEMENT_DYNAMIC_CLASS(wxIconizeEvent, wxEvent)
86 IMPLEMENT_DYNAMIC_CLASS(wxMenuEvent, wxEvent)
87 IMPLEMENT_DYNAMIC_CLASS(wxJoystickEvent, wxEvent)
88 IMPLEMENT_DYNAMIC_CLASS(wxDropFilesEvent, wxEvent)
89 IMPLEMENT_DYNAMIC_CLASS(wxActivateEvent, wxEvent)
90 IMPLEMENT_DYNAMIC_CLASS(wxInitDialogEvent, wxEvent)
91 IMPLEMENT_DYNAMIC_CLASS(wxSetCursorEvent, wxEvent)
92 IMPLEMENT_DYNAMIC_CLASS(wxSysColourChangedEvent, wxEvent)
93 IMPLEMENT_DYNAMIC_CLASS(wxDisplayChangedEvent, wxEvent)
94 IMPLEMENT_DYNAMIC_CLASS(wxUpdateUIEvent, wxCommandEvent)
95 IMPLEMENT_DYNAMIC_CLASS(wxNavigationKeyEvent, wxEvent)
96 IMPLEMENT_DYNAMIC_CLASS(wxPaletteChangedEvent, wxEvent)
97 IMPLEMENT_DYNAMIC_CLASS(wxQueryNewPaletteEvent, wxEvent)
98 IMPLEMENT_DYNAMIC_CLASS(wxWindowCreateEvent, wxEvent)
99 IMPLEMENT_DYNAMIC_CLASS(wxWindowDestroyEvent, wxEvent)
100 IMPLEMENT_DYNAMIC_CLASS(wxHelpEvent, wxCommandEvent)
101 IMPLEMENT_DYNAMIC_CLASS(wxContextMenuEvent, wxCommandEvent)
102 IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureChangedEvent, wxEvent)
103 IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureLostEvent, wxEvent)
104 IMPLEMENT_DYNAMIC_CLASS(wxClipboardTextEvent, wxCommandEvent)
105 #endif // wxUSE_GUI
106
107 #if wxUSE_BASE
108
109 const wxEventTable *wxEvtHandler::GetEventTable() const
110 { return &wxEvtHandler::sm_eventTable; }
111
112 const wxEventTable wxEvtHandler::sm_eventTable =
113 { (const wxEventTable *)NULL, &wxEvtHandler::sm_eventTableEntries[0] };
114
115 wxEventHashTable &wxEvtHandler::GetEventHashTable() const
116 { return wxEvtHandler::sm_eventHashTable; }
117
118 wxEventHashTable wxEvtHandler::sm_eventHashTable(wxEvtHandler::sm_eventTable);
119
120 const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] =
121 { DECLARE_EVENT_TABLE_TERMINATOR() };
122
123
124 // wxUSE_MEMORY_TRACING considers memory freed from the static objects dtors
125 // leaked, so we need to manually clean up all event tables before checking for
126 // the memory leaks when using it, however this breaks re-initializing the
127 // library (i.e. repeated calls to wxInitialize/wxUninitialize) because the
128 // event tables won't be rebuilt the next time, so disable this by default
129 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
130
131 class wxEventTableEntryModule: public wxModule
132 {
133 public:
134 wxEventTableEntryModule() { }
135 virtual bool OnInit() { return true; }
136 virtual void OnExit() { wxEventHashTable::ClearAll(); }
137
138 DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule)
139 };
140
141 IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule, wxModule)
142
143 #endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
144
145 // ----------------------------------------------------------------------------
146 // global variables
147 // ----------------------------------------------------------------------------
148
149 // common event types are defined here, other event types are defined by the
150 // components which use them
151
152 const wxEventType wxEVT_FIRST = 10000;
153 const wxEventType wxEVT_USER_FIRST = wxEVT_FIRST + 2000;
154
155 DEFINE_EVENT_TYPE(wxEVT_NULL)
156 wxDEFINE_EVENT( wxEVT_IDLE, wxIdleEvent );
157
158 #endif // wxUSE_BASE
159
160 #if wxUSE_GUI
161
162 wxDEFINE_EVENT( wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEvent );
163 wxDEFINE_EVENT( wxEVT_COMMAND_CHECKBOX_CLICKED, wxCommandEvent );
164 wxDEFINE_EVENT( wxEVT_COMMAND_CHOICE_SELECTED, wxCommandEvent );
165 wxDEFINE_EVENT( wxEVT_COMMAND_LISTBOX_SELECTED, wxCommandEvent );
166 wxDEFINE_EVENT( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, wxCommandEvent );
167 wxDEFINE_EVENT( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, wxCommandEvent );
168 wxDEFINE_EVENT( wxEVT_COMMAND_MENU_SELECTED, wxCommandEvent );
169 wxDEFINE_EVENT( wxEVT_COMMAND_SLIDER_UPDATED, wxCommandEvent );
170 wxDEFINE_EVENT( wxEVT_COMMAND_RADIOBOX_SELECTED, wxCommandEvent );
171 wxDEFINE_EVENT( wxEVT_COMMAND_RADIOBUTTON_SELECTED, wxCommandEvent );
172 wxDEFINE_EVENT( wxEVT_COMMAND_SCROLLBAR_UPDATED, wxCommandEvent );
173 wxDEFINE_EVENT( wxEVT_COMMAND_VLBOX_SELECTED, wxCommandEvent );
174 wxDEFINE_EVENT( wxEVT_COMMAND_COMBOBOX_SELECTED, wxCommandEvent );
175 wxDEFINE_EVENT( wxEVT_COMMAND_TOOL_RCLICKED, wxCommandEvent );
176 wxDEFINE_EVENT( wxEVT_COMMAND_TOOL_ENTER, wxCommandEvent );
177 wxDEFINE_EVENT( wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEvent );
178 wxDEFINE_EVENT( wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED, wxCommandEvent );
179 wxDEFINE_EVENT( wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, wxCommandEvent );
180
181 // Mouse event types
182 wxDEFINE_EVENT( wxEVT_LEFT_DOWN, wxMouseEvent );
183 wxDEFINE_EVENT( wxEVT_LEFT_UP, wxMouseEvent );
184 wxDEFINE_EVENT( wxEVT_MIDDLE_DOWN, wxMouseEvent );
185 wxDEFINE_EVENT( wxEVT_MIDDLE_UP, wxMouseEvent );
186 wxDEFINE_EVENT( wxEVT_RIGHT_DOWN, wxMouseEvent );
187 wxDEFINE_EVENT( wxEVT_RIGHT_UP, wxMouseEvent );
188 wxDEFINE_EVENT( wxEVT_MOTION, wxMouseEvent );
189 wxDEFINE_EVENT( wxEVT_ENTER_WINDOW, wxMouseEvent );
190 wxDEFINE_EVENT( wxEVT_LEAVE_WINDOW, wxMouseEvent );
191 wxDEFINE_EVENT( wxEVT_LEFT_DCLICK, wxMouseEvent );
192 wxDEFINE_EVENT( wxEVT_MIDDLE_DCLICK, wxMouseEvent );
193 wxDEFINE_EVENT( wxEVT_RIGHT_DCLICK, wxMouseEvent );
194 wxDEFINE_EVENT( wxEVT_SET_FOCUS, wxFocusEvent );
195 wxDEFINE_EVENT( wxEVT_KILL_FOCUS, wxFocusEvent );
196 wxDEFINE_EVENT( wxEVT_CHILD_FOCUS, wxChildFocusEvent );
197 wxDEFINE_EVENT( wxEVT_MOUSEWHEEL, wxMouseEvent );
198 wxDEFINE_EVENT( wxEVT_AUX1_DOWN, wxMouseEvent );
199 wxDEFINE_EVENT( wxEVT_AUX1_UP, wxMouseEvent );
200 wxDEFINE_EVENT( wxEVT_AUX1_DCLICK, wxMouseEvent );
201 wxDEFINE_EVENT( wxEVT_AUX2_DOWN, wxMouseEvent );
202 wxDEFINE_EVENT( wxEVT_AUX2_UP, wxMouseEvent );
203 wxDEFINE_EVENT( wxEVT_AUX2_DCLICK, wxMouseEvent );
204
205 // Character input event type
206 wxDEFINE_EVENT( wxEVT_CHAR, wxKeyEvent );
207 wxDEFINE_EVENT( wxEVT_CHAR_HOOK, wxKeyEvent );
208 wxDEFINE_EVENT( wxEVT_NAVIGATION_KEY, wxNavigationKeyEvent );
209 wxDEFINE_EVENT( wxEVT_KEY_DOWN, wxKeyEvent );
210 wxDEFINE_EVENT( wxEVT_KEY_UP, wxKeyEvent );
211 #if wxUSE_HOTKEY
212 wxDEFINE_EVENT( wxEVT_HOTKEY, wxKeyEvent );
213 #endif
214
215 // Set cursor event
216 wxDEFINE_EVENT( wxEVT_SET_CURSOR, wxSetCursorEvent );
217
218 // wxScrollbar and wxSlider event identifiers
219 wxDEFINE_EVENT( wxEVT_SCROLL_TOP, wxScrollEvent );
220 wxDEFINE_EVENT( wxEVT_SCROLL_BOTTOM, wxScrollEvent );
221 wxDEFINE_EVENT( wxEVT_SCROLL_LINEUP, wxScrollEvent );
222 wxDEFINE_EVENT( wxEVT_SCROLL_LINEDOWN, wxScrollEvent );
223 wxDEFINE_EVENT( wxEVT_SCROLL_PAGEUP, wxScrollEvent );
224 wxDEFINE_EVENT( wxEVT_SCROLL_PAGEDOWN, wxScrollEvent );
225 wxDEFINE_EVENT( wxEVT_SCROLL_THUMBTRACK, wxScrollEvent );
226 wxDEFINE_EVENT( wxEVT_SCROLL_THUMBRELEASE, wxScrollEvent );
227 wxDEFINE_EVENT( wxEVT_SCROLL_CHANGED, wxScrollEvent );
228
229 // Due to a bug in older wx versions, wxSpinEvents were being sent with type of
230 // wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But
231 // with the type-safe events in place, these event types are associated with
232 // wxScrollEvent. To allow handling of spin events, new event types have been
233 // defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility
234 // the spin event types are being initialized with the scroll event types.
235
236 #if wxUSE_SPINBTN
237
238 wxDEFINE_EVENT_ALIAS( wxEVT_SPIN_UP, wxSpinEvent, wxEVT_SCROLL_LINEUP );
239 wxDEFINE_EVENT_ALIAS( wxEVT_SPIN_DOWN, wxSpinEvent, wxEVT_SCROLL_LINEDOWN );
240 wxDEFINE_EVENT_ALIAS( wxEVT_SPIN, wxSpinEvent, wxEVT_SCROLL_THUMBTRACK );
241
242 #endif // wxUSE_SPINBTN
243
244 // Scroll events from wxWindow
245 wxDEFINE_EVENT( wxEVT_SCROLLWIN_TOP, wxScrollWinEvent );
246 wxDEFINE_EVENT( wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEvent );
247 wxDEFINE_EVENT( wxEVT_SCROLLWIN_LINEUP, wxScrollWinEvent );
248 wxDEFINE_EVENT( wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEvent );
249 wxDEFINE_EVENT( wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEvent );
250 wxDEFINE_EVENT( wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEvent );
251 wxDEFINE_EVENT( wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEvent );
252 wxDEFINE_EVENT( wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEvent );
253
254 // System events
255 wxDEFINE_EVENT( wxEVT_SIZE, wxSizeEvent );
256 wxDEFINE_EVENT( wxEVT_SIZING, wxSizeEvent );
257 wxDEFINE_EVENT( wxEVT_MOVE, wxMoveEvent );
258 wxDEFINE_EVENT( wxEVT_MOVING, wxMoveEvent );
259 wxDEFINE_EVENT( wxEVT_MOVE_START, wxMoveEvent );
260 wxDEFINE_EVENT( wxEVT_MOVE_END, wxMoveEvent );
261 wxDEFINE_EVENT( wxEVT_CLOSE_WINDOW, wxCloseEvent );
262 wxDEFINE_EVENT( wxEVT_END_SESSION, wxCloseEvent );
263 wxDEFINE_EVENT( wxEVT_QUERY_END_SESSION, wxCloseEvent );
264 wxDEFINE_EVENT( wxEVT_HIBERNATE, wxActivateEvent );
265 wxDEFINE_EVENT( wxEVT_ACTIVATE_APP, wxActivateEvent );
266 wxDEFINE_EVENT( wxEVT_ACTIVATE, wxActivateEvent );
267 wxDEFINE_EVENT( wxEVT_CREATE, wxWindowCreateEvent );
268 wxDEFINE_EVENT( wxEVT_DESTROY, wxWindowDestroyEvent );
269 wxDEFINE_EVENT( wxEVT_SHOW, wxShowEvent );
270 wxDEFINE_EVENT( wxEVT_ICONIZE, wxIconizeEvent );
271 wxDEFINE_EVENT( wxEVT_MAXIMIZE, wxMaximizeEvent );
272 wxDEFINE_EVENT( wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEvent );
273 wxDEFINE_EVENT( wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEvent );
274 wxDEFINE_EVENT( wxEVT_PAINT, wxPaintEvent );
275 wxDEFINE_EVENT( wxEVT_ERASE_BACKGROUND, wxEraseEvent );
276 wxDEFINE_EVENT( wxEVT_NC_PAINT, wxNcPaintEvent );
277 wxDEFINE_EVENT( wxEVT_MENU_OPEN, wxMenuEvent );
278 wxDEFINE_EVENT( wxEVT_MENU_CLOSE, wxMenuEvent );
279 wxDEFINE_EVENT( wxEVT_MENU_HIGHLIGHT, wxMenuEvent );
280 wxDEFINE_EVENT( wxEVT_CONTEXT_MENU, wxContextMenuEvent );
281 wxDEFINE_EVENT( wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEvent );
282 wxDEFINE_EVENT( wxEVT_DISPLAY_CHANGED, wxDisplayChangedEvent );
283 wxDEFINE_EVENT( wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEvent );
284 wxDEFINE_EVENT( wxEVT_PALETTE_CHANGED, wxPaletteChangedEvent );
285 wxDEFINE_EVENT( wxEVT_JOY_BUTTON_DOWN, wxJoystickEvent );
286 wxDEFINE_EVENT( wxEVT_JOY_BUTTON_UP, wxJoystickEvent );
287 wxDEFINE_EVENT( wxEVT_JOY_MOVE, wxJoystickEvent );
288 wxDEFINE_EVENT( wxEVT_JOY_ZMOVE, wxJoystickEvent );
289 wxDEFINE_EVENT( wxEVT_DROP_FILES, wxDropFilesEvent );
290 wxDEFINE_EVENT( wxEVT_INIT_DIALOG, wxInitDialogEvent );
291 wxDEFINE_EVENT( wxEVT_UPDATE_UI, wxUpdateUIEvent );
292
293 // Clipboard events
294 wxDEFINE_EVENT( wxEVT_COMMAND_TEXT_COPY, wxClipboardTextEvent );
295 wxDEFINE_EVENT( wxEVT_COMMAND_TEXT_CUT, wxClipboardTextEvent );
296 wxDEFINE_EVENT( wxEVT_COMMAND_TEXT_PASTE, wxClipboardTextEvent );
297
298 // Generic command events
299 // Note: a click is a higher-level event than button down/up
300 wxDEFINE_EVENT( wxEVT_COMMAND_LEFT_CLICK, wxCommandEvent );
301 wxDEFINE_EVENT( wxEVT_COMMAND_LEFT_DCLICK, wxCommandEvent );
302 wxDEFINE_EVENT( wxEVT_COMMAND_RIGHT_CLICK, wxCommandEvent );
303 wxDEFINE_EVENT( wxEVT_COMMAND_RIGHT_DCLICK, wxCommandEvent );
304 wxDEFINE_EVENT( wxEVT_COMMAND_SET_FOCUS, wxCommandEvent );
305 wxDEFINE_EVENT( wxEVT_COMMAND_KILL_FOCUS, wxCommandEvent );
306 wxDEFINE_EVENT( wxEVT_COMMAND_ENTER, wxCommandEvent );
307
308 // Help events
309 wxDEFINE_EVENT( wxEVT_HELP, wxHelpEvent );
310 wxDEFINE_EVENT( wxEVT_DETAILED_HELP, wxHelpEvent );
311
312 // Thread event
313 wxDEFINE_EVENT( wxEVT_COMMAND_THREAD, wxThreadEvent );
314
315 #endif // wxUSE_GUI
316
317 #if wxUSE_BASE
318
319 wxIdleMode wxIdleEvent::sm_idleMode = wxIDLE_PROCESS_ALL;
320
321 // ============================================================================
322 // implementation
323 // ============================================================================
324
325 // ----------------------------------------------------------------------------
326 // event initialization
327 // ----------------------------------------------------------------------------
328
329 int wxNewEventType()
330 {
331 // MT-FIXME
332 static int s_lastUsedEventType = wxEVT_FIRST;
333
334 return s_lastUsedEventType++;
335 }
336 // ----------------------------------------------------------------------------
337 // wxEventFunctor
338 // ----------------------------------------------------------------------------
339
340 wxEventFunctor::~wxEventFunctor()
341 {
342 }
343
344 // ----------------------------------------------------------------------------
345 // wxEvent
346 // ----------------------------------------------------------------------------
347
348 /*
349 * General wxWidgets events, covering all interesting things that might happen
350 * (button clicking, resizing, setting text in widgets, etc.).
351 *
352 * For each completely new event type, derive a new event class.
353 *
354 */
355
356 wxEvent::wxEvent(int theId, wxEventType commandType)
357 {
358 m_eventType = commandType;
359 m_eventObject = NULL;
360 m_timeStamp = 0;
361 m_id = theId;
362 m_skipped = false;
363 m_callbackUserData = NULL;
364 m_isCommandEvent = false;
365 m_propagationLevel = wxEVENT_PROPAGATE_NONE;
366 m_wasProcessed = false;
367 }
368
369 wxEvent::wxEvent(const wxEvent& src)
370 : wxObject(src)
371 , m_eventObject(src.m_eventObject)
372 , m_eventType(src.m_eventType)
373 , m_timeStamp(src.m_timeStamp)
374 , m_id(src.m_id)
375 , m_callbackUserData(src.m_callbackUserData)
376 , m_propagationLevel(src.m_propagationLevel)
377 , m_skipped(src.m_skipped)
378 , m_isCommandEvent(src.m_isCommandEvent)
379 , m_wasProcessed(false)
380 {
381 }
382
383 wxEvent& wxEvent::operator=(const wxEvent& src)
384 {
385 wxObject::operator=(src);
386
387 m_eventObject = src.m_eventObject;
388 m_eventType = src.m_eventType;
389 m_timeStamp = src.m_timeStamp;
390 m_id = src.m_id;
391 m_callbackUserData = src.m_callbackUserData;
392 m_propagationLevel = src.m_propagationLevel;
393 m_skipped = src.m_skipped;
394 m_isCommandEvent = src.m_isCommandEvent;
395
396 // don't change m_wasProcessed
397
398 return *this;
399 }
400
401 #endif // wxUSE_BASE
402
403 #if wxUSE_GUI
404
405 /*
406 * Command events
407 *
408 */
409
410 #ifdef __VISUALC__
411 // 'this' : used in base member initializer list (for m_commandString)
412 #pragma warning(disable:4355)
413 #endif
414
415 wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId)
416 : wxEvent(theId, commandType)
417 {
418 m_clientData = NULL;
419 m_clientObject = NULL;
420 m_extraLong = 0;
421 m_commandInt = 0;
422 m_isCommandEvent = true;
423
424 // the command events are propagated upwards by default
425 m_propagationLevel = wxEVENT_PROPAGATE_MAX;
426 }
427
428 #ifdef __VISUALC__
429 #pragma warning(default:4355)
430 #endif
431
432 wxString wxCommandEvent::GetString() const
433 {
434 if (m_eventType != wxEVT_COMMAND_TEXT_UPDATED || !m_eventObject)
435 {
436 return m_cmdString;
437 }
438 else
439 {
440 #if wxUSE_TEXTCTRL
441 wxTextCtrl *txt = wxDynamicCast(m_eventObject, wxTextCtrl);
442 if ( txt )
443 return txt->GetValue();
444 else
445 #endif // wxUSE_TEXTCTRL
446 return m_cmdString;
447 }
448 }
449
450 /*
451 * UI update events
452 */
453
454 #if wxUSE_LONGLONG
455 wxLongLong wxUpdateUIEvent::sm_lastUpdate = 0;
456 #endif
457
458 long wxUpdateUIEvent::sm_updateInterval = 0;
459
460 wxUpdateUIMode wxUpdateUIEvent::sm_updateMode = wxUPDATE_UI_PROCESS_ALL;
461
462 // Can we update?
463 bool wxUpdateUIEvent::CanUpdate(wxWindowBase *win)
464 {
465 // Don't update if we've switched global updating off
466 // and this window doesn't support updates.
467 if (win &&
468 (GetMode() == wxUPDATE_UI_PROCESS_SPECIFIED &&
469 ((win->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES) == 0)))
470 return false;
471
472 if (sm_updateInterval == -1)
473 return false;
474
475 if (sm_updateInterval == 0)
476 return true;
477
478 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
479 wxLongLong now = wxGetLocalTimeMillis();
480 if (now > (sm_lastUpdate + sm_updateInterval))
481 {
482 return true;
483 }
484
485 return false;
486 #else
487 // If we don't have wxStopWatch or wxLongLong, we
488 // should err on the safe side and update now anyway.
489 return true;
490 #endif
491 }
492
493 // Reset the update time to provide a delay until the next
494 // time we should update
495 void wxUpdateUIEvent::ResetUpdateTime()
496 {
497 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
498 if (sm_updateInterval > 0)
499 {
500 wxLongLong now = wxGetLocalTimeMillis();
501 if (now > (sm_lastUpdate + sm_updateInterval))
502 {
503 sm_lastUpdate = now;
504 }
505 }
506 #endif
507 }
508
509 /*
510 * Scroll events
511 */
512
513 wxScrollEvent::wxScrollEvent(wxEventType commandType,
514 int id,
515 int pos,
516 int orient)
517 : wxCommandEvent(commandType, id)
518 {
519 m_extraLong = orient;
520 m_commandInt = pos;
521 }
522
523 /*
524 * ScrollWin events
525 */
526
527 wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType,
528 int pos,
529 int orient)
530 {
531 m_eventType = commandType;
532 m_extraLong = orient;
533 m_commandInt = pos;
534 }
535
536 /*
537 * Mouse events
538 *
539 */
540
541 wxMouseEvent::wxMouseEvent(wxEventType commandType)
542 {
543 m_eventType = commandType;
544
545 m_x = 0;
546 m_y = 0;
547
548 m_leftDown = false;
549 m_middleDown = false;
550 m_rightDown = false;
551 m_aux1Down = false;
552 m_aux2Down = false;
553
554 m_clickCount = -1;
555
556 m_wheelRotation = 0;
557 m_wheelDelta = 0;
558 m_linesPerAction = 0;
559 m_wheelAxis = 0;
560 }
561
562 void wxMouseEvent::Assign(const wxMouseEvent& event)
563 {
564 wxEvent::operator=(event);
565
566 // Borland C++ 5.82 doesn't compile an explicit call to an implicitly
567 // defined operator=() so need to do it this way:
568 *static_cast<wxMouseState *>(this) = event;
569
570 m_x = event.m_x;
571 m_y = event.m_y;
572
573 m_leftDown = event.m_leftDown;
574 m_middleDown = event.m_middleDown;
575 m_rightDown = event.m_rightDown;
576 m_aux1Down = event.m_aux1Down;
577 m_aux2Down = event.m_aux2Down;
578
579 m_wheelRotation = event.m_wheelRotation;
580 m_wheelDelta = event.m_wheelDelta;
581 m_linesPerAction = event.m_linesPerAction;
582 m_wheelAxis = event.m_wheelAxis;
583 }
584
585 // return true if was a button dclick event
586 bool wxMouseEvent::ButtonDClick(int but) const
587 {
588 switch (but)
589 {
590 default:
591 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
592 // fall through
593
594 case wxMOUSE_BTN_ANY:
595 return (LeftDClick() || MiddleDClick() || RightDClick() ||
596 Aux1DClick() || Aux2DClick());
597
598 case wxMOUSE_BTN_LEFT:
599 return LeftDClick();
600
601 case wxMOUSE_BTN_MIDDLE:
602 return MiddleDClick();
603
604 case wxMOUSE_BTN_RIGHT:
605 return RightDClick();
606
607 case wxMOUSE_BTN_AUX1:
608 return Aux1DClick();
609
610 case wxMOUSE_BTN_AUX2:
611 return Aux2DClick();
612 }
613 }
614
615 // return true if was a button down event
616 bool wxMouseEvent::ButtonDown(int but) const
617 {
618 switch (but)
619 {
620 default:
621 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
622 // fall through
623
624 case wxMOUSE_BTN_ANY:
625 return (LeftDown() || MiddleDown() || RightDown() ||
626 Aux1Down() || Aux2Down());
627
628 case wxMOUSE_BTN_LEFT:
629 return LeftDown();
630
631 case wxMOUSE_BTN_MIDDLE:
632 return MiddleDown();
633
634 case wxMOUSE_BTN_RIGHT:
635 return RightDown();
636
637 case wxMOUSE_BTN_AUX1:
638 return Aux1Down();
639
640 case wxMOUSE_BTN_AUX2:
641 return Aux2Down();
642 }
643 }
644
645 // return true if was a button up event
646 bool wxMouseEvent::ButtonUp(int but) const
647 {
648 switch (but)
649 {
650 default:
651 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
652 // fall through
653
654 case wxMOUSE_BTN_ANY:
655 return (LeftUp() || MiddleUp() || RightUp() ||
656 Aux1Up() || Aux2Up());
657
658 case wxMOUSE_BTN_LEFT:
659 return LeftUp();
660
661 case wxMOUSE_BTN_MIDDLE:
662 return MiddleUp();
663
664 case wxMOUSE_BTN_RIGHT:
665 return RightUp();
666
667 case wxMOUSE_BTN_AUX1:
668 return Aux1Up();
669
670 case wxMOUSE_BTN_AUX2:
671 return Aux2Up();
672 }
673 }
674
675 // return true if the given button is currently changing state
676 bool wxMouseEvent::Button(int but) const
677 {
678 switch (but)
679 {
680 default:
681 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
682 // fall through
683
684 case wxMOUSE_BTN_ANY:
685 return ButtonUp(wxMOUSE_BTN_ANY) ||
686 ButtonDown(wxMOUSE_BTN_ANY) ||
687 ButtonDClick(wxMOUSE_BTN_ANY);
688
689 case wxMOUSE_BTN_LEFT:
690 return LeftDown() || LeftUp() || LeftDClick();
691
692 case wxMOUSE_BTN_MIDDLE:
693 return MiddleDown() || MiddleUp() || MiddleDClick();
694
695 case wxMOUSE_BTN_RIGHT:
696 return RightDown() || RightUp() || RightDClick();
697
698 case wxMOUSE_BTN_AUX1:
699 return Aux1Down() || Aux1Up() || Aux1DClick();
700
701 case wxMOUSE_BTN_AUX2:
702 return Aux2Down() || Aux2Up() || Aux2DClick();
703 }
704 }
705
706 bool wxMouseEvent::ButtonIsDown(int but) const
707 {
708 switch (but)
709 {
710 default:
711 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonIsDown"));
712 // fall through
713
714 case wxMOUSE_BTN_ANY:
715 return LeftIsDown() || MiddleIsDown() || RightIsDown() || Aux1Down() || Aux2Down();
716
717 case wxMOUSE_BTN_LEFT:
718 return LeftIsDown();
719
720 case wxMOUSE_BTN_MIDDLE:
721 return MiddleIsDown();
722
723 case wxMOUSE_BTN_RIGHT:
724 return RightIsDown();
725
726 case wxMOUSE_BTN_AUX1:
727 return Aux1IsDown();
728
729 case wxMOUSE_BTN_AUX2:
730 return Aux2IsDown();
731 }
732 }
733
734 int wxMouseEvent::GetButton() const
735 {
736 for ( int i = 1; i < wxMOUSE_BTN_MAX; i++ )
737 {
738 if ( Button(i) )
739 {
740 return i;
741 }
742 }
743
744 return wxMOUSE_BTN_NONE;
745 }
746
747 // Find the logical position of the event given the DC
748 wxPoint wxMouseEvent::GetLogicalPosition(const wxDC& dc) const
749 {
750 wxPoint pt(dc.DeviceToLogicalX(m_x), dc.DeviceToLogicalY(m_y));
751 return pt;
752 }
753
754
755 /*
756 * Keyboard event
757 *
758 */
759
760 wxKeyEvent::wxKeyEvent(wxEventType type)
761 {
762 m_eventType = type;
763 m_keyCode = 0;
764 m_scanCode = 0;
765 #if wxUSE_UNICODE
766 m_uniChar = 0;
767 #endif
768 }
769
770 wxKeyEvent::wxKeyEvent(const wxKeyEvent& evt)
771 : wxEvent(evt),
772 wxKeyboardState(evt)
773 {
774 m_x = evt.m_x;
775 m_y = evt.m_y;
776
777 m_keyCode = evt.m_keyCode;
778
779 m_scanCode = evt.m_scanCode;
780 m_rawCode = evt.m_rawCode;
781 m_rawFlags = evt.m_rawFlags;
782
783 #if wxUSE_UNICODE
784 m_uniChar = evt.m_uniChar;
785 #endif
786 }
787
788 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win)
789 {
790 SetEventType(wxEVT_CREATE);
791 SetEventObject(win);
792 }
793
794 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow *win)
795 {
796 SetEventType(wxEVT_DESTROY);
797 SetEventObject(win);
798 }
799
800 wxChildFocusEvent::wxChildFocusEvent(wxWindow *win)
801 : wxCommandEvent(wxEVT_CHILD_FOCUS)
802 {
803 SetEventObject(win);
804 }
805
806 // ----------------------------------------------------------------------------
807 // wxHelpEvent
808 // ----------------------------------------------------------------------------
809
810 /* static */
811 wxHelpEvent::Origin wxHelpEvent::GuessOrigin(Origin origin)
812 {
813 if ( origin == Origin_Unknown )
814 {
815 // assume that the event comes from the help button if it's not from
816 // keyboard and that pressing F1 always results in the help event
817 origin = wxGetKeyState(WXK_F1) ? Origin_Keyboard : Origin_HelpButton;
818 }
819
820 return origin;
821 }
822
823 #endif // wxUSE_GUI
824
825
826 #if wxUSE_BASE
827
828 // ----------------------------------------------------------------------------
829 // wxEventHashTable
830 // ----------------------------------------------------------------------------
831
832 static const int EVENT_TYPE_TABLE_INIT_SIZE = 31; // Not too big not too small...
833
834 wxEventHashTable* wxEventHashTable::sm_first = NULL;
835
836 wxEventHashTable::wxEventHashTable(const wxEventTable &table)
837 : m_table(table),
838 m_rebuildHash(true)
839 {
840 AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE);
841
842 m_next = sm_first;
843 if (m_next)
844 m_next->m_previous = this;
845 sm_first = this;
846 }
847
848 wxEventHashTable::~wxEventHashTable()
849 {
850 if (m_next)
851 m_next->m_previous = m_previous;
852 if (m_previous)
853 m_previous->m_next = m_next;
854 if (sm_first == this)
855 sm_first = m_next;
856
857 Clear();
858 }
859
860 void wxEventHashTable::Clear()
861 {
862 for ( size_t i = 0; i < m_size; i++ )
863 {
864 EventTypeTablePointer eTTnode = m_eventTypeTable[i];
865 delete eTTnode;
866 }
867
868 delete[] m_eventTypeTable;
869 m_eventTypeTable = NULL;
870
871 m_size = 0;
872 }
873
874 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
875
876 // Clear all tables
877 void wxEventHashTable::ClearAll()
878 {
879 wxEventHashTable* table = sm_first;
880 while (table)
881 {
882 table->Clear();
883 table = table->m_next;
884 }
885 }
886
887 #endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
888
889 bool wxEventHashTable::HandleEvent(wxEvent &event, wxEvtHandler *self)
890 {
891 if (m_rebuildHash)
892 {
893 InitHashTable();
894 m_rebuildHash = false;
895 }
896
897 if (!m_eventTypeTable)
898 return false;
899
900 // Find all entries for the given event type.
901 wxEventType eventType = event.GetEventType();
902 const EventTypeTablePointer eTTnode = m_eventTypeTable[eventType % m_size];
903 if (eTTnode && eTTnode->eventType == eventType)
904 {
905 // Now start the search for an event handler
906 // that can handle an event with the given ID.
907 const wxEventTableEntryPointerArray&
908 eventEntryTable = eTTnode->eventEntryTable;
909
910 const size_t count = eventEntryTable.GetCount();
911 for (size_t n = 0; n < count; n++)
912 {
913 const wxEventTableEntry& entry = *eventEntryTable[n];
914 if ( wxEvtHandler::ProcessEventIfMatchesId(entry, self, event) )
915 return true;
916 }
917 }
918
919 return false;
920 }
921
922 void wxEventHashTable::InitHashTable()
923 {
924 // Loop over the event tables and all its base tables.
925 const wxEventTable *table = &m_table;
926 while (table)
927 {
928 // Retrieve all valid event handler entries
929 const wxEventTableEntry *entry = table->entries;
930 while (entry->m_fn != 0)
931 {
932 // Add the event entry in the Hash.
933 AddEntry(*entry);
934
935 entry++;
936 }
937
938 table = table->baseTable;
939 }
940
941 // Lets free some memory.
942 size_t i;
943 for(i = 0; i < m_size; i++)
944 {
945 EventTypeTablePointer eTTnode = m_eventTypeTable[i];
946 if (eTTnode)
947 {
948 eTTnode->eventEntryTable.Shrink();
949 }
950 }
951 }
952
953 void wxEventHashTable::AddEntry(const wxEventTableEntry &entry)
954 {
955 // This might happen 'accidentally' as the app is exiting
956 if (!m_eventTypeTable)
957 return;
958
959 EventTypeTablePointer *peTTnode = &m_eventTypeTable[entry.m_eventType % m_size];
960 EventTypeTablePointer eTTnode = *peTTnode;
961
962 if (eTTnode)
963 {
964 if (eTTnode->eventType != entry.m_eventType)
965 {
966 // Resize the table!
967 GrowEventTypeTable();
968 // Try again to add it.
969 AddEntry(entry);
970 return;
971 }
972 }
973 else
974 {
975 eTTnode = new EventTypeTable;
976 eTTnode->eventType = entry.m_eventType;
977 *peTTnode = eTTnode;
978 }
979
980 // Fill all hash entries between entry.m_id and entry.m_lastId...
981 eTTnode->eventEntryTable.Add(&entry);
982 }
983
984 void wxEventHashTable::AllocEventTypeTable(size_t size)
985 {
986 m_eventTypeTable = new EventTypeTablePointer[size];
987 memset((void *)m_eventTypeTable, 0, sizeof(EventTypeTablePointer)*size);
988 m_size = size;
989 }
990
991 void wxEventHashTable::GrowEventTypeTable()
992 {
993 size_t oldSize = m_size;
994 EventTypeTablePointer *oldEventTypeTable = m_eventTypeTable;
995
996 // TODO: Search the most optimal grow sequence
997 AllocEventTypeTable(/* GetNextPrime(oldSize) */oldSize*2+1);
998
999 for ( size_t i = 0; i < oldSize; /* */ )
1000 {
1001 EventTypeTablePointer eTToldNode = oldEventTypeTable[i];
1002 if (eTToldNode)
1003 {
1004 EventTypeTablePointer *peTTnode = &m_eventTypeTable[eTToldNode->eventType % m_size];
1005 EventTypeTablePointer eTTnode = *peTTnode;
1006
1007 // Check for collision, we don't want any.
1008 if (eTTnode)
1009 {
1010 GrowEventTypeTable();
1011 continue; // Don't increment the counter,
1012 // as we still need to add this element.
1013 }
1014 else
1015 {
1016 // Get the old value and put it in the new table.
1017 *peTTnode = oldEventTypeTable[i];
1018 }
1019 }
1020
1021 i++;
1022 }
1023
1024 delete[] oldEventTypeTable;
1025 }
1026
1027 // ----------------------------------------------------------------------------
1028 // wxEvtHandler
1029 // ----------------------------------------------------------------------------
1030
1031 wxEvtHandler::wxEvtHandler()
1032 {
1033 m_nextHandler = NULL;
1034 m_previousHandler = NULL;
1035 m_enabled = true;
1036 m_dynamicEvents = NULL;
1037 m_pendingEvents = NULL;
1038
1039 // no client data (yet)
1040 m_clientData = NULL;
1041 m_clientDataType = wxClientData_None;
1042 }
1043
1044 wxEvtHandler::~wxEvtHandler()
1045 {
1046 Unlink();
1047
1048 if (m_dynamicEvents)
1049 {
1050 for ( wxList::iterator it = m_dynamicEvents->begin(),
1051 end = m_dynamicEvents->end();
1052 it != end;
1053 ++it )
1054 {
1055 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)*it;
1056
1057 // Remove ourselves from sink destructor notifications
1058 // (this has usually been done, in wxTrackable destructor)
1059 wxEvtHandler *eventSink = entry->m_fn->GetEvtHandler();
1060 if ( eventSink )
1061 {
1062 wxEventConnectionRef * const
1063 evtConnRef = FindRefInTrackerList(eventSink);
1064 if ( evtConnRef )
1065 {
1066 eventSink->RemoveNode(evtConnRef);
1067 delete evtConnRef;
1068 }
1069 }
1070
1071 delete entry->m_callbackUserData;
1072 delete entry;
1073 }
1074 delete m_dynamicEvents;
1075 }
1076
1077 if (m_pendingEvents)
1078 m_pendingEvents->DeleteContents(true);
1079 delete m_pendingEvents;
1080
1081 // Remove us from the list of the pending events if necessary.
1082 wxEventLoopBase *loop = wxEventLoopBase::GetActive();
1083 if (loop)
1084 loop->RemovePendingEventHandler(this);
1085
1086 // we only delete object data, not untyped
1087 if ( m_clientDataType == wxClientData_Object )
1088 delete m_clientObject;
1089 }
1090
1091 void wxEvtHandler::Unlink()
1092 {
1093 // this event handler must take itself out of the chain of handlers:
1094
1095 if (m_previousHandler)
1096 m_previousHandler->SetNextHandler(m_nextHandler);
1097
1098 if (m_nextHandler)
1099 m_nextHandler->SetPreviousHandler(m_previousHandler);
1100
1101 m_nextHandler = NULL;
1102 m_previousHandler = NULL;
1103 }
1104
1105 bool wxEvtHandler::IsUnlinked() const
1106 {
1107 return m_previousHandler == NULL &&
1108 m_nextHandler == NULL;
1109 }
1110
1111 #if wxUSE_THREADS
1112
1113 bool wxEvtHandler::ProcessThreadEvent(const wxEvent& event)
1114 {
1115 // check that we are really in a child thread
1116 wxASSERT_MSG( !wxThread::IsMain(),
1117 wxT("use ProcessEvent() in main thread") );
1118
1119 AddPendingEvent(event);
1120
1121 return true;
1122 }
1123
1124 #endif // wxUSE_THREADS
1125
1126 void wxEvtHandler::QueueEvent(wxEvent *event)
1127 {
1128 wxCHECK_RET( event, "NULL event can't be posted" );
1129
1130 wxEventLoopBase* loop = wxEventLoopBase::GetActive();
1131 if (!loop)
1132 {
1133 // we need an event loop which manages the list of event handlers with
1134 // pending events... cannot proceed without it!
1135 wxLogDebug("No event loop is running!");
1136 return;
1137 }
1138
1139 // 1) Add this event to our list of pending events
1140 wxENTER_CRIT_SECT( m_pendingEventsLock );
1141
1142 if ( !m_pendingEvents )
1143 m_pendingEvents = new wxList;
1144
1145 m_pendingEvents->Append(event);
1146
1147 // 2) Add this event handler to list of event handlers that
1148 // have pending events.
1149
1150 loop->AppendPendingEventHandler(this);
1151
1152 // only release m_pendingEventsLock now because otherwise there is a race
1153 // condition as described in the ticket #9093: we could process the event
1154 // just added to m_pendingEvents in our ProcessPendingEvents() below before
1155 // we had time to append this pointer to wxHandlersWithPendingEvents list; thus
1156 // breaking the invariant that a handler should be in the list iff it has
1157 // any pending events to process
1158 wxLEAVE_CRIT_SECT( m_pendingEventsLock );
1159
1160 // 3) Inform the system that new pending events are somewhere,
1161 // and that these should be processed in idle time.
1162 wxWakeUpIdle();
1163 }
1164
1165 void wxEvtHandler::ProcessPendingEvents()
1166 {
1167 wxEventLoopBase* loop = wxEventLoopBase::GetActive();
1168 if (!loop)
1169 {
1170 // we need an event loop which manages the list of event handlers with
1171 // pending events... cannot proceed without it!
1172 wxLogDebug("No event loop is running!");
1173 return;
1174 }
1175
1176 // we need to process only a single pending event in this call because
1177 // each call to ProcessEvent() could result in the destruction of this
1178 // same event handler (see the comment at the end of this function)
1179
1180 wxENTER_CRIT_SECT( m_pendingEventsLock );
1181
1182 // this method is only called by wxApp if this handler does have
1183 // pending events
1184 wxCHECK_RET( m_pendingEvents && !m_pendingEvents->IsEmpty(),
1185 "should have pending events if called" );
1186
1187 wxList::compatibility_iterator node = m_pendingEvents->GetFirst();
1188 wxEvent* pEvent = static_cast<wxEvent *>(node->GetData());
1189
1190 // find the first event which can be processed now:
1191 wxEventLoopBase* evtLoop = wxEventLoopBase::GetActive();
1192 if (evtLoop && evtLoop->IsYielding())
1193 {
1194 while (node && pEvent && !evtLoop->IsEventAllowedInsideYield(pEvent->GetEventCategory()))
1195 {
1196 node = node->GetNext();
1197 pEvent = node ? static_cast<wxEvent *>(node->GetData()) : NULL;
1198 }
1199
1200 if (!node)
1201 {
1202 // all our events are NOT processable now... signal this:
1203 loop->DelayPendingEventHandler(this);
1204
1205 // see the comment at the beginning of evtloop.h header for the
1206 // logic behind YieldFor() and behind DelayPendingEventHandler()
1207
1208 wxLEAVE_CRIT_SECT( m_pendingEventsLock );
1209
1210 return;
1211 }
1212 }
1213
1214 wxEventPtr event(pEvent);
1215
1216 // it's important we remove event from list before processing it, else a
1217 // nested event loop, for example from a modal dialog, might process the
1218 // same event again.
1219 m_pendingEvents->Erase(node);
1220
1221 if ( m_pendingEvents->IsEmpty() )
1222 {
1223 // if there are no more pending events left, we don't need to
1224 // stay in this list
1225 loop->RemovePendingEventHandler(this);
1226 }
1227
1228 wxLEAVE_CRIT_SECT( m_pendingEventsLock );
1229
1230 ProcessEvent(*event);
1231
1232 // careful: this object could have been deleted by the event handler
1233 // executed by the above ProcessEvent() call, so we can't access any fields
1234 // of this object any more
1235 }
1236
1237 /*
1238 * Event table stuff
1239 */
1240 /* static */ bool
1241 wxEvtHandler::ProcessEventIfMatchesId(const wxEventTableEntryBase& entry,
1242 wxEvtHandler *handler,
1243 wxEvent& event)
1244 {
1245 int tableId1 = entry.m_id,
1246 tableId2 = entry.m_lastId;
1247
1248 // match only if the event type is the same and the id is either -1 in
1249 // the event table (meaning "any") or the event id matches the id
1250 // specified in the event table either exactly or by falling into
1251 // range between first and last
1252 if ((tableId1 == wxID_ANY) ||
1253 (tableId2 == wxID_ANY && tableId1 == event.GetId()) ||
1254 (tableId2 != wxID_ANY &&
1255 (event.GetId() >= tableId1 && event.GetId() <= tableId2)))
1256 {
1257 event.Skip(false);
1258 event.m_callbackUserData = entry.m_callbackUserData;
1259
1260 #if wxUSE_EXCEPTIONS
1261 if ( wxTheApp )
1262 {
1263 // call the handler via wxApp method which allows the user to catch
1264 // any exceptions which may be thrown by any handler in the program
1265 // in one place
1266 wxTheApp->CallEventHandler(handler, *entry.m_fn, event);
1267 }
1268 else
1269 #endif // wxUSE_EXCEPTIONS
1270 {
1271 (*entry.m_fn)(handler, event);
1272 }
1273
1274 if (!event.GetSkipped())
1275 return true;
1276 }
1277
1278 return false;
1279 }
1280
1281 bool wxEvtHandler::TryParent(wxEvent& event)
1282 {
1283 if ( GetNextHandler() )
1284 {
1285 // the next handler will pass it to wxTheApp if it doesn't process it,
1286 // so return from here to avoid doing it again
1287 return GetNextHandler()->TryParent(event);
1288 }
1289
1290 if ( wxTheApp && (this != wxTheApp) )
1291 {
1292 // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
1293 // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
1294 // processed appropriately via SearchEventTable.
1295 if ( event.GetEventType() != wxEVT_IDLE )
1296 {
1297 if ( wxTheApp->ProcessEvent(event) )
1298 return true;
1299 }
1300 }
1301
1302 return false;
1303 }
1304
1305 bool wxEvtHandler::ProcessEvent(wxEvent& event)
1306 {
1307 // allow the application to hook into event processing
1308 //
1309 // note that we should only do it if we're the first event handler called
1310 // to avoid calling FilterEvent() multiple times as the event goes through
1311 // the event handler chain and possibly upwards the window hierarchy
1312 if ( !event.WasProcessed() )
1313 {
1314 if ( wxTheApp )
1315 {
1316 int rc = wxTheApp->FilterEvent(event);
1317 if ( rc != -1 )
1318 {
1319 wxASSERT_MSG( rc == 1 || rc == 0,
1320 "unexpected wxApp::FilterEvent return value" );
1321
1322 return rc != 0;
1323 }
1324 //else: proceed normally
1325 }
1326 }
1327
1328 if ( ProcessEventHere(event) )
1329 return true;
1330
1331 // pass the event to the next handler, notice that we shouldn't call
1332 // TryParent() even if it doesn't handle the event as the last handler in
1333 // the chain will do it
1334 if ( GetNextHandler() )
1335 return GetNextHandler()->ProcessEvent(event);
1336
1337 // propagate the event upwards the window chain and/or to the application
1338 // object if it wasn't processed at this level
1339 return TryParent(event);
1340 }
1341
1342 bool wxEvtHandler::ProcessEventHere(wxEvent& event)
1343 {
1344 // If the event handler is disabled it doesn't process any events
1345 if ( !GetEvtHandlerEnabled() )
1346 return false;
1347
1348 // If we have a validator, it has higher priority than our own event
1349 // handlers
1350 if ( TryValidator(event) )
1351 return true;
1352
1353 // Handle per-instance dynamic event tables first
1354 if ( m_dynamicEvents && SearchDynamicEventTable(event) )
1355 return true;
1356
1357 // Then static per-class event tables
1358 if ( GetEventHashTable().HandleEvent(event, this) )
1359 return true;
1360
1361 // We don't have a handler for this event.
1362 return false;
1363 }
1364
1365 bool wxEvtHandler::SafelyProcessEvent(wxEvent& event)
1366 {
1367 #if wxUSE_EXCEPTIONS
1368 try
1369 {
1370 #endif
1371 return ProcessEvent(event);
1372 #if wxUSE_EXCEPTIONS
1373 }
1374 catch ( ... )
1375 {
1376 wxEventLoopBase *loop = wxEventLoopBase::GetActive();
1377 try
1378 {
1379 if ( !wxTheApp || !wxTheApp->OnExceptionInMainLoop() )
1380 {
1381 if ( loop )
1382 loop->Exit();
1383 }
1384 //else: continue running current event loop
1385
1386 return false;
1387 }
1388 catch ( ... )
1389 {
1390 // OnExceptionInMainLoop() threw, possibly rethrowing the same
1391 // exception again: very good, but we still need Exit() to
1392 // be called
1393 if ( loop )
1394 loop->Exit();
1395 throw;
1396 }
1397 }
1398 #endif // wxUSE_EXCEPTIONS
1399 }
1400
1401
1402 bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event)
1403 {
1404 const wxEventType eventType = event.GetEventType();
1405 for ( int i = 0; table.entries[i].m_fn != 0; i++ )
1406 {
1407 const wxEventTableEntry& entry = table.entries[i];
1408 if ( eventType == entry.m_eventType )
1409 {
1410 if ( ProcessEventIfMatchesId(entry, this, event) )
1411 return true;
1412 }
1413 }
1414
1415 return false;
1416 }
1417
1418 void wxEvtHandler::DoConnect(int id,
1419 int lastId,
1420 wxEventType eventType,
1421 wxEventFunctor *func,
1422 wxObject *userData)
1423 {
1424 wxDynamicEventTableEntry *entry =
1425 new wxDynamicEventTableEntry(eventType, id, lastId, func, userData);
1426
1427 if (!m_dynamicEvents)
1428 m_dynamicEvents = new wxList;
1429
1430 // Insert at the front of the list so most recent additions are found first
1431 m_dynamicEvents->Insert( (wxObject*) entry );
1432
1433 // Make sure we get to know when a sink is destroyed
1434 wxEvtHandler *eventSink = func->GetEvtHandler();
1435 if ( eventSink && eventSink != this )
1436 {
1437 wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink);
1438 if ( evtConnRef )
1439 evtConnRef->IncRef( );
1440 else
1441 new wxEventConnectionRef(this, eventSink);
1442 }
1443 }
1444
1445 bool
1446 wxEvtHandler::DoDisconnect(int id,
1447 int lastId,
1448 wxEventType eventType,
1449 const wxEventFunctor& func,
1450 wxObject *userData)
1451 {
1452 if (!m_dynamicEvents)
1453 return false;
1454
1455 // Remove connection from tracker node (wxEventConnectionRef)
1456 wxEvtHandler *eventSink = func.GetEvtHandler();
1457 if ( eventSink && eventSink != this )
1458 {
1459 wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink);
1460 if ( evtConnRef )
1461 evtConnRef->DecRef();
1462 }
1463
1464 wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();
1465 while (node)
1466 {
1467 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1468
1469 if ((entry->m_id == id) &&
1470 ((entry->m_lastId == lastId) || (lastId == wxID_ANY)) &&
1471 ((entry->m_eventType == eventType) || (eventType == wxEVT_NULL)) &&
1472 entry->m_fn->Matches(func) &&
1473 ((entry->m_callbackUserData == userData) || !userData))
1474 {
1475 delete entry->m_callbackUserData;
1476 m_dynamicEvents->Erase( node );
1477 delete entry;
1478 return true;
1479 }
1480 node = node->GetNext();
1481 }
1482 return false;
1483 }
1484
1485 bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event )
1486 {
1487 wxCHECK_MSG( m_dynamicEvents, false,
1488 wxT("caller should check that we have dynamic events") );
1489
1490 wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();
1491 while (node)
1492 {
1493 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1494
1495 // get next node before (maybe) calling the event handler as it could
1496 // call Disconnect() invalidating the current node
1497 node = node->GetNext();
1498
1499 if ( event.GetEventType() == entry->m_eventType )
1500 {
1501 wxEvtHandler *handler = entry->m_fn->GetEvtHandler();
1502 if ( !handler )
1503 handler = this;
1504 if ( ProcessEventIfMatchesId(*entry, handler, event) )
1505 return true;
1506 }
1507 }
1508
1509 return false;
1510 }
1511
1512 void wxEvtHandler::DoSetClientObject( wxClientData *data )
1513 {
1514 wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1515 wxT("can't have both object and void client data") );
1516
1517 if ( m_clientObject )
1518 delete m_clientObject;
1519
1520 m_clientObject = data;
1521 m_clientDataType = wxClientData_Object;
1522 }
1523
1524 wxClientData *wxEvtHandler::DoGetClientObject() const
1525 {
1526 // it's not an error to call GetClientObject() on a window which doesn't
1527 // have client data at all - NULL will be returned
1528 wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1529 wxT("this window doesn't have object client data") );
1530
1531 return m_clientObject;
1532 }
1533
1534 void wxEvtHandler::DoSetClientData( void *data )
1535 {
1536 wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1537 wxT("can't have both object and void client data") );
1538
1539 m_clientData = data;
1540 m_clientDataType = wxClientData_Void;
1541 }
1542
1543 void *wxEvtHandler::DoGetClientData() const
1544 {
1545 // it's not an error to call GetClientData() on a window which doesn't have
1546 // client data at all - NULL will be returned
1547 wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1548 wxT("this window doesn't have void client data") );
1549
1550 return m_clientData;
1551 }
1552
1553 // A helper to find an wxEventConnectionRef object
1554 wxEventConnectionRef *
1555 wxEvtHandler::FindRefInTrackerList(wxEvtHandler *eventSink)
1556 {
1557 for ( wxTrackerNode *node = eventSink->GetFirst(); node; node = node->m_nxt )
1558 {
1559 // we only want wxEventConnectionRef nodes here
1560 wxEventConnectionRef *evtConnRef = node->ToEventConnection();
1561 if ( evtConnRef && evtConnRef->m_src == this )
1562 {
1563 wxASSERT( evtConnRef->m_sink==eventSink );
1564 return evtConnRef;
1565 }
1566 }
1567
1568 return NULL;
1569 }
1570
1571 void wxEvtHandler::OnSinkDestroyed( wxEvtHandler *sink )
1572 {
1573 wxASSERT(m_dynamicEvents);
1574
1575 // remove all connections with this sink
1576 wxList::compatibility_iterator node = m_dynamicEvents->GetFirst(), node_nxt;
1577 while (node)
1578 {
1579 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1580 node_nxt = node->GetNext();
1581
1582 if ( entry->m_fn->GetEvtHandler() == sink )
1583 {
1584 delete entry->m_callbackUserData;
1585 m_dynamicEvents->Erase( node );
1586 delete entry;
1587 }
1588 node = node_nxt;
1589 }
1590 }
1591
1592 #endif // wxUSE_BASE
1593
1594 #if wxUSE_GUI
1595
1596 // Find a window with the focus, that is also a descendant of the given window.
1597 // This is used to determine the window to initially send commands to.
1598 wxWindow* wxFindFocusDescendant(wxWindow* ancestor)
1599 {
1600 // Process events starting with the window with the focus, if any.
1601 wxWindow* focusWin = wxWindow::FindFocus();
1602 wxWindow* win = focusWin;
1603
1604 // Check if this is a descendant of this frame.
1605 // If not, win will be set to NULL.
1606 while (win)
1607 {
1608 if (win == ancestor)
1609 break;
1610 else
1611 win = win->GetParent();
1612 }
1613 if (win == NULL)
1614 focusWin = NULL;
1615
1616 return focusWin;
1617 }
1618
1619 // ----------------------------------------------------------------------------
1620 // wxEventBlocker
1621 // ----------------------------------------------------------------------------
1622
1623 wxEventBlocker::wxEventBlocker(wxWindow *win, wxEventType type)
1624 {
1625 wxCHECK_RET(win, wxT("Null window given to wxEventBlocker"));
1626
1627 m_window = win;
1628
1629 Block(type);
1630 m_window->PushEventHandler(this);
1631 }
1632
1633 wxEventBlocker::~wxEventBlocker()
1634 {
1635 wxEvtHandler *popped = m_window->PopEventHandler(false);
1636 wxCHECK_RET(popped == this,
1637 wxT("Don't push other event handlers into a window managed by wxEventBlocker!"));
1638 }
1639
1640 bool wxEventBlocker::ProcessEvent(wxEvent& event)
1641 {
1642 // should this event be blocked?
1643 for ( size_t i = 0; i < m_eventsToBlock.size(); i++ )
1644 {
1645 wxEventType t = (wxEventType)m_eventsToBlock[i];
1646 if ( t == wxEVT_ANY || t == event.GetEventType() )
1647 return true; // yes, it should: mark this event as processed
1648 }
1649
1650 return false;
1651 }
1652
1653 #endif // wxUSE_GUI
1654
wxWidgets (Impactor)