1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Event classes
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
21 #pragma implementation "event.h"
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
37 #include "wx/control.h"
46 #include "wx/validate.h"
48 #include "wx/stopwatch.h"
52 // ----------------------------------------------------------------------------
54 // ----------------------------------------------------------------------------
57 IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler
, wxObject
)
58 IMPLEMENT_ABSTRACT_CLASS(wxEvent
, wxObject
)
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
)
101 const wxEventTable
*wxEvtHandler::GetEventTable() const
102 { return &wxEvtHandler::sm_eventTable
; }
104 const wxEventTable
wxEvtHandler::sm_eventTable
=
105 { (const wxEventTable
*)NULL
, &wxEvtHandler::sm_eventTableEntries
[0] };
107 wxEventHashTable
&wxEvtHandler::GetEventHashTable() const
108 { return wxEvtHandler::sm_eventHashTable
; }
110 wxEventHashTable
wxEvtHandler::sm_eventHashTable(wxEvtHandler::sm_eventTable
);
112 const wxEventTableEntry
wxEvtHandler::sm_eventTableEntries
[] =
113 { DECLARE_EVENT_TABLE_ENTRY(wxEVT_NULL
, 0, 0, (wxObjectEventFunction
)NULL
, NULL
) };
115 // ----------------------------------------------------------------------------
117 // ----------------------------------------------------------------------------
119 // To put pending event handlers
120 wxList
*wxPendingEvents
= (wxList
*)NULL
;
123 // protects wxPendingEvents list
124 wxCriticalSection
*wxPendingEventsLocker
= (wxCriticalSection
*)NULL
;
127 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
129 // common event types are defined here, other event types are defined by the
130 // components which use them
132 const wxEventType wxEVT_FIRST
= 10000;
133 const wxEventType wxEVT_USER_FIRST
= wxEVT_FIRST
+ 2000;
135 DEFINE_EVENT_TYPE(wxEVT_NULL
)
136 DEFINE_EVENT_TYPE(wxEVT_IDLE
)
137 DEFINE_EVENT_TYPE(wxEVT_SOCKET
)
139 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
145 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
147 DEFINE_EVENT_TYPE(wxEVT_COMMAND_BUTTON_CLICKED
)
148 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKBOX_CLICKED
)
149 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHOICE_SELECTED
)
150 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_SELECTED
)
151 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
)
152 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
)
153 DEFINE_EVENT_TYPE(wxEVT_COMMAND_MENU_SELECTED
)
154 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SLIDER_UPDATED
)
155 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBOX_SELECTED
)
156 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBUTTON_SELECTED
)
157 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SCROLLBAR_UPDATED
)
158 DEFINE_EVENT_TYPE(wxEVT_COMMAND_VLBOX_SELECTED
)
159 DEFINE_EVENT_TYPE(wxEVT_COMMAND_COMBOBOX_SELECTED
)
160 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED
)
161 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER
)
162 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED
)
164 // Sockets and timers send events, too
165 DEFINE_EVENT_TYPE(wxEVT_TIMER
)
168 DEFINE_EVENT_TYPE(wxEVT_LEFT_DOWN
)
169 DEFINE_EVENT_TYPE(wxEVT_LEFT_UP
)
170 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DOWN
)
171 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_UP
)
172 DEFINE_EVENT_TYPE(wxEVT_RIGHT_DOWN
)
173 DEFINE_EVENT_TYPE(wxEVT_RIGHT_UP
)
174 DEFINE_EVENT_TYPE(wxEVT_MOTION
)
175 DEFINE_EVENT_TYPE(wxEVT_ENTER_WINDOW
)
176 DEFINE_EVENT_TYPE(wxEVT_LEAVE_WINDOW
)
177 DEFINE_EVENT_TYPE(wxEVT_LEFT_DCLICK
)
178 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DCLICK
)
179 DEFINE_EVENT_TYPE(wxEVT_RIGHT_DCLICK
)
180 DEFINE_EVENT_TYPE(wxEVT_SET_FOCUS
)
181 DEFINE_EVENT_TYPE(wxEVT_KILL_FOCUS
)
182 DEFINE_EVENT_TYPE(wxEVT_CHILD_FOCUS
)
183 DEFINE_EVENT_TYPE(wxEVT_MOUSEWHEEL
)
185 // Non-client mouse events
186 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN
)
187 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_UP
)
188 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DOWN
)
189 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_UP
)
190 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DOWN
)
191 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_UP
)
192 DEFINE_EVENT_TYPE(wxEVT_NC_MOTION
)
193 DEFINE_EVENT_TYPE(wxEVT_NC_ENTER_WINDOW
)
194 DEFINE_EVENT_TYPE(wxEVT_NC_LEAVE_WINDOW
)
195 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DCLICK
)
196 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DCLICK
)
197 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DCLICK
)
199 // Character input event type
200 DEFINE_EVENT_TYPE(wxEVT_CHAR
)
201 DEFINE_EVENT_TYPE(wxEVT_CHAR_HOOK
)
202 DEFINE_EVENT_TYPE(wxEVT_NAVIGATION_KEY
)
203 DEFINE_EVENT_TYPE(wxEVT_KEY_DOWN
)
204 DEFINE_EVENT_TYPE(wxEVT_KEY_UP
)
206 DEFINE_EVENT_TYPE(wxEVT_HOTKEY
)
210 DEFINE_EVENT_TYPE(wxEVT_SET_CURSOR
)
212 // wxScrollbar and wxSlider event identifiers
213 DEFINE_EVENT_TYPE(wxEVT_SCROLL_TOP
)
214 DEFINE_EVENT_TYPE(wxEVT_SCROLL_BOTTOM
)
215 DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEUP
)
216 DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEDOWN
)
217 DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEUP
)
218 DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN
)
219 DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK
)
220 DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE
)
221 DEFINE_EVENT_TYPE(wxEVT_SCROLL_ENDSCROLL
)
223 // Scroll events from wxWindow
224 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP
)
225 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_BOTTOM
)
226 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEUP
)
227 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEDOWN
)
228 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEUP
)
229 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEDOWN
)
230 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBTRACK
)
231 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBRELEASE
)
234 DEFINE_EVENT_TYPE(wxEVT_SIZE
)
235 DEFINE_EVENT_TYPE(wxEVT_SIZING
)
236 DEFINE_EVENT_TYPE(wxEVT_MOVE
)
237 DEFINE_EVENT_TYPE(wxEVT_MOVING
)
238 DEFINE_EVENT_TYPE(wxEVT_CLOSE_WINDOW
)
239 DEFINE_EVENT_TYPE(wxEVT_END_SESSION
)
240 DEFINE_EVENT_TYPE(wxEVT_QUERY_END_SESSION
)
241 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE_APP
)
242 DEFINE_EVENT_TYPE(wxEVT_POWER
)
243 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE
)
244 DEFINE_EVENT_TYPE(wxEVT_CREATE
)
245 DEFINE_EVENT_TYPE(wxEVT_DESTROY
)
246 DEFINE_EVENT_TYPE(wxEVT_SHOW
)
247 DEFINE_EVENT_TYPE(wxEVT_ICONIZE
)
248 DEFINE_EVENT_TYPE(wxEVT_MAXIMIZE
)
249 DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED
)
250 DEFINE_EVENT_TYPE(wxEVT_PAINT
)
251 DEFINE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND
)
252 DEFINE_EVENT_TYPE(wxEVT_NC_PAINT
)
253 DEFINE_EVENT_TYPE(wxEVT_PAINT_ICON
)
254 DEFINE_EVENT_TYPE(wxEVT_MENU_OPEN
)
255 DEFINE_EVENT_TYPE(wxEVT_MENU_CLOSE
)
256 DEFINE_EVENT_TYPE(wxEVT_MENU_HIGHLIGHT
)
257 DEFINE_EVENT_TYPE(wxEVT_CONTEXT_MENU
)
258 DEFINE_EVENT_TYPE(wxEVT_SYS_COLOUR_CHANGED
)
259 DEFINE_EVENT_TYPE(wxEVT_DISPLAY_CHANGED
)
260 DEFINE_EVENT_TYPE(wxEVT_SETTING_CHANGED
)
261 DEFINE_EVENT_TYPE(wxEVT_QUERY_NEW_PALETTE
)
262 DEFINE_EVENT_TYPE(wxEVT_PALETTE_CHANGED
)
263 DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_DOWN
)
264 DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_UP
)
265 DEFINE_EVENT_TYPE(wxEVT_JOY_MOVE
)
266 DEFINE_EVENT_TYPE(wxEVT_JOY_ZMOVE
)
267 DEFINE_EVENT_TYPE(wxEVT_DROP_FILES
)
268 DEFINE_EVENT_TYPE(wxEVT_DRAW_ITEM
)
269 DEFINE_EVENT_TYPE(wxEVT_MEASURE_ITEM
)
270 DEFINE_EVENT_TYPE(wxEVT_COMPARE_ITEM
)
271 DEFINE_EVENT_TYPE(wxEVT_INIT_DIALOG
)
272 DEFINE_EVENT_TYPE(wxEVT_UPDATE_UI
)
274 // Generic command events
275 // Note: a click is a higher-level event than button down/up
276 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK
)
277 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_DCLICK
)
278 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_CLICK
)
279 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_DCLICK
)
280 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SET_FOCUS
)
281 DEFINE_EVENT_TYPE(wxEVT_COMMAND_KILL_FOCUS
)
282 DEFINE_EVENT_TYPE(wxEVT_COMMAND_ENTER
)
285 DEFINE_EVENT_TYPE(wxEVT_HELP
)
286 DEFINE_EVENT_TYPE(wxEVT_DETAILED_HELP
)
288 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
294 // ============================================================================
296 // ============================================================================
298 // ----------------------------------------------------------------------------
299 // event initialization
300 // ----------------------------------------------------------------------------
305 static int s_lastUsedEventType
= wxEVT_FIRST
;
307 #if WXWIN_COMPATIBILITY_2
308 // check that we don't overlap with the user-defined types: if it does
309 // happen, the best solution is probably to update the existing code to
310 // use wxNewEventType() instead of wxEVT_USER_FIRST
312 // due to the uncertainty
313 wxASSERT_MSG( s_lastUsedEventType
< wxEVT_USER_FIRST
- 1,
314 _T("possible event type conflict") );
315 #endif // WXWIN_COMPATIBILITY_2
317 return s_lastUsedEventType
++;
320 // ----------------------------------------------------------------------------
322 // ----------------------------------------------------------------------------
325 * General wxWindows events, covering
326 * all interesting things that might happen (button clicking, resizing,
327 * setting text in widgets, etc.).
329 * For each completely new event type, derive a new event class.
333 wxEvent::wxEvent(int theId
, wxEventType commandType
)
335 m_eventType
= commandType
;
336 m_eventObject
= (wxObject
*) NULL
;
340 m_callbackUserData
= (wxObject
*) NULL
;
341 m_isCommandEvent
= FALSE
;
344 wxEvent::wxEvent(const wxEvent
&src
)
346 , m_eventObject(src
.m_eventObject
)
347 , m_eventType(src
.m_eventType
)
348 , m_timeStamp(src
.m_timeStamp
)
350 , m_callbackUserData(src
.m_callbackUserData
)
351 , m_skipped(src
.m_skipped
)
352 , m_isCommandEvent(src
.m_isCommandEvent
)
365 wxCommandEvent::wxCommandEvent(wxEventType commandType
, int theId
)
366 : wxEvent(theId
, commandType
)
368 m_clientData
= (char *) NULL
;
369 m_clientObject
= (wxClientData
*) NULL
;
372 m_isCommandEvent
= TRUE
;
380 wxLongLong
wxUpdateUIEvent::sm_lastUpdate
= 0;
383 long wxUpdateUIEvent::sm_updateInterval
= 0;
385 wxUpdateUIMode
wxUpdateUIEvent::sm_updateMode
= wxUPDATE_UI_PROCESS_ALL
;
388 bool wxUpdateUIEvent::CanUpdate(wxWindow
* win
)
390 // Don't update if we've switched global updating off
391 // and this window doesn't support updates.
393 (GetMode() == wxUPDATE_UI_PROCESS_SPECIFIED
&&
394 ((win
->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES
) == 0)))
397 if (sm_updateInterval
== -1)
399 else if (sm_updateInterval
== 0)
403 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
404 wxLongLong now
= wxGetLocalTimeMillis();
405 if (now
> (sm_lastUpdate
+ sm_updateInterval
))
410 // If we don't have wxStopWatch or wxLongLong, we
411 // should err on the safe side and update now anyway.
418 // Reset the update time to provide a delay until the next
419 // time we should update
420 void wxUpdateUIEvent::ResetUpdateTime()
422 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
423 if (sm_updateInterval
> 0)
425 wxLongLong now
= wxGetLocalTimeMillis();
426 if (now
> (sm_lastUpdate
+ sm_updateInterval
))
438 wxIdleMode
wxIdleEvent::sm_idleMode
= wxIDLE_PROCESS_ALL
;
440 // Can we send an idle event?
441 bool wxIdleEvent::CanSend(wxWindow
* win
)
443 // Don't update if we've switched global updating off
444 // and this window doesn't support updates.
446 (GetMode() == wxIDLE_PROCESS_SPECIFIED
&&
447 ((win
->GetExtraStyle() & wxWS_EX_PROCESS_IDLE
) == 0)))
457 wxScrollEvent::wxScrollEvent(wxEventType commandType
,
461 : wxCommandEvent(commandType
, id
)
463 m_extraLong
= orient
;
471 wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType
,
475 m_eventType
= commandType
;
476 m_extraLong
= orient
;
485 wxMouseEvent::wxMouseEvent(wxEventType commandType
)
487 m_eventType
= commandType
;
490 m_controlDown
= FALSE
;
494 m_middleDown
= FALSE
;
499 m_linesPerAction
= 0;
502 void wxMouseEvent::Assign(const wxMouseEvent
& event
)
504 m_eventType
= event
.m_eventType
;
509 m_leftDown
= event
.m_leftDown
;
510 m_middleDown
= event
.m_middleDown
;
511 m_rightDown
= event
.m_rightDown
;
513 m_controlDown
= event
.m_controlDown
;
514 m_shiftDown
= event
.m_shiftDown
;
515 m_altDown
= event
.m_altDown
;
516 m_metaDown
= event
.m_metaDown
;
518 m_wheelRotation
= event
.m_wheelRotation
;
519 m_wheelDelta
= event
.m_wheelDelta
;
520 m_linesPerAction
= event
.m_linesPerAction
;
523 // True if was a button dclick event (1 = left, 2 = middle, 3 = right)
524 // or any button dclick event (but = -1)
525 bool wxMouseEvent::ButtonDClick(int but
) const
530 return (LeftDClick() || MiddleDClick() || RightDClick());
534 return MiddleDClick();
536 return RightDClick();
538 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
544 // True if was a button down event (1 = left, 2 = middle, 3 = right)
545 // or any button down event (but = -1)
546 bool wxMouseEvent::ButtonDown(int but
) const
551 return (LeftDown() || MiddleDown() || RightDown());
559 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
565 // True if was a button up event (1 = left, 2 = middle, 3 = right)
566 // or any button up event (but = -1)
567 bool wxMouseEvent::ButtonUp(int but
) const
572 return (LeftUp() || MiddleUp() || RightUp());
580 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
586 // True if the given button is currently changing state
587 bool wxMouseEvent::Button(int but
) const
592 return (ButtonUp(-1) || ButtonDown(-1) || ButtonDClick(-1));
594 return (LeftDown() || LeftUp() || LeftDClick());
596 return (MiddleDown() || MiddleUp() || MiddleDClick());
598 return (RightDown() || RightUp() || RightDClick());
600 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
606 bool wxMouseEvent::ButtonIsDown(int but
) const
611 return (LeftIsDown() || MiddleIsDown() || RightIsDown());
615 return MiddleIsDown();
617 return RightIsDown();
619 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonIsDown"));
625 int wxMouseEvent::GetButton() const
627 for ( int i
= 1; i
<= 3; i
++ )
638 // Find the logical position of the event given the DC
639 wxPoint
wxMouseEvent::GetLogicalPosition(const wxDC
& dc
) const
641 wxPoint
pt(dc
.DeviceToLogicalX(m_x
), dc
.DeviceToLogicalY(m_y
));
651 wxKeyEvent::wxKeyEvent(wxEventType type
)
655 m_controlDown
= FALSE
;
665 wxKeyEvent::wxKeyEvent(const wxKeyEvent
& evt
)
671 m_keyCode
= evt
.m_keyCode
;
673 m_controlDown
= evt
.m_controlDown
;
674 m_shiftDown
= evt
.m_shiftDown
;
675 m_altDown
= evt
.m_altDown
;
676 m_metaDown
= evt
.m_metaDown
;
677 m_scanCode
= evt
.m_scanCode
;
678 m_rawCode
= evt
.m_rawCode
;
679 m_rawFlags
= evt
.m_rawFlags
;
682 m_uniChar
= evt
.m_uniChar
;
686 long wxKeyEvent::KeyCode() const
691 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow
*win
)
693 SetEventType(wxEVT_CREATE
);
697 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow
*win
)
699 SetEventType(wxEVT_DESTROY
);
703 wxChildFocusEvent::wxChildFocusEvent(wxWindow
*win
)
704 : wxCommandEvent(wxEVT_CHILD_FOCUS
)
711 // ----------------------------------------------------------------------------
713 // ----------------------------------------------------------------------------
715 static const int EVENT_TYPE_TABLE_INIT_SIZE
= 31; // Not to big not to small...
717 wxEventHashTable::wxEventHashTable(const wxEventTable
&table
)
721 AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE
);
724 wxEventHashTable::~wxEventHashTable()
727 for(i
= 0; i
< m_size
; i
++)
729 EventTypeTablePointer eTTnode
= m_eventTypeTable
[i
];
736 delete[] m_eventTypeTable
;
739 bool wxEventHashTable::HandleEvent(wxEvent
&event
, wxEvtHandler
*self
)
744 m_rebuildHash
= FALSE
;
747 // Find all entries for the given event type.
748 wxEventType eventType
= event
.GetEventType();
749 const EventTypeTablePointer eTTnode
= m_eventTypeTable
[eventType
% m_size
];
750 if (eTTnode
&& eTTnode
->eventType
== eventType
)
752 // Now start the search for an event handler
753 // that can handle an event with the given ID.
754 int eventId
= event
.GetId();
755 const wxEventTableEntryPointerArray
&eventEntryTable
= eTTnode
->eventEntryTable
;
758 size_t count
= eventEntryTable
.GetCount();
759 for (n
= 0; n
< count
; n
++)
761 const wxEventTableEntry
* entry
= eventEntryTable
[n
];
762 int tableId1
= entry
->m_id
,
763 tableId2
= entry
->m_lastId
;
765 if ((tableId1
== -1) ||
766 (tableId2
== -1 && tableId1
== eventId
) ||
768 (eventId
>= tableId1
&& eventId
<= tableId2
)))
771 event
.m_callbackUserData
= entry
->m_callbackUserData
;
773 (self
->*((wxEventFunction
) (entry
->m_fn
)))(event
);
775 if (!event
.GetSkipped())
786 void wxEventHashTable::InitHashTable()
788 // Loop over the event tables and all its base tables.
789 const wxEventTable
*table
= &m_table
;
792 // Retrieve all valid event handler entries
793 const wxEventTableEntry
*entry
= table
->entries
;
794 while (entry
->m_fn
!= 0)
796 // Add the event entry in the Hash.
802 table
= table
->baseTable
;
805 // Lets free some memory.
807 for(i
= 0; i
< m_size
; i
++)
809 EventTypeTablePointer eTTnode
= m_eventTypeTable
[i
];
812 eTTnode
->eventEntryTable
.Shrink();
817 void wxEventHashTable::AddEntry(const wxEventTableEntry
&entry
)
819 EventTypeTablePointer
*peTTnode
= &m_eventTypeTable
[entry
.m_eventType
% m_size
];
820 EventTypeTablePointer eTTnode
= *peTTnode
;
824 if (eTTnode
->eventType
!= entry
.m_eventType
)
827 GrowEventTypeTable();
828 // Try again to add it.
835 eTTnode
= new EventTypeTable
;
836 eTTnode
->eventType
= entry
.m_eventType
;
840 // Fill all hash entries between entry.m_id and entry.m_lastId...
841 eTTnode
->eventEntryTable
.Add(&entry
);
844 void wxEventHashTable::AllocEventTypeTable(size_t size
)
846 m_eventTypeTable
= new EventTypeTablePointer
[size
];
847 memset((void *)m_eventTypeTable
, 0, sizeof(EventTypeTablePointer
)*size
);
851 void wxEventHashTable::GrowEventTypeTable()
853 size_t oldSize
= m_size
;
854 EventTypeTablePointer
*oldEventTypeTable
= m_eventTypeTable
;
856 // TODO: Search the most optimal grow sequence
857 AllocEventTypeTable(/* GetNextPrime(oldSize) */oldSize
*2+1);
859 for ( size_t i
= 0; i
< oldSize
; /* */ )
861 EventTypeTablePointer eTToldNode
= oldEventTypeTable
[i
];
864 EventTypeTablePointer
*peTTnode
= &m_eventTypeTable
[eTToldNode
->eventType
% m_size
];
865 EventTypeTablePointer eTTnode
= *peTTnode
;
867 // Check for collision, we don't want any.
870 GrowEventTypeTable();
871 continue; // Don't increment the counter,
872 // as we still need to add this element.
876 // Get the old value and put it in the new table.
877 *peTTnode
= oldEventTypeTable
[i
];
884 delete[] oldEventTypeTable
;
887 // ----------------------------------------------------------------------------
889 // ----------------------------------------------------------------------------
897 wxEvtHandler::wxEvtHandler()
899 m_nextHandler
= (wxEvtHandler
*) NULL
;
900 m_previousHandler
= (wxEvtHandler
*) NULL
;
902 m_dynamicEvents
= (wxList
*) NULL
;
903 m_pendingEvents
= (wxList
*) NULL
;
905 # if !defined(__VISAGECPP__)
906 m_eventsLocker
= new wxCriticalSection
;
909 // no client data (yet)
911 m_clientDataType
= wxClientData_None
;
914 wxEvtHandler::~wxEvtHandler()
916 // Takes itself out of the list of handlers
917 if (m_previousHandler
)
918 m_previousHandler
->m_nextHandler
= m_nextHandler
;
921 m_nextHandler
->m_previousHandler
= m_previousHandler
;
925 wxList::iterator it
= m_dynamicEvents
->begin(),
926 en
= m_dynamicEvents
->end();
927 for (;it
!= en
; ++it
)
929 #if WXWIN_COMPATIBILITY_EVENT_TYPES
930 wxEventTableEntry
*entry
= (wxEventTableEntry
*)*it
;
931 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
932 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)*it
;
933 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
935 if (entry
->m_callbackUserData
)
936 delete entry
->m_callbackUserData
;
939 delete m_dynamicEvents
;
942 delete m_pendingEvents
;
945 # if !defined(__VISAGECPP__)
946 delete m_eventsLocker
;
949 // Remove us from wxPendingEvents if necessary.
950 if(wxPendingEventsLocker
)
951 wxENTER_CRIT_SECT(*wxPendingEventsLocker
);
952 if ( wxPendingEvents
) {
953 wxPendingEvents
->DeleteObject(this);
955 if(wxPendingEventsLocker
)
956 wxLEAVE_CRIT_SECT(*wxPendingEventsLocker
);
959 // we only delete object data, not untyped
960 if ( m_clientDataType
== wxClientData_Object
)
961 delete m_clientObject
;
966 bool wxEvtHandler::ProcessThreadEvent(wxEvent
& event
)
968 // check that we are really in a child thread
969 wxASSERT_MSG( !wxThread::IsMain(),
970 wxT("use ProcessEvent() in main thread") );
972 AddPendingEvent(event
);
977 #endif // wxUSE_THREADS
979 void wxEvtHandler::AddPendingEvent(wxEvent
& event
)
981 // 1) Add event to list of pending events of this event handler
983 wxEvent
*eventCopy
= event
.Clone();
985 // we must be able to copy the events here so the event class must
986 // implement Clone() properly instead of just providing a NULL stab for it
987 wxCHECK_RET( eventCopy
,
988 _T("events of this type aren't supposed to be posted") );
990 #if defined(__VISAGECPP__)
991 wxENTER_CRIT_SECT( m_eventsLocker
);
993 wxENTER_CRIT_SECT( *m_eventsLocker
);
996 if ( !m_pendingEvents
)
997 m_pendingEvents
= new wxList
;
999 m_pendingEvents
->Append(eventCopy
);
1001 #if defined(__VISAGECPP__)
1002 wxLEAVE_CRIT_SECT( m_eventsLocker
);
1004 wxLEAVE_CRIT_SECT( *m_eventsLocker
);
1007 // 2) Add this event handler to list of event handlers that
1008 // have pending events.
1010 wxENTER_CRIT_SECT(*wxPendingEventsLocker
);
1012 if ( !wxPendingEvents
)
1013 wxPendingEvents
= new wxList
;
1014 wxPendingEvents
->Append(this);
1016 wxLEAVE_CRIT_SECT(*wxPendingEventsLocker
);
1018 // 3) Inform the system that new pending events are somwehere,
1019 // and that these should be processed in idle time.
1023 void wxEvtHandler::ProcessPendingEvents()
1025 #if defined(__VISAGECPP__)
1026 wxENTER_CRIT_SECT( m_eventsLocker
);
1028 wxENTER_CRIT_SECT( *m_eventsLocker
);
1031 wxList::compatibility_iterator node
= m_pendingEvents
->GetFirst();
1034 wxEvent
*event
= (wxEvent
*)node
->GetData();
1035 m_pendingEvents
->Erase(node
);
1037 // In ProcessEvent, new events might get added and
1038 // we can safely leave the crtical section here.
1039 #if defined(__VISAGECPP__)
1040 wxLEAVE_CRIT_SECT( m_eventsLocker
);
1042 wxLEAVE_CRIT_SECT( *m_eventsLocker
);
1044 ProcessEvent(*event
);
1046 #if defined(__VISAGECPP__)
1047 wxENTER_CRIT_SECT( m_eventsLocker
);
1049 wxENTER_CRIT_SECT( *m_eventsLocker
);
1052 node
= m_pendingEvents
->GetFirst();
1055 #if defined(__VISAGECPP__)
1056 wxLEAVE_CRIT_SECT( m_eventsLocker
);
1058 wxLEAVE_CRIT_SECT( *m_eventsLocker
);
1066 bool wxEvtHandler::TryParent(wxEvent
& event
)
1068 if ( wxTheApp
&& (this != wxTheApp
) )
1070 // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
1071 // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
1072 // processed appropriately via SearchEventTable.
1073 if ( event
.GetEventType() != wxEVT_IDLE
)
1075 if ( wxTheApp
->ProcessEvent(event
) )
1083 bool wxEvtHandler::ProcessEvent(wxEvent
& event
)
1085 // allow the application to hook into event processing
1088 int rc
= wxTheApp
->FilterEvent(event
);
1091 wxASSERT_MSG( rc
== 1 || rc
== 0,
1092 _T("unexpected wxApp::FilterEvent return value") );
1096 //else: proceed normally
1099 // An event handler can be enabled or disabled
1100 if ( GetEvtHandlerEnabled() )
1102 // if we have a validator, it has higher priority than our own event
1104 #if wxUSE_VALIDATORS
1105 if ( TryValidator(event
) )
1107 #endif // wxUSE_VALIDATORS
1109 // Handle per-instance dynamic event tables first
1110 if ( m_dynamicEvents
&& SearchDynamicEventTable(event
) )
1113 // Then static per-class event tables
1114 if ( GetEventHashTable().HandleEvent(event
, this) )
1118 // Try going down the event handler chain
1119 if ( GetNextHandler() )
1121 if ( GetNextHandler()->ProcessEvent(event
) )
1125 // Finally propagate the event upwards the window chain and/or to the
1126 // application object as necessary
1127 return TryParent(event
);
1131 bool wxEvtHandler::SearchEventTable(wxEventTable
& table
, wxEvent
& event
)
1133 wxEventType eventType
= event
.GetEventType();
1134 int eventId
= event
.GetId();
1136 // BC++ doesn't like testing for m_fn without != 0
1137 for ( int i
= 0; table
.entries
[i
].m_fn
!= 0; i
++ )
1139 // the line using reference exposes a bug in gcc: although it _seems_
1140 // to work, it leads to weird crashes later on during program
1143 wxEventTableEntry entry
= table
.entries
[i
];
1145 const wxEventTableEntry
& entry
= table
.entries
[i
];
1148 // match only if the event type is the same and the id is either -1 in
1149 // the event table (meaning "any") or the event id matches the id
1150 // specified in the event table either exactly or by falling into
1151 // range between first and last
1152 if ( eventType
== entry
.m_eventType
)
1154 int tableId1
= entry
.m_id
,
1155 tableId2
= entry
.m_lastId
;
1157 if ( (tableId1
== -1) ||
1158 (tableId2
== -1 && eventId
== tableId1
) ||
1160 (eventId
>= tableId1
&& eventId
<= tableId2
)) )
1163 event
.m_callbackUserData
= entry
.m_callbackUserData
;
1165 (this->*((wxEventFunction
) (entry
.m_fn
)))(event
);
1167 return !event
.GetSkipped();
1175 void wxEvtHandler::Connect( int id
, int lastId
,
1177 wxObjectEventFunction func
,
1179 wxEvtHandler
* eventSink
)
1181 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1182 wxEventTableEntry
*entry
= new wxEventTableEntry
;
1183 entry
->m_eventType
= eventType
;
1185 entry
->m_lastId
= lastId
;
1187 entry
->m_callbackUserData
= userData
;
1188 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1189 wxDynamicEventTableEntry
*entry
=
1190 new wxDynamicEventTableEntry(eventType
, id
, lastId
, func
, userData
, eventSink
);
1191 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1193 if (!m_dynamicEvents
)
1194 m_dynamicEvents
= new wxList
;
1196 // Insert at the front of the list so most recent additions are found first
1197 m_dynamicEvents
->Insert( (wxObject
*) entry
);
1200 bool wxEvtHandler::Disconnect( int id
, int lastId
, wxEventType eventType
,
1201 wxObjectEventFunction func
,
1203 wxEvtHandler
* eventSink
)
1205 if (!m_dynamicEvents
)
1208 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1211 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1212 wxEventTableEntry
*entry
= (wxEventTableEntry
*)node
->GetData();
1213 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1214 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1215 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1217 if ((entry
->m_id
== id
) &&
1218 ((entry
->m_lastId
== lastId
) || (lastId
== -1)) &&
1219 ((entry
->m_eventType
== eventType
) || (eventType
== wxEVT_NULL
)) &&
1220 ((entry
->m_fn
== func
) || (func
== (wxObjectEventFunction
)NULL
)) &&
1221 ((entry
->m_eventSink
== eventSink
) || (eventSink
== (wxEvtHandler
*)NULL
)) &&
1222 ((entry
->m_callbackUserData
== userData
) || (userData
== (wxObject
*)NULL
)))
1224 if (entry
->m_callbackUserData
)
1225 delete entry
->m_callbackUserData
;
1226 m_dynamicEvents
->Erase( node
);
1230 node
= node
->GetNext();
1235 bool wxEvtHandler::SearchDynamicEventTable( wxEvent
& event
)
1237 wxCHECK_MSG( m_dynamicEvents
, FALSE
,
1238 wxT("caller should check that we have dynamic events") );
1240 int commandId
= event
.GetId();
1242 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1245 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1246 wxEventTableEntry
*entry
= (wxEventTableEntry
*)node
->GetData();
1247 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1248 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1249 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1253 // Match, if event spec says any id will do (id == -1)
1254 if ( (event
.GetEventType() == entry
->m_eventType
) &&
1255 (entry
->m_id
== -1 ||
1256 (entry
->m_lastId
== -1 && commandId
== entry
->m_id
) ||
1257 (entry
->m_lastId
!= -1 &&
1258 (commandId
>= entry
->m_id
&& commandId
<= entry
->m_lastId
))) )
1261 event
.m_callbackUserData
= entry
->m_callbackUserData
;
1263 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
1264 if (entry
->m_eventSink
)
1265 ((entry
->m_eventSink
)->*((wxEventFunction
) (entry
->m_fn
)))(event
);
1268 (this->*((wxEventFunction
) (entry
->m_fn
)))(event
);
1270 if ( ! event
.GetSkipped() )
1274 node
= node
->GetNext();
1279 void wxEvtHandler::DoSetClientObject( wxClientData
*data
)
1281 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1282 wxT("can't have both object and void client data") );
1284 if ( m_clientObject
)
1285 delete m_clientObject
;
1287 m_clientObject
= data
;
1288 m_clientDataType
= wxClientData_Object
;
1291 wxClientData
*wxEvtHandler::DoGetClientObject() const
1293 // it's not an error to call GetClientObject() on a window which doesn't
1294 // have client data at all - NULL will be returned
1295 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1296 wxT("this window doesn't have object client data") );
1298 return m_clientObject
;
1301 void wxEvtHandler::DoSetClientData( void *data
)
1303 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1304 wxT("can't have both object and void client data") );
1306 m_clientData
= data
;
1307 m_clientDataType
= wxClientData_Void
;
1310 void *wxEvtHandler::DoGetClientData() const
1312 // it's not an error to call GetClientData() on a window which doesn't have
1313 // client data at all - NULL will be returned
1314 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1315 wxT("this window doesn't have void client data") );
1317 return m_clientData
;
1321 #if WXWIN_COMPATIBILITY
1322 bool wxEvtHandler::OnClose()
1324 if (GetNextHandler())
1325 return GetNextHandler()->OnClose();
1329 #endif // WXWIN_COMPATIBILITY
1331 #endif // wxUSE_BASE
1335 // Find a window with the focus, that is also a descendant of the given window.
1336 // This is used to determine the window to initially send commands to.
1337 wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
)
1339 // Process events starting with the window with the focus, if any.
1340 wxWindow
* focusWin
= wxWindow::FindFocus();
1341 wxWindow
* win
= focusWin
;
1343 // Check if this is a descendant of this frame.
1344 // If not, win will be set to NULL.
1347 if (win
== ancestor
)
1350 win
= win
->GetParent();
1352 if (win
== (wxWindow
*) NULL
)
1353 focusWin
= (wxWindow
*) NULL
;