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
)
99 const wxEventTable
*wxEvtHandler::GetEventTable() const
100 { return &wxEvtHandler::sm_eventTable
; }
102 const wxEventTable
wxEvtHandler::sm_eventTable
=
103 { (const wxEventTable
*)NULL
, &wxEvtHandler::sm_eventTableEntries
[0] };
105 wxEventHashTable
&wxEvtHandler::GetEventHashTable() const
106 { return wxEvtHandler::sm_eventHashTable
; }
108 wxEventHashTable
wxEvtHandler::sm_eventHashTable(wxEvtHandler::sm_eventTable
);
110 const wxEventTableEntry
wxEvtHandler::sm_eventTableEntries
[] =
111 { DECLARE_EVENT_TABLE_ENTRY(wxEVT_NULL
, 0, 0, (wxObjectEventFunction
)NULL
, NULL
) };
115 // Clear up event hash table contents or we can get problems
116 // when C++ is cleaning up the static object
117 class wxEventTableEntryModule
: public wxModule
119 DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule
)
121 wxEventTableEntryModule() {}
122 bool OnInit() { return true; }
125 wxEventHashTable::ClearAll();
128 IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule
, wxModule
)
131 // ----------------------------------------------------------------------------
133 // ----------------------------------------------------------------------------
135 // To put pending event handlers
136 wxList
*wxPendingEvents
= (wxList
*)NULL
;
139 // protects wxPendingEvents list
140 wxCriticalSection
*wxPendingEventsLocker
= (wxCriticalSection
*)NULL
;
143 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
145 // common event types are defined here, other event types are defined by the
146 // components which use them
148 const wxEventType wxEVT_FIRST
= 10000;
149 const wxEventType wxEVT_USER_FIRST
= wxEVT_FIRST
+ 2000;
151 DEFINE_EVENT_TYPE(wxEVT_NULL
)
152 DEFINE_EVENT_TYPE(wxEVT_IDLE
)
153 DEFINE_EVENT_TYPE(wxEVT_SOCKET
)
155 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
161 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
163 DEFINE_EVENT_TYPE(wxEVT_COMMAND_BUTTON_CLICKED
)
164 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKBOX_CLICKED
)
165 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHOICE_SELECTED
)
166 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_SELECTED
)
167 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
)
168 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
)
169 DEFINE_EVENT_TYPE(wxEVT_COMMAND_MENU_SELECTED
)
170 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SLIDER_UPDATED
)
171 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBOX_SELECTED
)
172 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBUTTON_SELECTED
)
173 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SCROLLBAR_UPDATED
)
174 DEFINE_EVENT_TYPE(wxEVT_COMMAND_VLBOX_SELECTED
)
175 DEFINE_EVENT_TYPE(wxEVT_COMMAND_COMBOBOX_SELECTED
)
176 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED
)
177 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER
)
178 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED
)
180 // Sockets and timers send events, too
181 DEFINE_EVENT_TYPE(wxEVT_TIMER
)
184 DEFINE_EVENT_TYPE(wxEVT_LEFT_DOWN
)
185 DEFINE_EVENT_TYPE(wxEVT_LEFT_UP
)
186 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DOWN
)
187 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_UP
)
188 DEFINE_EVENT_TYPE(wxEVT_RIGHT_DOWN
)
189 DEFINE_EVENT_TYPE(wxEVT_RIGHT_UP
)
190 DEFINE_EVENT_TYPE(wxEVT_MOTION
)
191 DEFINE_EVENT_TYPE(wxEVT_ENTER_WINDOW
)
192 DEFINE_EVENT_TYPE(wxEVT_LEAVE_WINDOW
)
193 DEFINE_EVENT_TYPE(wxEVT_LEFT_DCLICK
)
194 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DCLICK
)
195 DEFINE_EVENT_TYPE(wxEVT_RIGHT_DCLICK
)
196 DEFINE_EVENT_TYPE(wxEVT_SET_FOCUS
)
197 DEFINE_EVENT_TYPE(wxEVT_KILL_FOCUS
)
198 DEFINE_EVENT_TYPE(wxEVT_CHILD_FOCUS
)
199 DEFINE_EVENT_TYPE(wxEVT_MOUSEWHEEL
)
201 // Non-client mouse events
202 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN
)
203 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_UP
)
204 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DOWN
)
205 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_UP
)
206 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DOWN
)
207 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_UP
)
208 DEFINE_EVENT_TYPE(wxEVT_NC_MOTION
)
209 DEFINE_EVENT_TYPE(wxEVT_NC_ENTER_WINDOW
)
210 DEFINE_EVENT_TYPE(wxEVT_NC_LEAVE_WINDOW
)
211 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DCLICK
)
212 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DCLICK
)
213 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DCLICK
)
215 // Character input event type
216 DEFINE_EVENT_TYPE(wxEVT_CHAR
)
217 DEFINE_EVENT_TYPE(wxEVT_CHAR_HOOK
)
218 DEFINE_EVENT_TYPE(wxEVT_NAVIGATION_KEY
)
219 DEFINE_EVENT_TYPE(wxEVT_KEY_DOWN
)
220 DEFINE_EVENT_TYPE(wxEVT_KEY_UP
)
222 DEFINE_EVENT_TYPE(wxEVT_HOTKEY
)
226 DEFINE_EVENT_TYPE(wxEVT_SET_CURSOR
)
228 // wxScrollbar and wxSlider event identifiers
229 DEFINE_EVENT_TYPE(wxEVT_SCROLL_TOP
)
230 DEFINE_EVENT_TYPE(wxEVT_SCROLL_BOTTOM
)
231 DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEUP
)
232 DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEDOWN
)
233 DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEUP
)
234 DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN
)
235 DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK
)
236 DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE
)
237 DEFINE_EVENT_TYPE(wxEVT_SCROLL_CHANGED
)
239 // Scroll events from wxWindow
240 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP
)
241 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_BOTTOM
)
242 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEUP
)
243 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEDOWN
)
244 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEUP
)
245 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEDOWN
)
246 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBTRACK
)
247 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBRELEASE
)
250 DEFINE_EVENT_TYPE(wxEVT_SIZE
)
251 DEFINE_EVENT_TYPE(wxEVT_SIZING
)
252 DEFINE_EVENT_TYPE(wxEVT_MOVE
)
253 DEFINE_EVENT_TYPE(wxEVT_MOVING
)
254 DEFINE_EVENT_TYPE(wxEVT_CLOSE_WINDOW
)
255 DEFINE_EVENT_TYPE(wxEVT_END_SESSION
)
256 DEFINE_EVENT_TYPE(wxEVT_QUERY_END_SESSION
)
257 DEFINE_EVENT_TYPE(wxEVT_HIBERNATE
)
258 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE_APP
)
259 DEFINE_EVENT_TYPE(wxEVT_POWER
)
260 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE
)
261 DEFINE_EVENT_TYPE(wxEVT_CREATE
)
262 DEFINE_EVENT_TYPE(wxEVT_DESTROY
)
263 DEFINE_EVENT_TYPE(wxEVT_SHOW
)
264 DEFINE_EVENT_TYPE(wxEVT_ICONIZE
)
265 DEFINE_EVENT_TYPE(wxEVT_MAXIMIZE
)
266 DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED
)
267 DEFINE_EVENT_TYPE(wxEVT_PAINT
)
268 DEFINE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND
)
269 DEFINE_EVENT_TYPE(wxEVT_NC_PAINT
)
270 DEFINE_EVENT_TYPE(wxEVT_PAINT_ICON
)
271 DEFINE_EVENT_TYPE(wxEVT_MENU_OPEN
)
272 DEFINE_EVENT_TYPE(wxEVT_MENU_CLOSE
)
273 DEFINE_EVENT_TYPE(wxEVT_MENU_HIGHLIGHT
)
274 DEFINE_EVENT_TYPE(wxEVT_CONTEXT_MENU
)
275 DEFINE_EVENT_TYPE(wxEVT_SYS_COLOUR_CHANGED
)
276 DEFINE_EVENT_TYPE(wxEVT_DISPLAY_CHANGED
)
277 DEFINE_EVENT_TYPE(wxEVT_SETTING_CHANGED
)
278 DEFINE_EVENT_TYPE(wxEVT_QUERY_NEW_PALETTE
)
279 DEFINE_EVENT_TYPE(wxEVT_PALETTE_CHANGED
)
280 DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_DOWN
)
281 DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_UP
)
282 DEFINE_EVENT_TYPE(wxEVT_JOY_MOVE
)
283 DEFINE_EVENT_TYPE(wxEVT_JOY_ZMOVE
)
284 DEFINE_EVENT_TYPE(wxEVT_DROP_FILES
)
285 DEFINE_EVENT_TYPE(wxEVT_DRAW_ITEM
)
286 DEFINE_EVENT_TYPE(wxEVT_MEASURE_ITEM
)
287 DEFINE_EVENT_TYPE(wxEVT_COMPARE_ITEM
)
288 DEFINE_EVENT_TYPE(wxEVT_INIT_DIALOG
)
289 DEFINE_EVENT_TYPE(wxEVT_UPDATE_UI
)
291 // Generic command events
292 // Note: a click is a higher-level event than button down/up
293 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK
)
294 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_DCLICK
)
295 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_CLICK
)
296 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_DCLICK
)
297 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SET_FOCUS
)
298 DEFINE_EVENT_TYPE(wxEVT_COMMAND_KILL_FOCUS
)
299 DEFINE_EVENT_TYPE(wxEVT_COMMAND_ENTER
)
302 DEFINE_EVENT_TYPE(wxEVT_HELP
)
303 DEFINE_EVENT_TYPE(wxEVT_DETAILED_HELP
)
305 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
311 // ============================================================================
313 // ============================================================================
315 // ----------------------------------------------------------------------------
316 // event initialization
317 // ----------------------------------------------------------------------------
322 static int s_lastUsedEventType
= wxEVT_FIRST
;
324 return s_lastUsedEventType
++;
327 // ----------------------------------------------------------------------------
329 // ----------------------------------------------------------------------------
332 * General wxWidgets events, covering
333 * all interesting things that might happen (button clicking, resizing,
334 * setting text in widgets, etc.).
336 * For each completely new event type, derive a new event class.
340 wxEvent::wxEvent(int theId
, wxEventType commandType
)
342 m_eventType
= commandType
;
343 m_eventObject
= (wxObject
*) NULL
;
347 m_callbackUserData
= (wxObject
*) NULL
;
348 m_isCommandEvent
= false;
349 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
352 wxEvent::wxEvent(const wxEvent
&src
)
354 , m_eventObject(src
.m_eventObject
)
355 , m_eventType(src
.m_eventType
)
356 , m_timeStamp(src
.m_timeStamp
)
358 , m_callbackUserData(src
.m_callbackUserData
)
359 , m_propagationLevel(src
.m_propagationLevel
)
360 , m_skipped(src
.m_skipped
)
361 , m_isCommandEvent(src
.m_isCommandEvent
)
375 // 'this' : used in base member initializer list (for m_commandString)
376 #pragma warning(disable:4355)
379 wxCommandEvent::wxCommandEvent(wxEventType commandType
, int theId
)
380 : wxEvent(theId
, commandType
)
381 #if WXWIN_COMPATIBILITY_2_4
382 , m_commandString(this)
385 m_clientData
= (char *) NULL
;
386 m_clientObject
= (wxClientData
*) NULL
;
389 m_isCommandEvent
= true;
391 // the command events are propagated upwards by default
392 m_propagationLevel
= wxEVENT_PROPAGATE_MAX
;
396 #pragma warning(default:4355)
399 wxString
wxCommandEvent::GetString() const
401 if(m_eventType
!= wxEVT_COMMAND_TEXT_UPDATED
|| !m_eventObject
)
406 wxTextCtrl
*txt
= wxDynamicCast(m_eventObject
, wxTextCtrl
);
408 return txt
->GetValue();
410 #endif // wxUSE_TEXTCTRL
420 wxLongLong
wxUpdateUIEvent::sm_lastUpdate
= 0;
423 long wxUpdateUIEvent::sm_updateInterval
= 0;
425 wxUpdateUIMode
wxUpdateUIEvent::sm_updateMode
= wxUPDATE_UI_PROCESS_ALL
;
428 bool wxUpdateUIEvent::CanUpdate(wxWindowBase
*win
)
430 // Don't update if we've switched global updating off
431 // and this window doesn't support updates.
433 (GetMode() == wxUPDATE_UI_PROCESS_SPECIFIED
&&
434 ((win
->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES
) == 0)))
437 if (sm_updateInterval
== -1)
440 if (sm_updateInterval
== 0)
443 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
444 wxLongLong now
= wxGetLocalTimeMillis();
445 if (now
> (sm_lastUpdate
+ sm_updateInterval
))
452 // If we don't have wxStopWatch or wxLongLong, we
453 // should err on the safe side and update now anyway.
458 // Reset the update time to provide a delay until the next
459 // time we should update
460 void wxUpdateUIEvent::ResetUpdateTime()
462 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
463 if (sm_updateInterval
> 0)
465 wxLongLong now
= wxGetLocalTimeMillis();
466 if (now
> (sm_lastUpdate
+ sm_updateInterval
))
478 wxIdleMode
wxIdleEvent::sm_idleMode
= wxIDLE_PROCESS_ALL
;
480 // Can we send an idle event?
481 bool wxIdleEvent::CanSend(wxWindow
* win
)
483 // Don't update if we've switched global updating off
484 // and this window doesn't support updates.
486 (GetMode() == wxIDLE_PROCESS_SPECIFIED
&&
487 ((win
->GetExtraStyle() & wxWS_EX_PROCESS_IDLE
) == 0)))
497 wxScrollEvent::wxScrollEvent(wxEventType commandType
,
501 : wxCommandEvent(commandType
, id
)
503 m_extraLong
= orient
;
511 wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType
,
515 m_eventType
= commandType
;
516 m_extraLong
= orient
;
525 wxMouseEvent::wxMouseEvent(wxEventType commandType
)
527 m_eventType
= commandType
;
530 m_controlDown
= false;
534 m_middleDown
= false;
539 m_linesPerAction
= 0;
542 void wxMouseEvent::Assign(const wxMouseEvent
& event
)
544 m_eventType
= event
.m_eventType
;
549 m_leftDown
= event
.m_leftDown
;
550 m_middleDown
= event
.m_middleDown
;
551 m_rightDown
= event
.m_rightDown
;
553 m_controlDown
= event
.m_controlDown
;
554 m_shiftDown
= event
.m_shiftDown
;
555 m_altDown
= event
.m_altDown
;
556 m_metaDown
= event
.m_metaDown
;
558 m_wheelRotation
= event
.m_wheelRotation
;
559 m_wheelDelta
= event
.m_wheelDelta
;
560 m_linesPerAction
= event
.m_linesPerAction
;
563 // return true if was a button dclick event
564 bool wxMouseEvent::ButtonDClick(int but
) const
569 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
572 case wxMOUSE_BTN_ANY
:
573 return (LeftDClick() || MiddleDClick() || RightDClick());
575 case wxMOUSE_BTN_LEFT
:
578 case wxMOUSE_BTN_MIDDLE
:
579 return MiddleDClick();
581 case wxMOUSE_BTN_RIGHT
:
582 return RightDClick();
586 // return true if was a button down event
587 bool wxMouseEvent::ButtonDown(int but
) const
592 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
595 case wxMOUSE_BTN_ANY
:
596 return (LeftDown() || MiddleDown() || RightDown());
598 case wxMOUSE_BTN_LEFT
:
601 case wxMOUSE_BTN_MIDDLE
:
604 case wxMOUSE_BTN_RIGHT
:
609 // return true if was a button up event
610 bool wxMouseEvent::ButtonUp(int but
) const
615 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
618 case wxMOUSE_BTN_ANY
:
619 return (LeftUp() || MiddleUp() || RightUp());
621 case wxMOUSE_BTN_LEFT
:
624 case wxMOUSE_BTN_MIDDLE
:
627 case wxMOUSE_BTN_RIGHT
:
632 // return true if the given button is currently changing state
633 bool wxMouseEvent::Button(int but
) const
638 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
641 case wxMOUSE_BTN_ANY
:
642 return ButtonUp(wxMOUSE_BTN_ANY
) ||
643 ButtonDown(wxMOUSE_BTN_ANY
) ||
644 ButtonDClick(wxMOUSE_BTN_ANY
);
646 case wxMOUSE_BTN_LEFT
:
647 return LeftDown() || LeftUp() || LeftDClick();
649 case wxMOUSE_BTN_MIDDLE
:
650 return MiddleDown() || MiddleUp() || MiddleDClick();
652 case wxMOUSE_BTN_RIGHT
:
653 return RightDown() || RightUp() || RightDClick();
657 bool wxMouseEvent::ButtonIsDown(int but
) const
662 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonIsDown"));
665 case wxMOUSE_BTN_ANY
:
666 return LeftIsDown() || MiddleIsDown() || RightIsDown();
668 case wxMOUSE_BTN_LEFT
:
671 case wxMOUSE_BTN_MIDDLE
:
672 return MiddleIsDown();
674 case wxMOUSE_BTN_RIGHT
:
675 return RightIsDown();
679 int wxMouseEvent::GetButton() const
681 for ( int i
= 1; i
<= 3; i
++ )
689 return wxMOUSE_BTN_NONE
;
692 // Find the logical position of the event given the DC
693 wxPoint
wxMouseEvent::GetLogicalPosition(const wxDC
& dc
) const
695 wxPoint
pt(dc
.DeviceToLogicalX(m_x
), dc
.DeviceToLogicalY(m_y
));
705 wxKeyEvent::wxKeyEvent(wxEventType type
)
709 m_controlDown
= false;
719 wxKeyEvent::wxKeyEvent(const wxKeyEvent
& evt
)
725 m_keyCode
= evt
.m_keyCode
;
727 m_controlDown
= evt
.m_controlDown
;
728 m_shiftDown
= evt
.m_shiftDown
;
729 m_altDown
= evt
.m_altDown
;
730 m_metaDown
= evt
.m_metaDown
;
731 m_scanCode
= evt
.m_scanCode
;
732 m_rawCode
= evt
.m_rawCode
;
733 m_rawFlags
= evt
.m_rawFlags
;
736 m_uniChar
= evt
.m_uniChar
;
740 #if WXWIN_COMPATIBILITY_2_6
741 long wxKeyEvent::KeyCode() const
745 #endif // WXWIN_COMPATIBILITY_2_6
747 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow
*win
)
749 SetEventType(wxEVT_CREATE
);
753 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow
*win
)
755 SetEventType(wxEVT_DESTROY
);
759 wxChildFocusEvent::wxChildFocusEvent(wxWindow
*win
)
760 : wxCommandEvent(wxEVT_CHILD_FOCUS
)
770 // ----------------------------------------------------------------------------
772 // ----------------------------------------------------------------------------
774 static const int EVENT_TYPE_TABLE_INIT_SIZE
= 31; // Not too big not too small...
776 wxEventHashTable
* wxEventHashTable::sm_first
= NULL
;
778 wxEventHashTable::wxEventHashTable(const wxEventTable
&table
)
782 AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE
);
786 m_next
->m_previous
= this;
790 wxEventHashTable::~wxEventHashTable()
793 m_next
->m_previous
= m_previous
;
795 m_previous
->m_next
= m_next
;
796 if (sm_first
== this)
802 void wxEventHashTable::Clear()
805 for(i
= 0; i
< m_size
; i
++)
807 EventTypeTablePointer eTTnode
= m_eventTypeTable
[i
];
814 // Necessary in order to not invoke the
815 // overloaded delete operator when statics are cleaned up
816 if (m_eventTypeTable
)
817 delete[] m_eventTypeTable
;
819 m_eventTypeTable
= NULL
;
824 void wxEventHashTable::ClearAll()
826 wxEventHashTable
* table
= sm_first
;
830 table
= table
->m_next
;
834 bool wxEventHashTable::HandleEvent(wxEvent
&event
, wxEvtHandler
*self
)
839 m_rebuildHash
= false;
842 if (!m_eventTypeTable
)
845 // Find all entries for the given event type.
846 wxEventType eventType
= event
.GetEventType();
847 const EventTypeTablePointer eTTnode
= m_eventTypeTable
[eventType
% m_size
];
848 if (eTTnode
&& eTTnode
->eventType
== eventType
)
850 // Now start the search for an event handler
851 // that can handle an event with the given ID.
852 const wxEventTableEntryPointerArray
&
853 eventEntryTable
= eTTnode
->eventEntryTable
;
855 const size_t count
= eventEntryTable
.GetCount();
856 for (size_t n
= 0; n
< count
; n
++)
859 ProcessEventIfMatches(*eventEntryTable
[n
], self
, event
) )
869 void wxEventHashTable::InitHashTable()
871 // Loop over the event tables and all its base tables.
872 const wxEventTable
*table
= &m_table
;
875 // Retrieve all valid event handler entries
876 const wxEventTableEntry
*entry
= table
->entries
;
877 while (entry
->m_fn
!= 0)
879 // Add the event entry in the Hash.
885 table
= table
->baseTable
;
888 // Lets free some memory.
890 for(i
= 0; i
< m_size
; i
++)
892 EventTypeTablePointer eTTnode
= m_eventTypeTable
[i
];
895 eTTnode
->eventEntryTable
.Shrink();
900 void wxEventHashTable::AddEntry(const wxEventTableEntry
&entry
)
902 // This might happen 'accidentally' as the app is exiting
903 if (!m_eventTypeTable
)
906 EventTypeTablePointer
*peTTnode
= &m_eventTypeTable
[entry
.m_eventType
% m_size
];
907 EventTypeTablePointer eTTnode
= *peTTnode
;
911 if (eTTnode
->eventType
!= entry
.m_eventType
)
914 GrowEventTypeTable();
915 // Try again to add it.
922 eTTnode
= new EventTypeTable
;
923 eTTnode
->eventType
= entry
.m_eventType
;
927 // Fill all hash entries between entry.m_id and entry.m_lastId...
928 eTTnode
->eventEntryTable
.Add(&entry
);
931 void wxEventHashTable::AllocEventTypeTable(size_t size
)
933 m_eventTypeTable
= new EventTypeTablePointer
[size
];
934 memset((void *)m_eventTypeTable
, 0, sizeof(EventTypeTablePointer
)*size
);
938 void wxEventHashTable::GrowEventTypeTable()
940 size_t oldSize
= m_size
;
941 EventTypeTablePointer
*oldEventTypeTable
= m_eventTypeTable
;
943 // TODO: Search the most optimal grow sequence
944 AllocEventTypeTable(/* GetNextPrime(oldSize) */oldSize
*2+1);
946 for ( size_t i
= 0; i
< oldSize
; /* */ )
948 EventTypeTablePointer eTToldNode
= oldEventTypeTable
[i
];
951 EventTypeTablePointer
*peTTnode
= &m_eventTypeTable
[eTToldNode
->eventType
% m_size
];
952 EventTypeTablePointer eTTnode
= *peTTnode
;
954 // Check for collision, we don't want any.
957 GrowEventTypeTable();
958 continue; // Don't increment the counter,
959 // as we still need to add this element.
963 // Get the old value and put it in the new table.
964 *peTTnode
= oldEventTypeTable
[i
];
971 delete[] oldEventTypeTable
;
975 // ----------------------------------------------------------------------------
977 // ----------------------------------------------------------------------------
983 wxEvtHandler::wxEvtHandler()
985 m_nextHandler
= (wxEvtHandler
*) NULL
;
986 m_previousHandler
= (wxEvtHandler
*) NULL
;
988 m_dynamicEvents
= (wxList
*) NULL
;
989 m_pendingEvents
= (wxList
*) NULL
;
991 # if !defined(__VISAGECPP__)
992 m_eventsLocker
= new wxCriticalSection
;
995 // no client data (yet)
997 m_clientDataType
= wxClientData_None
;
1000 wxEvtHandler::~wxEvtHandler()
1002 // Takes itself out of the list of handlers
1003 if (m_previousHandler
)
1004 m_previousHandler
->m_nextHandler
= m_nextHandler
;
1007 m_nextHandler
->m_previousHandler
= m_previousHandler
;
1009 if (m_dynamicEvents
)
1011 wxList::iterator it
= m_dynamicEvents
->begin(),
1012 en
= m_dynamicEvents
->end();
1013 for (;it
!= en
; ++it
)
1015 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1016 wxEventTableEntry
*entry
= (wxEventTableEntry
*)*it
;
1017 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1018 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)*it
;
1019 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1021 if (entry
->m_callbackUserData
)
1022 delete entry
->m_callbackUserData
;
1025 delete m_dynamicEvents
;
1028 if (m_pendingEvents
)
1029 m_pendingEvents
->DeleteContents(true);
1030 delete m_pendingEvents
;
1033 # if !defined(__VISAGECPP__)
1034 delete m_eventsLocker
;
1037 // Remove us from wxPendingEvents if necessary.
1038 if(wxPendingEventsLocker
)
1039 wxENTER_CRIT_SECT(*wxPendingEventsLocker
);
1040 if ( wxPendingEvents
)
1042 // Delete all occurences of this from the list of pending events
1043 while (wxPendingEvents
->DeleteObject(this)) { } // Do nothing
1045 if(wxPendingEventsLocker
)
1046 wxLEAVE_CRIT_SECT(*wxPendingEventsLocker
);
1049 // we only delete object data, not untyped
1050 if ( m_clientDataType
== wxClientData_Object
)
1051 delete m_clientObject
;
1056 bool wxEvtHandler::ProcessThreadEvent(wxEvent
& event
)
1058 // check that we are really in a child thread
1059 wxASSERT_MSG( !wxThread::IsMain(),
1060 wxT("use ProcessEvent() in main thread") );
1062 AddPendingEvent(event
);
1067 void wxEvtHandler::ClearEventLocker()
1069 #if !defined(__VISAGECPP__)
1070 delete m_eventsLocker
;
1071 m_eventsLocker
= NULL
;
1075 #endif // wxUSE_THREADS
1077 void wxEvtHandler::AddPendingEvent(wxEvent
& event
)
1079 // 1) Add event to list of pending events of this event handler
1081 wxEvent
*eventCopy
= event
.Clone();
1083 // we must be able to copy the events here so the event class must
1084 // implement Clone() properly instead of just providing a NULL stab for it
1085 wxCHECK_RET( eventCopy
,
1086 _T("events of this type aren't supposed to be posted") );
1088 wxENTER_CRIT_SECT( Lock() );
1090 if ( !m_pendingEvents
)
1091 m_pendingEvents
= new wxList
;
1093 m_pendingEvents
->Append(eventCopy
);
1095 wxLEAVE_CRIT_SECT( Lock() );
1097 // 2) Add this event handler to list of event handlers that
1098 // have pending events.
1100 wxENTER_CRIT_SECT(*wxPendingEventsLocker
);
1102 if ( !wxPendingEvents
)
1103 wxPendingEvents
= new wxList
;
1104 wxPendingEvents
->Append(this);
1106 wxLEAVE_CRIT_SECT(*wxPendingEventsLocker
);
1108 // 3) Inform the system that new pending events are somewhere,
1109 // and that these should be processed in idle time.
1113 void wxEvtHandler::ProcessPendingEvents()
1115 // this method is only called by wxApp if this handler does have pending
1117 wxCHECK_RET( m_pendingEvents
,
1118 wxT("Please call wxApp::ProcessPendingEvents() instead") );
1120 wxENTER_CRIT_SECT( Lock() );
1122 // we leave the loop once we have processed all events that were present at
1123 // the start of ProcessPendingEvents because otherwise we could get into
1124 // infinite loop if the pending event handler execution resulted in another
1125 // event being posted
1126 size_t n
= m_pendingEvents
->size();
1127 for ( wxList::compatibility_iterator node
= m_pendingEvents
->GetFirst();
1129 node
= m_pendingEvents
->GetFirst() )
1131 wxEvent
*event
= (wxEvent
*)node
->GetData();
1133 // It's importan we remove event from list before processing it.
1134 // Else a nested event loop, for example from a modal dialog, might
1135 // process the same event again.
1136 m_pendingEvents
->Erase(node
);
1138 wxLEAVE_CRIT_SECT( Lock() );
1140 ProcessEvent(*event
);
1143 wxENTER_CRIT_SECT( Lock() );
1149 wxLEAVE_CRIT_SECT( Lock() );
1156 wxEvtHandler::ProcessEventIfMatches(const wxEventTableEntryBase
& entry
,
1157 wxEvtHandler
*handler
,
1160 int tableId1
= entry
.m_id
,
1161 tableId2
= entry
.m_lastId
;
1163 // match only if the event type is the same and the id is either -1 in
1164 // the event table (meaning "any") or the event id matches the id
1165 // specified in the event table either exactly or by falling into
1166 // range between first and last
1167 if ((tableId1
== wxID_ANY
) ||
1168 (tableId2
== wxID_ANY
&& tableId1
== event
.GetId()) ||
1169 (tableId2
!= wxID_ANY
&&
1170 (event
.GetId() >= tableId1
&& event
.GetId() <= tableId2
)))
1173 event
.m_callbackUserData
= entry
.m_callbackUserData
;
1175 #if wxUSE_EXCEPTIONS
1178 // call the handler via wxApp method which allows the user to catch
1179 // any exceptions which may be thrown by any handler in the program
1181 wxTheApp
->HandleEvent(handler
, (wxEventFunction
)entry
.m_fn
, event
);
1184 #endif // wxUSE_EXCEPTIONS
1186 // no need for an extra virtual function call
1187 (handler
->*((wxEventFunction
) (entry
.m_fn
)))(event
);
1190 if (!event
.GetSkipped())
1197 bool wxEvtHandler::TryParent(wxEvent
& event
)
1199 if ( wxTheApp
&& (this != wxTheApp
) )
1201 // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
1202 // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
1203 // processed appropriately via SearchEventTable.
1204 if ( event
.GetEventType() != wxEVT_IDLE
)
1206 if ( wxTheApp
->ProcessEvent(event
) )
1214 bool wxEvtHandler::ProcessEvent(wxEvent
& event
)
1216 // allow the application to hook into event processing
1219 int rc
= wxTheApp
->FilterEvent(event
);
1222 wxASSERT_MSG( rc
== 1 || rc
== 0,
1223 _T("unexpected wxApp::FilterEvent return value") );
1227 //else: proceed normally
1230 // An event handler can be enabled or disabled
1231 if ( GetEvtHandlerEnabled() )
1233 // if we have a validator, it has higher priority than our own event
1235 if ( TryValidator(event
) )
1238 // Handle per-instance dynamic event tables first
1239 if ( m_dynamicEvents
&& SearchDynamicEventTable(event
) )
1242 // Then static per-class event tables
1243 if ( GetEventHashTable().HandleEvent(event
, this) )
1247 // Try going down the event handler chain
1248 if ( GetNextHandler() )
1250 if ( GetNextHandler()->ProcessEvent(event
) )
1254 // Finally propagate the event upwards the window chain and/or to the
1255 // application object as necessary
1256 return TryParent(event
);
1260 bool wxEvtHandler::SearchEventTable(wxEventTable
& table
, wxEvent
& event
)
1262 const wxEventType eventType
= event
.GetEventType();
1263 for ( int i
= 0; table
.entries
[i
].m_fn
!= 0; i
++ )
1265 const wxEventTableEntry
& entry
= table
.entries
[i
];
1266 if ( eventType
== entry
.m_eventType
)
1268 if ( ProcessEventIfMatches(entry
, this, event
) )
1276 void wxEvtHandler::Connect( int id
, int lastId
,
1278 wxObjectEventFunction func
,
1280 wxEvtHandler
* eventSink
)
1282 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1283 wxEventTableEntry
*entry
= new wxEventTableEntry
;
1284 entry
->m_eventType
= eventType
;
1286 entry
->m_lastId
= lastId
;
1288 entry
->m_callbackUserData
= userData
;
1289 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1290 wxDynamicEventTableEntry
*entry
=
1291 new wxDynamicEventTableEntry(eventType
, id
, lastId
, func
, userData
, eventSink
);
1292 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1294 if (!m_dynamicEvents
)
1295 m_dynamicEvents
= new wxList
;
1297 // Insert at the front of the list so most recent additions are found first
1298 m_dynamicEvents
->Insert( (wxObject
*) entry
);
1301 bool wxEvtHandler::Disconnect( int id
, int lastId
, wxEventType eventType
,
1302 wxObjectEventFunction func
,
1304 wxEvtHandler
* eventSink
)
1306 if (!m_dynamicEvents
)
1309 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1312 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1313 wxEventTableEntry
*entry
= (wxEventTableEntry
*)node
->GetData();
1314 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1315 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1316 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1318 if ((entry
->m_id
== id
) &&
1319 ((entry
->m_lastId
== lastId
) || (lastId
== wxID_ANY
)) &&
1320 ((entry
->m_eventType
== eventType
) || (eventType
== wxEVT_NULL
)) &&
1321 ((entry
->m_fn
== func
) || (func
== (wxObjectEventFunction
)NULL
)) &&
1322 ((entry
->m_eventSink
== eventSink
) || (eventSink
== (wxEvtHandler
*)NULL
)) &&
1323 ((entry
->m_callbackUserData
== userData
) || (userData
== (wxObject
*)NULL
)))
1325 if (entry
->m_callbackUserData
)
1326 delete entry
->m_callbackUserData
;
1327 m_dynamicEvents
->Erase( node
);
1331 node
= node
->GetNext();
1336 bool wxEvtHandler::SearchDynamicEventTable( wxEvent
& event
)
1338 wxCHECK_MSG( m_dynamicEvents
, false,
1339 wxT("caller should check that we have dynamic events") );
1341 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1344 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1345 wxEventTableEntry
*entry
= (wxEventTableEntry
*)node
->GetData();
1346 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1347 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1348 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1350 // get next node before (maybe) calling the event handler as it could
1351 // call Disconnect() invalidating the current node
1352 node
= node
->GetNext();
1354 if ((event
.GetEventType() == entry
->m_eventType
) && (entry
->m_fn
!= 0))
1356 wxEvtHandler
*handler
=
1357 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
1358 entry
->m_eventSink
? entry
->m_eventSink
1363 if ( ProcessEventIfMatches(*entry
, handler
, event
) )
1373 void wxEvtHandler::DoSetClientObject( wxClientData
*data
)
1375 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1376 wxT("can't have both object and void client data") );
1378 if ( m_clientObject
)
1379 delete m_clientObject
;
1381 m_clientObject
= data
;
1382 m_clientDataType
= wxClientData_Object
;
1385 wxClientData
*wxEvtHandler::DoGetClientObject() const
1387 // it's not an error to call GetClientObject() on a window which doesn't
1388 // have client data at all - NULL will be returned
1389 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1390 wxT("this window doesn't have object client data") );
1392 return m_clientObject
;
1395 void wxEvtHandler::DoSetClientData( void *data
)
1397 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1398 wxT("can't have both object and void client data") );
1400 m_clientData
= data
;
1401 m_clientDataType
= wxClientData_Void
;
1404 void *wxEvtHandler::DoGetClientData() const
1406 // it's not an error to call GetClientData() on a window which doesn't have
1407 // client data at all - NULL will be returned
1408 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1409 wxT("this window doesn't have void client data") );
1411 return m_clientData
;
1414 #endif // wxUSE_BASE
1418 // Find a window with the focus, that is also a descendant of the given window.
1419 // This is used to determine the window to initially send commands to.
1420 wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
)
1422 // Process events starting with the window with the focus, if any.
1423 wxWindow
* focusWin
= wxWindow::FindFocus();
1424 wxWindow
* win
= focusWin
;
1426 // Check if this is a descendant of this frame.
1427 // If not, win will be set to NULL.
1430 if (win
== ancestor
)
1433 win
= win
->GetParent();
1435 if (win
== (wxWindow
*) NULL
)
1436 focusWin
= (wxWindow
*) NULL
;