1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/event.cpp
3 // Purpose: Event classes
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
35 #include "wx/control.h"
37 #include "wx/textctrl.h"
41 #include "wx/module.h"
44 #include "wx/validate.h"
46 #include "wx/stopwatch.h"
50 // ----------------------------------------------------------------------------
52 // ----------------------------------------------------------------------------
55 IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler
, wxObject
)
56 IMPLEMENT_ABSTRACT_CLASS(wxEvent
, wxObject
)
60 IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent
, wxEvent
)
61 IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent
, wxEvent
)
62 IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent
, wxCommandEvent
)
63 IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent
, wxCommandEvent
)
64 IMPLEMENT_DYNAMIC_CLASS(wxScrollWinEvent
, wxEvent
)
65 IMPLEMENT_DYNAMIC_CLASS(wxMouseEvent
, wxEvent
)
66 IMPLEMENT_DYNAMIC_CLASS(wxKeyEvent
, wxEvent
)
67 IMPLEMENT_DYNAMIC_CLASS(wxSizeEvent
, wxEvent
)
68 IMPLEMENT_DYNAMIC_CLASS(wxPaintEvent
, wxEvent
)
69 IMPLEMENT_DYNAMIC_CLASS(wxNcPaintEvent
, wxEvent
)
70 IMPLEMENT_DYNAMIC_CLASS(wxEraseEvent
, wxEvent
)
71 IMPLEMENT_DYNAMIC_CLASS(wxMoveEvent
, wxEvent
)
72 IMPLEMENT_DYNAMIC_CLASS(wxFocusEvent
, wxEvent
)
73 IMPLEMENT_DYNAMIC_CLASS(wxChildFocusEvent
, wxCommandEvent
)
74 IMPLEMENT_DYNAMIC_CLASS(wxCloseEvent
, wxEvent
)
75 IMPLEMENT_DYNAMIC_CLASS(wxShowEvent
, wxEvent
)
76 IMPLEMENT_DYNAMIC_CLASS(wxMaximizeEvent
, wxEvent
)
77 IMPLEMENT_DYNAMIC_CLASS(wxIconizeEvent
, wxEvent
)
78 IMPLEMENT_DYNAMIC_CLASS(wxMenuEvent
, wxEvent
)
79 IMPLEMENT_DYNAMIC_CLASS(wxJoystickEvent
, wxEvent
)
80 IMPLEMENT_DYNAMIC_CLASS(wxDropFilesEvent
, wxEvent
)
81 IMPLEMENT_DYNAMIC_CLASS(wxActivateEvent
, wxEvent
)
82 IMPLEMENT_DYNAMIC_CLASS(wxInitDialogEvent
, wxEvent
)
83 IMPLEMENT_DYNAMIC_CLASS(wxSetCursorEvent
, wxEvent
)
84 IMPLEMENT_DYNAMIC_CLASS(wxSysColourChangedEvent
, wxEvent
)
85 IMPLEMENT_DYNAMIC_CLASS(wxDisplayChangedEvent
, wxEvent
)
86 IMPLEMENT_DYNAMIC_CLASS(wxUpdateUIEvent
, wxCommandEvent
)
87 IMPLEMENT_DYNAMIC_CLASS(wxNavigationKeyEvent
, wxEvent
)
88 IMPLEMENT_DYNAMIC_CLASS(wxPaletteChangedEvent
, wxEvent
)
89 IMPLEMENT_DYNAMIC_CLASS(wxQueryNewPaletteEvent
, wxEvent
)
90 IMPLEMENT_DYNAMIC_CLASS(wxWindowCreateEvent
, wxEvent
)
91 IMPLEMENT_DYNAMIC_CLASS(wxWindowDestroyEvent
, wxEvent
)
92 IMPLEMENT_DYNAMIC_CLASS(wxHelpEvent
, wxCommandEvent
)
93 IMPLEMENT_DYNAMIC_CLASS(wxContextMenuEvent
, wxCommandEvent
)
94 IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureChangedEvent
, wxEvent
)
95 IMPLEMENT_DYNAMIC_CLASS(wxClipboardTextEvent
, wxCommandEvent
)
100 const wxEventTable
*wxEvtHandler::GetEventTable() const
101 { return &wxEvtHandler::sm_eventTable
; }
103 const wxEventTable
wxEvtHandler::sm_eventTable
=
104 { (const wxEventTable
*)NULL
, &wxEvtHandler::sm_eventTableEntries
[0] };
106 wxEventHashTable
&wxEvtHandler::GetEventHashTable() const
107 { return wxEvtHandler::sm_eventHashTable
; }
109 wxEventHashTable
wxEvtHandler::sm_eventHashTable(wxEvtHandler::sm_eventTable
);
111 const wxEventTableEntry
wxEvtHandler::sm_eventTableEntries
[] =
112 { DECLARE_EVENT_TABLE_ENTRY(wxEVT_NULL
, 0, 0, (wxObjectEventFunction
)NULL
, NULL
) };
116 // Clear up event hash table contents or we can get problems
117 // when C++ is cleaning up the static object
118 class wxEventTableEntryModule
: public wxModule
120 DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule
)
122 wxEventTableEntryModule() {}
123 bool OnInit() { return true; }
126 wxEventHashTable::ClearAll();
129 IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule
, wxModule
)
132 // ----------------------------------------------------------------------------
134 // ----------------------------------------------------------------------------
136 // To put pending event handlers
137 wxList
*wxPendingEvents
= (wxList
*)NULL
;
140 // protects wxPendingEvents list
141 wxCriticalSection
*wxPendingEventsLocker
= (wxCriticalSection
*)NULL
;
144 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
146 // common event types are defined here, other event types are defined by the
147 // components which use them
149 const wxEventType wxEVT_FIRST
= 10000;
150 const wxEventType wxEVT_USER_FIRST
= wxEVT_FIRST
+ 2000;
152 DEFINE_EVENT_TYPE(wxEVT_NULL
)
153 DEFINE_EVENT_TYPE(wxEVT_IDLE
)
154 DEFINE_EVENT_TYPE(wxEVT_SOCKET
)
156 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
162 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
164 DEFINE_EVENT_TYPE(wxEVT_COMMAND_BUTTON_CLICKED
)
165 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKBOX_CLICKED
)
166 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHOICE_SELECTED
)
167 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_SELECTED
)
168 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
)
169 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
)
170 DEFINE_EVENT_TYPE(wxEVT_COMMAND_MENU_SELECTED
)
171 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SLIDER_UPDATED
)
172 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBOX_SELECTED
)
173 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBUTTON_SELECTED
)
174 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SCROLLBAR_UPDATED
)
175 DEFINE_EVENT_TYPE(wxEVT_COMMAND_VLBOX_SELECTED
)
176 DEFINE_EVENT_TYPE(wxEVT_COMMAND_COMBOBOX_SELECTED
)
177 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED
)
178 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER
)
179 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED
)
181 // Sockets and timers send events, too
182 DEFINE_EVENT_TYPE(wxEVT_TIMER
)
185 DEFINE_EVENT_TYPE(wxEVT_LEFT_DOWN
)
186 DEFINE_EVENT_TYPE(wxEVT_LEFT_UP
)
187 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DOWN
)
188 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_UP
)
189 DEFINE_EVENT_TYPE(wxEVT_RIGHT_DOWN
)
190 DEFINE_EVENT_TYPE(wxEVT_RIGHT_UP
)
191 DEFINE_EVENT_TYPE(wxEVT_MOTION
)
192 DEFINE_EVENT_TYPE(wxEVT_ENTER_WINDOW
)
193 DEFINE_EVENT_TYPE(wxEVT_LEAVE_WINDOW
)
194 DEFINE_EVENT_TYPE(wxEVT_LEFT_DCLICK
)
195 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DCLICK
)
196 DEFINE_EVENT_TYPE(wxEVT_RIGHT_DCLICK
)
197 DEFINE_EVENT_TYPE(wxEVT_SET_FOCUS
)
198 DEFINE_EVENT_TYPE(wxEVT_KILL_FOCUS
)
199 DEFINE_EVENT_TYPE(wxEVT_CHILD_FOCUS
)
200 DEFINE_EVENT_TYPE(wxEVT_MOUSEWHEEL
)
202 // Non-client mouse events
203 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN
)
204 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_UP
)
205 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DOWN
)
206 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_UP
)
207 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DOWN
)
208 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_UP
)
209 DEFINE_EVENT_TYPE(wxEVT_NC_MOTION
)
210 DEFINE_EVENT_TYPE(wxEVT_NC_ENTER_WINDOW
)
211 DEFINE_EVENT_TYPE(wxEVT_NC_LEAVE_WINDOW
)
212 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DCLICK
)
213 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DCLICK
)
214 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DCLICK
)
216 // Character input event type
217 DEFINE_EVENT_TYPE(wxEVT_CHAR
)
218 DEFINE_EVENT_TYPE(wxEVT_CHAR_HOOK
)
219 DEFINE_EVENT_TYPE(wxEVT_NAVIGATION_KEY
)
220 DEFINE_EVENT_TYPE(wxEVT_KEY_DOWN
)
221 DEFINE_EVENT_TYPE(wxEVT_KEY_UP
)
223 DEFINE_EVENT_TYPE(wxEVT_HOTKEY
)
227 DEFINE_EVENT_TYPE(wxEVT_SET_CURSOR
)
229 // wxScrollbar and wxSlider event identifiers
230 DEFINE_EVENT_TYPE(wxEVT_SCROLL_TOP
)
231 DEFINE_EVENT_TYPE(wxEVT_SCROLL_BOTTOM
)
232 DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEUP
)
233 DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEDOWN
)
234 DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEUP
)
235 DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN
)
236 DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK
)
237 DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE
)
238 DEFINE_EVENT_TYPE(wxEVT_SCROLL_CHANGED
)
240 // Scroll events from wxWindow
241 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP
)
242 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_BOTTOM
)
243 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEUP
)
244 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEDOWN
)
245 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEUP
)
246 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEDOWN
)
247 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBTRACK
)
248 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBRELEASE
)
251 DEFINE_EVENT_TYPE(wxEVT_SIZE
)
252 DEFINE_EVENT_TYPE(wxEVT_SIZING
)
253 DEFINE_EVENT_TYPE(wxEVT_MOVE
)
254 DEFINE_EVENT_TYPE(wxEVT_MOVING
)
255 DEFINE_EVENT_TYPE(wxEVT_CLOSE_WINDOW
)
256 DEFINE_EVENT_TYPE(wxEVT_END_SESSION
)
257 DEFINE_EVENT_TYPE(wxEVT_QUERY_END_SESSION
)
258 DEFINE_EVENT_TYPE(wxEVT_HIBERNATE
)
259 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE_APP
)
260 DEFINE_EVENT_TYPE(wxEVT_POWER
)
261 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE
)
262 DEFINE_EVENT_TYPE(wxEVT_CREATE
)
263 DEFINE_EVENT_TYPE(wxEVT_DESTROY
)
264 DEFINE_EVENT_TYPE(wxEVT_SHOW
)
265 DEFINE_EVENT_TYPE(wxEVT_ICONIZE
)
266 DEFINE_EVENT_TYPE(wxEVT_MAXIMIZE
)
267 DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED
)
268 DEFINE_EVENT_TYPE(wxEVT_PAINT
)
269 DEFINE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND
)
270 DEFINE_EVENT_TYPE(wxEVT_NC_PAINT
)
271 DEFINE_EVENT_TYPE(wxEVT_PAINT_ICON
)
272 DEFINE_EVENT_TYPE(wxEVT_MENU_OPEN
)
273 DEFINE_EVENT_TYPE(wxEVT_MENU_CLOSE
)
274 DEFINE_EVENT_TYPE(wxEVT_MENU_HIGHLIGHT
)
275 DEFINE_EVENT_TYPE(wxEVT_CONTEXT_MENU
)
276 DEFINE_EVENT_TYPE(wxEVT_SYS_COLOUR_CHANGED
)
277 DEFINE_EVENT_TYPE(wxEVT_DISPLAY_CHANGED
)
278 DEFINE_EVENT_TYPE(wxEVT_SETTING_CHANGED
)
279 DEFINE_EVENT_TYPE(wxEVT_QUERY_NEW_PALETTE
)
280 DEFINE_EVENT_TYPE(wxEVT_PALETTE_CHANGED
)
281 DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_DOWN
)
282 DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_UP
)
283 DEFINE_EVENT_TYPE(wxEVT_JOY_MOVE
)
284 DEFINE_EVENT_TYPE(wxEVT_JOY_ZMOVE
)
285 DEFINE_EVENT_TYPE(wxEVT_DROP_FILES
)
286 DEFINE_EVENT_TYPE(wxEVT_DRAW_ITEM
)
287 DEFINE_EVENT_TYPE(wxEVT_MEASURE_ITEM
)
288 DEFINE_EVENT_TYPE(wxEVT_COMPARE_ITEM
)
289 DEFINE_EVENT_TYPE(wxEVT_INIT_DIALOG
)
290 DEFINE_EVENT_TYPE(wxEVT_UPDATE_UI
)
293 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_COPY
)
294 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_CUT
)
295 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_PASTE
)
297 // Generic command events
298 // Note: a click is a higher-level event than button down/up
299 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK
)
300 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_DCLICK
)
301 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_CLICK
)
302 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_DCLICK
)
303 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SET_FOCUS
)
304 DEFINE_EVENT_TYPE(wxEVT_COMMAND_KILL_FOCUS
)
305 DEFINE_EVENT_TYPE(wxEVT_COMMAND_ENTER
)
308 DEFINE_EVENT_TYPE(wxEVT_HELP
)
309 DEFINE_EVENT_TYPE(wxEVT_DETAILED_HELP
)
311 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
317 // ============================================================================
319 // ============================================================================
321 // ----------------------------------------------------------------------------
322 // event initialization
323 // ----------------------------------------------------------------------------
328 static int s_lastUsedEventType
= wxEVT_FIRST
;
330 return s_lastUsedEventType
++;
333 // ----------------------------------------------------------------------------
335 // ----------------------------------------------------------------------------
338 * General wxWidgets events, covering
339 * all interesting things that might happen (button clicking, resizing,
340 * setting text in widgets, etc.).
342 * For each completely new event type, derive a new event class.
346 wxEvent::wxEvent(int theId
, wxEventType commandType
)
348 m_eventType
= commandType
;
349 m_eventObject
= (wxObject
*) NULL
;
353 m_callbackUserData
= (wxObject
*) NULL
;
354 m_isCommandEvent
= false;
355 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
358 wxEvent::wxEvent(const wxEvent
&src
)
360 , m_eventObject(src
.m_eventObject
)
361 , m_eventType(src
.m_eventType
)
362 , m_timeStamp(src
.m_timeStamp
)
364 , m_callbackUserData(src
.m_callbackUserData
)
365 , m_propagationLevel(src
.m_propagationLevel
)
366 , m_skipped(src
.m_skipped
)
367 , m_isCommandEvent(src
.m_isCommandEvent
)
381 // 'this' : used in base member initializer list (for m_commandString)
382 #pragma warning(disable:4355)
385 wxCommandEvent::wxCommandEvent(wxEventType commandType
, int theId
)
386 : wxEvent(theId
, commandType
)
387 #if WXWIN_COMPATIBILITY_2_4
388 , m_commandString(this)
391 m_clientData
= (char *) NULL
;
392 m_clientObject
= (wxClientData
*) NULL
;
395 m_isCommandEvent
= true;
397 // the command events are propagated upwards by default
398 m_propagationLevel
= wxEVENT_PROPAGATE_MAX
;
402 #pragma warning(default:4355)
405 wxString
wxCommandEvent::GetString() const
407 if(m_eventType
!= wxEVT_COMMAND_TEXT_UPDATED
|| !m_eventObject
)
412 wxTextCtrl
*txt
= wxDynamicCast(m_eventObject
, wxTextCtrl
);
414 return txt
->GetValue();
416 #endif // wxUSE_TEXTCTRL
426 wxLongLong
wxUpdateUIEvent::sm_lastUpdate
= 0;
429 long wxUpdateUIEvent::sm_updateInterval
= 0;
431 wxUpdateUIMode
wxUpdateUIEvent::sm_updateMode
= wxUPDATE_UI_PROCESS_ALL
;
434 bool wxUpdateUIEvent::CanUpdate(wxWindowBase
*win
)
436 // Don't update if we've switched global updating off
437 // and this window doesn't support updates.
439 (GetMode() == wxUPDATE_UI_PROCESS_SPECIFIED
&&
440 ((win
->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES
) == 0)))
443 if (sm_updateInterval
== -1)
446 if (sm_updateInterval
== 0)
449 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
450 wxLongLong now
= wxGetLocalTimeMillis();
451 if (now
> (sm_lastUpdate
+ sm_updateInterval
))
458 // If we don't have wxStopWatch or wxLongLong, we
459 // should err on the safe side and update now anyway.
464 // Reset the update time to provide a delay until the next
465 // time we should update
466 void wxUpdateUIEvent::ResetUpdateTime()
468 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
469 if (sm_updateInterval
> 0)
471 wxLongLong now
= wxGetLocalTimeMillis();
472 if (now
> (sm_lastUpdate
+ sm_updateInterval
))
484 wxIdleMode
wxIdleEvent::sm_idleMode
= wxIDLE_PROCESS_ALL
;
486 // Can we send an idle event?
487 bool wxIdleEvent::CanSend(wxWindow
* win
)
489 // Don't update if we've switched global updating off
490 // and this window doesn't support updates.
492 (GetMode() == wxIDLE_PROCESS_SPECIFIED
&&
493 ((win
->GetExtraStyle() & wxWS_EX_PROCESS_IDLE
) == 0)))
503 wxScrollEvent::wxScrollEvent(wxEventType commandType
,
507 : wxCommandEvent(commandType
, id
)
509 m_extraLong
= orient
;
517 wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType
,
521 m_eventType
= commandType
;
522 m_extraLong
= orient
;
531 wxMouseEvent::wxMouseEvent(wxEventType commandType
)
533 m_eventType
= commandType
;
536 m_controlDown
= false;
540 m_middleDown
= false;
545 m_linesPerAction
= 0;
548 void wxMouseEvent::Assign(const wxMouseEvent
& event
)
550 m_eventType
= event
.m_eventType
;
555 m_leftDown
= event
.m_leftDown
;
556 m_middleDown
= event
.m_middleDown
;
557 m_rightDown
= event
.m_rightDown
;
559 m_controlDown
= event
.m_controlDown
;
560 m_shiftDown
= event
.m_shiftDown
;
561 m_altDown
= event
.m_altDown
;
562 m_metaDown
= event
.m_metaDown
;
564 m_wheelRotation
= event
.m_wheelRotation
;
565 m_wheelDelta
= event
.m_wheelDelta
;
566 m_linesPerAction
= event
.m_linesPerAction
;
569 // return true if was a button dclick event
570 bool wxMouseEvent::ButtonDClick(int but
) const
575 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
578 case wxMOUSE_BTN_ANY
:
579 return (LeftDClick() || MiddleDClick() || RightDClick());
581 case wxMOUSE_BTN_LEFT
:
584 case wxMOUSE_BTN_MIDDLE
:
585 return MiddleDClick();
587 case wxMOUSE_BTN_RIGHT
:
588 return RightDClick();
592 // return true if was a button down event
593 bool wxMouseEvent::ButtonDown(int but
) const
598 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
601 case wxMOUSE_BTN_ANY
:
602 return (LeftDown() || MiddleDown() || RightDown());
604 case wxMOUSE_BTN_LEFT
:
607 case wxMOUSE_BTN_MIDDLE
:
610 case wxMOUSE_BTN_RIGHT
:
615 // return true if was a button up event
616 bool wxMouseEvent::ButtonUp(int but
) const
621 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
624 case wxMOUSE_BTN_ANY
:
625 return (LeftUp() || MiddleUp() || RightUp());
627 case wxMOUSE_BTN_LEFT
:
630 case wxMOUSE_BTN_MIDDLE
:
633 case wxMOUSE_BTN_RIGHT
:
638 // return true if the given button is currently changing state
639 bool wxMouseEvent::Button(int but
) const
644 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
647 case wxMOUSE_BTN_ANY
:
648 return ButtonUp(wxMOUSE_BTN_ANY
) ||
649 ButtonDown(wxMOUSE_BTN_ANY
) ||
650 ButtonDClick(wxMOUSE_BTN_ANY
);
652 case wxMOUSE_BTN_LEFT
:
653 return LeftDown() || LeftUp() || LeftDClick();
655 case wxMOUSE_BTN_MIDDLE
:
656 return MiddleDown() || MiddleUp() || MiddleDClick();
658 case wxMOUSE_BTN_RIGHT
:
659 return RightDown() || RightUp() || RightDClick();
663 bool wxMouseEvent::ButtonIsDown(int but
) const
668 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonIsDown"));
671 case wxMOUSE_BTN_ANY
:
672 return LeftIsDown() || MiddleIsDown() || RightIsDown();
674 case wxMOUSE_BTN_LEFT
:
677 case wxMOUSE_BTN_MIDDLE
:
678 return MiddleIsDown();
680 case wxMOUSE_BTN_RIGHT
:
681 return RightIsDown();
685 int wxMouseEvent::GetButton() const
687 for ( int i
= 1; i
<= 3; i
++ )
695 return wxMOUSE_BTN_NONE
;
698 // Find the logical position of the event given the DC
699 wxPoint
wxMouseEvent::GetLogicalPosition(const wxDC
& dc
) const
701 wxPoint
pt(dc
.DeviceToLogicalX(m_x
), dc
.DeviceToLogicalY(m_y
));
711 wxKeyEvent::wxKeyEvent(wxEventType type
)
715 m_controlDown
= false;
725 wxKeyEvent::wxKeyEvent(const wxKeyEvent
& evt
)
731 m_keyCode
= evt
.m_keyCode
;
733 m_controlDown
= evt
.m_controlDown
;
734 m_shiftDown
= evt
.m_shiftDown
;
735 m_altDown
= evt
.m_altDown
;
736 m_metaDown
= evt
.m_metaDown
;
737 m_scanCode
= evt
.m_scanCode
;
738 m_rawCode
= evt
.m_rawCode
;
739 m_rawFlags
= evt
.m_rawFlags
;
742 m_uniChar
= evt
.m_uniChar
;
746 #if WXWIN_COMPATIBILITY_2_6
747 long wxKeyEvent::KeyCode() const
751 #endif // WXWIN_COMPATIBILITY_2_6
753 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow
*win
)
755 SetEventType(wxEVT_CREATE
);
759 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow
*win
)
761 SetEventType(wxEVT_DESTROY
);
765 wxChildFocusEvent::wxChildFocusEvent(wxWindow
*win
)
766 : wxCommandEvent(wxEVT_CHILD_FOCUS
)
771 // ----------------------------------------------------------------------------
773 // ----------------------------------------------------------------------------
776 wxHelpEvent::Origin
wxHelpEvent::GuessOrigin(Origin origin
)
778 if ( origin
== Origin_Unknown
)
780 // assume that the event comes from the help button if it's not from
781 // keyboard and that pressing F1 always results in the help event
782 origin
= wxGetKeyState(WXK_F1
) ? Origin_Keyboard
: Origin_HelpButton
;
793 // ----------------------------------------------------------------------------
795 // ----------------------------------------------------------------------------
797 static const int EVENT_TYPE_TABLE_INIT_SIZE
= 31; // Not too big not too small...
799 wxEventHashTable
* wxEventHashTable::sm_first
= NULL
;
801 wxEventHashTable::wxEventHashTable(const wxEventTable
&table
)
805 AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE
);
809 m_next
->m_previous
= this;
813 wxEventHashTable::~wxEventHashTable()
816 m_next
->m_previous
= m_previous
;
818 m_previous
->m_next
= m_next
;
819 if (sm_first
== this)
825 void wxEventHashTable::Clear()
828 for(i
= 0; i
< m_size
; i
++)
830 EventTypeTablePointer eTTnode
= m_eventTypeTable
[i
];
837 // Necessary in order to not invoke the
838 // overloaded delete operator when statics are cleaned up
839 if (m_eventTypeTable
)
840 delete[] m_eventTypeTable
;
842 m_eventTypeTable
= NULL
;
847 void wxEventHashTable::ClearAll()
849 wxEventHashTable
* table
= sm_first
;
853 table
= table
->m_next
;
857 bool wxEventHashTable::HandleEvent(wxEvent
&event
, wxEvtHandler
*self
)
862 m_rebuildHash
= false;
865 if (!m_eventTypeTable
)
868 // Find all entries for the given event type.
869 wxEventType eventType
= event
.GetEventType();
870 const EventTypeTablePointer eTTnode
= m_eventTypeTable
[eventType
% m_size
];
871 if (eTTnode
&& eTTnode
->eventType
== eventType
)
873 // Now start the search for an event handler
874 // that can handle an event with the given ID.
875 const wxEventTableEntryPointerArray
&
876 eventEntryTable
= eTTnode
->eventEntryTable
;
878 const size_t count
= eventEntryTable
.GetCount();
879 for (size_t n
= 0; n
< count
; n
++)
882 ProcessEventIfMatches(*eventEntryTable
[n
], self
, event
) )
892 void wxEventHashTable::InitHashTable()
894 // Loop over the event tables and all its base tables.
895 const wxEventTable
*table
= &m_table
;
898 // Retrieve all valid event handler entries
899 const wxEventTableEntry
*entry
= table
->entries
;
900 while (entry
->m_fn
!= 0)
902 // Add the event entry in the Hash.
908 table
= table
->baseTable
;
911 // Lets free some memory.
913 for(i
= 0; i
< m_size
; i
++)
915 EventTypeTablePointer eTTnode
= m_eventTypeTable
[i
];
918 eTTnode
->eventEntryTable
.Shrink();
923 void wxEventHashTable::AddEntry(const wxEventTableEntry
&entry
)
925 // This might happen 'accidentally' as the app is exiting
926 if (!m_eventTypeTable
)
929 EventTypeTablePointer
*peTTnode
= &m_eventTypeTable
[entry
.m_eventType
% m_size
];
930 EventTypeTablePointer eTTnode
= *peTTnode
;
934 if (eTTnode
->eventType
!= entry
.m_eventType
)
937 GrowEventTypeTable();
938 // Try again to add it.
945 eTTnode
= new EventTypeTable
;
946 eTTnode
->eventType
= entry
.m_eventType
;
950 // Fill all hash entries between entry.m_id and entry.m_lastId...
951 eTTnode
->eventEntryTable
.Add(&entry
);
954 void wxEventHashTable::AllocEventTypeTable(size_t size
)
956 m_eventTypeTable
= new EventTypeTablePointer
[size
];
957 memset((void *)m_eventTypeTable
, 0, sizeof(EventTypeTablePointer
)*size
);
961 void wxEventHashTable::GrowEventTypeTable()
963 size_t oldSize
= m_size
;
964 EventTypeTablePointer
*oldEventTypeTable
= m_eventTypeTable
;
966 // TODO: Search the most optimal grow sequence
967 AllocEventTypeTable(/* GetNextPrime(oldSize) */oldSize
*2+1);
969 for ( size_t i
= 0; i
< oldSize
; /* */ )
971 EventTypeTablePointer eTToldNode
= oldEventTypeTable
[i
];
974 EventTypeTablePointer
*peTTnode
= &m_eventTypeTable
[eTToldNode
->eventType
% m_size
];
975 EventTypeTablePointer eTTnode
= *peTTnode
;
977 // Check for collision, we don't want any.
980 GrowEventTypeTable();
981 continue; // Don't increment the counter,
982 // as we still need to add this element.
986 // Get the old value and put it in the new table.
987 *peTTnode
= oldEventTypeTable
[i
];
994 delete[] oldEventTypeTable
;
998 // ----------------------------------------------------------------------------
1000 // ----------------------------------------------------------------------------
1006 wxEvtHandler::wxEvtHandler()
1008 m_nextHandler
= (wxEvtHandler
*) NULL
;
1009 m_previousHandler
= (wxEvtHandler
*) NULL
;
1011 m_dynamicEvents
= (wxList
*) NULL
;
1012 m_pendingEvents
= (wxList
*) NULL
;
1014 # if !defined(__VISAGECPP__)
1015 m_eventsLocker
= new wxCriticalSection
;
1018 // no client data (yet)
1019 m_clientData
= NULL
;
1020 m_clientDataType
= wxClientData_None
;
1023 wxEvtHandler::~wxEvtHandler()
1025 // Takes itself out of the list of handlers
1026 if (m_previousHandler
)
1027 m_previousHandler
->m_nextHandler
= m_nextHandler
;
1030 m_nextHandler
->m_previousHandler
= m_previousHandler
;
1032 if (m_dynamicEvents
)
1034 wxList::iterator it
= m_dynamicEvents
->begin(),
1035 en
= m_dynamicEvents
->end();
1036 for (;it
!= en
; ++it
)
1038 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1039 wxEventTableEntry
*entry
= (wxEventTableEntry
*)*it
;
1040 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1041 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)*it
;
1042 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1044 if (entry
->m_callbackUserData
)
1045 delete entry
->m_callbackUserData
;
1048 delete m_dynamicEvents
;
1051 if (m_pendingEvents
)
1052 m_pendingEvents
->DeleteContents(true);
1053 delete m_pendingEvents
;
1056 # if !defined(__VISAGECPP__)
1057 delete m_eventsLocker
;
1060 // Remove us from wxPendingEvents if necessary.
1061 if(wxPendingEventsLocker
)
1062 wxENTER_CRIT_SECT(*wxPendingEventsLocker
);
1063 if ( wxPendingEvents
)
1065 // Delete all occurences of this from the list of pending events
1066 while (wxPendingEvents
->DeleteObject(this)) { } // Do nothing
1068 if(wxPendingEventsLocker
)
1069 wxLEAVE_CRIT_SECT(*wxPendingEventsLocker
);
1072 // we only delete object data, not untyped
1073 if ( m_clientDataType
== wxClientData_Object
)
1074 delete m_clientObject
;
1079 bool wxEvtHandler::ProcessThreadEvent(wxEvent
& event
)
1081 // check that we are really in a child thread
1082 wxASSERT_MSG( !wxThread::IsMain(),
1083 wxT("use ProcessEvent() in main thread") );
1085 AddPendingEvent(event
);
1090 void wxEvtHandler::ClearEventLocker()
1092 #if !defined(__VISAGECPP__)
1093 delete m_eventsLocker
;
1094 m_eventsLocker
= NULL
;
1098 #endif // wxUSE_THREADS
1100 void wxEvtHandler::AddPendingEvent(wxEvent
& event
)
1102 // 1) Add event to list of pending events of this event handler
1104 wxEvent
*eventCopy
= event
.Clone();
1106 // we must be able to copy the events here so the event class must
1107 // implement Clone() properly instead of just providing a NULL stab for it
1108 wxCHECK_RET( eventCopy
,
1109 _T("events of this type aren't supposed to be posted") );
1111 wxENTER_CRIT_SECT( Lock() );
1113 if ( !m_pendingEvents
)
1114 m_pendingEvents
= new wxList
;
1116 m_pendingEvents
->Append(eventCopy
);
1118 wxLEAVE_CRIT_SECT( Lock() );
1120 // 2) Add this event handler to list of event handlers that
1121 // have pending events.
1123 wxENTER_CRIT_SECT(*wxPendingEventsLocker
);
1125 if ( !wxPendingEvents
)
1126 wxPendingEvents
= new wxList
;
1127 wxPendingEvents
->Append(this);
1129 wxLEAVE_CRIT_SECT(*wxPendingEventsLocker
);
1131 // 3) Inform the system that new pending events are somewhere,
1132 // and that these should be processed in idle time.
1136 void wxEvtHandler::ProcessPendingEvents()
1138 // this method is only called by wxApp if this handler does have pending
1140 wxCHECK_RET( m_pendingEvents
,
1141 wxT("Please call wxApp::ProcessPendingEvents() instead") );
1143 wxENTER_CRIT_SECT( Lock() );
1145 // we leave the loop once we have processed all events that were present at
1146 // the start of ProcessPendingEvents because otherwise we could get into
1147 // infinite loop if the pending event handler execution resulted in another
1148 // event being posted
1149 size_t n
= m_pendingEvents
->size();
1150 for ( wxList::compatibility_iterator node
= m_pendingEvents
->GetFirst();
1152 node
= m_pendingEvents
->GetFirst() )
1154 wxEvent
*event
= (wxEvent
*)node
->GetData();
1156 // It's importan we remove event from list before processing it.
1157 // Else a nested event loop, for example from a modal dialog, might
1158 // process the same event again.
1159 m_pendingEvents
->Erase(node
);
1161 wxLEAVE_CRIT_SECT( Lock() );
1163 ProcessEvent(*event
);
1166 wxENTER_CRIT_SECT( Lock() );
1172 wxLEAVE_CRIT_SECT( Lock() );
1179 wxEvtHandler::ProcessEventIfMatches(const wxEventTableEntryBase
& entry
,
1180 wxEvtHandler
*handler
,
1183 int tableId1
= entry
.m_id
,
1184 tableId2
= entry
.m_lastId
;
1186 // match only if the event type is the same and the id is either -1 in
1187 // the event table (meaning "any") or the event id matches the id
1188 // specified in the event table either exactly or by falling into
1189 // range between first and last
1190 if ((tableId1
== wxID_ANY
) ||
1191 (tableId2
== wxID_ANY
&& tableId1
== event
.GetId()) ||
1192 (tableId2
!= wxID_ANY
&&
1193 (event
.GetId() >= tableId1
&& event
.GetId() <= tableId2
)))
1196 event
.m_callbackUserData
= entry
.m_callbackUserData
;
1198 #if wxUSE_EXCEPTIONS
1201 // call the handler via wxApp method which allows the user to catch
1202 // any exceptions which may be thrown by any handler in the program
1204 wxTheApp
->HandleEvent(handler
, (wxEventFunction
)entry
.m_fn
, event
);
1207 #endif // wxUSE_EXCEPTIONS
1209 // no need for an extra virtual function call
1210 (handler
->*((wxEventFunction
) (entry
.m_fn
)))(event
);
1213 if (!event
.GetSkipped())
1220 bool wxEvtHandler::TryParent(wxEvent
& event
)
1222 if ( wxTheApp
&& (this != wxTheApp
) )
1224 // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
1225 // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
1226 // processed appropriately via SearchEventTable.
1227 if ( event
.GetEventType() != wxEVT_IDLE
)
1229 if ( wxTheApp
->ProcessEvent(event
) )
1237 bool wxEvtHandler::ProcessEvent(wxEvent
& event
)
1239 // allow the application to hook into event processing
1242 int rc
= wxTheApp
->FilterEvent(event
);
1245 wxASSERT_MSG( rc
== 1 || rc
== 0,
1246 _T("unexpected wxApp::FilterEvent return value") );
1250 //else: proceed normally
1253 // An event handler can be enabled or disabled
1254 if ( GetEvtHandlerEnabled() )
1256 // if we have a validator, it has higher priority than our own event
1258 if ( TryValidator(event
) )
1261 // Handle per-instance dynamic event tables first
1262 if ( m_dynamicEvents
&& SearchDynamicEventTable(event
) )
1265 // Then static per-class event tables
1266 if ( GetEventHashTable().HandleEvent(event
, this) )
1270 // Try going down the event handler chain
1271 if ( GetNextHandler() )
1273 if ( GetNextHandler()->ProcessEvent(event
) )
1277 // Finally propagate the event upwards the window chain and/or to the
1278 // application object as necessary
1279 return TryParent(event
);
1283 bool wxEvtHandler::SearchEventTable(wxEventTable
& table
, wxEvent
& event
)
1285 const wxEventType eventType
= event
.GetEventType();
1286 for ( int i
= 0; table
.entries
[i
].m_fn
!= 0; i
++ )
1288 const wxEventTableEntry
& entry
= table
.entries
[i
];
1289 if ( eventType
== entry
.m_eventType
)
1291 if ( ProcessEventIfMatches(entry
, this, event
) )
1299 void wxEvtHandler::Connect( int id
, int lastId
,
1301 wxObjectEventFunction func
,
1303 wxEvtHandler
* eventSink
)
1305 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1306 wxEventTableEntry
*entry
= new wxEventTableEntry
;
1307 entry
->m_eventType
= eventType
;
1309 entry
->m_lastId
= lastId
;
1311 entry
->m_callbackUserData
= userData
;
1312 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1313 wxDynamicEventTableEntry
*entry
=
1314 new wxDynamicEventTableEntry(eventType
, id
, lastId
, func
, userData
, eventSink
);
1315 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1317 if (!m_dynamicEvents
)
1318 m_dynamicEvents
= new wxList
;
1320 // Insert at the front of the list so most recent additions are found first
1321 m_dynamicEvents
->Insert( (wxObject
*) entry
);
1324 bool wxEvtHandler::Disconnect( int id
, int lastId
, wxEventType eventType
,
1325 wxObjectEventFunction func
,
1327 wxEvtHandler
* eventSink
)
1329 if (!m_dynamicEvents
)
1332 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1335 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1336 wxEventTableEntry
*entry
= (wxEventTableEntry
*)node
->GetData();
1337 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1338 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1339 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1341 if ((entry
->m_id
== id
) &&
1342 ((entry
->m_lastId
== lastId
) || (lastId
== wxID_ANY
)) &&
1343 ((entry
->m_eventType
== eventType
) || (eventType
== wxEVT_NULL
)) &&
1344 ((entry
->m_fn
== func
) || (func
== (wxObjectEventFunction
)NULL
)) &&
1345 ((entry
->m_eventSink
== eventSink
) || (eventSink
== (wxEvtHandler
*)NULL
)) &&
1346 ((entry
->m_callbackUserData
== userData
) || (userData
== (wxObject
*)NULL
)))
1348 if (entry
->m_callbackUserData
)
1349 delete entry
->m_callbackUserData
;
1350 m_dynamicEvents
->Erase( node
);
1354 node
= node
->GetNext();
1359 bool wxEvtHandler::SearchDynamicEventTable( wxEvent
& event
)
1361 wxCHECK_MSG( m_dynamicEvents
, false,
1362 wxT("caller should check that we have dynamic events") );
1364 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1367 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1368 wxEventTableEntry
*entry
= (wxEventTableEntry
*)node
->GetData();
1369 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1370 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1371 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1373 // get next node before (maybe) calling the event handler as it could
1374 // call Disconnect() invalidating the current node
1375 node
= node
->GetNext();
1377 if ((event
.GetEventType() == entry
->m_eventType
) && (entry
->m_fn
!= 0))
1379 wxEvtHandler
*handler
=
1380 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
1381 entry
->m_eventSink
? entry
->m_eventSink
1386 if ( ProcessEventIfMatches(*entry
, handler
, event
) )
1396 void wxEvtHandler::DoSetClientObject( wxClientData
*data
)
1398 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1399 wxT("can't have both object and void client data") );
1401 if ( m_clientObject
)
1402 delete m_clientObject
;
1404 m_clientObject
= data
;
1405 m_clientDataType
= wxClientData_Object
;
1408 wxClientData
*wxEvtHandler::DoGetClientObject() const
1410 // it's not an error to call GetClientObject() on a window which doesn't
1411 // have client data at all - NULL will be returned
1412 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1413 wxT("this window doesn't have object client data") );
1415 return m_clientObject
;
1418 void wxEvtHandler::DoSetClientData( void *data
)
1420 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1421 wxT("can't have both object and void client data") );
1423 m_clientData
= data
;
1424 m_clientDataType
= wxClientData_Void
;
1427 void *wxEvtHandler::DoGetClientData() const
1429 // it's not an error to call GetClientData() on a window which doesn't have
1430 // client data at all - NULL will be returned
1431 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1432 wxT("this window doesn't have void client data") );
1434 return m_clientData
;
1437 #endif // wxUSE_BASE
1441 // Find a window with the focus, that is also a descendant of the given window.
1442 // This is used to determine the window to initially send commands to.
1443 wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
)
1445 // Process events starting with the window with the focus, if any.
1446 wxWindow
* focusWin
= wxWindow::FindFocus();
1447 wxWindow
* win
= focusWin
;
1449 // Check if this is a descendant of this frame.
1450 // If not, win will be set to NULL.
1453 if (win
== ancestor
)
1456 win
= win
->GetParent();
1458 if (win
== (wxWindow
*) NULL
)
1459 focusWin
= (wxWindow
*) NULL
;