]> git.saurik.com Git - wxWidgets.git/blob - src/common/event.cpp
Added m_scanCode field to wxKeyEvent
[wxWidgets.git] / src / common / event.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: 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 and Markus Holzem
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifdef __GNUG__
13 #pragma implementation "event.h"
14 #endif
15
16 // For compilers that support precompilation, includes "wx.h".
17 #include "wx/wxprec.h"
18
19 #ifdef __BORLANDC__
20 #pragma hdrstop
21 #endif
22
23 #ifndef WX_PRECOMP
24 #include "wx/defs.h"
25 #include "wx/control.h"
26 #include "wx/utils.h"
27 #include "wx/app.h"
28 #include "wx/dc.h"
29 #endif
30
31 #include "wx/event.h"
32 #include "wx/validate.h"
33
34 #if !USE_SHARED_LIBRARY
35 IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler, wxObject)
36 IMPLEMENT_ABSTRACT_CLASS(wxEvent, wxObject)
37 IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent, wxEvent)
38 IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent, wxCommandEvent)
39 IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent, wxCommandEvent)
40 IMPLEMENT_DYNAMIC_CLASS(wxScrollWinEvent, wxEvent)
41 IMPLEMENT_DYNAMIC_CLASS(wxMouseEvent, wxEvent)
42 IMPLEMENT_DYNAMIC_CLASS(wxKeyEvent, wxEvent)
43 IMPLEMENT_DYNAMIC_CLASS(wxSizeEvent, wxEvent)
44 IMPLEMENT_DYNAMIC_CLASS(wxPaintEvent, wxEvent)
45 IMPLEMENT_DYNAMIC_CLASS(wxEraseEvent, wxEvent)
46 IMPLEMENT_DYNAMIC_CLASS(wxMoveEvent, wxEvent)
47 IMPLEMENT_DYNAMIC_CLASS(wxFocusEvent, wxEvent)
48 IMPLEMENT_DYNAMIC_CLASS(wxCloseEvent, wxEvent)
49 IMPLEMENT_DYNAMIC_CLASS(wxShowEvent, wxEvent)
50 IMPLEMENT_DYNAMIC_CLASS(wxMaximizeEvent, wxEvent)
51 IMPLEMENT_DYNAMIC_CLASS(wxIconizeEvent, wxEvent)
52 IMPLEMENT_DYNAMIC_CLASS(wxMenuEvent, wxEvent)
53 IMPLEMENT_DYNAMIC_CLASS(wxJoystickEvent, wxEvent)
54 IMPLEMENT_DYNAMIC_CLASS(wxDropFilesEvent, wxEvent)
55 IMPLEMENT_DYNAMIC_CLASS(wxActivateEvent, wxEvent)
56 IMPLEMENT_DYNAMIC_CLASS(wxInitDialogEvent, wxEvent)
57 IMPLEMENT_DYNAMIC_CLASS(wxSysColourChangedEvent, wxEvent)
58 IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent)
59 IMPLEMENT_DYNAMIC_CLASS(wxUpdateUIEvent, wxCommandEvent)
60 IMPLEMENT_DYNAMIC_CLASS(wxNavigationKeyEvent, wxCommandEvent)
61 IMPLEMENT_DYNAMIC_CLASS(wxPaletteChangedEvent, wxEvent)
62 IMPLEMENT_DYNAMIC_CLASS(wxQueryNewPaletteEvent, wxEvent)
63
64 const wxEventTable *wxEvtHandler::GetEventTable() const
65 { return &wxEvtHandler::sm_eventTable; }
66
67 const wxEventTable wxEvtHandler::sm_eventTable =
68 { (const wxEventTable *)NULL, &wxEvtHandler::sm_eventTableEntries[0] };
69
70 const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] =
71 { { 0, 0, 0, (wxObjectEventFunction) NULL, (wxObject*) NULL } };
72
73 #endif // !USE_SHARED_LIBRARY
74
75 #if wxUSE_THREADS
76 /* To put pending event handlers */
77 extern wxList *wxPendingEvents;
78 extern wxCriticalSection *wxPendingEventsLocker;
79 #endif
80
81 /*
82 * General wxWindows events, covering
83 * all interesting things that might happen (button clicking, resizing,
84 * setting text in widgets, etc.).
85 *
86 * For each completely new event type, derive a new event class.
87 *
88 */
89
90 wxEvent::wxEvent(int theId)
91 {
92 m_eventType = wxEVT_NULL;
93 m_eventObject = (wxObject *) NULL;
94 m_eventHandle = (char *) NULL;
95 m_timeStamp = 0;
96 m_id = theId;
97 m_skipped = FALSE;
98 m_callbackUserData = (wxObject *) NULL;
99 m_isCommandEvent = FALSE;
100 }
101
102 void wxEvent::CopyObject(wxObject& object_dest) const
103 {
104 wxEvent *obj = (wxEvent *)&object_dest;
105 wxObject::CopyObject(object_dest);
106
107 obj->m_eventType = m_eventType;
108 obj->m_eventObject = m_eventObject;
109 obj->m_eventHandle = m_eventHandle;
110 obj->m_timeStamp = m_timeStamp;
111 obj->m_id = m_id;
112 obj->m_skipped = m_skipped;
113 obj->m_callbackUserData = m_callbackUserData;
114 obj->m_isCommandEvent = m_isCommandEvent;
115 }
116
117 /*
118 * Command events
119 *
120 */
121
122 wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId)
123 {
124 m_eventType = commandType;
125 m_clientData = (char *) NULL;
126 m_clientObject = (wxClientData *) NULL;
127 m_extraLong = 0;
128 m_commandInt = 0;
129 m_id = theId;
130 m_commandString = (wxChar *) NULL;
131 m_isCommandEvent = TRUE;
132 }
133
134 void wxCommandEvent::CopyObject(wxObject& obj_d) const
135 {
136 wxCommandEvent *obj = (wxCommandEvent *)&obj_d;
137
138 wxEvent::CopyObject(obj_d);
139
140 obj->m_clientData = m_clientData;
141 obj->m_clientObject = m_clientObject;
142 obj->m_extraLong = m_extraLong;
143 obj->m_commandInt = m_commandInt;
144 }
145
146 /*
147 * Scroll events
148 */
149
150 wxScrollEvent::wxScrollEvent(wxEventType commandType,
151 int id,
152 int pos,
153 int orient)
154 : wxCommandEvent(commandType, id)
155 {
156 m_extraLong = orient;
157 m_commandInt = pos;
158 }
159
160 /*
161 * ScrollWin events
162 */
163
164 wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType,
165 int pos,
166 int orient)
167 : wxEvent(commandType)
168 {
169 m_extraLong = orient;
170 m_commandInt = pos;
171 }
172
173 /*
174 * Mouse events
175 *
176 */
177
178 wxMouseEvent::wxMouseEvent(wxEventType commandType)
179 {
180 m_eventType = commandType;
181 m_metaDown = FALSE;
182 m_altDown = FALSE;
183 m_controlDown = FALSE;
184 m_shiftDown = FALSE;
185 m_leftDown = FALSE;
186 m_rightDown = FALSE;
187 m_middleDown = FALSE;
188 m_x = 0;
189 m_y = 0;
190 }
191
192 void wxMouseEvent::CopyObject(wxObject& obj_d) const
193 {
194 wxMouseEvent *obj = (wxMouseEvent *)&obj_d;
195
196 wxEvent::CopyObject(obj_d);
197
198 obj->m_metaDown = m_metaDown;
199 obj->m_altDown = m_altDown;
200 obj->m_controlDown = m_controlDown;
201 obj->m_shiftDown = m_shiftDown;
202 obj->m_leftDown = m_leftDown;
203 obj->m_rightDown = m_rightDown;
204 obj->m_middleDown = m_middleDown;
205 obj->m_x = m_x;
206 obj->m_y = m_y;
207 }
208
209 // True if was a button dclick event (1 = left, 2 = middle, 3 = right)
210 // or any button dclick event (but = -1)
211 bool wxMouseEvent::ButtonDClick(int but) const
212 {
213 switch (but)
214 {
215 case -1:
216 return (LeftDClick() || MiddleDClick() || RightDClick());
217 case 1:
218 return LeftDClick();
219 case 2:
220 return MiddleDClick();
221 case 3:
222 return RightDClick();
223 default:
224 wxFAIL_MSG(_T("invalid parameter in wxMouseEvent::ButtonDClick"));
225 }
226
227 return FALSE;
228 }
229
230 // True if was a button down event (1 = left, 2 = middle, 3 = right)
231 // or any button down event (but = -1)
232 bool wxMouseEvent::ButtonDown(int but) const
233 {
234 switch (but)
235 {
236 case -1:
237 return (LeftDown() || MiddleDown() || RightDown());
238 case 1:
239 return LeftDown();
240 case 2:
241 return MiddleDown();
242 case 3:
243 return RightDown();
244 default:
245 wxFAIL_MSG(_T("invalid parameter in wxMouseEvent::ButtonDown"));
246 }
247
248 return FALSE;
249 }
250
251 // True if was a button up event (1 = left, 2 = middle, 3 = right)
252 // or any button up event (but = -1)
253 bool wxMouseEvent::ButtonUp(int but) const
254 {
255 switch (but) {
256 case -1:
257 return (LeftUp() || MiddleUp() || RightUp());
258 case 1:
259 return LeftUp();
260 case 2:
261 return MiddleUp();
262 case 3:
263 return RightUp();
264 default:
265 wxFAIL_MSG(_T("invalid parameter in wxMouseEvent::ButtonUp"));
266 }
267
268 return FALSE;
269 }
270
271 // True if the given button is currently changing state
272 bool wxMouseEvent::Button(int but) const
273 {
274 switch (but) {
275 case -1:
276 return (ButtonUp(-1) || ButtonDown(-1) || ButtonDClick(-1)) ;
277 case 1:
278 return (LeftDown() || LeftUp() || LeftDClick());
279 case 2:
280 return (MiddleDown() || MiddleUp() || MiddleDClick());
281 case 3:
282 return (RightDown() || RightUp() || RightDClick());
283 default:
284 wxFAIL_MSG(_T("invalid parameter in wxMouseEvent::Button"));
285 }
286
287 return FALSE;
288 }
289
290 bool wxMouseEvent::ButtonIsDown(int but) const
291 {
292 switch (but) {
293 case -1:
294 return (LeftIsDown() || MiddleIsDown() || RightIsDown());
295 case 1:
296 return LeftIsDown();
297 case 2:
298 return MiddleIsDown();
299 case 3:
300 return RightIsDown();
301 default:
302 wxFAIL_MSG(_T("invalid parameter in wxMouseEvent::ButtonIsDown"));
303 }
304
305 return FALSE;
306 }
307
308 // Find the logical position of the event given the DC
309 wxPoint wxMouseEvent::GetLogicalPosition(const wxDC& dc) const
310 {
311 wxPoint pt(dc.DeviceToLogicalX(m_x), dc.DeviceToLogicalY(m_y));
312 return pt;
313 }
314
315
316 /*
317 * Keyboard events
318 *
319 */
320
321 wxKeyEvent::wxKeyEvent(wxEventType type)
322 {
323 m_eventType = type;
324 m_shiftDown = FALSE;
325 m_controlDown = FALSE;
326 m_metaDown = FALSE;
327 m_altDown = FALSE;
328 m_keyCode = 0;
329 m_scanCode = 0;
330 }
331
332 void wxKeyEvent::CopyObject(wxObject& obj_d) const
333 {
334 wxKeyEvent *obj = (wxKeyEvent *)&obj_d;
335 wxEvent::CopyObject(obj_d);
336
337 obj->m_shiftDown = m_shiftDown;
338 obj->m_controlDown = m_controlDown;
339 obj->m_metaDown = m_metaDown;
340 obj->m_altDown = m_altDown;
341 obj->m_keyCode = m_keyCode;
342 }
343
344
345 /*
346 * Misc events
347 */
348
349 void wxSizeEvent::CopyObject(wxObject& obj_d) const
350 {
351 wxSizeEvent *obj = (wxSizeEvent *)&obj_d;
352 wxEvent::CopyObject(obj_d);
353
354 obj->m_size = m_size;
355 }
356
357 void wxMoveEvent::CopyObject(wxObject& obj_d) const
358 {
359 wxMoveEvent *obj = (wxMoveEvent *)&obj_d;
360 wxEvent::CopyObject(obj_d);
361
362 obj->m_pos = m_pos;
363 }
364
365 void wxEraseEvent::CopyObject(wxObject& obj_d) const
366 {
367 wxEraseEvent *obj = (wxEraseEvent *)&obj_d;
368 wxEvent::CopyObject(obj_d);
369
370 obj->m_dc = m_dc;
371 }
372
373 void wxActivateEvent::CopyObject(wxObject& obj_d) const
374 {
375 wxActivateEvent *obj = (wxActivateEvent *)&obj_d;
376 wxEvent::CopyObject(obj_d);
377
378 obj->m_active = m_active;
379 }
380
381 void wxMenuEvent::CopyObject(wxObject& obj_d) const
382 {
383 wxMenuEvent *obj = (wxMenuEvent *)&obj_d;
384 wxEvent::CopyObject(obj_d);
385
386 obj->m_menuId = m_menuId;
387 }
388
389 void wxCloseEvent::CopyObject(wxObject& obj_d) const
390 {
391 wxCloseEvent *obj = (wxCloseEvent *)&obj_d;
392 wxEvent::CopyObject(obj_d);
393
394 obj->m_loggingOff = m_loggingOff;
395 obj->m_veto = m_veto;
396 #if WXWIN_COMPATIBILITY
397 obj->m_force = m_force;
398 #endif
399 obj->m_canVeto = m_canVeto;
400 }
401
402 void wxShowEvent::CopyObject(wxObject& obj_d) const
403 {
404 wxShowEvent *obj = (wxShowEvent *)&obj_d;
405 wxEvent::CopyObject(obj_d);
406
407 obj->m_show = m_show;
408 }
409
410
411 /*
412 * Event handler
413 */
414
415 wxEvtHandler::wxEvtHandler()
416 {
417 m_nextHandler = (wxEvtHandler *) NULL;
418 m_previousHandler = (wxEvtHandler *) NULL;
419 m_enabled = TRUE;
420 m_dynamicEvents = (wxList *) NULL;
421 m_isWindow = FALSE;
422 #if wxUSE_THREADS
423 m_eventsLocker = new wxCriticalSection();
424 #endif
425 m_pendingEvents = (wxList *) NULL;
426 }
427
428 wxEvtHandler::~wxEvtHandler()
429 {
430 // Takes itself out of the list of handlers
431 if (m_previousHandler)
432 m_previousHandler->m_nextHandler = m_nextHandler;
433
434 if (m_nextHandler)
435 m_nextHandler->m_previousHandler = m_previousHandler;
436
437 if (m_dynamicEvents)
438 {
439 wxNode *node = m_dynamicEvents->First();
440 while (node)
441 {
442 wxEventTableEntry *entry = (wxEventTableEntry*)node->Data();
443 if (entry->m_callbackUserData) delete entry->m_callbackUserData;
444 delete entry;
445 node = node->Next();
446 }
447 delete m_dynamicEvents;
448 };
449
450 #if wxUSE_THREADS
451 if (m_pendingEvents)
452 delete m_pendingEvents;
453
454 delete m_eventsLocker;
455 #endif
456 }
457
458 #if wxUSE_THREADS
459
460 #ifdef __WXGTK__
461 extern bool g_isIdle;
462
463 extern void wxapp_install_idle_handler();
464 #endif
465
466 bool wxEvtHandler::ProcessThreadEvent(wxEvent& event)
467 {
468 wxEvent *event_main;
469 wxCriticalSectionLocker locker(*m_eventsLocker);
470
471
472 // check that we are really in a child thread
473 wxASSERT( !wxThread::IsMain() );
474
475 if (m_pendingEvents == NULL)
476 m_pendingEvents = new wxList();
477
478 event_main = (wxEvent *)event.Clone();
479
480 m_pendingEvents->Append(event_main);
481
482 wxPendingEventsLocker->Enter();
483 wxPendingEvents->Append(this);
484 wxPendingEventsLocker->Leave();
485
486 #ifdef __WXGTK__
487 if (g_isIdle) wxapp_install_idle_handler();
488 #endif
489
490 return TRUE;
491 }
492
493 void wxEvtHandler::ProcessPendingEvents()
494 {
495 wxCriticalSectionLocker locker(*m_eventsLocker);
496 wxNode *node = m_pendingEvents->First();
497 wxEvent *event;
498
499 while (node != NULL) {
500 event = (wxEvent *)node->Data();
501 ProcessEvent(*event);
502 delete node;
503 node = m_pendingEvents->First();
504 }
505 }
506 #endif
507
508 /*
509 * Event table stuff
510 */
511
512 bool wxEvtHandler::ProcessEvent(wxEvent& event)
513 {
514 // check that our flag corresponds to reality
515 wxASSERT( m_isWindow == IsKindOf(CLASSINFO(wxWindow)) );
516
517 // An event handler can be enabled or disabled
518 if ( GetEvtHandlerEnabled() )
519 {
520 #if wxUSE_THREADS
521 // Check whether we are in a child thread.
522 if (!wxThread::IsMain())
523 return ProcessThreadEvent(event);
524 #endif
525 // Handle per-instance dynamic event tables first
526
527 if ( m_dynamicEvents && SearchDynamicEventTable(event) )
528 return TRUE;
529
530 // Then static per-class event tables
531
532 const wxEventTable *table = GetEventTable();
533
534 // Try the associated validator first, if this is a window.
535 // Problem: if the event handler of the window has been replaced,
536 // this wxEvtHandler may no longer be a window.
537 // Therefore validators won't be processed if the handler
538 // has been replaced with SetEventHandler.
539 // THIS CAN BE CURED if PushEventHandler is used instead of
540 // SetEventHandler, and then processing will be passed down the
541 // chain of event handlers.
542 if ( m_isWindow )
543 {
544 wxWindow *win = (wxWindow *)this;
545
546 // Can only use the validator of the window which
547 // is receiving the event
548 if ( win == event.GetEventObject() )
549 {
550 wxValidator *validator = win->GetValidator();
551 if ( validator && validator->ProcessEvent(event) )
552 {
553 return TRUE;
554 }
555 }
556 }
557
558 // Search upwards through the inheritance hierarchy
559 while ( table )
560 {
561 if ( SearchEventTable((wxEventTable&)*table, event) )
562 return TRUE;
563 table = table->baseTable;
564 }
565 }
566
567 // Try going down the event handler chain
568 if ( GetNextHandler() )
569 {
570 if ( GetNextHandler()->ProcessEvent(event) )
571 return TRUE;
572 }
573
574 // Carry on up the parent-child hierarchy,
575 // but only if event is a command event: it wouldn't
576 // make sense for a parent to receive a child's size event, for example
577 if ( m_isWindow && event.IsCommandEvent() )
578 {
579 wxWindow *win = (wxWindow *)this;
580 wxWindow *parent = win->GetParent();
581 if (parent && !parent->IsBeingDeleted())
582 return parent->GetEventHandler()->ProcessEvent(event);
583 }
584
585 // Last try - application object.
586 if ( wxTheApp && (this != wxTheApp) )
587 {
588 // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
589 // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
590 // processed appropriately via SearchEventTable.
591 if ( event.GetEventType() != wxEVT_IDLE )
592 {
593 if ( wxTheApp->ProcessEvent(event) )
594 return TRUE;
595 }
596 }
597
598 return FALSE;
599 }
600
601 bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event)
602 {
603 int i = 0;
604 int commandId = event.GetId();
605
606 // BC++ doesn't like while (table.entries[i].m_fn)
607
608 #ifdef __SC__
609 while (table.entries[i].m_fn != 0)
610 #else
611 while (table.entries[i].m_fn != 0L)
612 #endif
613 {
614 if ((event.GetEventType() == table.entries[i].m_eventType) &&
615 (table.entries[i].m_id == -1 || // Match, if event spec says any id will do (id == -1)
616 (table.entries[i].m_lastId == -1 && commandId == table.entries[i].m_id) ||
617 (table.entries[i].m_lastId != -1 &&
618 (commandId >= table.entries[i].m_id && commandId <= table.entries[i].m_lastId))))
619 {
620 event.Skip(FALSE);
621 event.m_callbackUserData = table.entries[i].m_callbackUserData;
622
623 (this->*((wxEventFunction) (table.entries[i].m_fn)))(event);
624
625 if ( event.GetSkipped() )
626 return FALSE;
627 else
628 return TRUE;
629 }
630 i++;
631 }
632 return FALSE;
633 }
634 void wxEvtHandler::Connect( int id, int lastId,
635 wxEventType eventType,
636 wxObjectEventFunction func,
637 wxObject *userData )
638 {
639 wxEventTableEntry *entry = new wxEventTableEntry;
640 entry->m_id = id;
641 entry->m_lastId = lastId;
642 entry->m_eventType = eventType;
643 entry->m_fn = func;
644 entry->m_callbackUserData = userData;
645
646 if (!m_dynamicEvents)
647 m_dynamicEvents = new wxList;
648
649 m_dynamicEvents->Append( (wxObject*) entry );
650 }
651
652 bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event )
653 {
654 wxCHECK_MSG( m_dynamicEvents, FALSE,
655 _T("caller should check that we have dynamic events") );
656
657 int commandId = event.GetId();
658
659 wxNode *node = m_dynamicEvents->First();
660 while (node)
661 {
662 wxEventTableEntry *entry = (wxEventTableEntry*)node->Data();
663
664 if (entry->m_fn)
665 {
666 // Match, if event spec says any id will do (id == -1)
667 if ( (event.GetEventType() == entry->m_eventType) &&
668 (entry->m_id == -1 ||
669 (entry->m_lastId == -1 && commandId == entry->m_id) ||
670 (entry->m_lastId != -1 &&
671 (commandId >= entry->m_id && commandId <= entry->m_lastId))) )
672 {
673 event.Skip(FALSE);
674 event.m_callbackUserData = entry->m_callbackUserData;
675
676 (this->*((wxEventFunction) (entry->m_fn)))(event);
677
678 if (event.GetSkipped())
679 return FALSE;
680 else
681 return TRUE;
682 }
683 }
684 node = node->Next();
685 }
686 return FALSE;
687 };
688
689 #if WXWIN_COMPATIBILITY
690 bool wxEvtHandler::OnClose()
691 {
692 if (GetNextHandler())
693 return GetNextHandler()->OnClose();
694 else
695 return FALSE;
696 }
697 #endif // WXWIN_COMPATIBILITY
698
699 // Find a window with the focus, that is also a descendant of the given window.
700 // This is used to determine the window to initially send commands to.
701 wxWindow* wxFindFocusDescendant(wxWindow* ancestor)
702 {
703 // Process events starting with the window with the focus, if any.
704 wxWindow* focusWin = wxWindow::FindFocus();
705 wxWindow* win = focusWin;
706
707 // Check if this is a descendant of this frame.
708 // If not, win will be set to NULL.
709 while (win)
710 {
711 if (win == ancestor)
712 break;
713 else
714 win = win->GetParent();
715 }
716 if (win == (wxWindow*) NULL)
717 focusWin = (wxWindow*) NULL;
718
719 return focusWin;
720 }
721