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