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