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