]> 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
some wxArtProv docs
[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{
312 m_eventType = src.m_eventType;
313 m_eventObject = src.m_eventObject;
314 m_timeStamp = src.m_timeStamp;
315 m_id = src.m_id;
316 m_skipped = src.m_skipped;
317 m_callbackUserData = src.m_callbackUserData;
318 m_isCommandEvent = src.m_isCommandEvent;
319}
320
321#if wxUSE_GUI
322
323/*
324 * Command events
325 *
326 */
327
328wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId)
329 : wxEvent( theId, commandType )
330{
331 m_clientData = (char *) NULL;
332 m_clientObject = (wxClientData *) NULL;
333 m_extraLong = 0;
334 m_commandInt = 0;
335 m_commandString = wxEmptyString;
336 m_isCommandEvent = TRUE;
337}
338
339/*
340 * Scroll events
341 */
342
343wxScrollEvent::wxScrollEvent(wxEventType commandType,
344 int id,
345 int pos,
346 int orient)
347 : wxCommandEvent(commandType, id)
348{
349 m_extraLong = orient;
350 m_commandInt = pos;
351}
352
353/*
354 * ScrollWin events
355 */
356
357wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType,
358 int pos,
359 int orient)
360{
361 m_eventType = commandType;
362 m_extraLong = orient;
363 m_commandInt = pos;
364}
365
366/*
367 * Mouse events
368 *
369 */
370
371wxMouseEvent::wxMouseEvent(wxEventType commandType)
372{
373 m_eventType = commandType;
374 m_metaDown = FALSE;
375 m_altDown = FALSE;
376 m_controlDown = FALSE;
377 m_shiftDown = FALSE;
378 m_leftDown = FALSE;
379 m_rightDown = FALSE;
380 m_middleDown = FALSE;
381 m_x = 0;
382 m_y = 0;
383 m_wheelRotation = 0;
384 m_wheelDelta = 0;
385 m_linesPerAction = 0;
386}
387
388// True if was a button dclick event (1 = left, 2 = middle, 3 = right)
389// or any button dclick event (but = -1)
390bool wxMouseEvent::ButtonDClick(int but) const
391{
392 switch (but)
393 {
394 case -1:
395 return (LeftDClick() || MiddleDClick() || RightDClick());
396 case 1:
397 return LeftDClick();
398 case 2:
399 return MiddleDClick();
400 case 3:
401 return RightDClick();
402 default:
403 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
404 }
405
406 return FALSE;
407}
408
409// True if was a button down event (1 = left, 2 = middle, 3 = right)
410// or any button down event (but = -1)
411bool wxMouseEvent::ButtonDown(int but) const
412{
413 switch (but)
414 {
415 case -1:
416 return (LeftDown() || MiddleDown() || RightDown());
417 case 1:
418 return LeftDown();
419 case 2:
420 return MiddleDown();
421 case 3:
422 return RightDown();
423 default:
424 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
425 }
426
427 return FALSE;
428}
429
430// True if was a button up event (1 = left, 2 = middle, 3 = right)
431// or any button up event (but = -1)
432bool wxMouseEvent::ButtonUp(int but) const
433{
434 switch (but)
435 {
436 case -1:
437 return (LeftUp() || MiddleUp() || RightUp());
438 case 1:
439 return LeftUp();
440 case 2:
441 return MiddleUp();
442 case 3:
443 return RightUp();
444 default:
445 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
446 }
447
448 return FALSE;
449}
450
451// True if the given button is currently changing state
452bool wxMouseEvent::Button(int but) const
453{
454 switch (but)
455 {
456 case -1:
457 return (ButtonUp(-1) || ButtonDown(-1) || ButtonDClick(-1));
458 case 1:
459 return (LeftDown() || LeftUp() || LeftDClick());
460 case 2:
461 return (MiddleDown() || MiddleUp() || MiddleDClick());
462 case 3:
463 return (RightDown() || RightUp() || RightDClick());
464 default:
465 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
466 }
467
468 return FALSE;
469}
470
471bool wxMouseEvent::ButtonIsDown(int but) const
472{
473 switch (but)
474 {
475 case -1:
476 return (LeftIsDown() || MiddleIsDown() || RightIsDown());
477 case 1:
478 return LeftIsDown();
479 case 2:
480 return MiddleIsDown();
481 case 3:
482 return RightIsDown();
483 default:
484 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonIsDown"));
485 }
486
487 return FALSE;
488}
489
490int wxMouseEvent::GetButton() const
491{
492 for ( int i = 1; i <= 3; i++ )
493 {
494 if ( Button(i) )
495 {
496 return i;
497 }
498 }
499
500 return -1;
501}
502
503// Find the logical position of the event given the DC
504wxPoint wxMouseEvent::GetLogicalPosition(const wxDC& dc) const
505{
506 wxPoint pt(dc.DeviceToLogicalX(m_x), dc.DeviceToLogicalY(m_y));
507 return pt;
508}
509
510
511/*
512 * Keyboard event
513 *
514 */
515
516wxKeyEvent::wxKeyEvent(wxEventType type)
517{
518 m_eventType = type;
519 m_shiftDown = FALSE;
520 m_controlDown = FALSE;
521 m_metaDown = FALSE;
522 m_altDown = FALSE;
523 m_keyCode = 0;
524 m_scanCode = 0;
525}
526
527
528wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win)
529{
530 SetEventType(wxEVT_CREATE);
531 SetEventObject(win);
532}
533
534wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow *win)
535{
536 SetEventType(wxEVT_DESTROY);
537 SetEventObject(win);
538}
539
540wxChildFocusEvent::wxChildFocusEvent(wxWindow *win)
541 : wxCommandEvent(wxEVT_CHILD_FOCUS)
542{
543 SetEventObject(win);
544}
545
546#endif // wxUSE_GUI
547
548// ----------------------------------------------------------------------------
549// wxEvtHandler
550// ----------------------------------------------------------------------------
551
552/*
553 * Event handler
554 */
555
556wxEvtHandler::wxEvtHandler()
557{
558 m_nextHandler = (wxEvtHandler *) NULL;
559 m_previousHandler = (wxEvtHandler *) NULL;
560 m_enabled = TRUE;
561 m_dynamicEvents = (wxList *) NULL;
562 m_isWindow = FALSE;
563 m_pendingEvents = (wxList *) NULL;
564#if wxUSE_THREADS
565# if !defined(__VISAGECPP__)
566 m_eventsLocker = new wxCriticalSection;
567# endif
568#endif
569 // no client data (yet)
570 m_clientData = NULL;
571 m_clientDataType = wxClientData_None;
572}
573
574wxEvtHandler::~wxEvtHandler()
575{
576 // Takes itself out of the list of handlers
577 if (m_previousHandler)
578 m_previousHandler->m_nextHandler = m_nextHandler;
579
580 if (m_nextHandler)
581 m_nextHandler->m_previousHandler = m_previousHandler;
582
583 if (m_dynamicEvents)
584 {
585 wxNode *node = m_dynamicEvents->First();
586 while (node)
587 {
588#if WXWIN_COMPATIBILITY_EVENT_TYPES
589 wxEventTableEntry *entry = (wxEventTableEntry*)node->Data();
590#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
591 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->Data();
592#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
593
594 if (entry->m_callbackUserData)
595 delete entry->m_callbackUserData;
596 delete entry;
597 node = node->Next();
598 }
599 delete m_dynamicEvents;
600 };
601
602 delete m_pendingEvents;
603
604#if wxUSE_THREADS
605# if !defined(__VISAGECPP__)
606 delete m_eventsLocker;
607# endif
608#endif
609
610 // we only delete object data, not untyped
611 if ( m_clientDataType == wxClientData_Object )
612 delete m_clientObject;
613}
614
615#if wxUSE_THREADS
616
617bool wxEvtHandler::ProcessThreadEvent(wxEvent& event)
618{
619 // check that we are really in a child thread
620 wxASSERT_MSG( !wxThread::IsMain(),
621 wxT("use ProcessEvent() in main thread") );
622
623 AddPendingEvent(event);
624
625 return TRUE;
626}
627
628#endif // wxUSE_THREADS
629
630void wxEvtHandler::AddPendingEvent(wxEvent& event)
631{
632 // 1) Add event to list of pending events of this event handler
633
634 wxEvent *eventCopy = event.Clone();
635
636 // we must be able to copy the events here so the event class must
637 // implement Clone() properly instead of just providing a NULL stab for it
638 wxCHECK_RET( eventCopy,
639 _T("events of this type aren't supposed to be posted") );
640
641#if defined(__VISAGECPP__)
642 wxENTER_CRIT_SECT( m_eventsLocker);
643#else
644 wxENTER_CRIT_SECT( *m_eventsLocker);
645#endif
646
647 if ( !m_pendingEvents )
648 m_pendingEvents = new wxList;
649
650 m_pendingEvents->Append(eventCopy);
651
652#if defined(__VISAGECPP__)
653 wxLEAVE_CRIT_SECT( m_eventsLocker);
654#else
655 wxLEAVE_CRIT_SECT( *m_eventsLocker);
656#endif
657
658 // 2) Add this event handler to list of event handlers that
659 // have pending events.
660
661 wxENTER_CRIT_SECT(*wxPendingEventsLocker);
662
663 if ( !wxPendingEvents )
664 wxPendingEvents = new wxList;
665 wxPendingEvents->Append(this);
666
667 wxLEAVE_CRIT_SECT(*wxPendingEventsLocker);
668
669 // 3) Inform the system that new pending events are somwehere,
670 // and that these should be processed in idle time.
671 wxWakeUpIdle();
672}
673
674void wxEvtHandler::ProcessPendingEvents()
675{
676#if defined(__VISAGECPP__)
677 wxENTER_CRIT_SECT( m_eventsLocker);
678#else
679 wxENTER_CRIT_SECT( *m_eventsLocker);
680#endif
681
682 wxNode *node = m_pendingEvents->First();
683 while ( node )
684 {
685 wxEvent *event = (wxEvent *)node->Data();
686 delete node;
687
688 // In ProcessEvent, new events might get added and
689 // we can safely leave the crtical section here.
690#if defined(__VISAGECPP__)
691 wxLEAVE_CRIT_SECT( m_eventsLocker);
692#else
693 wxLEAVE_CRIT_SECT( *m_eventsLocker);
694#endif
695 ProcessEvent(*event);
696 delete event;
697#if defined(__VISAGECPP__)
698 wxENTER_CRIT_SECT( m_eventsLocker);
699#else
700 wxENTER_CRIT_SECT( *m_eventsLocker);
701#endif
702
703 node = m_pendingEvents->First();
704 }
705
706#if defined(__VISAGECPP__)
707 wxLEAVE_CRIT_SECT( m_eventsLocker);
708#else
709 wxLEAVE_CRIT_SECT( *m_eventsLocker);
710#endif
711}
712
713/*
714 * Event table stuff
715 */
716
717bool wxEvtHandler::ProcessEvent(wxEvent& event)
718{
719#if wxUSE_GUI
720
721 // We have to use the actual window or processing events from
722 // wxWindowNative destructor won't work (we don't see the wxWindow class)
723#ifdef __WXDEBUG__
724 // check that our flag corresponds to reality
725 wxClassInfo* info = NULL;
726#ifdef __WXUNIVERSAL__
727# if defined(__WXMSW__)
728 info = CLASSINFO(wxWindowMSW);
729# elif defined(__WXGTK__)
730 info = CLASSINFO(wxWindowGTK);
731# elif defined(__WXX11__)
732 info = CLASSINFO(wxWindowX11);
733# elif defined(__WXMGL__)
734 info = CLASSINFO(wxWindowMGL);
735# elif defined(__WXPM__)
736 info = CLASSINFO(wxWindowOS2);
737# elif defined(__WXMAC__)
738 info = CLASSINFO(wxWindowMac);
739# elif defined(__WXMOTIF__)
740 info = CLASSINFO(wxWindowMotif);
741# endif
742#else
743 info = CLASSINFO(wxWindow);
744#endif
745
746 wxASSERT_MSG( m_isWindow == IsKindOf(info),
747 wxString(GetClassInfo()->GetClassName()) + _T(" should [not] be a window but it is [not]") );
748#endif
749
750#endif // wxUSE_GUI
751
752 // An event handler can be enabled or disabled
753 if ( GetEvtHandlerEnabled() )
754 {
755
756#if 0
757/*
758 What is this? When using GUI threads, a non main
759 threads can send an event and process it itself.
760 This breaks GTK's GUI threads, so please explain.
761*/
762
763 // Check whether we are in a child thread.
764 if ( !wxThread::IsMain() )
765 return ProcessThreadEvent(event);
766#endif
767
768 // Handle per-instance dynamic event tables first
769 if ( m_dynamicEvents && SearchDynamicEventTable(event) )
770 return TRUE;
771
772 // Then static per-class event tables
773 const wxEventTable *table = GetEventTable();
774
775#if wxUSE_GUI && wxUSE_VALIDATORS
776 // Try the associated validator first, if this is a window.
777 // Problem: if the event handler of the window has been replaced,
778 // this wxEvtHandler may no longer be a window.
779 // Therefore validators won't be processed if the handler
780 // has been replaced with SetEventHandler.
781 // THIS CAN BE CURED if PushEventHandler is used instead of
782 // SetEventHandler, and then processing will be passed down the
783 // chain of event handlers.
784 if (m_isWindow)
785 {
786 wxWindow *win = (wxWindow *)this;
787
788 // Can only use the validator of the window which
789 // is receiving the event
790 if ( win == event.GetEventObject() )
791 {
792 wxValidator *validator = win->GetValidator();
793 if ( validator && validator->ProcessEvent(event) )
794 {
795 return TRUE;
796 }
797 }
798 }
799#endif
800
801 // Search upwards through the inheritance hierarchy
802 while (table)
803 {
804 if ( SearchEventTable((wxEventTable&)*table, event) )
805 return TRUE;
806 table = table->baseTable;
807 }
808 }
809
810 // Try going down the event handler chain
811 if ( GetNextHandler() )
812 {
813 if ( GetNextHandler()->ProcessEvent(event) )
814 return TRUE;
815 }
816
817#if wxUSE_GUI
818 // Carry on up the parent-child hierarchy, but only if event is a command
819 // event: it wouldn't make sense for a parent to receive a child's size
820 // event, for example
821 if ( m_isWindow && event.IsCommandEvent() )
822 {
823 wxWindow *win = (wxWindow *)this;
824
825 // honour the requests to stop propagation at this window: this is
826 // used by the dialogs, for example, to prevent processing the events
827 // from the dialog controls in the parent frame which rarely, if ever,
828 // makes sense
829 if ( !(win->GetExtraStyle() & wxWS_EX_BLOCK_EVENTS) )
830 {
831 wxWindow *parent = win->GetParent();
832 if ( parent && !parent->IsBeingDeleted() )
833 return parent->GetEventHandler()->ProcessEvent(event);
834 }
835 }
836#endif // wxUSE_GUI
837
838 // Last try - application object.
839 if ( wxTheApp && (this != wxTheApp) )
840 {
841 // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
842 // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
843 // processed appropriately via SearchEventTable.
844 if ( event.GetEventType() != wxEVT_IDLE )
845 {
846 if ( wxTheApp->ProcessEvent(event) )
847 return TRUE;
848 }
849 }
850
851 return FALSE;
852}
853
854bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event)
855{
856 wxEventType eventType = event.GetEventType();
857 int eventId = event.GetId();
858
859 // BC++ doesn't like testing for m_fn without != 0
860 for ( int i = 0; table.entries[i].m_fn != 0; i++ )
861 {
862 // the line using reference exposes a bug in gcc: although it _seems_
863 // to work, it leads to weird crashes later on during program
864 // execution
865#ifdef __GNUG__
866 wxEventTableEntry entry = table.entries[i];
867#else
868 const wxEventTableEntry& entry = table.entries[i];
869#endif
870
871 // match only if the event type is the same and the id is either -1 in
872 // the event table (meaning "any") or the event id matches the id
873 // specified in the event table either exactly or by falling into
874 // range between first and last
875 if ( eventType == entry.m_eventType )
876 {
877 int tableId1 = entry.m_id,
878 tableId2 = entry.m_lastId;
879
880 if ( (tableId1 == -1) ||
881 (tableId2 == -1 && eventId == tableId1) ||
882 (tableId2 != -1 &&
883 (eventId >= tableId1 && eventId <= tableId2)) )
884 {
885 event.Skip(FALSE);
886 event.m_callbackUserData = entry.m_callbackUserData;
887
888 (this->*((wxEventFunction) (entry.m_fn)))(event);
889
890 return !event.GetSkipped();
891 }
892 }
893 }
894
895 return FALSE;
896}
897
898void wxEvtHandler::Connect( int id, int lastId,
899 int eventType,
900 wxObjectEventFunction func,
901 wxObject *userData )
902{
903#if WXWIN_COMPATIBILITY_EVENT_TYPES
904 wxEventTableEntry *entry = new wxEventTableEntry;
905 entry->m_eventType = eventType;
906 entry->m_id = id;
907 entry->m_lastId = lastId;
908 entry->m_fn = func;
909 entry->m_callbackUserData = userData;
910#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
911 wxDynamicEventTableEntry *entry =
912 new wxDynamicEventTableEntry(eventType, id, lastId, func, userData);
913#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
914
915 if (!m_dynamicEvents)
916 m_dynamicEvents = new wxList;
917
918 m_dynamicEvents->Append( (wxObject*) entry );
919}
920
921bool wxEvtHandler::Disconnect( int id, int lastId, wxEventType eventType,
922 wxObjectEventFunction func,
923 wxObject *userData )
924{
925 if (!m_dynamicEvents)
926 return FALSE;
927
928 wxNode *node = m_dynamicEvents->First();
929 while (node)
930 {
931#if WXWIN_COMPATIBILITY_EVENT_TYPES
932 wxEventTableEntry *entry = (wxEventTableEntry*)node->Data();
933#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
934 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->Data();
935#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
936
937 if ((entry->m_id == id) &&
938 ((entry->m_lastId == lastId) || (lastId == -1)) &&
939 ((entry->m_eventType == eventType) || (eventType == wxEVT_NULL)) &&
940 ((entry->m_fn == func) || (func == (wxObjectEventFunction)NULL)) &&
941 ((entry->m_callbackUserData == userData) || (userData == (wxObject*)NULL)))
942 {
943 if (entry->m_callbackUserData)
944 delete entry->m_callbackUserData;
945 m_dynamicEvents->DeleteNode( node );
946 delete entry;
947 return TRUE;
948 }
949 node = node->Next();
950 }
951 return FALSE;
952}
953
954bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event )
955{
956 wxCHECK_MSG( m_dynamicEvents, FALSE,
957 wxT("caller should check that we have dynamic events") );
958
959 int commandId = event.GetId();
960
961 wxNode *node = m_dynamicEvents->First();
962 while (node)
963 {
964#if WXWIN_COMPATIBILITY_EVENT_TYPES
965 wxEventTableEntry *entry = (wxEventTableEntry*)node->Data();
966#else // !WXWIN_COMPATIBILITY_EVENT_TYPES
967 wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->Data();
968#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
969
970 if (entry->m_fn)
971 {
972 // Match, if event spec says any id will do (id == -1)
973 if ( (event.GetEventType() == entry->m_eventType) &&
974 (entry->m_id == -1 ||
975 (entry->m_lastId == -1 && commandId == entry->m_id) ||
976 (entry->m_lastId != -1 &&
977 (commandId >= entry->m_id && commandId <= entry->m_lastId))) )
978 {
979 event.Skip(FALSE);
980 event.m_callbackUserData = entry->m_callbackUserData;
981
982 (this->*((wxEventFunction) (entry->m_fn)))(event);
983
984 if (event.GetSkipped())
985 return FALSE;
986 else
987 return TRUE;
988 }
989 }
990 node = node->Next();
991 }
992 return FALSE;
993};
994
995void wxEvtHandler::DoSetClientObject( wxClientData *data )
996{
997 wxASSERT_MSG( m_clientDataType != wxClientData_Void,
998 wxT("can't have both object and void client data") );
999
1000 if ( m_clientObject )
1001 delete m_clientObject;
1002
1003 m_clientObject = data;
1004 m_clientDataType = wxClientData_Object;
1005}
1006
1007wxClientData *wxEvtHandler::DoGetClientObject() const
1008{
1009 // it's not an error to call GetClientObject() on a window which doesn't
1010 // have client data at all - NULL will be returned
1011 wxASSERT_MSG( m_clientDataType != wxClientData_Void,
1012 wxT("this window doesn't have object client data") );
1013
1014 return m_clientObject;
1015}
1016
1017void wxEvtHandler::DoSetClientData( void *data )
1018{
1019 wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1020 wxT("can't have both object and void client data") );
1021
1022 m_clientData = data;
1023 m_clientDataType = wxClientData_Void;
1024}
1025
1026void *wxEvtHandler::DoGetClientData() const
1027{
1028 // it's not an error to call GetClientData() on a window which doesn't have
1029 // client data at all - NULL will be returned
1030 wxASSERT_MSG( m_clientDataType != wxClientData_Object,
1031 wxT("this window doesn't have void client data") );
1032
1033 return m_clientData;
1034}
1035
1036
1037#if WXWIN_COMPATIBILITY
1038bool wxEvtHandler::OnClose()
1039{
1040 if (GetNextHandler())
1041 return GetNextHandler()->OnClose();
1042 else
1043 return FALSE;
1044}
1045#endif // WXWIN_COMPATIBILITY
1046
1047#if wxUSE_GUI
1048
1049// Find a window with the focus, that is also a descendant of the given window.
1050// This is used to determine the window to initially send commands to.
1051wxWindow* wxFindFocusDescendant(wxWindow* ancestor)
1052{
1053 // Process events starting with the window with the focus, if any.
1054 wxWindow* focusWin = wxWindow::FindFocus();
1055 wxWindow* win = focusWin;
1056
1057 // Check if this is a descendant of this frame.
1058 // If not, win will be set to NULL.
1059 while (win)
1060 {
1061 if (win == ancestor)
1062 break;
1063 else
1064 win = win->GetParent();
1065 }
1066 if (win == (wxWindow*) NULL)
1067 focusWin = (wxWindow*) NULL;
1068
1069 return focusWin;
1070}
1071
1072#endif // wxUSE_GUI
wxWidgets (Impactor)