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