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