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"
33 #include "wx/stopwatch.h"
36 #include "wx/control.h"
38 #include "wx/textctrl.h"
39 #include "wx/validate.h"
43 #include "wx/module.h"
45 // ----------------------------------------------------------------------------
47 // ----------------------------------------------------------------------------
50 IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler
, wxObject
)
51 IMPLEMENT_ABSTRACT_CLASS(wxEvent
, wxObject
)
55 IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent
, wxEvent
)
56 IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent
, wxEvent
)
57 IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent
, wxCommandEvent
)
58 IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent
, wxCommandEvent
)
59 IMPLEMENT_DYNAMIC_CLASS(wxScrollWinEvent
, wxEvent
)
60 IMPLEMENT_DYNAMIC_CLASS(wxMouseEvent
, wxEvent
)
61 IMPLEMENT_DYNAMIC_CLASS(wxKeyEvent
, wxEvent
)
62 IMPLEMENT_DYNAMIC_CLASS(wxSizeEvent
, wxEvent
)
63 IMPLEMENT_DYNAMIC_CLASS(wxPaintEvent
, wxEvent
)
64 IMPLEMENT_DYNAMIC_CLASS(wxNcPaintEvent
, wxEvent
)
65 IMPLEMENT_DYNAMIC_CLASS(wxEraseEvent
, wxEvent
)
66 IMPLEMENT_DYNAMIC_CLASS(wxMoveEvent
, wxEvent
)
67 IMPLEMENT_DYNAMIC_CLASS(wxFocusEvent
, wxEvent
)
68 IMPLEMENT_DYNAMIC_CLASS(wxChildFocusEvent
, wxCommandEvent
)
69 IMPLEMENT_DYNAMIC_CLASS(wxCloseEvent
, wxEvent
)
70 IMPLEMENT_DYNAMIC_CLASS(wxShowEvent
, wxEvent
)
71 IMPLEMENT_DYNAMIC_CLASS(wxMaximizeEvent
, wxEvent
)
72 IMPLEMENT_DYNAMIC_CLASS(wxIconizeEvent
, wxEvent
)
73 IMPLEMENT_DYNAMIC_CLASS(wxMenuEvent
, wxEvent
)
74 IMPLEMENT_DYNAMIC_CLASS(wxJoystickEvent
, wxEvent
)
75 IMPLEMENT_DYNAMIC_CLASS(wxDropFilesEvent
, wxEvent
)
76 IMPLEMENT_DYNAMIC_CLASS(wxActivateEvent
, wxEvent
)
77 IMPLEMENT_DYNAMIC_CLASS(wxInitDialogEvent
, wxEvent
)
78 IMPLEMENT_DYNAMIC_CLASS(wxSetCursorEvent
, wxEvent
)
79 IMPLEMENT_DYNAMIC_CLASS(wxSysColourChangedEvent
, wxEvent
)
80 IMPLEMENT_DYNAMIC_CLASS(wxDisplayChangedEvent
, wxEvent
)
81 IMPLEMENT_DYNAMIC_CLASS(wxUpdateUIEvent
, wxCommandEvent
)
82 IMPLEMENT_DYNAMIC_CLASS(wxNavigationKeyEvent
, wxEvent
)
83 IMPLEMENT_DYNAMIC_CLASS(wxPaletteChangedEvent
, wxEvent
)
84 IMPLEMENT_DYNAMIC_CLASS(wxQueryNewPaletteEvent
, wxEvent
)
85 IMPLEMENT_DYNAMIC_CLASS(wxWindowCreateEvent
, wxEvent
)
86 IMPLEMENT_DYNAMIC_CLASS(wxWindowDestroyEvent
, wxEvent
)
87 IMPLEMENT_DYNAMIC_CLASS(wxHelpEvent
, wxCommandEvent
)
88 IMPLEMENT_DYNAMIC_CLASS(wxContextMenuEvent
, wxCommandEvent
)
89 IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureChangedEvent
, wxEvent
)
90 IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureLostEvent
, wxEvent
)
91 IMPLEMENT_DYNAMIC_CLASS(wxClipboardTextEvent
, wxCommandEvent
)
96 const wxEventTable
*wxEvtHandler::GetEventTable() const
97 { return &wxEvtHandler::sm_eventTable
; }
99 const wxEventTable
wxEvtHandler::sm_eventTable
=
100 { (const wxEventTable
*)NULL
, &wxEvtHandler::sm_eventTableEntries
[0] };
102 wxEventHashTable
&wxEvtHandler::GetEventHashTable() const
103 { return wxEvtHandler::sm_eventHashTable
; }
105 wxEventHashTable
wxEvtHandler::sm_eventHashTable(wxEvtHandler::sm_eventTable
);
107 const wxEventTableEntry
wxEvtHandler::sm_eventTableEntries
[] =
108 { DECLARE_EVENT_TABLE_ENTRY(wxEVT_NULL
, 0, 0, (wxObjectEventFunction
)NULL
, NULL
) };
112 // Clear up event hash table contents or we can get problems
113 // when C++ is cleaning up the static object
114 class wxEventTableEntryModule
: public wxModule
116 DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule
)
118 wxEventTableEntryModule() {}
119 bool OnInit() { return true; }
122 wxEventHashTable::ClearAll();
125 IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule
, wxModule
)
128 // ----------------------------------------------------------------------------
130 // ----------------------------------------------------------------------------
132 // To put pending event handlers
133 wxList
*wxPendingEvents
= (wxList
*)NULL
;
136 // protects wxPendingEvents list
137 wxCriticalSection
*wxPendingEventsLocker
= (wxCriticalSection
*)NULL
;
140 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
142 // common event types are defined here, other event types are defined by the
143 // components which use them
145 const wxEventType wxEVT_FIRST
= 10000;
146 const wxEventType wxEVT_USER_FIRST
= wxEVT_FIRST
+ 2000;
148 DEFINE_EVENT_TYPE(wxEVT_NULL
)
149 DEFINE_EVENT_TYPE(wxEVT_IDLE
)
150 DEFINE_EVENT_TYPE(wxEVT_SOCKET
)
152 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
158 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
160 DEFINE_EVENT_TYPE(wxEVT_COMMAND_BUTTON_CLICKED
)
161 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKBOX_CLICKED
)
162 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHOICE_SELECTED
)
163 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_SELECTED
)
164 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
)
165 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
)
166 DEFINE_EVENT_TYPE(wxEVT_COMMAND_MENU_SELECTED
)
167 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SLIDER_UPDATED
)
168 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBOX_SELECTED
)
169 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBUTTON_SELECTED
)
170 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SCROLLBAR_UPDATED
)
171 DEFINE_EVENT_TYPE(wxEVT_COMMAND_VLBOX_SELECTED
)
172 DEFINE_EVENT_TYPE(wxEVT_COMMAND_COMBOBOX_SELECTED
)
173 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED
)
174 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER
)
175 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED
)
177 // Sockets and timers send events, too
178 DEFINE_EVENT_TYPE(wxEVT_TIMER
)
181 DEFINE_EVENT_TYPE(wxEVT_LEFT_DOWN
)
182 DEFINE_EVENT_TYPE(wxEVT_LEFT_UP
)
183 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DOWN
)
184 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_UP
)
185 DEFINE_EVENT_TYPE(wxEVT_RIGHT_DOWN
)
186 DEFINE_EVENT_TYPE(wxEVT_RIGHT_UP
)
187 DEFINE_EVENT_TYPE(wxEVT_MOTION
)
188 DEFINE_EVENT_TYPE(wxEVT_ENTER_WINDOW
)
189 DEFINE_EVENT_TYPE(wxEVT_LEAVE_WINDOW
)
190 DEFINE_EVENT_TYPE(wxEVT_LEFT_DCLICK
)
191 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DCLICK
)
192 DEFINE_EVENT_TYPE(wxEVT_RIGHT_DCLICK
)
193 DEFINE_EVENT_TYPE(wxEVT_SET_FOCUS
)
194 DEFINE_EVENT_TYPE(wxEVT_KILL_FOCUS
)
195 DEFINE_EVENT_TYPE(wxEVT_CHILD_FOCUS
)
196 DEFINE_EVENT_TYPE(wxEVT_MOUSEWHEEL
)
198 // Non-client mouse events
199 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN
)
200 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_UP
)
201 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DOWN
)
202 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_UP
)
203 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DOWN
)
204 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_UP
)
205 DEFINE_EVENT_TYPE(wxEVT_NC_MOTION
)
206 DEFINE_EVENT_TYPE(wxEVT_NC_ENTER_WINDOW
)
207 DEFINE_EVENT_TYPE(wxEVT_NC_LEAVE_WINDOW
)
208 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DCLICK
)
209 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DCLICK
)
210 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DCLICK
)
212 // Character input event type
213 DEFINE_EVENT_TYPE(wxEVT_CHAR
)
214 DEFINE_EVENT_TYPE(wxEVT_CHAR_HOOK
)
215 DEFINE_EVENT_TYPE(wxEVT_NAVIGATION_KEY
)
216 DEFINE_EVENT_TYPE(wxEVT_KEY_DOWN
)
217 DEFINE_EVENT_TYPE(wxEVT_KEY_UP
)
219 DEFINE_EVENT_TYPE(wxEVT_HOTKEY
)
223 DEFINE_EVENT_TYPE(wxEVT_SET_CURSOR
)
225 // wxScrollbar and wxSlider event identifiers
226 DEFINE_EVENT_TYPE(wxEVT_SCROLL_TOP
)
227 DEFINE_EVENT_TYPE(wxEVT_SCROLL_BOTTOM
)
228 DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEUP
)
229 DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEDOWN
)
230 DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEUP
)
231 DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN
)
232 DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK
)
233 DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE
)
234 DEFINE_EVENT_TYPE(wxEVT_SCROLL_CHANGED
)
236 // Scroll events from wxWindow
237 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP
)
238 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_BOTTOM
)
239 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEUP
)
240 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEDOWN
)
241 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEUP
)
242 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEDOWN
)
243 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBTRACK
)
244 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBRELEASE
)
247 DEFINE_EVENT_TYPE(wxEVT_SIZE
)
248 DEFINE_EVENT_TYPE(wxEVT_SIZING
)
249 DEFINE_EVENT_TYPE(wxEVT_MOVE
)
250 DEFINE_EVENT_TYPE(wxEVT_MOVING
)
251 DEFINE_EVENT_TYPE(wxEVT_CLOSE_WINDOW
)
252 DEFINE_EVENT_TYPE(wxEVT_END_SESSION
)
253 DEFINE_EVENT_TYPE(wxEVT_QUERY_END_SESSION
)
254 DEFINE_EVENT_TYPE(wxEVT_HIBERNATE
)
255 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE_APP
)
256 DEFINE_EVENT_TYPE(wxEVT_POWER
)
257 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE
)
258 DEFINE_EVENT_TYPE(wxEVT_CREATE
)
259 DEFINE_EVENT_TYPE(wxEVT_DESTROY
)
260 DEFINE_EVENT_TYPE(wxEVT_SHOW
)
261 DEFINE_EVENT_TYPE(wxEVT_ICONIZE
)
262 DEFINE_EVENT_TYPE(wxEVT_MAXIMIZE
)
263 DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED
)
264 DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_LOST
)
265 DEFINE_EVENT_TYPE(wxEVT_PAINT
)
266 DEFINE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND
)
267 DEFINE_EVENT_TYPE(wxEVT_NC_PAINT
)
268 DEFINE_EVENT_TYPE(wxEVT_PAINT_ICON
)
269 DEFINE_EVENT_TYPE(wxEVT_MENU_OPEN
)
270 DEFINE_EVENT_TYPE(wxEVT_MENU_CLOSE
)
271 DEFINE_EVENT_TYPE(wxEVT_MENU_HIGHLIGHT
)
272 DEFINE_EVENT_TYPE(wxEVT_CONTEXT_MENU
)
273 DEFINE_EVENT_TYPE(wxEVT_SYS_COLOUR_CHANGED
)
274 DEFINE_EVENT_TYPE(wxEVT_DISPLAY_CHANGED
)
275 DEFINE_EVENT_TYPE(wxEVT_SETTING_CHANGED
)
276 DEFINE_EVENT_TYPE(wxEVT_QUERY_NEW_PALETTE
)
277 DEFINE_EVENT_TYPE(wxEVT_PALETTE_CHANGED
)
278 DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_DOWN
)
279 DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_UP
)
280 DEFINE_EVENT_TYPE(wxEVT_JOY_MOVE
)
281 DEFINE_EVENT_TYPE(wxEVT_JOY_ZMOVE
)
282 DEFINE_EVENT_TYPE(wxEVT_DROP_FILES
)
283 DEFINE_EVENT_TYPE(wxEVT_DRAW_ITEM
)
284 DEFINE_EVENT_TYPE(wxEVT_MEASURE_ITEM
)
285 DEFINE_EVENT_TYPE(wxEVT_COMPARE_ITEM
)
286 DEFINE_EVENT_TYPE(wxEVT_INIT_DIALOG
)
287 DEFINE_EVENT_TYPE(wxEVT_UPDATE_UI
)
290 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_COPY
)
291 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_CUT
)
292 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_PASTE
)
294 // Generic command events
295 // Note: a click is a higher-level event than button down/up
296 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK
)
297 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_DCLICK
)
298 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_CLICK
)
299 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_DCLICK
)
300 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SET_FOCUS
)
301 DEFINE_EVENT_TYPE(wxEVT_COMMAND_KILL_FOCUS
)
302 DEFINE_EVENT_TYPE(wxEVT_COMMAND_ENTER
)
305 DEFINE_EVENT_TYPE(wxEVT_HELP
)
306 DEFINE_EVENT_TYPE(wxEVT_DETAILED_HELP
)
308 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
314 // ============================================================================
316 // ============================================================================
318 // ----------------------------------------------------------------------------
319 // event initialization
320 // ----------------------------------------------------------------------------
325 static int s_lastUsedEventType
= wxEVT_FIRST
;
327 return s_lastUsedEventType
++;
330 // ----------------------------------------------------------------------------
332 // ----------------------------------------------------------------------------
335 * General wxWidgets events, covering
336 * all interesting things that might happen (button clicking, resizing,
337 * setting text in widgets, etc.).
339 * For each completely new event type, derive a new event class.
343 wxEvent::wxEvent(int theId
, wxEventType commandType
)
345 m_eventType
= commandType
;
346 m_eventObject
= (wxObject
*) NULL
;
350 m_callbackUserData
= (wxObject
*) NULL
;
351 m_isCommandEvent
= false;
352 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
355 wxEvent::wxEvent(const wxEvent
&src
)
357 , m_eventObject(src
.m_eventObject
)
358 , m_eventType(src
.m_eventType
)
359 , m_timeStamp(src
.m_timeStamp
)
361 , m_callbackUserData(src
.m_callbackUserData
)
362 , m_propagationLevel(src
.m_propagationLevel
)
363 , m_skipped(src
.m_skipped
)
364 , m_isCommandEvent(src
.m_isCommandEvent
)
378 // 'this' : used in base member initializer list (for m_commandString)
379 #pragma warning(disable:4355)
382 wxCommandEvent::wxCommandEvent(wxEventType commandType
, int theId
)
383 : wxEvent(theId
, commandType
)
384 #if WXWIN_COMPATIBILITY_2_4
385 , m_commandString(this)
388 m_clientData
= (char *) NULL
;
389 m_clientObject
= (wxClientData
*) NULL
;
392 m_isCommandEvent
= true;
394 // the command events are propagated upwards by default
395 m_propagationLevel
= wxEVENT_PROPAGATE_MAX
;
399 #pragma warning(default:4355)
402 wxString
wxCommandEvent::GetString() const
404 if(m_eventType
!= wxEVT_COMMAND_TEXT_UPDATED
|| !m_eventObject
)
409 wxTextCtrl
*txt
= wxDynamicCast(m_eventObject
, wxTextCtrl
);
411 return txt
->GetValue();
413 #endif // wxUSE_TEXTCTRL
423 wxLongLong
wxUpdateUIEvent::sm_lastUpdate
= 0;
426 long wxUpdateUIEvent::sm_updateInterval
= 0;
428 wxUpdateUIMode
wxUpdateUIEvent::sm_updateMode
= wxUPDATE_UI_PROCESS_ALL
;
431 bool wxUpdateUIEvent::CanUpdate(wxWindowBase
*win
)
433 // Don't update if we've switched global updating off
434 // and this window doesn't support updates.
436 (GetMode() == wxUPDATE_UI_PROCESS_SPECIFIED
&&
437 ((win
->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES
) == 0)))
440 if (sm_updateInterval
== -1)
443 if (sm_updateInterval
== 0)
446 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
447 wxLongLong now
= wxGetLocalTimeMillis();
448 if (now
> (sm_lastUpdate
+ sm_updateInterval
))
455 // If we don't have wxStopWatch or wxLongLong, we
456 // should err on the safe side and update now anyway.
461 // Reset the update time to provide a delay until the next
462 // time we should update
463 void wxUpdateUIEvent::ResetUpdateTime()
465 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
466 if (sm_updateInterval
> 0)
468 wxLongLong now
= wxGetLocalTimeMillis();
469 if (now
> (sm_lastUpdate
+ sm_updateInterval
))
481 wxIdleMode
wxIdleEvent::sm_idleMode
= wxIDLE_PROCESS_ALL
;
483 // Can we send an idle event?
484 bool wxIdleEvent::CanSend(wxWindow
* win
)
486 // Don't update if we've switched global updating off
487 // and this window doesn't support updates.
489 (GetMode() == wxIDLE_PROCESS_SPECIFIED
&&
490 ((win
->GetExtraStyle() & wxWS_EX_PROCESS_IDLE
) == 0)))
500 wxScrollEvent::wxScrollEvent(wxEventType commandType
,
504 : wxCommandEvent(commandType
, id
)
506 m_extraLong
= orient
;
514 wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType
,
518 m_eventType
= commandType
;
519 m_extraLong
= orient
;
528 wxMouseEvent::wxMouseEvent(wxEventType commandType
)
530 m_eventType
= commandType
;
533 m_controlDown
= false;
537 m_middleDown
= false;
542 m_linesPerAction
= 0;
545 void wxMouseEvent::Assign(const wxMouseEvent
& event
)
547 m_eventType
= event
.m_eventType
;
552 m_leftDown
= event
.m_leftDown
;
553 m_middleDown
= event
.m_middleDown
;
554 m_rightDown
= event
.m_rightDown
;
556 m_controlDown
= event
.m_controlDown
;
557 m_shiftDown
= event
.m_shiftDown
;
558 m_altDown
= event
.m_altDown
;
559 m_metaDown
= event
.m_metaDown
;
561 m_wheelRotation
= event
.m_wheelRotation
;
562 m_wheelDelta
= event
.m_wheelDelta
;
563 m_linesPerAction
= event
.m_linesPerAction
;
566 // return true if was a button dclick event
567 bool wxMouseEvent::ButtonDClick(int but
) const
572 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
575 case wxMOUSE_BTN_ANY
:
576 return (LeftDClick() || MiddleDClick() || RightDClick());
578 case wxMOUSE_BTN_LEFT
:
581 case wxMOUSE_BTN_MIDDLE
:
582 return MiddleDClick();
584 case wxMOUSE_BTN_RIGHT
:
585 return RightDClick();
589 // return true if was a button down event
590 bool wxMouseEvent::ButtonDown(int but
) const
595 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
598 case wxMOUSE_BTN_ANY
:
599 return (LeftDown() || MiddleDown() || RightDown());
601 case wxMOUSE_BTN_LEFT
:
604 case wxMOUSE_BTN_MIDDLE
:
607 case wxMOUSE_BTN_RIGHT
:
612 // return true if was a button up event
613 bool wxMouseEvent::ButtonUp(int but
) const
618 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
621 case wxMOUSE_BTN_ANY
:
622 return (LeftUp() || MiddleUp() || RightUp());
624 case wxMOUSE_BTN_LEFT
:
627 case wxMOUSE_BTN_MIDDLE
:
630 case wxMOUSE_BTN_RIGHT
:
635 // return true if the given button is currently changing state
636 bool wxMouseEvent::Button(int but
) const
641 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
644 case wxMOUSE_BTN_ANY
:
645 return ButtonUp(wxMOUSE_BTN_ANY
) ||
646 ButtonDown(wxMOUSE_BTN_ANY
) ||
647 ButtonDClick(wxMOUSE_BTN_ANY
);
649 case wxMOUSE_BTN_LEFT
:
650 return LeftDown() || LeftUp() || LeftDClick();
652 case wxMOUSE_BTN_MIDDLE
:
653 return MiddleDown() || MiddleUp() || MiddleDClick();
655 case wxMOUSE_BTN_RIGHT
:
656 return RightDown() || RightUp() || RightDClick();
660 bool wxMouseEvent::ButtonIsDown(int but
) const
665 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonIsDown"));
668 case wxMOUSE_BTN_ANY
:
669 return LeftIsDown() || MiddleIsDown() || RightIsDown();
671 case wxMOUSE_BTN_LEFT
:
674 case wxMOUSE_BTN_MIDDLE
:
675 return MiddleIsDown();
677 case wxMOUSE_BTN_RIGHT
:
678 return RightIsDown();
682 int wxMouseEvent::GetButton() const
684 for ( int i
= 1; i
<= 3; i
++ )
692 return wxMOUSE_BTN_NONE
;
695 // Find the logical position of the event given the DC
696 wxPoint
wxMouseEvent::GetLogicalPosition(const wxDC
& dc
) const
698 wxPoint
pt(dc
.DeviceToLogicalX(m_x
), dc
.DeviceToLogicalY(m_y
));
708 wxKeyEvent::wxKeyEvent(wxEventType type
)
712 m_controlDown
= false;
722 wxKeyEvent::wxKeyEvent(const wxKeyEvent
& evt
)
728 m_keyCode
= evt
.m_keyCode
;
730 m_controlDown
= evt
.m_controlDown
;
731 m_shiftDown
= evt
.m_shiftDown
;
732 m_altDown
= evt
.m_altDown
;
733 m_metaDown
= evt
.m_metaDown
;
734 m_scanCode
= evt
.m_scanCode
;
735 m_rawCode
= evt
.m_rawCode
;
736 m_rawFlags
= evt
.m_rawFlags
;
739 m_uniChar
= evt
.m_uniChar
;
743 #if WXWIN_COMPATIBILITY_2_6
744 long wxKeyEvent::KeyCode() const
748 #endif // WXWIN_COMPATIBILITY_2_6
750 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow
*win
)
752 SetEventType(wxEVT_CREATE
);
756 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow
*win
)
758 SetEventType(wxEVT_DESTROY
);
762 wxChildFocusEvent::wxChildFocusEvent(wxWindow
*win
)
763 : wxCommandEvent(wxEVT_CHILD_FOCUS
)
768 // ----------------------------------------------------------------------------
770 // ----------------------------------------------------------------------------
773 wxHelpEvent::Origin
wxHelpEvent::GuessOrigin(Origin origin
)
775 if ( origin
== Origin_Unknown
)
777 // assume that the event comes from the help button if it's not from
778 // keyboard and that pressing F1 always results in the help event
779 origin
= wxGetKeyState(WXK_F1
) ? Origin_Keyboard
: Origin_HelpButton
;
790 // ----------------------------------------------------------------------------
792 // ----------------------------------------------------------------------------
794 static const int EVENT_TYPE_TABLE_INIT_SIZE
= 31; // Not too big not too small...
796 wxEventHashTable
* wxEventHashTable::sm_first
= NULL
;
798 wxEventHashTable::wxEventHashTable(const wxEventTable
&table
)
802 AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE
);
806 m_next
->m_previous
= this;
810 wxEventHashTable::~wxEventHashTable()
813 m_next
->m_previous
= m_previous
;
815 m_previous
->m_next
= m_next
;
816 if (sm_first
== this)
822 void wxEventHashTable::Clear()
825 for(i
= 0; i
< m_size
; i
++)
827 EventTypeTablePointer eTTnode
= m_eventTypeTable
[i
];
834 // Necessary in order to not invoke the
835 // overloaded delete operator when statics are cleaned up
836 if (m_eventTypeTable
)
837 delete[] m_eventTypeTable
;
839 m_eventTypeTable
= NULL
;
844 void wxEventHashTable::ClearAll()
846 wxEventHashTable
* table
= sm_first
;
850 table
= table
->m_next
;
854 bool wxEventHashTable::HandleEvent(wxEvent
&event
, wxEvtHandler
*self
)
859 m_rebuildHash
= false;
862 if (!m_eventTypeTable
)
865 // Find all entries for the given event type.
866 wxEventType eventType
= event
.GetEventType();
867 const EventTypeTablePointer eTTnode
= m_eventTypeTable
[eventType
% m_size
];
868 if (eTTnode
&& eTTnode
->eventType
== eventType
)
870 // Now start the search for an event handler
871 // that can handle an event with the given ID.
872 const wxEventTableEntryPointerArray
&
873 eventEntryTable
= eTTnode
->eventEntryTable
;
875 const size_t count
= eventEntryTable
.GetCount();
876 for (size_t n
= 0; n
< count
; n
++)
879 ProcessEventIfMatches(*eventEntryTable
[n
], self
, event
) )
889 void wxEventHashTable::InitHashTable()
891 // Loop over the event tables and all its base tables.
892 const wxEventTable
*table
= &m_table
;
895 // Retrieve all valid event handler entries
896 const wxEventTableEntry
*entry
= table
->entries
;
897 while (entry
->m_fn
!= 0)
899 // Add the event entry in the Hash.
905 table
= table
->baseTable
;
908 // Lets free some memory.
910 for(i
= 0; i
< m_size
; i
++)
912 EventTypeTablePointer eTTnode
= m_eventTypeTable
[i
];
915 eTTnode
->eventEntryTable
.Shrink();
920 void wxEventHashTable::AddEntry(const wxEventTableEntry
&entry
)
922 // This might happen 'accidentally' as the app is exiting
923 if (!m_eventTypeTable
)
926 EventTypeTablePointer
*peTTnode
= &m_eventTypeTable
[entry
.m_eventType
% m_size
];
927 EventTypeTablePointer eTTnode
= *peTTnode
;
931 if (eTTnode
->eventType
!= entry
.m_eventType
)
934 GrowEventTypeTable();
935 // Try again to add it.
942 eTTnode
= new EventTypeTable
;
943 eTTnode
->eventType
= entry
.m_eventType
;
947 // Fill all hash entries between entry.m_id and entry.m_lastId...
948 eTTnode
->eventEntryTable
.Add(&entry
);
951 void wxEventHashTable::AllocEventTypeTable(size_t size
)
953 m_eventTypeTable
= new EventTypeTablePointer
[size
];
954 memset((void *)m_eventTypeTable
, 0, sizeof(EventTypeTablePointer
)*size
);
958 void wxEventHashTable::GrowEventTypeTable()
960 size_t oldSize
= m_size
;
961 EventTypeTablePointer
*oldEventTypeTable
= m_eventTypeTable
;
963 // TODO: Search the most optimal grow sequence
964 AllocEventTypeTable(/* GetNextPrime(oldSize) */oldSize
*2+1);
966 for ( size_t i
= 0; i
< oldSize
; /* */ )
968 EventTypeTablePointer eTToldNode
= oldEventTypeTable
[i
];
971 EventTypeTablePointer
*peTTnode
= &m_eventTypeTable
[eTToldNode
->eventType
% m_size
];
972 EventTypeTablePointer eTTnode
= *peTTnode
;
974 // Check for collision, we don't want any.
977 GrowEventTypeTable();
978 continue; // Don't increment the counter,
979 // as we still need to add this element.
983 // Get the old value and put it in the new table.
984 *peTTnode
= oldEventTypeTable
[i
];
991 delete[] oldEventTypeTable
;
995 // ----------------------------------------------------------------------------
997 // ----------------------------------------------------------------------------
1003 wxEvtHandler::wxEvtHandler()
1005 m_nextHandler
= (wxEvtHandler
*) NULL
;
1006 m_previousHandler
= (wxEvtHandler
*) NULL
;
1008 m_dynamicEvents
= (wxList
*) NULL
;
1009 m_pendingEvents
= (wxList
*) NULL
;
1011 # if !defined(__VISAGECPP__)
1012 m_eventsLocker
= new wxCriticalSection
;
1015 // no client data (yet)
1016 m_clientData
= NULL
;
1017 m_clientDataType
= wxClientData_None
;
1020 wxEvtHandler::~wxEvtHandler()
1022 // Takes itself out of the list of handlers
1023 if (m_previousHandler
)
1024 m_previousHandler
->m_nextHandler
= m_nextHandler
;
1027 m_nextHandler
->m_previousHandler
= m_previousHandler
;
1029 if (m_dynamicEvents
)
1031 wxList::iterator it
= m_dynamicEvents
->begin(),
1032 en
= m_dynamicEvents
->end();
1033 for (;it
!= en
; ++it
)
1035 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1036 wxEventTableEntry
*entry
= (wxEventTableEntry
*)*it
;
1037 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1038 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)*it
;
1039 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1041 if (entry
->m_callbackUserData
)
1042 delete entry
->m_callbackUserData
;
1045 delete m_dynamicEvents
;
1048 if (m_pendingEvents
)
1049 m_pendingEvents
->DeleteContents(true);
1050 delete m_pendingEvents
;
1053 # if !defined(__VISAGECPP__)
1054 delete m_eventsLocker
;
1057 // Remove us from wxPendingEvents if necessary.
1058 if(wxPendingEventsLocker
)
1059 wxENTER_CRIT_SECT(*wxPendingEventsLocker
);
1060 if ( wxPendingEvents
)
1062 // Delete all occurences of this from the list of pending events
1063 while (wxPendingEvents
->DeleteObject(this)) { } // Do nothing
1065 if(wxPendingEventsLocker
)
1066 wxLEAVE_CRIT_SECT(*wxPendingEventsLocker
);
1069 // we only delete object data, not untyped
1070 if ( m_clientDataType
== wxClientData_Object
)
1071 delete m_clientObject
;
1076 bool wxEvtHandler::ProcessThreadEvent(wxEvent
& event
)
1078 // check that we are really in a child thread
1079 wxASSERT_MSG( !wxThread::IsMain(),
1080 wxT("use ProcessEvent() in main thread") );
1082 AddPendingEvent(event
);
1087 void wxEvtHandler::ClearEventLocker()
1089 #if !defined(__VISAGECPP__)
1090 delete m_eventsLocker
;
1091 m_eventsLocker
= NULL
;
1095 #endif // wxUSE_THREADS
1097 void wxEvtHandler::AddPendingEvent(wxEvent
& event
)
1099 // 1) Add event to list of pending events of this event handler
1101 wxEvent
*eventCopy
= event
.Clone();
1103 // we must be able to copy the events here so the event class must
1104 // implement Clone() properly instead of just providing a NULL stab for it
1105 wxCHECK_RET( eventCopy
,
1106 _T("events of this type aren't supposed to be posted") );
1108 wxENTER_CRIT_SECT( Lock() );
1110 if ( !m_pendingEvents
)
1111 m_pendingEvents
= new wxList
;
1113 m_pendingEvents
->Append(eventCopy
);
1115 wxLEAVE_CRIT_SECT( Lock() );
1117 // 2) Add this event handler to list of event handlers that
1118 // have pending events.
1120 wxENTER_CRIT_SECT(*wxPendingEventsLocker
);
1122 if ( !wxPendingEvents
)
1123 wxPendingEvents
= new wxList
;
1124 wxPendingEvents
->Append(this);
1126 wxLEAVE_CRIT_SECT(*wxPendingEventsLocker
);
1128 // 3) Inform the system that new pending events are somewhere,
1129 // and that these should be processed in idle time.
1133 void wxEvtHandler::ProcessPendingEvents()
1135 // this method is only called by wxApp if this handler does have pending
1137 wxCHECK_RET( m_pendingEvents
,
1138 wxT("Please call wxApp::ProcessPendingEvents() instead") );
1140 wxENTER_CRIT_SECT( Lock() );
1142 // we leave the loop once we have processed all events that were present at
1143 // the start of ProcessPendingEvents because otherwise we could get into
1144 // infinite loop if the pending event handler execution resulted in another
1145 // event being posted
1146 size_t n
= m_pendingEvents
->size();
1147 for ( wxList::compatibility_iterator node
= m_pendingEvents
->GetFirst();
1149 node
= m_pendingEvents
->GetFirst() )
1151 wxEvent
*event
= (wxEvent
*)node
->GetData();
1153 // It's importan we remove event from list before processing it.
1154 // Else a nested event loop, for example from a modal dialog, might
1155 // process the same event again.
1156 m_pendingEvents
->Erase(node
);
1158 wxLEAVE_CRIT_SECT( Lock() );
1160 ProcessEvent(*event
);
1163 wxENTER_CRIT_SECT( Lock() );
1169 wxLEAVE_CRIT_SECT( Lock() );
1176 wxEvtHandler::ProcessEventIfMatches(const wxEventTableEntryBase
& entry
,
1177 wxEvtHandler
*handler
,
1180 int tableId1
= entry
.m_id
,
1181 tableId2
= entry
.m_lastId
;
1183 // match only if the event type is the same and the id is either -1 in
1184 // the event table (meaning "any") or the event id matches the id
1185 // specified in the event table either exactly or by falling into
1186 // range between first and last
1187 if ((tableId1
== wxID_ANY
) ||
1188 (tableId2
== wxID_ANY
&& tableId1
== event
.GetId()) ||
1189 (tableId2
!= wxID_ANY
&&
1190 (event
.GetId() >= tableId1
&& event
.GetId() <= tableId2
)))
1193 event
.m_callbackUserData
= entry
.m_callbackUserData
;
1195 #if wxUSE_EXCEPTIONS
1198 // call the handler via wxApp method which allows the user to catch
1199 // any exceptions which may be thrown by any handler in the program
1201 wxTheApp
->HandleEvent(handler
, (wxEventFunction
)entry
.m_fn
, event
);
1204 #endif // wxUSE_EXCEPTIONS
1206 // no need for an extra virtual function call
1207 (handler
->*((wxEventFunction
) (entry
.m_fn
)))(event
);
1210 if (!event
.GetSkipped())
1217 bool wxEvtHandler::TryParent(wxEvent
& event
)
1219 if ( wxTheApp
&& (this != wxTheApp
) )
1221 // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
1222 // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
1223 // processed appropriately via SearchEventTable.
1224 if ( event
.GetEventType() != wxEVT_IDLE
)
1226 if ( wxTheApp
->ProcessEvent(event
) )
1234 bool wxEvtHandler::ProcessEvent(wxEvent
& event
)
1236 // allow the application to hook into event processing
1239 int rc
= wxTheApp
->FilterEvent(event
);
1242 wxASSERT_MSG( rc
== 1 || rc
== 0,
1243 _T("unexpected wxApp::FilterEvent return value") );
1247 //else: proceed normally
1250 // An event handler can be enabled or disabled
1251 if ( GetEvtHandlerEnabled() )
1253 // if we have a validator, it has higher priority than our own event
1255 if ( TryValidator(event
) )
1258 // Handle per-instance dynamic event tables first
1259 if ( m_dynamicEvents
&& SearchDynamicEventTable(event
) )
1262 // Then static per-class event tables
1263 if ( GetEventHashTable().HandleEvent(event
, this) )
1267 // Try going down the event handler chain
1268 if ( GetNextHandler() )
1270 if ( GetNextHandler()->ProcessEvent(event
) )
1274 // Finally propagate the event upwards the window chain and/or to the
1275 // application object as necessary
1276 return TryParent(event
);
1280 bool wxEvtHandler::SearchEventTable(wxEventTable
& table
, wxEvent
& event
)
1282 const wxEventType eventType
= event
.GetEventType();
1283 for ( int i
= 0; table
.entries
[i
].m_fn
!= 0; i
++ )
1285 const wxEventTableEntry
& entry
= table
.entries
[i
];
1286 if ( eventType
== entry
.m_eventType
)
1288 if ( ProcessEventIfMatches(entry
, this, event
) )
1296 void wxEvtHandler::Connect( int id
, int lastId
,
1298 wxObjectEventFunction func
,
1300 wxEvtHandler
* eventSink
)
1302 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1303 wxEventTableEntry
*entry
= new wxEventTableEntry
;
1304 entry
->m_eventType
= eventType
;
1306 entry
->m_lastId
= lastId
;
1308 entry
->m_callbackUserData
= userData
;
1309 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1310 wxDynamicEventTableEntry
*entry
=
1311 new wxDynamicEventTableEntry(eventType
, id
, lastId
, func
, userData
, eventSink
);
1312 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1314 if (!m_dynamicEvents
)
1315 m_dynamicEvents
= new wxList
;
1317 // Insert at the front of the list so most recent additions are found first
1318 m_dynamicEvents
->Insert( (wxObject
*) entry
);
1321 bool wxEvtHandler::Disconnect( int id
, int lastId
, wxEventType eventType
,
1322 wxObjectEventFunction func
,
1324 wxEvtHandler
* eventSink
)
1326 if (!m_dynamicEvents
)
1329 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1332 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1333 wxEventTableEntry
*entry
= (wxEventTableEntry
*)node
->GetData();
1334 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1335 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1336 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1338 if ((entry
->m_id
== id
) &&
1339 ((entry
->m_lastId
== lastId
) || (lastId
== wxID_ANY
)) &&
1340 ((entry
->m_eventType
== eventType
) || (eventType
== wxEVT_NULL
)) &&
1341 ((entry
->m_fn
== func
) || (func
== (wxObjectEventFunction
)NULL
)) &&
1342 ((entry
->m_eventSink
== eventSink
) || (eventSink
== (wxEvtHandler
*)NULL
)) &&
1343 ((entry
->m_callbackUserData
== userData
) || (userData
== (wxObject
*)NULL
)))
1345 if (entry
->m_callbackUserData
)
1346 delete entry
->m_callbackUserData
;
1347 m_dynamicEvents
->Erase( node
);
1351 node
= node
->GetNext();
1356 bool wxEvtHandler::SearchDynamicEventTable( wxEvent
& event
)
1358 wxCHECK_MSG( m_dynamicEvents
, false,
1359 wxT("caller should check that we have dynamic events") );
1361 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1364 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1365 wxEventTableEntry
*entry
= (wxEventTableEntry
*)node
->GetData();
1366 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1367 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1368 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1370 // get next node before (maybe) calling the event handler as it could
1371 // call Disconnect() invalidating the current node
1372 node
= node
->GetNext();
1374 if ((event
.GetEventType() == entry
->m_eventType
) && (entry
->m_fn
!= 0))
1376 wxEvtHandler
*handler
=
1377 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
1378 entry
->m_eventSink
? entry
->m_eventSink
1383 if ( ProcessEventIfMatches(*entry
, handler
, event
) )
1393 void wxEvtHandler::DoSetClientObject( wxClientData
*data
)
1395 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1396 wxT("can't have both object and void client data") );
1398 if ( m_clientObject
)
1399 delete m_clientObject
;
1401 m_clientObject
= data
;
1402 m_clientDataType
= wxClientData_Object
;
1405 wxClientData
*wxEvtHandler::DoGetClientObject() const
1407 // it's not an error to call GetClientObject() on a window which doesn't
1408 // have client data at all - NULL will be returned
1409 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1410 wxT("this window doesn't have object client data") );
1412 return m_clientObject
;
1415 void wxEvtHandler::DoSetClientData( void *data
)
1417 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1418 wxT("can't have both object and void client data") );
1420 m_clientData
= data
;
1421 m_clientDataType
= wxClientData_Void
;
1424 void *wxEvtHandler::DoGetClientData() const
1426 // it's not an error to call GetClientData() on a window which doesn't have
1427 // client data at all - NULL will be returned
1428 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1429 wxT("this window doesn't have void client data") );
1431 return m_clientData
;
1434 #endif // wxUSE_BASE
1438 // Find a window with the focus, that is also a descendant of the given window.
1439 // This is used to determine the window to initially send commands to.
1440 wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
)
1442 // Process events starting with the window with the focus, if any.
1443 wxWindow
* focusWin
= wxWindow::FindFocus();
1444 wxWindow
* win
= focusWin
;
1446 // Check if this is a descendant of this frame.
1447 // If not, win will be set to NULL.
1450 if (win
== ancestor
)
1453 win
= win
->GetParent();
1455 if (win
== (wxWindow
*) NULL
)
1456 focusWin
= (wxWindow
*) NULL
;