]> 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
Italian translation corrections from Roberto Boriotti.
[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 #ifdef __VISUALC__
417 // 'this' : used in base member initializer list (for m_commandString)
418 #pragma warning(disable:4355)
419 #endif
420
421 wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId)
422 : wxEvent(theId, commandType)
423 {
424 m_clientData = NULL;
425 m_clientObject = NULL;
426 m_isCommandEvent = true;
427
428 // the command events are propagated upwards by default
429 m_propagationLevel = wxEVENT_PROPAGATE_MAX;
430 }
431
432 #ifdef __VISUALC__
433 #pragma warning(default:4355)
434 #endif
435
436 wxString wxCommandEvent::GetString() const
437 {
438 if (m_eventType != wxEVT_COMMAND_TEXT_UPDATED || !m_eventObject)
439 {
440 return m_cmdString;
441 }
442 else
443 {
444 #if wxUSE_TEXTCTRL
445 wxTextCtrl *txt = wxDynamicCast(m_eventObject, wxTextCtrl);
446 if ( txt )
447 return txt->GetValue();
448 else
449 #endif // wxUSE_TEXTCTRL
450 return m_cmdString;
451 }
452 }
453
454 // ----------------------------------------------------------------------------
455 // wxUpdateUIEvent
456 // ----------------------------------------------------------------------------
457
458 #if wxUSE_LONGLONG
459 wxLongLong wxUpdateUIEvent::sm_lastUpdate = 0;
460 #endif
461
462 long wxUpdateUIEvent::sm_updateInterval = 0;
463
464 wxUpdateUIMode wxUpdateUIEvent::sm_updateMode = wxUPDATE_UI_PROCESS_ALL;
465
466 // Can we update?
467 bool wxUpdateUIEvent::CanUpdate(wxWindowBase *win)
468 {
469 // Don't update if we've switched global updating off
470 // and this window doesn't support updates.
471 if (win &&
472 (GetMode() == wxUPDATE_UI_PROCESS_SPECIFIED &&
473 ((win->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES) == 0)))
474 return false;
475
476 // Don't update children of the hidden windows: this is useless as any
477 // change to their state won't be seen by the user anyhow. Notice that this
478 // argument doesn't apply to the hidden windows (with visible parent)
479 // themselves as they could be shown by their EVT_UPDATE_UI handler.
480 if ( win->GetParent() && !win->GetParent()->IsShownOnScreen() )
481 return false;
482
483 if (sm_updateInterval == -1)
484 return false;
485
486 if (sm_updateInterval == 0)
487 return true;
488
489 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
490 wxLongLong now = wxGetLocalTimeMillis();
491 if (now > (sm_lastUpdate + sm_updateInterval))
492 {
493 return true;
494 }
495
496 return false;
497 #else
498 // If we don't have wxStopWatch or wxLongLong, we
499 // should err on the safe side and update now anyway.
500 return true;
501 #endif
502 }
503
504 // Reset the update time to provide a delay until the next
505 // time we should update
506 void wxUpdateUIEvent::ResetUpdateTime()
507 {
508 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
509 if (sm_updateInterval > 0)
510 {
511 wxLongLong now = wxGetLocalTimeMillis();
512 if (now > (sm_lastUpdate + sm_updateInterval))
513 {
514 sm_lastUpdate = now;
515 }
516 }
517 #endif
518 }
519
520 // ----------------------------------------------------------------------------
521 // wxScrollEvent
522 // ----------------------------------------------------------------------------
523
524 wxScrollEvent::wxScrollEvent(wxEventType commandType,
525 int id,
526 int pos,
527 int orient)
528 : wxCommandEvent(commandType, id)
529 {
530 m_extraLong = orient;
531 m_commandInt = pos;
532 }
533
534 // ----------------------------------------------------------------------------
535 // wxScrollWinEvent
536 // ----------------------------------------------------------------------------
537
538 wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType,
539 int pos,
540 int orient)
541 {
542 m_eventType = commandType;
543 m_extraLong = orient;
544 m_commandInt = pos;
545 }
546
547 // ----------------------------------------------------------------------------
548 // wxMouseEvent
549 // ----------------------------------------------------------------------------
550
551 wxMouseEvent::wxMouseEvent(wxEventType commandType)
552 {
553 m_eventType = commandType;
554
555 m_x = 0;
556 m_y = 0;
557
558 m_leftDown = false;
559 m_middleDown = false;
560 m_rightDown = false;
561 m_aux1Down = false;
562 m_aux2Down = false;
563
564 m_clickCount = -1;
565
566 m_wheelRotation = 0;
567 m_wheelDelta = 0;
568 m_linesPerAction = 0;
569 m_wheelAxis = 0;
570 }
571
572 void wxMouseEvent::Assign(const wxMouseEvent& event)
573 {
574 wxEvent::operator=(event);
575
576 // Borland C++ 5.82 doesn't compile an explicit call to an implicitly
577 // defined operator=() so need to do it this way:
578 *static_cast<wxMouseState *>(this) = event;
579
580 m_x = event.m_x;
581 m_y = event.m_y;
582
583 m_leftDown = event.m_leftDown;
584 m_middleDown = event.m_middleDown;
585 m_rightDown = event.m_rightDown;
586 m_aux1Down = event.m_aux1Down;
587 m_aux2Down = event.m_aux2Down;
588
589 m_wheelRotation = event.m_wheelRotation;
590 m_wheelDelta = event.m_wheelDelta;
591 m_linesPerAction = event.m_linesPerAction;
592 m_wheelAxis = event.m_wheelAxis;
593 }
594
595 // return true if was a button dclick event
596 bool wxMouseEvent::ButtonDClick(int but) const
597 {
598 switch (but)
599 {
600 default:
601 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
602 // fall through
603
604 case wxMOUSE_BTN_ANY:
605 return (LeftDClick() || MiddleDClick() || RightDClick() ||
606 Aux1DClick() || Aux2DClick());
607
608 case wxMOUSE_BTN_LEFT:
609 return LeftDClick();
610
611 case wxMOUSE_BTN_MIDDLE:
612 return MiddleDClick();
613
614 case wxMOUSE_BTN_RIGHT:
615 return RightDClick();
616
617 case wxMOUSE_BTN_AUX1:
618 return Aux1DClick();
619
620 case wxMOUSE_BTN_AUX2:
621 return Aux2DClick();
622 }
623 }
624
625 // return true if was a button down event
626 bool wxMouseEvent::ButtonDown(int but) const
627 {
628 switch (but)
629 {
630 default:
631 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
632 // fall through
633
634 case wxMOUSE_BTN_ANY:
635 return (LeftDown() || MiddleDown() || RightDown() ||
636 Aux1Down() || Aux2Down());
637
638 case wxMOUSE_BTN_LEFT:
639 return LeftDown();
640
641 case wxMOUSE_BTN_MIDDLE:
642 return MiddleDown();
643
644 case wxMOUSE_BTN_RIGHT:
645 return RightDown();
646
647 case wxMOUSE_BTN_AUX1:
648 return Aux1Down();
649
650 case wxMOUSE_BTN_AUX2:
651 return Aux2Down();
652 }
653 }
654
655 // return true if was a button up event
656 bool wxMouseEvent::ButtonUp(int but) const
657 {
658 switch (but)
659 {
660 default:
661 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
662 // fall through
663
664 case wxMOUSE_BTN_ANY:
665 return (LeftUp() || MiddleUp() || RightUp() ||
666 Aux1Up() || Aux2Up());
667
668 case wxMOUSE_BTN_LEFT:
669 return LeftUp();
670
671 case wxMOUSE_BTN_MIDDLE:
672 return MiddleUp();
673
674 case wxMOUSE_BTN_RIGHT:
675 return RightUp();
676
677 case wxMOUSE_BTN_AUX1:
678 return Aux1Up();
679
680 case wxMOUSE_BTN_AUX2:
681 return Aux2Up();
682 }
683 }
684
685 // return true if the given button is currently changing state
686 bool wxMouseEvent::Button(int but) const
687 {
688 switch (but)
689 {
690 default:
691 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
692 // fall through
693
694 case wxMOUSE_BTN_ANY:
695 return ButtonUp(wxMOUSE_BTN_ANY) ||
696 ButtonDown(wxMOUSE_BTN_ANY) ||
697 ButtonDClick(wxMOUSE_BTN_ANY);
698
699 case wxMOUSE_BTN_LEFT:
700 return LeftDown() || LeftUp() || LeftDClick();
701
702 case wxMOUSE_BTN_MIDDLE:
703 return MiddleDown() || MiddleUp() || MiddleDClick();
704
705 case wxMOUSE_BTN_RIGHT:
706 return RightDown() || RightUp() || RightDClick();
707
708 case wxMOUSE_BTN_AUX1:
709 return Aux1Down() || Aux1Up() || Aux1DClick();
710
711 case wxMOUSE_BTN_AUX2:
712 return Aux2Down() || Aux2Up() || Aux2DClick();
713 }
714 }
715
716 int wxMouseEvent::GetButton() const
717 {
718 for ( int i = 1; i < wxMOUSE_BTN_MAX; i++ )
719 {
720 if ( Button(i) )
721 {
722 return i;
723 }
724 }
725
726 return wxMOUSE_BTN_NONE;
727 }
728
729 // Find the logical position of the event given the DC
730 wxPoint wxMouseEvent::GetLogicalPosition(const wxDC& dc) const
731 {
732 wxPoint pt(dc.DeviceToLogicalX(m_x), dc.DeviceToLogicalY(m_y));
733 return pt;
734 }
735
736 // ----------------------------------------------------------------------------
737 // wxKeyEvent
738 // ----------------------------------------------------------------------------
739
740 wxKeyEvent::wxKeyEvent(wxEventType type)
741 {
742 m_eventType = type;
743 m_keyCode = WXK_NONE;
744 #if wxUSE_UNICODE
745 m_uniChar = WXK_NONE;
746 #endif
747 }
748
749 wxKeyEvent::wxKeyEvent(const wxKeyEvent& evt)
750 : wxEvent(evt),
751 wxKeyboardState(evt)
752 {
753 m_x = evt.m_x;
754 m_y = evt.m_y;
755
756 m_keyCode = evt.m_keyCode;
757 m_rawCode = evt.m_rawCode;
758 m_rawFlags = evt.m_rawFlags;
759
760 #if wxUSE_UNICODE
761 m_uniChar = evt.m_uniChar;
762 #endif
763 }
764
765 bool wxKeyEvent::IsKeyInCategory(int category) const
766 {
767 switch ( GetKeyCode() )
768 {
769 case WXK_LEFT:
770 case WXK_RIGHT:
771 case WXK_UP:
772 case WXK_DOWN:
773 case WXK_NUMPAD_LEFT:
774 case WXK_NUMPAD_RIGHT:
775 case WXK_NUMPAD_UP:
776 case WXK_NUMPAD_DOWN:
777 return (category & WXK_CATEGORY_ARROW) != 0;
778
779 case WXK_PAGEDOWN:
780 case WXK_END:
781 case WXK_NUMPAD_PAGEUP:
782 case WXK_NUMPAD_PAGEDOWN:
783 return (category & WXK_CATEGORY_PAGING) != 0;
784
785 case WXK_HOME:
786 case WXK_PAGEUP:
787 case WXK_NUMPAD_HOME:
788 case WXK_NUMPAD_END:
789 return (category & WXK_CATEGORY_JUMP) != 0;
790
791 case WXK_TAB:
792 case WXK_NUMPAD_TAB:
793 return (category & WXK_CATEGORY_TAB) != 0;
794
795 case WXK_BACK:
796 case WXK_DELETE:
797 case WXK_NUMPAD_DELETE:
798 return (category & WXK_CATEGORY_CUT) != 0;
799
800 default:
801 return false;
802 }
803 }
804
805 // ----------------------------------------------------------------------------
806 // wxWindowCreateEvent
807 // ----------------------------------------------------------------------------
808
809 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win)
810 {
811 SetEventType(wxEVT_CREATE);
812 SetEventObject(win);
813 }
814
815 // ----------------------------------------------------------------------------
816 // wxWindowDestroyEvent
817 // ----------------------------------------------------------------------------
818
819 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow *win)
820 {
821 SetEventType(wxEVT_DESTROY);
822 SetEventObject(win);
823 }
824
825 // ----------------------------------------------------------------------------
826 // wxChildFocusEvent
827 // ----------------------------------------------------------------------------
828
829 wxChildFocusEvent::wxChildFocusEvent(wxWindow *win)
830 : wxCommandEvent(wxEVT_CHILD_FOCUS)
831 {
832 SetEventObject(win);
833 }
834
835 // ----------------------------------------------------------------------------
836 // wxHelpEvent
837 // ----------------------------------------------------------------------------
838
839 /* static */
840 wxHelpEvent::Origin wxHelpEvent::GuessOrigin(Origin origin)
841 {
842 if ( origin == Origin_Unknown )
843 {
844 // assume that the event comes from the help button if it's not from
845 // keyboard and that pressing F1 always results in the help event
846 origin = wxGetKeyState(WXK_F1) ? Origin_Keyboard : Origin_HelpButton;
847 }
848
849 return origin;
850 }
851
852 #endif // wxUSE_GUI
853
854
855 #if wxUSE_BASE
856
857 // ----------------------------------------------------------------------------
858 // wxEventHashTable
859 // ----------------------------------------------------------------------------
860
861 static const int EVENT_TYPE_TABLE_INIT_SIZE = 31; // Not too big not too small...
862
863 wxEventHashTable* wxEventHashTable::sm_first = NULL;
864
865 wxEventHashTable::wxEventHashTable(const wxEventTable &table)
866 : m_table(table),
867 m_rebuildHash(true)
868 {
869 AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE);
870
871 m_next = sm_first;
872 if (m_next)
873 m_next->m_previous = this;
874 sm_first = this;
875 }
876
877 wxEventHashTable::~wxEventHashTable()
878 {
879 if (m_next)
880 m_next->m_previous = m_previous;
881 if (m_previous)
882 m_previous->m_next = m_next;
883 if (sm_first == this)
884 sm_first = m_next;
885
886 Clear();
887 }
888
889 void wxEventHashTable::Clear()
890 {
891 for ( size_t i = 0; i < m_size; i++ )
892 {
893 EventTypeTablePointer eTTnode = m_eventTypeTable[i];
894 delete eTTnode;
895 }
896
897 wxDELETEA(m_eventTypeTable);
898
899 m_size = 0;
900 }
901
902 #if wxUSE_MEMORY_TRACING
903
904 // Clear all tables
905 void wxEventHashTable::ClearAll()
906 {
907 wxEventHashTable* table = sm_first;
908 while (table)
909 {
910 table->Clear();
911 table = table->m_next;
912 }
913 }
914
915 #endif // wxUSE_MEMORY_TRACING
916
917 bool wxEventHashTable::HandleEvent(wxEvent &event, wxEvtHandler *self)
918 {
919 if (m_rebuildHash)
920 {
921 InitHashTable();
922 m_rebuildHash = false;
923 }
924
925 if (!m_eventTypeTable)
926 return false;
927
928 // Find all entries for the given event type.
929 wxEventType eventType = event.GetEventType();
930 const EventTypeTablePointer eTTnode = m_eventTypeTable[eventType % m_size];
931 if (eTTnode && eTTnode->eventType == eventType)
932 {
933 // Now start the search for an event handler
934 // that can handle an event with the given ID.
935 const wxEventTableEntryPointerArray&
936 eventEntryTable = eTTnode->eventEntryTable;
937
938 const size_t count = eventEntryTable.GetCount();
939 for (size_t n = 0; n < count; n++)
940 {
941 const wxEventTableEntry& entry = *eventEntryTable[n];
942 if ( wxEvtHandler::ProcessEventIfMatchesId(entry, self, event) )
943 return true;
944 }
945 }
946
947 return false;
948 }
949
950 void wxEventHashTable::InitHashTable()
951 {
952 // Loop over the event tables and all its base tables.
953 const wxEventTable *table = &m_table;
954 while (table)
955 {
956 // Retrieve all valid event handler entries
957 const wxEventTableEntry *entry = table->entries;
958 while (entry->m_fn != 0)
959 {
960 // Add the event entry in the Hash.
961 AddEntry(*entry);
962
963 entry++;
964 }
965
966 table = table->baseTable;
967 }
968
969 // Let's free some memory.
970 size_t i;
971 for(i = 0; i < m_size; i++)
972 {
973 EventTypeTablePointer eTTnode = m_eventTypeTable[i];
974 if (eTTnode)
975 {
976 eTTnode->eventEntryTable.Shrink();
977 }
978 }
979 }
980
981 void wxEventHashTable::AddEntry(const wxEventTableEntry &entry)
982 {
983 // This might happen 'accidentally' as the app is exiting
984 if (!m_eventTypeTable)
985 return;
986
987 EventTypeTablePointer *peTTnode = &m_eventTypeTable[entry.m_eventType % m_size];
988 EventTypeTablePointer eTTnode = *peTTnode;
989
990 if (eTTnode)
991 {
992 if (eTTnode->eventType != entry.m_eventType)
993 {
994 // Resize the table!
995 GrowEventTypeTable();
996 // Try again to add it.
997 AddEntry(entry);
998 return;
999 }
1000 }
1001 else
1002 {
1003 eTTnode = new EventTypeTable;
1004 eTTnode->eventType = entry.m_eventType;
1005 *peTTnode = eTTnode;
1006 }
1007
1008 // Fill all hash entries between entry.m_id and entry.m_lastId...
1009 eTTnode->eventEntryTable.Add(&entry);
1010 }
1011
1012 void wxEventHashTable::AllocEventTypeTable(size_t size)
1013 {
1014 m_eventTypeTable = new EventTypeTablePointer[size];
1015 memset((void *)m_eventTypeTable, 0, sizeof(EventTypeTablePointer)*size);
1016 m_size = size;
1017 }
1018
1019 void wxEventHashTable::GrowEventTypeTable()
1020 {
1021 size_t oldSize = m_size;
1022 EventTypeTablePointer *oldEventTypeTable = m_eventTypeTable;
1023
1024 // TODO: Search the most optimal grow sequence
1025 AllocEventTypeTable(/* GetNextPrime(oldSize) */oldSize*2+1);
1026
1027 for ( size_t i = 0; i < oldSize; /* */ )
1028 {
1029 EventTypeTablePointer eTToldNode = oldEventTypeTable[i];
1030 if (eTToldNode)
1031 {
1032 EventTypeTablePointer *peTTnode = &m_eventTypeTable[eTToldNode->eventType % m_size];
1033 EventTypeTablePointer eTTnode = *peTTnode;
1034
1035 // Check for collision, we don't want any.
1036 if (eTTnode)
1037 {
1038 GrowEventTypeTable();
1039 continue; // Don't increment the counter,
1040 // as we still need to add this element.
1041 }
1042 else
1043 {
1044 // Get the old value and put it in the new table.
1045 *peTTnode = oldEventTypeTable[i];
1046 }
1047 }
1048
1049 i++;
1050 }
1051
1052 delete[] oldEventTypeTable;
1053 }
1054
1055 // ----------------------------------------------------------------------------
1056 // wxEvtHandler
1057 // ----------------------------------------------------------------------------
1058
1059 wxEvtHandler::wxEvtHandler()
1060 {
1061 m_nextHandler = NULL;
1062 m_previousHandler = NULL;
1063 m_enabled = true;
1064 m_dynamicEvents = NULL;
1065 m_pendingEvents = NULL;
1066
1067 // no client data (yet)
1068 m_clientData = NULL;
1069 m_clientDataType = wxClientData_None;
1070 }
1071
1072 wxEvtHandler::~wxEvtHandler()
1073 {
1074 Unlink();
1075
1076 if (m_dynamicEvents)
1077 {
1078 for ( wxList::iterator it = m_dynamicEvents->begin(),
1079 end = m_dynamicEvents->end();
1080 it != end;
1081 ++it )
1082 {
1083 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)*it;
1084
1085 // Remove ourselves from sink destructor notifications
1086 // (this has usually been done, in wxTrackable destructor)
1087 wxEvtHandler *eventSink = entry->m_fn->GetEvtHandler();
1088 if ( eventSink )
1089 {
1090 wxEventConnectionRef * const
1091 evtConnRef = FindRefInTrackerList(eventSink);
1092 if ( evtConnRef )
1093 {
1094 eventSink->RemoveNode(evtConnRef);
1095 delete evtConnRef;
1096 }
1097 }
1098
1099 delete entry->m_callbackUserData;
1100 delete entry;
1101 }
1102 delete m_dynamicEvents;
1103 }
1104
1105 // Remove us from the list of the pending events if necessary.
1106 if (wxTheApp)
1107 wxTheApp->RemovePendingEventHandler(this);
1108
1109 DeletePendingEvents();
1110
1111 // we only delete object data, not untyped
1112 if ( m_clientDataType == wxClientData_Object )
1113 delete m_clientObject;
1114 }
1115
1116 void wxEvtHandler::Unlink()
1117 {
1118 // this event handler must take itself out of the chain of handlers:
1119
1120 if (m_previousHandler)
1121 m_previousHandler->SetNextHandler(m_nextHandler);
1122
1123 if (m_nextHandler)
1124 m_nextHandler->SetPreviousHandler(m_previousHandler);
1125
1126 m_nextHandler = NULL;
1127 m_previousHandler = NULL;
1128 }
1129
1130 bool wxEvtHandler::IsUnlinked() const
1131 {
1132 return m_previousHandler == NULL &&
1133 m_nextHandler == NULL;
1134 }
1135
1136 wxEventFilter* wxEvtHandler::ms_filterList = NULL;
1137
1138 /* static */ void wxEvtHandler::AddFilter(wxEventFilter* filter)
1139 {
1140 wxCHECK_RET( filter, "NULL filter" );
1141
1142 filter->m_next = ms_filterList;
1143 ms_filterList = filter;
1144 }
1145
1146 /* static */ void wxEvtHandler::RemoveFilter(wxEventFilter* filter)
1147 {
1148 wxEventFilter* prev = NULL;
1149 for ( wxEventFilter* f = ms_filterList; f; f = f->m_next )
1150 {
1151 if ( f == filter )
1152 {
1153 // Set the previous list element or the list head to the next
1154 // element.
1155 if ( prev )
1156 prev->m_next = f->m_next;
1157 else
1158 ms_filterList = f->m_next;
1159
1160 // Also reset the next pointer in the filter itself just to avoid
1161 // having possibly dangling pointers, even though it's not strictly
1162 // necessary.
1163 f->m_next = NULL;
1164
1165 // Skip the assert below.
1166 return;
1167 }
1168 }
1169
1170 wxFAIL_MSG( "Filter not found" );
1171 }
1172
1173 #if wxUSE_THREADS
1174
1175 bool wxEvtHandler::ProcessThreadEvent(const wxEvent& event)
1176 {
1177 // check that we are really in a child thread
1178 wxASSERT_MSG( !wxThread::IsMain(),
1179 wxT("use ProcessEvent() in main thread") );
1180
1181 AddPendingEvent(event);
1182
1183 return true;
1184 }
1185
1186 #endif // wxUSE_THREADS
1187
1188 void wxEvtHandler::QueueEvent(wxEvent *event)
1189 {
1190 wxCHECK_RET( event, "NULL event can't be posted" );
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 queue this event!");
1197
1198 // anyway delete the given event to avoid memory leaks
1199 delete event;
1200
1201 return;
1202 }
1203
1204 // 1) Add this event to our list of pending events
1205 wxENTER_CRIT_SECT( m_pendingEventsLock );
1206
1207 if ( !m_pendingEvents )
1208 m_pendingEvents = new wxList;
1209
1210 m_pendingEvents->Append(event);
1211
1212 // 2) Add this event handler to list of event handlers that
1213 // have pending events.
1214
1215 wxTheApp->AppendPendingEventHandler(this);
1216
1217 // only release m_pendingEventsLock now because otherwise there is a race
1218 // condition as described in the ticket #9093: we could process the event
1219 // just added to m_pendingEvents in our ProcessPendingEvents() below before
1220 // we had time to append this pointer to wxHandlersWithPendingEvents list; thus
1221 // breaking the invariant that a handler should be in the list iff it has
1222 // any pending events to process
1223 wxLEAVE_CRIT_SECT( m_pendingEventsLock );
1224
1225 // 3) Inform the system that new pending events are somewhere,
1226 // and that these should be processed in idle time.
1227 wxWakeUpIdle();
1228 }
1229
1230 void wxEvtHandler::DeletePendingEvents()
1231 {
1232 if (m_pendingEvents)
1233 m_pendingEvents->DeleteContents(true);
1234 wxDELETE(m_pendingEvents);
1235 }
1236
1237 void wxEvtHandler::ProcessPendingEvents()
1238 {
1239 if (!wxTheApp)
1240 {
1241 // we need an event loop which manages the list of event handlers with
1242 // pending events... cannot proceed without it!
1243 wxLogDebug("No application object! Cannot process pending events!");
1244 return;
1245 }
1246
1247 // we need to process only a single pending event in this call because
1248 // each call to ProcessEvent() could result in the destruction of this
1249 // same event handler (see the comment at the end of this function)
1250
1251 wxENTER_CRIT_SECT( m_pendingEventsLock );
1252
1253 // this method is only called by wxApp if this handler does have
1254 // pending events
1255 wxCHECK_RET( m_pendingEvents && !m_pendingEvents->IsEmpty(),
1256 "should have pending events if called" );
1257
1258 wxList::compatibility_iterator node = m_pendingEvents->GetFirst();
1259 wxEvent* pEvent = static_cast<wxEvent *>(node->GetData());
1260
1261 // find the first event which can be processed now:
1262 wxEventLoopBase* evtLoop = wxEventLoopBase::GetActive();
1263 if (evtLoop && evtLoop->IsYielding())
1264 {
1265 while (node && pEvent && !evtLoop->IsEventAllowedInsideYield(pEvent->GetEventCategory()))
1266 {
1267 node = node->GetNext();
1268 pEvent = node ? static_cast<wxEvent *>(node->GetData()) : NULL;
1269 }
1270
1271 if (!node)
1272 {
1273 // all our events are NOT processable now... signal this:
1274 wxTheApp->DelayPendingEventHandler(this);
1275
1276 // see the comment at the beginning of evtloop.h header for the
1277 // logic behind YieldFor() and behind DelayPendingEventHandler()
1278
1279 wxLEAVE_CRIT_SECT( m_pendingEventsLock );
1280
1281 return;
1282 }
1283 }
1284
1285 wxEventPtr event(pEvent);
1286
1287 // it's important we remove event from list before processing it, else a
1288 // nested event loop, for example from a modal dialog, might process the
1289 // same event again.
1290 m_pendingEvents->Erase(node);
1291
1292 if ( m_pendingEvents->IsEmpty() )
1293 {
1294 // if there are no more pending events left, we don't need to
1295 // stay in this list
1296 wxTheApp->RemovePendingEventHandler(this);
1297 }
1298
1299 wxLEAVE_CRIT_SECT( m_pendingEventsLock );
1300
1301 ProcessEvent(*event);
1302
1303 // careful: this object could have been deleted by the event handler
1304 // executed by the above ProcessEvent() call, so we can't access any fields
1305 // of this object any more
1306 }
1307
1308 /* static */
1309 bool wxEvtHandler::ProcessEventIfMatchesId(const wxEventTableEntryBase& entry,
1310 wxEvtHandler *handler,
1311 wxEvent& event)
1312 {
1313 int tableId1 = entry.m_id,
1314 tableId2 = entry.m_lastId;
1315
1316 // match only if the event type is the same and the id is either -1 in
1317 // the event table (meaning "any") or the event id matches the id
1318 // specified in the event table either exactly or by falling into
1319 // range between first and last
1320 if ((tableId1 == wxID_ANY) ||
1321 (tableId2 == wxID_ANY && tableId1 == event.GetId()) ||
1322 (tableId2 != wxID_ANY &&
1323 (event.GetId() >= tableId1 && event.GetId() <= tableId2)))
1324 {
1325 event.Skip(false);
1326 event.m_callbackUserData = entry.m_callbackUserData;
1327
1328 #if wxUSE_EXCEPTIONS
1329 if ( wxTheApp )
1330 {
1331 // call the handler via wxApp method which allows the user to catch
1332 // any exceptions which may be thrown by any handler in the program
1333 // in one place
1334 wxTheApp->CallEventHandler(handler, *entry.m_fn, event);
1335 }
1336 else
1337 #endif // wxUSE_EXCEPTIONS
1338 {
1339 (*entry.m_fn)(handler, event);
1340 }
1341
1342 if (!event.GetSkipped())
1343 return true;
1344 }
1345
1346 return false;
1347 }
1348
1349 bool wxEvtHandler::DoTryApp(wxEvent& event)
1350 {
1351 if ( wxTheApp && (this != wxTheApp) )
1352 {
1353 // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
1354 // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
1355 // processed appropriately via SearchEventTable.
1356 if ( event.GetEventType() != wxEVT_IDLE )
1357 {
1358 if ( wxTheApp->ProcessEvent(event) )
1359 return true;
1360 }
1361 }
1362
1363 return false;
1364 }
1365
1366 bool wxEvtHandler::TryBefore(wxEvent& event)
1367 {
1368 #if WXWIN_COMPATIBILITY_2_8
1369 // call the old virtual function to keep the code overriding it working
1370 return TryValidator(event);
1371 #else
1372 wxUnusedVar(event);
1373 return false;
1374 #endif
1375 }
1376
1377 bool wxEvtHandler::TryAfter(wxEvent& event)
1378 {
1379 // We only want to pass the window to the application object once even if
1380 // there are several chained handlers. Ensure that this is what happens by
1381 // only calling DoTryApp() if there is no next handler (which would do it).
1382 //
1383 // Notice that, unlike simply calling TryAfter() on the last handler in the
1384 // chain only from ProcessEvent(), this also works with wxWindow object in
1385 // the middle of the chain: its overridden TryAfter() will still be called
1386 // and propagate the event upwards the window hierarchy even if it's not
1387 // the last one in the chain (which, admittedly, shouldn't happen often).
1388 if ( GetNextHandler() )
1389 return GetNextHandler()->TryAfter(event);
1390
1391 #if WXWIN_COMPATIBILITY_2_8
1392 // as above, call the old virtual function for compatibility
1393 return TryParent(event);
1394 #else
1395 return DoTryApp(event);
1396 #endif
1397 }
1398
1399 bool wxEvtHandler::ProcessEvent(wxEvent& event)
1400 {
1401 // The very first thing we do is to allow any registered filters to hook
1402 // into event processing in order to globally pre-process all events.
1403 //
1404 // Note that we should only do it if we're the first event handler called
1405 // to avoid calling FilterEvent() multiple times as the event goes through
1406 // the event handler chain and possibly upwards the window hierarchy.
1407 if ( !event.WasProcessed() )
1408 {
1409 for ( wxEventFilter* f = ms_filterList; f; f = f->m_next )
1410 {
1411 int rc = f->FilterEvent(event);
1412 if ( rc != wxEventFilter::Event_Skip )
1413 {
1414 wxASSERT_MSG( rc == wxEventFilter::Event_Ignore ||
1415 rc == wxEventFilter::Event_Processed,
1416 "unexpected FilterEvent() return value" );
1417
1418 return rc != wxEventFilter::Event_Ignore;
1419 }
1420 //else: proceed normally
1421 }
1422 }
1423
1424 // Short circuit the event processing logic if we're requested to process
1425 // this event in this handler only, see DoTryChain() for more details.
1426 if ( event.ShouldProcessOnlyIn(this) )
1427 return TryBeforeAndHere(event);
1428
1429
1430 // Try to process the event in this handler itself.
1431 if ( ProcessEventLocally(event) )
1432 {
1433 // It is possible that DoTryChain() called from ProcessEventLocally()
1434 // returned true but the event was not really processed: this happens
1435 // if a custom handler ignores the request to process the event in this
1436 // handler only and in this case we should skip the post processing
1437 // done in TryAfter() but still return the correct value ourselves to
1438 // indicate whether we did or did not find a handler for this event.
1439 return !event.GetSkipped();
1440 }
1441
1442 // If we still didn't find a handler, propagate the event upwards the
1443 // window chain and/or to the application object.
1444 if ( TryAfter(event) )
1445 return true;
1446
1447
1448 // No handler found anywhere, bail out.
1449 return false;
1450 }
1451
1452 bool wxEvtHandler::ProcessEventLocally(wxEvent& event)
1453 {
1454 // Try the hooks which should be called before our own handlers and this
1455 // handler itself first. Notice that we should not call ProcessEvent() on
1456 // this one as we're already called from it, which explains why we do it
1457 // here and not in DoTryChain()
1458 return TryBeforeAndHere(event) || DoTryChain(event);
1459 }
1460
1461 bool wxEvtHandler::DoTryChain(wxEvent& event)
1462 {
1463 for ( wxEvtHandler *h = GetNextHandler(); h; h = h->GetNextHandler() )
1464 {
1465 // We need to process this event at the level of this handler only
1466 // right now, the pre-/post-processing was either already done by
1467 // ProcessEvent() from which we were called or will be done by it when
1468 // we return.
1469 //
1470 // However we must call ProcessEvent() and not TryHereOnly() because the
1471 // existing code (including some in wxWidgets itself) expects the
1472 // overridden ProcessEvent() in its custom event handlers pushed on a
1473 // window to be called.
1474 //
1475 // So we must call ProcessEvent() but it must not do what it usually
1476 // does. To resolve this paradox we set up a special flag inside the
1477 // object itself to let ProcessEvent() know that it shouldn't do any
1478 // pre/post-processing for this event if it gets it. Note that this
1479 // only applies to this handler, if the event is passed to another one
1480 // by explicitly calling its ProcessEvent(), pre/post-processing should
1481 // be done as usual.
1482 //
1483 // Final complication is that if the implementation of ProcessEvent()
1484 // called wxEvent::DidntHonourProcessOnlyIn() (as the gross hack that
1485 // is wxScrollHelperEvtHandler::ProcessEvent() does) and ignored our
1486 // request to process event in this handler only, we have to compensate
1487 // for it by not processing the event further because this was already
1488 // done by that rogue event handler.
1489 wxEventProcessInHandlerOnly processInHandlerOnly(event, h);
1490 if ( h->ProcessEvent(event) )
1491 {
1492 // Make sure "skipped" flag is not set as the event was really
1493 // processed in this case. Normally it shouldn't be set anyhow but
1494 // make sure just in case the user code does something strange.
1495 event.Skip(false);
1496
1497 return true;
1498 }
1499
1500 if ( !event.ShouldProcessOnlyIn(h) )
1501 {
1502 // Still return true to indicate that no further processing should
1503 // be undertaken but ensure that "skipped" flag is set so that the
1504 // caller knows that the event was not really processed.
1505 event.Skip();
1506
1507 return true;
1508 }
1509 }
1510
1511 return false;
1512 }
1513
1514 bool wxEvtHandler::TryHereOnly(wxEvent& event)
1515 {
1516 // If the event handler is disabled it doesn't process any events
1517 if ( !GetEvtHandlerEnabled() )
1518 return false;
1519
1520 // Handle per-instance dynamic event tables first
1521 if ( m_dynamicEvents && SearchDynamicEventTable(event) )
1522 return true;
1523
1524 // Then static per-class event tables
1525 if ( GetEventHashTable().HandleEvent(event, this) )
1526 return true;
1527
1528 // We don't have a handler for this event.
1529 return false;
1530 }
1531
1532 bool wxEvtHandler::SafelyProcessEvent(wxEvent& event)
1533 {
1534 #if wxUSE_EXCEPTIONS
1535 try
1536 {
1537 #endif
1538 return ProcessEvent(event);
1539 #if wxUSE_EXCEPTIONS
1540 }
1541 catch ( ... )
1542 {
1543 // notice that we do it in 2 steps to avoid warnings about possibly
1544 // uninitialized loop variable from some versions of g++ which are not
1545 // smart enough to figure out that GetActive() doesn't throw and so
1546 // that loop will always be initialized
1547 wxEventLoopBase *loop = NULL;
1548 try
1549 {
1550 loop = wxEventLoopBase::GetActive();
1551
1552 if ( !wxTheApp || !wxTheApp->OnExceptionInMainLoop() )
1553 {
1554 if ( loop )
1555 loop->Exit();
1556 }
1557 //else: continue running current event loop
1558
1559 return false;
1560 }
1561 catch ( ... )
1562 {
1563 // OnExceptionInMainLoop() threw, possibly rethrowing the same
1564 // exception again: very good, but we still need Exit() to
1565 // be called
1566 if ( loop )
1567 loop->Exit();
1568 throw;
1569 }
1570 }
1571 #endif // wxUSE_EXCEPTIONS
1572 }
1573
1574 bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event)
1575 {
1576 const wxEventType eventType = event.GetEventType();
1577 for ( int i = 0; table.entries[i].m_fn != 0; i++ )
1578 {
1579 const wxEventTableEntry& entry = table.entries[i];
1580 if ( eventType == entry.m_eventType )
1581 {
1582 if ( ProcessEventIfMatchesId(entry, this, event) )
1583 return true;
1584 }
1585 }
1586
1587 return false;
1588 }
1589
1590 void wxEvtHandler::DoBind(int id,
1591 int lastId,
1592 wxEventType eventType,
1593 wxEventFunctor *func,
1594 wxObject *userData)
1595 {
1596 wxDynamicEventTableEntry *entry =
1597 new wxDynamicEventTableEntry(eventType, id, lastId, func, userData);
1598
1599 if (!m_dynamicEvents)
1600 m_dynamicEvents = new wxList;
1601
1602 // Insert at the front of the list so most recent additions are found first
1603 m_dynamicEvents->Insert( (wxObject*) entry );
1604
1605 // Make sure we get to know when a sink is destroyed
1606 wxEvtHandler *eventSink = func->GetEvtHandler();
1607 if ( eventSink && eventSink != this )
1608 {
1609 wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink);
1610 if ( evtConnRef )
1611 evtConnRef->IncRef( );
1612 else
1613 new wxEventConnectionRef(this, eventSink);
1614 }
1615 }
1616
1617 bool
1618 wxEvtHandler::DoUnbind(int id,
1619 int lastId,
1620 wxEventType eventType,
1621 const wxEventFunctor& func,
1622 wxObject *userData)
1623 {
1624 if (!m_dynamicEvents)
1625 return false;
1626
1627 // Remove connection from tracker node (wxEventConnectionRef)
1628 wxEvtHandler *eventSink = func.GetEvtHandler();
1629 if ( eventSink && eventSink != this )
1630 {
1631 wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink);
1632 if ( evtConnRef )
1633 evtConnRef->DecRef();
1634 }
1635
1636 wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();
1637 while (node)
1638 {
1639 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1640
1641 if ((entry->m_id == id) &&
1642 ((entry->m_lastId == lastId) || (lastId == wxID_ANY)) &&
1643 ((entry->m_eventType == eventType) || (eventType == wxEVT_NULL)) &&
1644 entry->m_fn->IsMatching(func) &&
1645 ((entry->m_callbackUserData == userData) || !userData))
1646 {
1647 delete entry->m_callbackUserData;
1648 m_dynamicEvents->Erase( node );
1649 delete entry;
1650 return true;
1651 }
1652 node = node->GetNext();
1653 }
1654 return false;
1655 }
1656
1657 bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event )
1658 {
1659 wxCHECK_MSG( m_dynamicEvents, false,
1660 wxT("caller should check that we have dynamic events") );
1661
1662 wxList::compatibility_iterator node = m_dynamicEvents->GetFirst();
1663 while (node)
1664 {
1665 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1666
1667 // get next node before (maybe) calling the event handler as it could
1668 // call Disconnect() invalidating the current node
1669 node = node->GetNext();
1670
1671 if ( event.GetEventType() == entry->m_eventType )
1672 {
1673 wxEvtHandler *handler = entry->m_fn->GetEvtHandler();
1674 if ( !handler )
1675 handler = this;
1676 if ( ProcessEventIfMatchesId(*entry, handler, event) )
1677 return true;
1678 }
1679 }
1680
1681 return false;
1682 }
1683
1684 void wxEvtHandler::DoSetClientObject( wxClientData *data )
1685 {
1686 wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1687 wxT("can't have both object and void client data") );
1688
1689 if ( m_clientObject )
1690 delete m_clientObject;
1691
1692 m_clientObject = data;
1693 m_clientDataType = wxClientData_Object;
1694 }
1695
1696 wxClientData *wxEvtHandler::DoGetClientObject() const
1697 {
1698 // it's not an error to call GetClientObject() on a window which doesn't
1699 // have client data at all - NULL will be returned
1700 wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1701 wxT("this window doesn't have object client data") );
1702
1703 return m_clientObject;
1704 }
1705
1706 void wxEvtHandler::DoSetClientData( void *data )
1707 {
1708 wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1709 wxT("can't have both object and void client data") );
1710
1711 m_clientData = data;
1712 m_clientDataType = wxClientData_Void;
1713 }
1714
1715 void *wxEvtHandler::DoGetClientData() const
1716 {
1717 // it's not an error to call GetClientData() on a window which doesn't have
1718 // client data at all - NULL will be returned
1719 wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1720 wxT("this window doesn't have void client data") );
1721
1722 return m_clientData;
1723 }
1724
1725 // A helper to find an wxEventConnectionRef object
1726 wxEventConnectionRef *
1727 wxEvtHandler::FindRefInTrackerList(wxEvtHandler *eventSink)
1728 {
1729 for ( wxTrackerNode *node = eventSink->GetFirst(); node; node = node->m_nxt )
1730 {
1731 // we only want wxEventConnectionRef nodes here
1732 wxEventConnectionRef *evtConnRef = node->ToEventConnection();
1733 if ( evtConnRef && evtConnRef->m_src == this )
1734 {
1735 wxASSERT( evtConnRef->m_sink==eventSink );
1736 return evtConnRef;
1737 }
1738 }
1739
1740 return NULL;
1741 }
1742
1743 void wxEvtHandler::OnSinkDestroyed( wxEvtHandler *sink )
1744 {
1745 wxASSERT(m_dynamicEvents);
1746
1747 // remove all connections with this sink
1748 wxList::compatibility_iterator node = m_dynamicEvents->GetFirst(), node_nxt;
1749 while (node)
1750 {
1751 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData();
1752 node_nxt = node->GetNext();
1753
1754 if ( entry->m_fn->GetEvtHandler() == sink )
1755 {
1756 delete entry->m_callbackUserData;
1757 m_dynamicEvents->Erase( node );
1758 delete entry;
1759 }
1760 node = node_nxt;
1761 }
1762 }
1763
1764 #endif // wxUSE_BASE
1765
1766 #if wxUSE_GUI
1767
1768 // Find a window with the focus, that is also a descendant of the given window.
1769 // This is used to determine the window to initially send commands to.
1770 wxWindow* wxFindFocusDescendant(wxWindow* ancestor)
1771 {
1772 // Process events starting with the window with the focus, if any.
1773 wxWindow* focusWin = wxWindow::FindFocus();
1774 wxWindow* win = focusWin;
1775
1776 // Check if this is a descendant of this frame.
1777 // If not, win will be set to NULL.
1778 while (win)
1779 {
1780 if (win == ancestor)
1781 break;
1782 else
1783 win = win->GetParent();
1784 }
1785 if (win == NULL)
1786 focusWin = NULL;
1787
1788 return focusWin;
1789 }
1790
1791 // ----------------------------------------------------------------------------
1792 // wxEventBlocker
1793 // ----------------------------------------------------------------------------
1794
1795 wxEventBlocker::wxEventBlocker(wxWindow *win, wxEventType type)
1796 {
1797 wxCHECK_RET(win, wxT("Null window given to wxEventBlocker"));
1798
1799 m_window = win;
1800
1801 Block(type);
1802 m_window->PushEventHandler(this);
1803 }
1804
1805 wxEventBlocker::~wxEventBlocker()
1806 {
1807 wxEvtHandler *popped = m_window->PopEventHandler(false);
1808 wxCHECK_RET(popped == this,
1809 wxT("Don't push other event handlers into a window managed by wxEventBlocker!"));
1810 }
1811
1812 bool wxEventBlocker::ProcessEvent(wxEvent& event)
1813 {
1814 // should this event be blocked?
1815 for ( size_t i = 0; i < m_eventsToBlock.size(); i++ )
1816 {
1817 wxEventType t = (wxEventType)m_eventsToBlock[i];
1818 if ( t == wxEVT_ANY || t == event.GetEventType() )
1819 return true; // yes, it should: mark this event as processed
1820 }
1821
1822 return false;
1823 }
1824
1825 #endif // wxUSE_GUI
1826
wxWidgets (Impactor)