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