]> git.saurik.com Git - wxWidgets.git/blame_incremental - src/common/event.cpp
projects / wxWidgets.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
key handling
[wxWidgets.git] / src / common / event.cpp
... / ...
CommitLineData
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// ============================================================================
13// declarations
14// ============================================================================
15
16// ----------------------------------------------------------------------------
17// headers
18// ----------------------------------------------------------------------------
19
20#ifdef __GNUG__
21 #pragma implementation "event.h"
22#endif
23
24// For compilers that support precompilation, includes "wx.h".
25#include "wx/wxprec.h"
26
27#ifdef __BORLANDC__
28 #pragma hdrstop
29#endif
30
31#ifndef WX_PRECOMP
32 #include "wx/defs.h"
33 #include "wx/app.h"
34 #include "wx/list.h"
35
36 #if wxUSE_GUI
37 #include "wx/control.h"
38 #include "wx/utils.h"
39 #include "wx/dc.h"
40 #endif // wxUSE_GUI
41#endif
42
43#include "wx/event.h"
44
45#if wxUSE_GUI
46 #include "wx/validate.h"
47#endif // wxUSE_GUI
48
49// ----------------------------------------------------------------------------
50// wxWin macros
51// ----------------------------------------------------------------------------
52
53IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler, wxObject)
54IMPLEMENT_ABSTRACT_CLASS(wxEvent, wxObject)
55
56#if wxUSE_GUI
57 IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent)
58 IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent, wxEvent)
59 IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent, wxCommandEvent)
60 IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent, wxCommandEvent)
61 IMPLEMENT_DYNAMIC_CLASS(wxScrollWinEvent, wxEvent)
62 IMPLEMENT_DYNAMIC_CLASS(wxMouseEvent, wxEvent)
63 IMPLEMENT_DYNAMIC_CLASS(wxKeyEvent, wxEvent)
64 IMPLEMENT_DYNAMIC_CLASS(wxSizeEvent, wxEvent)
65 IMPLEMENT_DYNAMIC_CLASS(wxPaintEvent, wxEvent)
66 IMPLEMENT_DYNAMIC_CLASS(wxNcPaintEvent, wxEvent)
67 IMPLEMENT_DYNAMIC_CLASS(wxEraseEvent, wxEvent)
68 IMPLEMENT_DYNAMIC_CLASS(wxMoveEvent, wxEvent)
69 IMPLEMENT_DYNAMIC_CLASS(wxFocusEvent, wxEvent)
70 IMPLEMENT_DYNAMIC_CLASS(wxChildFocusEvent, wxCommandEvent)
71 IMPLEMENT_DYNAMIC_CLASS(wxCloseEvent, wxEvent)
72 IMPLEMENT_DYNAMIC_CLASS(wxShowEvent, wxEvent)
73 IMPLEMENT_DYNAMIC_CLASS(wxMaximizeEvent, wxEvent)
74 IMPLEMENT_DYNAMIC_CLASS(wxIconizeEvent, wxEvent)
75 IMPLEMENT_DYNAMIC_CLASS(wxMenuEvent, wxEvent)
76 IMPLEMENT_DYNAMIC_CLASS(wxJoystickEvent, wxEvent)
77 IMPLEMENT_DYNAMIC_CLASS(wxDropFilesEvent, wxEvent)
78 IMPLEMENT_DYNAMIC_CLASS(wxActivateEvent, wxEvent)
79 IMPLEMENT_DYNAMIC_CLASS(wxInitDialogEvent, wxEvent)
80 IMPLEMENT_DYNAMIC_CLASS(wxSetCursorEvent, wxEvent)
81 IMPLEMENT_DYNAMIC_CLASS(wxSysColourChangedEvent, wxEvent)
82 IMPLEMENT_DYNAMIC_CLASS(wxDisplayChangedEvent, wxEvent)
83 IMPLEMENT_DYNAMIC_CLASS(wxUpdateUIEvent, wxCommandEvent)
84 IMPLEMENT_DYNAMIC_CLASS(wxNavigationKeyEvent, wxCommandEvent)
85 IMPLEMENT_DYNAMIC_CLASS(wxPaletteChangedEvent, wxEvent)
86 IMPLEMENT_DYNAMIC_CLASS(wxQueryNewPaletteEvent, wxEvent)
87 IMPLEMENT_DYNAMIC_CLASS(wxWindowCreateEvent, wxEvent)
88 IMPLEMENT_DYNAMIC_CLASS(wxWindowDestroyEvent, wxEvent)
89 IMPLEMENT_DYNAMIC_CLASS(wxHelpEvent, wxCommandEvent)
90 IMPLEMENT_DYNAMIC_CLASS(wxContextMenuEvent, wxCommandEvent)
91 IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureChangedEvent, wxEvent)
92#endif // wxUSE_GUI
93
94const wxEventTable *wxEvtHandler::GetEventTable() const
95 { return &wxEvtHandler::sm_eventTable; }
96
97const wxEventTable wxEvtHandler::sm_eventTable =
98 { (const wxEventTable *)NULL, &wxEvtHandler::sm_eventTableEntries[0] };
99
100const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] =
101 { DECLARE_EVENT_TABLE_ENTRY(wxEVT_NULL, 0, 0, (wxObjectEventFunction)NULL, NULL) };
102
103// ----------------------------------------------------------------------------
104// global variables
105// ----------------------------------------------------------------------------
106
107// To put pending event handlers
108wxList *wxPendingEvents = (wxList *)NULL;
109
110#if wxUSE_THREADS
111 // protects wxPendingEvents list
112 wxCriticalSection *wxPendingEventsLocker = (wxCriticalSection *)NULL;
113#endif
114
115#if !WXWIN_COMPATIBILITY_EVENT_TYPES
116
117// common event types are defined here, other event types are defined by the
118// components which use them
119
120DEFINE_EVENT_TYPE(wxEVT_NULL)
121DEFINE_EVENT_TYPE(wxEVT_COMMAND_BUTTON_CLICKED)
122DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKBOX_CLICKED)
123DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHOICE_SELECTED)
124DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_SELECTED)
125DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED)
126DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED)
127DEFINE_EVENT_TYPE(wxEVT_COMMAND_MENU_SELECTED)
128DEFINE_EVENT_TYPE(wxEVT_COMMAND_SLIDER_UPDATED)
129DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBOX_SELECTED)
130DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBUTTON_SELECTED)
131DEFINE_EVENT_TYPE(wxEVT_COMMAND_SCROLLBAR_UPDATED)
132DEFINE_EVENT_TYPE(wxEVT_COMMAND_VLBOX_SELECTED)
133DEFINE_EVENT_TYPE(wxEVT_COMMAND_COMBOBOX_SELECTED)
134DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED)
135DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER)
136DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED)
137
138// Sockets and timers send events, too
139DEFINE_EVENT_TYPE(wxEVT_SOCKET)
140DEFINE_EVENT_TYPE(wxEVT_TIMER)
141
142// Mouse event types
143DEFINE_EVENT_TYPE(wxEVT_LEFT_DOWN)
144DEFINE_EVENT_TYPE(wxEVT_LEFT_UP)
145DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DOWN)
146DEFINE_EVENT_TYPE(wxEVT_MIDDLE_UP)
147DEFINE_EVENT_TYPE(wxEVT_RIGHT_DOWN)
148DEFINE_EVENT_TYPE(wxEVT_RIGHT_UP)
149DEFINE_EVENT_TYPE(wxEVT_MOTION)
150DEFINE_EVENT_TYPE(wxEVT_ENTER_WINDOW)
151DEFINE_EVENT_TYPE(wxEVT_LEAVE_WINDOW)
152DEFINE_EVENT_TYPE(wxEVT_LEFT_DCLICK)
153DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DCLICK)
154DEFINE_EVENT_TYPE(wxEVT_RIGHT_DCLICK)
155DEFINE_EVENT_TYPE(wxEVT_SET_FOCUS)
156DEFINE_EVENT_TYPE(wxEVT_KILL_FOCUS)
157DEFINE_EVENT_TYPE(wxEVT_CHILD_FOCUS)
158DEFINE_EVENT_TYPE(wxEVT_MOUSEWHEEL)
159
160// Non-client mouse events
161DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN)
162DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_UP)
163DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DOWN)
164DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_UP)
165DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DOWN)
166DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_UP)
167DEFINE_EVENT_TYPE(wxEVT_NC_MOTION)
168DEFINE_EVENT_TYPE(wxEVT_NC_ENTER_WINDOW)
169DEFINE_EVENT_TYPE(wxEVT_NC_LEAVE_WINDOW)
170DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DCLICK)
171DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DCLICK)
172DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DCLICK)
173
174// Character input event type
175DEFINE_EVENT_TYPE(wxEVT_CHAR)
176DEFINE_EVENT_TYPE(wxEVT_CHAR_HOOK)
177DEFINE_EVENT_TYPE(wxEVT_NAVIGATION_KEY)
178DEFINE_EVENT_TYPE(wxEVT_KEY_DOWN)
179DEFINE_EVENT_TYPE(wxEVT_KEY_UP)
180
181// Set cursor event
182DEFINE_EVENT_TYPE(wxEVT_SET_CURSOR)
183
184// wxScrollbar and wxSlider event identifiers
185DEFINE_EVENT_TYPE(wxEVT_SCROLL_TOP)
186DEFINE_EVENT_TYPE(wxEVT_SCROLL_BOTTOM)
187DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEUP)
188DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEDOWN)
189DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEUP)
190DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN)
191DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK)
192DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE)
193
194// Scroll events from wxWindow
195DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP)
196DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_BOTTOM)
197DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEUP)
198DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEDOWN)
199DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEUP)
200DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEDOWN)
201DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBTRACK)
202DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBRELEASE)
203
204// System events
205DEFINE_EVENT_TYPE(wxEVT_SIZE)
206DEFINE_EVENT_TYPE(wxEVT_MOVE)
207DEFINE_EVENT_TYPE(wxEVT_CLOSE_WINDOW)
208DEFINE_EVENT_TYPE(wxEVT_END_SESSION)
209DEFINE_EVENT_TYPE(wxEVT_QUERY_END_SESSION)
210DEFINE_EVENT_TYPE(wxEVT_ACTIVATE_APP)
211DEFINE_EVENT_TYPE(wxEVT_POWER)
212DEFINE_EVENT_TYPE(wxEVT_ACTIVATE)
213DEFINE_EVENT_TYPE(wxEVT_CREATE)
214DEFINE_EVENT_TYPE(wxEVT_DESTROY)
215DEFINE_EVENT_TYPE(wxEVT_SHOW)
216DEFINE_EVENT_TYPE(wxEVT_ICONIZE)
217DEFINE_EVENT_TYPE(wxEVT_MAXIMIZE)
218DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED)
219DEFINE_EVENT_TYPE(wxEVT_PAINT)
220DEFINE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND)
221DEFINE_EVENT_TYPE(wxEVT_NC_PAINT)
222DEFINE_EVENT_TYPE(wxEVT_PAINT_ICON)
223DEFINE_EVENT_TYPE(wxEVT_MENU_OPEN)
224DEFINE_EVENT_TYPE(wxEVT_MENU_CLOSE)
225DEFINE_EVENT_TYPE(wxEVT_MENU_HIGHLIGHT)
226DEFINE_EVENT_TYPE(wxEVT_CONTEXT_MENU)
227DEFINE_EVENT_TYPE(wxEVT_SYS_COLOUR_CHANGED)
228DEFINE_EVENT_TYPE(wxEVT_DISPLAY_CHANGED)
229DEFINE_EVENT_TYPE(wxEVT_SETTING_CHANGED)
230DEFINE_EVENT_TYPE(wxEVT_QUERY_NEW_PALETTE)
231DEFINE_EVENT_TYPE(wxEVT_PALETTE_CHANGED)
232DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_DOWN)
233DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_UP)
234DEFINE_EVENT_TYPE(wxEVT_JOY_MOVE)
235DEFINE_EVENT_TYPE(wxEVT_JOY_ZMOVE)
236DEFINE_EVENT_TYPE(wxEVT_DROP_FILES)
237DEFINE_EVENT_TYPE(wxEVT_DRAW_ITEM)
238DEFINE_EVENT_TYPE(wxEVT_MEASURE_ITEM)
239DEFINE_EVENT_TYPE(wxEVT_COMPARE_ITEM)
240DEFINE_EVENT_TYPE(wxEVT_INIT_DIALOG)
241DEFINE_EVENT_TYPE(wxEVT_IDLE)
242DEFINE_EVENT_TYPE(wxEVT_UPDATE_UI)
243
244// Generic command events
245// Note: a click is a higher-level event than button down/up
246DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK)
247DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_DCLICK)
248DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_CLICK)
249DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_DCLICK)
250DEFINE_EVENT_TYPE(wxEVT_COMMAND_SET_FOCUS)
251DEFINE_EVENT_TYPE(wxEVT_COMMAND_KILL_FOCUS)
252DEFINE_EVENT_TYPE(wxEVT_COMMAND_ENTER)
253
254// Help events
255DEFINE_EVENT_TYPE(wxEVT_HELP)
256DEFINE_EVENT_TYPE(wxEVT_DETAILED_HELP)
257
258#endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
259
260// ============================================================================
261// implementation
262// ============================================================================
263
264// ----------------------------------------------------------------------------
265// event initialization
266// ----------------------------------------------------------------------------
267
268int wxNewEventType()
269{
270 // MT-FIXME
271 static int s_lastUsedEventType = wxEVT_FIRST;
272
273#if WXWIN_COMPATIBILITY_2
274 // check that we don't overlap with the user-defined types: if it does
275 // happen, the best solution is probably to update the existing code to
276 // use wxNewEventType() instead of wxEVT_USER_FIRST
277 //
278 // due to the uncertainty
279 wxASSERT_MSG( s_lastUsedEventType < wxEVT_USER_FIRST - 1,
280 _T("possible event type conflict") );
281#endif // WXWIN_COMPATIBILITY_2
282
283 return s_lastUsedEventType++;
284}
285
286// ----------------------------------------------------------------------------
287// wxEvent
288// ----------------------------------------------------------------------------
289
290/*
291 * General wxWindows events, covering
292 * all interesting things that might happen (button clicking, resizing,
293 * setting text in widgets, etc.).
294 *
295 * For each completely new event type, derive a new event class.
296 *
297 */
298
299wxEvent::wxEvent(int theId, wxEventType commandType )
300{
301 m_eventType = commandType;
302 m_eventObject = (wxObject *) NULL;
303 m_timeStamp = 0;
304 m_id = theId;
305 m_skipped = FALSE;
306 m_callbackUserData = (wxObject *) NULL;
307 m_isCommandEvent = FALSE;
308}
309
310wxEvent::wxEvent(const wxEvent &src)
311 : wxObject()
312 , m_eventObject(src.m_eventObject)
313 , m_eventType(src.m_eventType)
314 , m_timeStamp(src.m_timeStamp)
315 , m_id(src.m_id)
316 , m_callbackUserData(src.m_callbackUserData)
317 , m_skipped(src.m_skipped)
318 , m_isCommandEvent(src.m_isCommandEvent)
319{
320}
321
322#if wxUSE_GUI
323
324/*
325 * Command events
326 *
327 */
328
329wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId)
330 : wxEvent(theId, commandType)
331{
332 m_clientData = (char *) NULL;
333 m_clientObject = (wxClientData *) NULL;
334 m_extraLong = 0;
335 m_commandInt = 0;
336 m_commandString = wxEmptyString;
337 m_isCommandEvent = TRUE;
338}
339
340/*
341 * Scroll events
342 */
343
344wxScrollEvent::wxScrollEvent(wxEventType commandType,
345 int id,
346 int pos,
347 int orient)
348 : wxCommandEvent(commandType, id)
349{
350 m_extraLong = orient;
351 m_commandInt = pos;
352}
353
354/*
355 * ScrollWin events
356 */
357
358wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType,
359 int pos,
360 int orient)
361{
362 m_eventType = commandType;
363 m_extraLong = orient;
364 m_commandInt = pos;
365}
366
367/*
368 * Mouse events
369 *
370 */
371
372wxMouseEvent::wxMouseEvent(wxEventType commandType)
373{
374 m_eventType = commandType;
375 m_metaDown = FALSE;
376 m_altDown = FALSE;
377 m_controlDown = FALSE;
378 m_shiftDown = FALSE;
379 m_leftDown = FALSE;
380 m_rightDown = FALSE;
381 m_middleDown = FALSE;
382 m_x = 0;
383 m_y = 0;
384 m_wheelRotation = 0;
385 m_wheelDelta = 0;
386 m_linesPerAction = 0;
387}
388
389// True if was a button dclick event (1 = left, 2 = middle, 3 = right)
390// or any button dclick event (but = -1)
391bool wxMouseEvent::ButtonDClick(int but) const
392{
393 switch (but)
394 {
395 case -1:
396 return (LeftDClick() || MiddleDClick() || RightDClick());
397 case 1:
398 return LeftDClick();
399 case 2:
400 return MiddleDClick();
401 case 3:
402 return RightDClick();
403 default:
404 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
405 }
406
407 return FALSE;
408}
409
410// True if was a button down event (1 = left, 2 = middle, 3 = right)
411// or any button down event (but = -1)
412bool wxMouseEvent::ButtonDown(int but) const
413{
414 switch (but)
415 {
416 case -1:
417 return (LeftDown() || MiddleDown() || RightDown());
418 case 1:
419 return LeftDown();
420 case 2:
421 return MiddleDown();
422 case 3:
423 return RightDown();
424 default:
425 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
426 }
427
428 return FALSE;
429}
430
431// True if was a button up event (1 = left, 2 = middle, 3 = right)
432// or any button up event (but = -1)
433bool wxMouseEvent::ButtonUp(int but) const
434{
435 switch (but)
436 {
437 case -1:
438 return (LeftUp() || MiddleUp() || RightUp());
439 case 1:
440 return LeftUp();
441 case 2:
442 return MiddleUp();
443 case 3:
444 return RightUp();
445 default:
446 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
447 }
448
449 return FALSE;
450}
451
452// True if the given button is currently changing state
453bool wxMouseEvent::Button(int but) const
454{
455 switch (but)
456 {
457 case -1:
458 return (ButtonUp(-1) || ButtonDown(-1) || ButtonDClick(-1));
459 case 1:
460 return (LeftDown() || LeftUp() || LeftDClick());
461 case 2:
462 return (MiddleDown() || MiddleUp() || MiddleDClick());
463 case 3:
464 return (RightDown() || RightUp() || RightDClick());
465 default:
466 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
467 }
468
469 return FALSE;
470}
471
472bool wxMouseEvent::ButtonIsDown(int but) const
473{
474 switch (but)
475 {
476 case -1:
477 return (LeftIsDown() || MiddleIsDown() || RightIsDown());
478 case 1:
479 return LeftIsDown();
480 case 2:
481 return MiddleIsDown();
482 case 3:
483 return RightIsDown();
484 default:
485 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonIsDown"));
486 }
487
488 return FALSE;
489}
490
491int wxMouseEvent::GetButton() const
492{
493 for ( int i = 1; i <= 3; i++ )
494 {
495 if ( Button(i) )
496 {
497 return i;
498 }
499 }
500
501 return -1;
502}
503
504// Find the logical position of the event given the DC
505wxPoint wxMouseEvent::GetLogicalPosition(const wxDC& dc) const
506{
507 wxPoint pt(dc.DeviceToLogicalX(m_x), dc.DeviceToLogicalY(m_y));
508 return pt;
509}
510
511
512/*
513 * Keyboard event
514 *
515 */
516
517wxKeyEvent::wxKeyEvent(wxEventType type)
518{
519 m_eventType = type;
520 m_shiftDown = FALSE;
521 m_controlDown = FALSE;
522 m_metaDown = FALSE;
523 m_altDown = FALSE;
524 m_keyCode = 0;
525 m_scanCode = 0;
526}
527
528
529wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win)
530{
531 SetEventType(wxEVT_CREATE);
532 SetEventObject(win);
533}
534
535wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow *win)
536{
537 SetEventType(wxEVT_DESTROY);
538 SetEventObject(win);
539}
540
541wxChildFocusEvent::wxChildFocusEvent(wxWindow *win)
542 : wxCommandEvent(wxEVT_CHILD_FOCUS)
543{
544 SetEventObject(win);
545}
546
547#endif // wxUSE_GUI
548
549// ----------------------------------------------------------------------------
550// wxEvtHandler
551// ----------------------------------------------------------------------------
552
553/*
554 * Event handler
555 */
556
557wxEvtHandler::wxEvtHandler()
558{
559 m_nextHandler = (wxEvtHandler *) NULL;
560 m_previousHandler = (wxEvtHandler *) NULL;
561 m_enabled = TRUE;
562 m_dynamicEvents = (wxList *) NULL;
563 m_isWindow = FALSE;
564 m_pendingEvents = (wxList *) NULL;
565#if wxUSE_THREADS
566# if !defined(__VISAGECPP__)
567 m_eventsLocker = new wxCriticalSection;
568# endif
569#endif
570 // no client data (yet)
571 m_clientData = NULL;
572 m_clientDataType = wxClientData_None;
573}
574
575wxEvtHandler::~wxEvtHandler()
576{
577 // Takes itself out of the list of handlers
578 if (m_previousHandler)
579 m_previousHandler->m_nextHandler = m_nextHandler;
580
581 if (m_nextHandler)
582 m_nextHandler->m_previousHandler = m_previousHandler;
583
584 if (m_dynamicEvents)
585 {
586 wxNode *node = m_dynamicEvents->First();
587 while (node)
588 {
589#if WXWIN_COMPATIBILITY_EVENT_TYPES
590 wxEventTableEntry *entry = (wxEventTableEntry*)node->Data();
591#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
592 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->Data();
593#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
594
595 if (entry->m_callbackUserData)
596 delete entry->m_callbackUserData;
597 delete entry;
598 node = node->Next();
599 }
600 delete m_dynamicEvents;
601 };
602
603 delete m_pendingEvents;
604
605#if wxUSE_THREADS
606# if !defined(__VISAGECPP__)
607 delete m_eventsLocker;
608# endif
609#endif
610
611 // we only delete object data, not untyped
612 if ( m_clientDataType == wxClientData_Object )
613 delete m_clientObject;
614}
615
616#if wxUSE_THREADS
617
618bool wxEvtHandler::ProcessThreadEvent(wxEvent& event)
619{
620 // check that we are really in a child thread
621 wxASSERT_MSG( !wxThread::IsMain(),
622 wxT("use ProcessEvent() in main thread") );
623
624 AddPendingEvent(event);
625
626 return TRUE;
627}
628
629#endif // wxUSE_THREADS
630
631void wxEvtHandler::AddPendingEvent(wxEvent& event)
632{
633 // 1) Add event to list of pending events of this event handler
634
635 wxEvent *eventCopy = event.Clone();
636
637 // we must be able to copy the events here so the event class must
638 // implement Clone() properly instead of just providing a NULL stab for it
639 wxCHECK_RET( eventCopy,
640 _T("events of this type aren't supposed to be posted") );
641
642#if defined(__VISAGECPP__)
643 wxENTER_CRIT_SECT( m_eventsLocker);
644#else
645 wxENTER_CRIT_SECT( *m_eventsLocker);
646#endif
647
648 if ( !m_pendingEvents )
649 m_pendingEvents = new wxList;
650
651 m_pendingEvents->Append(eventCopy);
652
653#if defined(__VISAGECPP__)
654 wxLEAVE_CRIT_SECT( m_eventsLocker);
655#else
656 wxLEAVE_CRIT_SECT( *m_eventsLocker);
657#endif
658
659 // 2) Add this event handler to list of event handlers that
660 // have pending events.
661
662 wxENTER_CRIT_SECT(*wxPendingEventsLocker);
663
664 if ( !wxPendingEvents )
665 wxPendingEvents = new wxList;
666 wxPendingEvents->Append(this);
667
668 wxLEAVE_CRIT_SECT(*wxPendingEventsLocker);
669
670 // 3) Inform the system that new pending events are somwehere,
671 // and that these should be processed in idle time.
672 wxWakeUpIdle();
673}
674
675void wxEvtHandler::ProcessPendingEvents()
676{
677#if defined(__VISAGECPP__)
678 wxENTER_CRIT_SECT( m_eventsLocker);
679#else
680 wxENTER_CRIT_SECT( *m_eventsLocker);
681#endif
682
683 wxNode *node = m_pendingEvents->First();
684 while ( node )
685 {
686 wxEvent *event = (wxEvent *)node->Data();
687 delete node;
688
689 // In ProcessEvent, new events might get added and
690 // we can safely leave the crtical section here.
691#if defined(__VISAGECPP__)
692 wxLEAVE_CRIT_SECT( m_eventsLocker);
693#else
694 wxLEAVE_CRIT_SECT( *m_eventsLocker);
695#endif
696 ProcessEvent(*event);
697 delete event;
698#if defined(__VISAGECPP__)
699 wxENTER_CRIT_SECT( m_eventsLocker);
700#else
701 wxENTER_CRIT_SECT( *m_eventsLocker);
702#endif
703
704 node = m_pendingEvents->First();
705 }
706
707#if defined(__VISAGECPP__)
708 wxLEAVE_CRIT_SECT( m_eventsLocker);
709#else
710 wxLEAVE_CRIT_SECT( *m_eventsLocker);
711#endif
712}
713
714/*
715 * Event table stuff
716 */
717
718bool wxEvtHandler::ProcessEvent(wxEvent& event)
719{
720#if wxUSE_GUI
721
722 // We have to use the actual window or processing events from
723 // wxWindowNative destructor won't work (we don't see the wxWindow class)
724#ifdef __WXDEBUG__
725 // check that our flag corresponds to reality
726 wxClassInfo* info = NULL;
727#ifdef __WXUNIVERSAL__
728# if defined(__WXMSW__)
729 info = CLASSINFO(wxWindowMSW);
730# elif defined(__WXGTK__)
731 info = CLASSINFO(wxWindowGTK);
732# elif defined(__WXX11__)
733 info = CLASSINFO(wxWindowX11);
734# elif defined(__WXMGL__)
735 info = CLASSINFO(wxWindowMGL);
736# elif defined(__WXPM__)
737 info = CLASSINFO(wxWindowOS2);
738# elif defined(__WXMAC__)
739 info = CLASSINFO(wxWindowMac);
740# elif defined(__WXMOTIF__)
741 info = CLASSINFO(wxWindowMotif);
742# endif
743#else
744 info = CLASSINFO(wxWindow);
745#endif
746
747 if ( m_isWindow != IsKindOf(info) )
748 {
749 wxString msg = GetClassInfo()->GetClassName();
750 msg += _T(" should [not] be a window but it is [not]");
751
752 wxFAIL_MSG( msg );
753 }
754
755#endif // __WXDEBUG__
756
757#endif // wxUSE_GUI
758
759 // allow the application to hook into event processing
760 if ( wxTheApp )
761 {
762 int rc = wxTheApp->FilterEvent(event);
763 if ( rc != -1 )
764 {
765 wxASSERT_MSG( rc == 1 || rc == 0,
766 _T("unexpected wxApp::FilterEvent return value") );
767
768 return rc != 0;
769 }
770 //else: proceed normally
771 }
772
773 // An event handler can be enabled or disabled
774 if ( GetEvtHandlerEnabled() )
775 {
776
777#if 0
778/*
779 What is this? When using GUI threads, a non main
780 threads can send an event and process it itself.
781 This breaks GTK's GUI threads, so please explain.
782*/
783
784 // Check whether we are in a child thread.
785 if ( !wxThread::IsMain() )
786 return ProcessThreadEvent(event);
787#endif
788
789 // Handle per-instance dynamic event tables first
790 if ( m_dynamicEvents && SearchDynamicEventTable(event) )
791 return TRUE;
792
793 // Then static per-class event tables
794 const wxEventTable *table = GetEventTable();
795
796#if wxUSE_GUI && wxUSE_VALIDATORS
797 // Try the associated validator first, if this is a window.
798 // Problem: if the event handler of the window has been replaced,
799 // this wxEvtHandler may no longer be a window.
800 // Therefore validators won't be processed if the handler
801 // has been replaced with SetEventHandler.
802 // THIS CAN BE CURED if PushEventHandler is used instead of
803 // SetEventHandler, and then processing will be passed down the
804 // chain of event handlers.
805 if (m_isWindow)
806 {
807 wxWindow *win = (wxWindow *)this;
808
809 // Can only use the validator of the window which
810 // is receiving the event
811 if ( win == event.GetEventObject() )
812 {
813 wxValidator *validator = win->GetValidator();
814 if ( validator && validator->ProcessEvent(event) )
815 {
816 return TRUE;
817 }
818 }
819 }
820#endif
821
822 // Search upwards through the inheritance hierarchy
823 while (table)
824 {
825 if ( SearchEventTable((wxEventTable&)*table, event) )
826 return TRUE;
827 table = table->baseTable;
828 }
829 }
830
831 // Try going down the event handler chain
832 if ( GetNextHandler() )
833 {
834 if ( GetNextHandler()->ProcessEvent(event) )
835 return TRUE;
836 }
837
838#if wxUSE_GUI
839 // Carry on up the parent-child hierarchy, but only if event is a command
840 // event: it wouldn't make sense for a parent to receive a child's size
841 // event, for example
842 if ( m_isWindow && event.IsCommandEvent() )
843 {
844 wxWindow *win = (wxWindow *)this;
845
846 // honour the requests to stop propagation at this window: this is
847 // used by the dialogs, for example, to prevent processing the events
848 // from the dialog controls in the parent frame which rarely, if ever,
849 // makes sense
850 if ( !(win->GetExtraStyle() & wxWS_EX_BLOCK_EVENTS) )
851 {
852 wxWindow *parent = win->GetParent();
853 if ( parent && !parent->IsBeingDeleted() )
854 return parent->GetEventHandler()->ProcessEvent(event);
855 }
856 }
857#endif // wxUSE_GUI
858
859 // Last try - application object.
860 if ( wxTheApp && (this != wxTheApp) )
861 {
862 // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
863 // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
864 // processed appropriately via SearchEventTable.
865 if ( event.GetEventType() != wxEVT_IDLE )
866 {
867 if ( wxTheApp->ProcessEvent(event) )
868 return TRUE;
869 }
870 }
871
872 return FALSE;
873}
874
875bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event)
876{
877 wxEventType eventType = event.GetEventType();
878 int eventId = event.GetId();
879
880 // BC++ doesn't like testing for m_fn without != 0
881 for ( int i = 0; table.entries[i].m_fn != 0; i++ )
882 {
883 // the line using reference exposes a bug in gcc: although it _seems_
884 // to work, it leads to weird crashes later on during program
885 // execution
886#ifdef __GNUG__
887 wxEventTableEntry entry = table.entries[i];
888#else
889 const wxEventTableEntry& entry = table.entries[i];
890#endif
891
892 // match only if the event type is the same and the id is either -1 in
893 // the event table (meaning "any") or the event id matches the id
894 // specified in the event table either exactly or by falling into
895 // range between first and last
896 if ( eventType == entry.m_eventType )
897 {
898 int tableId1 = entry.m_id,
899 tableId2 = entry.m_lastId;
900
901 if ( (tableId1 == -1) ||
902 (tableId2 == -1 && eventId == tableId1) ||
903 (tableId2 != -1 &&
904 (eventId >= tableId1 && eventId <= tableId2)) )
905 {
906 event.Skip(FALSE);
907 event.m_callbackUserData = entry.m_callbackUserData;
908
909 (this->*((wxEventFunction) (entry.m_fn)))(event);
910
911 return !event.GetSkipped();
912 }
913 }
914 }
915
916 return FALSE;
917}
918
919void wxEvtHandler::Connect( int id, int lastId,
920 int eventType,
921 wxObjectEventFunction func,
922 wxObject *userData )
923{
924#if WXWIN_COMPATIBILITY_EVENT_TYPES
925 wxEventTableEntry *entry = new wxEventTableEntry;
926 entry->m_eventType = eventType;
927 entry->m_id = id;
928 entry->m_lastId = lastId;
929 entry->m_fn = func;
930 entry->m_callbackUserData = userData;
931#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
932 wxDynamicEventTableEntry *entry =
933 new wxDynamicEventTableEntry(eventType, id, lastId, func, userData);
934#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
935
936 if (!m_dynamicEvents)
937 m_dynamicEvents = new wxList;
938
939 m_dynamicEvents->Append( (wxObject*) entry );
940}
941
942bool wxEvtHandler::Disconnect( int id, int lastId, wxEventType eventType,
943 wxObjectEventFunction func,
944 wxObject *userData )
945{
946 if (!m_dynamicEvents)
947 return FALSE;
948
949 wxNode *node = m_dynamicEvents->First();
950 while (node)
951 {
952#if WXWIN_COMPATIBILITY_EVENT_TYPES
953 wxEventTableEntry *entry = (wxEventTableEntry*)node->Data();
954#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
955 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->Data();
956#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
957
958 if ((entry->m_id == id) &&
959 ((entry->m_lastId == lastId) || (lastId == -1)) &&
960 ((entry->m_eventType == eventType) || (eventType == wxEVT_NULL)) &&
961 ((entry->m_fn == func) || (func == (wxObjectEventFunction)NULL)) &&
962 ((entry->m_callbackUserData == userData) || (userData == (wxObject*)NULL)))
963 {
964 if (entry->m_callbackUserData)
965 delete entry->m_callbackUserData;
966 m_dynamicEvents->DeleteNode( node );
967 delete entry;
968 return TRUE;
969 }
970 node = node->Next();
971 }
972 return FALSE;
973}
974
975bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event )
976{
977 wxCHECK_MSG( m_dynamicEvents, FALSE,
978 wxT("caller should check that we have dynamic events") );
979
980 int commandId = event.GetId();
981
982 wxNode *node = m_dynamicEvents->First();
983 while (node)
984 {
985#if WXWIN_COMPATIBILITY_EVENT_TYPES
986 wxEventTableEntry *entry = (wxEventTableEntry*)node->Data();
987#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
988 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->Data();
989#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
990
991 if (entry->m_fn)
992 {
993 // Match, if event spec says any id will do (id == -1)
994 if ( (event.GetEventType() == entry->m_eventType) &&
995 (entry->m_id == -1 ||
996 (entry->m_lastId == -1 && commandId == entry->m_id) ||
997 (entry->m_lastId != -1 &&
998 (commandId >= entry->m_id && commandId <= entry->m_lastId))) )
999 {
1000 event.Skip(FALSE);
1001 event.m_callbackUserData = entry->m_callbackUserData;
1002
1003 (this->*((wxEventFunction) (entry->m_fn)))(event);
1004
1005 if (event.GetSkipped())
1006 return FALSE;
1007 else
1008 return TRUE;
1009 }
1010 }
1011 node = node->Next();
1012 }
1013 return FALSE;
1014};
1015
1016void wxEvtHandler::DoSetClientObject( wxClientData *data )
1017{
1018 wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1019 wxT("can't have both object and void client data") );
1020
1021 if ( m_clientObject )
1022 delete m_clientObject;
1023
1024 m_clientObject = data;
1025 m_clientDataType = wxClientData_Object;
1026}
1027
1028wxClientData *wxEvtHandler::DoGetClientObject() const
1029{
1030 // it's not an error to call GetClientObject() on a window which doesn't
1031 // have client data at all - NULL will be returned
1032 wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1033 wxT("this window doesn't have object client data") );
1034
1035 return m_clientObject;
1036}
1037
1038void wxEvtHandler::DoSetClientData( void *data )
1039{
1040 wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1041 wxT("can't have both object and void client data") );
1042
1043 m_clientData = data;
1044 m_clientDataType = wxClientData_Void;
1045}
1046
1047void *wxEvtHandler::DoGetClientData() const
1048{
1049 // it's not an error to call GetClientData() on a window which doesn't have
1050 // client data at all - NULL will be returned
1051 wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1052 wxT("this window doesn't have void client data") );
1053
1054 return m_clientData;
1055}
1056
1057
1058#if WXWIN_COMPATIBILITY
1059bool wxEvtHandler::OnClose()
1060{
1061 if (GetNextHandler())
1062 return GetNextHandler()->OnClose();
1063 else
1064 return FALSE;
1065}
1066#endif // WXWIN_COMPATIBILITY
1067
1068#if wxUSE_GUI
1069
1070// Find a window with the focus, that is also a descendant of the given window.
1071// This is used to determine the window to initially send commands to.
1072wxWindow* wxFindFocusDescendant(wxWindow* ancestor)
1073{
1074 // Process events starting with the window with the focus, if any.
1075 wxWindow* focusWin = wxWindow::FindFocus();
1076 wxWindow* win = focusWin;
1077
1078 // Check if this is a descendant of this frame.
1079 // If not, win will be set to NULL.
1080 while (win)
1081 {
1082 if (win == ancestor)
1083 break;
1084 else
1085 win = win->GetParent();
1086 }
1087 if (win == (wxWindow*) NULL)
1088 focusWin = (wxWindow*) NULL;
1089
1090 return focusWin;
1091}
1092
1093#endif // wxUSE_GUI
wxWidgets (Impactor)