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"
34 #include "wx/module.h"
37 #include "wx/control.h"
39 #include "wx/textctrl.h"
40 #include "wx/validate.h"
44 // ----------------------------------------------------------------------------
46 // ----------------------------------------------------------------------------
49 IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler
, wxObject
)
50 IMPLEMENT_ABSTRACT_CLASS(wxEvent
, wxObject
)
51 IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent
, wxEvent
)
55 IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent
, wxEvent
)
56 IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent
, wxCommandEvent
)
57 IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent
, wxCommandEvent
)
58 IMPLEMENT_DYNAMIC_CLASS(wxScrollWinEvent
, wxEvent
)
59 IMPLEMENT_DYNAMIC_CLASS(wxMouseEvent
, wxEvent
)
60 IMPLEMENT_DYNAMIC_CLASS(wxKeyEvent
, wxEvent
)
61 IMPLEMENT_DYNAMIC_CLASS(wxSizeEvent
, wxEvent
)
62 IMPLEMENT_DYNAMIC_CLASS(wxPaintEvent
, wxEvent
)
63 IMPLEMENT_DYNAMIC_CLASS(wxNcPaintEvent
, wxEvent
)
64 IMPLEMENT_DYNAMIC_CLASS(wxEraseEvent
, wxEvent
)
65 IMPLEMENT_DYNAMIC_CLASS(wxMoveEvent
, wxEvent
)
66 IMPLEMENT_DYNAMIC_CLASS(wxFocusEvent
, wxEvent
)
67 IMPLEMENT_DYNAMIC_CLASS(wxChildFocusEvent
, wxCommandEvent
)
68 IMPLEMENT_DYNAMIC_CLASS(wxCloseEvent
, wxEvent
)
69 IMPLEMENT_DYNAMIC_CLASS(wxShowEvent
, wxEvent
)
70 IMPLEMENT_DYNAMIC_CLASS(wxMaximizeEvent
, wxEvent
)
71 IMPLEMENT_DYNAMIC_CLASS(wxIconizeEvent
, wxEvent
)
72 IMPLEMENT_DYNAMIC_CLASS(wxMenuEvent
, wxEvent
)
73 IMPLEMENT_DYNAMIC_CLASS(wxJoystickEvent
, wxEvent
)
74 IMPLEMENT_DYNAMIC_CLASS(wxDropFilesEvent
, wxEvent
)
75 IMPLEMENT_DYNAMIC_CLASS(wxActivateEvent
, wxEvent
)
76 IMPLEMENT_DYNAMIC_CLASS(wxInitDialogEvent
, wxEvent
)
77 IMPLEMENT_DYNAMIC_CLASS(wxSetCursorEvent
, wxEvent
)
78 IMPLEMENT_DYNAMIC_CLASS(wxSysColourChangedEvent
, wxEvent
)
79 IMPLEMENT_DYNAMIC_CLASS(wxDisplayChangedEvent
, wxEvent
)
80 IMPLEMENT_DYNAMIC_CLASS(wxUpdateUIEvent
, wxCommandEvent
)
81 IMPLEMENT_DYNAMIC_CLASS(wxNavigationKeyEvent
, wxEvent
)
82 IMPLEMENT_DYNAMIC_CLASS(wxPaletteChangedEvent
, wxEvent
)
83 IMPLEMENT_DYNAMIC_CLASS(wxQueryNewPaletteEvent
, wxEvent
)
84 IMPLEMENT_DYNAMIC_CLASS(wxWindowCreateEvent
, wxEvent
)
85 IMPLEMENT_DYNAMIC_CLASS(wxWindowDestroyEvent
, wxEvent
)
86 IMPLEMENT_DYNAMIC_CLASS(wxHelpEvent
, wxCommandEvent
)
87 IMPLEMENT_DYNAMIC_CLASS(wxContextMenuEvent
, wxCommandEvent
)
88 IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureChangedEvent
, wxEvent
)
89 IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureLostEvent
, wxEvent
)
90 IMPLEMENT_DYNAMIC_CLASS(wxClipboardTextEvent
, wxCommandEvent
)
95 const wxEventTable
*wxEvtHandler::GetEventTable() const
96 { return &wxEvtHandler::sm_eventTable
; }
98 const wxEventTable
wxEvtHandler::sm_eventTable
=
99 { (const wxEventTable
*)NULL
, &wxEvtHandler::sm_eventTableEntries
[0] };
101 wxEventHashTable
&wxEvtHandler::GetEventHashTable() const
102 { return wxEvtHandler::sm_eventHashTable
; }
104 wxEventHashTable
wxEvtHandler::sm_eventHashTable(wxEvtHandler::sm_eventTable
);
106 const wxEventTableEntry
wxEvtHandler::sm_eventTableEntries
[] =
107 { DECLARE_EVENT_TABLE_ENTRY(wxEVT_NULL
, 0, 0, (wxObjectEventFunction
)NULL
, NULL
) };
111 // Clear up event hash table contents or we can get problems
112 // when C++ is cleaning up the static object
113 class wxEventTableEntryModule
: public wxModule
115 DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule
)
117 wxEventTableEntryModule() {}
118 bool OnInit() { return true; }
121 wxEventHashTable::ClearAll();
124 IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule
, wxModule
)
127 // ----------------------------------------------------------------------------
129 // ----------------------------------------------------------------------------
131 // To put pending event handlers
132 wxList
*wxPendingEvents
= (wxList
*)NULL
;
135 // protects wxPendingEvents list
136 wxCriticalSection
*wxPendingEventsLocker
= (wxCriticalSection
*)NULL
;
139 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
141 // common event types are defined here, other event types are defined by the
142 // components which use them
144 const wxEventType wxEVT_FIRST
= 10000;
145 const wxEventType wxEVT_USER_FIRST
= wxEVT_FIRST
+ 2000;
147 DEFINE_EVENT_TYPE(wxEVT_NULL
)
148 DEFINE_EVENT_TYPE(wxEVT_IDLE
)
149 DEFINE_EVENT_TYPE(wxEVT_SOCKET
)
150 DEFINE_EVENT_TYPE(wxEVT_TIMER
)
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
)
176 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED
)
179 DEFINE_EVENT_TYPE(wxEVT_LEFT_DOWN
)
180 DEFINE_EVENT_TYPE(wxEVT_LEFT_UP
)
181 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DOWN
)
182 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_UP
)
183 DEFINE_EVENT_TYPE(wxEVT_RIGHT_DOWN
)
184 DEFINE_EVENT_TYPE(wxEVT_RIGHT_UP
)
185 DEFINE_EVENT_TYPE(wxEVT_MOTION
)
186 DEFINE_EVENT_TYPE(wxEVT_ENTER_WINDOW
)
187 DEFINE_EVENT_TYPE(wxEVT_LEAVE_WINDOW
)
188 DEFINE_EVENT_TYPE(wxEVT_LEFT_DCLICK
)
189 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DCLICK
)
190 DEFINE_EVENT_TYPE(wxEVT_RIGHT_DCLICK
)
191 DEFINE_EVENT_TYPE(wxEVT_SET_FOCUS
)
192 DEFINE_EVENT_TYPE(wxEVT_KILL_FOCUS
)
193 DEFINE_EVENT_TYPE(wxEVT_CHILD_FOCUS
)
194 DEFINE_EVENT_TYPE(wxEVT_MOUSEWHEEL
)
196 // Non-client mouse events
197 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN
)
198 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_UP
)
199 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DOWN
)
200 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_UP
)
201 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DOWN
)
202 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_UP
)
203 DEFINE_EVENT_TYPE(wxEVT_NC_MOTION
)
204 DEFINE_EVENT_TYPE(wxEVT_NC_ENTER_WINDOW
)
205 DEFINE_EVENT_TYPE(wxEVT_NC_LEAVE_WINDOW
)
206 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DCLICK
)
207 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DCLICK
)
208 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DCLICK
)
210 // Character input event type
211 DEFINE_EVENT_TYPE(wxEVT_CHAR
)
212 DEFINE_EVENT_TYPE(wxEVT_CHAR_HOOK
)
213 DEFINE_EVENT_TYPE(wxEVT_NAVIGATION_KEY
)
214 DEFINE_EVENT_TYPE(wxEVT_KEY_DOWN
)
215 DEFINE_EVENT_TYPE(wxEVT_KEY_UP
)
217 DEFINE_EVENT_TYPE(wxEVT_HOTKEY
)
221 DEFINE_EVENT_TYPE(wxEVT_SET_CURSOR
)
223 // wxScrollbar and wxSlider event identifiers
224 DEFINE_EVENT_TYPE(wxEVT_SCROLL_TOP
)
225 DEFINE_EVENT_TYPE(wxEVT_SCROLL_BOTTOM
)
226 DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEUP
)
227 DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEDOWN
)
228 DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEUP
)
229 DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN
)
230 DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK
)
231 DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE
)
232 DEFINE_EVENT_TYPE(wxEVT_SCROLL_CHANGED
)
234 // Scroll events from wxWindow
235 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP
)
236 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_BOTTOM
)
237 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEUP
)
238 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEDOWN
)
239 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEUP
)
240 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEDOWN
)
241 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBTRACK
)
242 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBRELEASE
)
245 DEFINE_EVENT_TYPE(wxEVT_SIZE
)
246 DEFINE_EVENT_TYPE(wxEVT_SIZING
)
247 DEFINE_EVENT_TYPE(wxEVT_MOVE
)
248 DEFINE_EVENT_TYPE(wxEVT_MOVING
)
249 DEFINE_EVENT_TYPE(wxEVT_CLOSE_WINDOW
)
250 DEFINE_EVENT_TYPE(wxEVT_END_SESSION
)
251 DEFINE_EVENT_TYPE(wxEVT_QUERY_END_SESSION
)
252 DEFINE_EVENT_TYPE(wxEVT_HIBERNATE
)
253 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE_APP
)
254 DEFINE_EVENT_TYPE(wxEVT_POWER
)
255 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE
)
256 DEFINE_EVENT_TYPE(wxEVT_CREATE
)
257 DEFINE_EVENT_TYPE(wxEVT_DESTROY
)
258 DEFINE_EVENT_TYPE(wxEVT_SHOW
)
259 DEFINE_EVENT_TYPE(wxEVT_ICONIZE
)
260 DEFINE_EVENT_TYPE(wxEVT_MAXIMIZE
)
261 DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED
)
262 DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_LOST
)
263 DEFINE_EVENT_TYPE(wxEVT_PAINT
)
264 DEFINE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND
)
265 DEFINE_EVENT_TYPE(wxEVT_NC_PAINT
)
266 DEFINE_EVENT_TYPE(wxEVT_PAINT_ICON
)
267 DEFINE_EVENT_TYPE(wxEVT_MENU_OPEN
)
268 DEFINE_EVENT_TYPE(wxEVT_MENU_CLOSE
)
269 DEFINE_EVENT_TYPE(wxEVT_MENU_HIGHLIGHT
)
270 DEFINE_EVENT_TYPE(wxEVT_CONTEXT_MENU
)
271 DEFINE_EVENT_TYPE(wxEVT_SYS_COLOUR_CHANGED
)
272 DEFINE_EVENT_TYPE(wxEVT_DISPLAY_CHANGED
)
273 DEFINE_EVENT_TYPE(wxEVT_SETTING_CHANGED
)
274 DEFINE_EVENT_TYPE(wxEVT_QUERY_NEW_PALETTE
)
275 DEFINE_EVENT_TYPE(wxEVT_PALETTE_CHANGED
)
276 DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_DOWN
)
277 DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_UP
)
278 DEFINE_EVENT_TYPE(wxEVT_JOY_MOVE
)
279 DEFINE_EVENT_TYPE(wxEVT_JOY_ZMOVE
)
280 DEFINE_EVENT_TYPE(wxEVT_DROP_FILES
)
281 DEFINE_EVENT_TYPE(wxEVT_DRAW_ITEM
)
282 DEFINE_EVENT_TYPE(wxEVT_MEASURE_ITEM
)
283 DEFINE_EVENT_TYPE(wxEVT_COMPARE_ITEM
)
284 DEFINE_EVENT_TYPE(wxEVT_INIT_DIALOG
)
285 DEFINE_EVENT_TYPE(wxEVT_UPDATE_UI
)
288 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_COPY
)
289 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_CUT
)
290 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_PASTE
)
292 // Generic command events
293 // Note: a click is a higher-level event than button down/up
294 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK
)
295 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_DCLICK
)
296 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_CLICK
)
297 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_DCLICK
)
298 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SET_FOCUS
)
299 DEFINE_EVENT_TYPE(wxEVT_COMMAND_KILL_FOCUS
)
300 DEFINE_EVENT_TYPE(wxEVT_COMMAND_ENTER
)
303 DEFINE_EVENT_TYPE(wxEVT_HELP
)
304 DEFINE_EVENT_TYPE(wxEVT_DETAILED_HELP
)
306 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
312 wxIdleMode
wxIdleEvent::sm_idleMode
= wxIDLE_PROCESS_ALL
;
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
)
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 wxScrollEvent::wxScrollEvent(wxEventType commandType
,
482 : wxCommandEvent(commandType
, id
)
484 m_extraLong
= orient
;
492 wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType
,
496 m_eventType
= commandType
;
497 m_extraLong
= orient
;
506 wxMouseEvent::wxMouseEvent(wxEventType commandType
)
508 m_eventType
= commandType
;
511 m_controlDown
= false;
515 m_middleDown
= false;
520 m_linesPerAction
= 0;
524 void wxMouseEvent::Assign(const wxMouseEvent
& event
)
526 m_eventType
= event
.m_eventType
;
531 m_leftDown
= event
.m_leftDown
;
532 m_middleDown
= event
.m_middleDown
;
533 m_rightDown
= event
.m_rightDown
;
535 m_controlDown
= event
.m_controlDown
;
536 m_shiftDown
= event
.m_shiftDown
;
537 m_altDown
= event
.m_altDown
;
538 m_metaDown
= event
.m_metaDown
;
540 m_wheelRotation
= event
.m_wheelRotation
;
541 m_wheelDelta
= event
.m_wheelDelta
;
542 m_linesPerAction
= event
.m_linesPerAction
;
543 m_wheelAxis
= event
.m_wheelAxis
;
546 // return true if was a button dclick event
547 bool wxMouseEvent::ButtonDClick(int but
) const
552 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
555 case wxMOUSE_BTN_ANY
:
556 return (LeftDClick() || MiddleDClick() || RightDClick());
558 case wxMOUSE_BTN_LEFT
:
561 case wxMOUSE_BTN_MIDDLE
:
562 return MiddleDClick();
564 case wxMOUSE_BTN_RIGHT
:
565 return RightDClick();
569 // return true if was a button down event
570 bool wxMouseEvent::ButtonDown(int but
) const
575 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
578 case wxMOUSE_BTN_ANY
:
579 return (LeftDown() || MiddleDown() || RightDown());
581 case wxMOUSE_BTN_LEFT
:
584 case wxMOUSE_BTN_MIDDLE
:
587 case wxMOUSE_BTN_RIGHT
:
592 // return true if was a button up event
593 bool wxMouseEvent::ButtonUp(int but
) const
598 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
601 case wxMOUSE_BTN_ANY
:
602 return (LeftUp() || MiddleUp() || RightUp());
604 case wxMOUSE_BTN_LEFT
:
607 case wxMOUSE_BTN_MIDDLE
:
610 case wxMOUSE_BTN_RIGHT
:
615 // return true if the given button is currently changing state
616 bool wxMouseEvent::Button(int but
) const
621 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
624 case wxMOUSE_BTN_ANY
:
625 return ButtonUp(wxMOUSE_BTN_ANY
) ||
626 ButtonDown(wxMOUSE_BTN_ANY
) ||
627 ButtonDClick(wxMOUSE_BTN_ANY
);
629 case wxMOUSE_BTN_LEFT
:
630 return LeftDown() || LeftUp() || LeftDClick();
632 case wxMOUSE_BTN_MIDDLE
:
633 return MiddleDown() || MiddleUp() || MiddleDClick();
635 case wxMOUSE_BTN_RIGHT
:
636 return RightDown() || RightUp() || RightDClick();
640 bool wxMouseEvent::ButtonIsDown(int but
) const
645 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonIsDown"));
648 case wxMOUSE_BTN_ANY
:
649 return LeftIsDown() || MiddleIsDown() || RightIsDown();
651 case wxMOUSE_BTN_LEFT
:
654 case wxMOUSE_BTN_MIDDLE
:
655 return MiddleIsDown();
657 case wxMOUSE_BTN_RIGHT
:
658 return RightIsDown();
662 int wxMouseEvent::GetButton() const
664 for ( int i
= 1; i
<= 3; i
++ )
672 return wxMOUSE_BTN_NONE
;
675 // Find the logical position of the event given the DC
676 wxPoint
wxMouseEvent::GetLogicalPosition(const wxDC
& dc
) const
678 wxPoint
pt(dc
.DeviceToLogicalX(m_x
), dc
.DeviceToLogicalY(m_y
));
688 wxKeyEvent::wxKeyEvent(wxEventType type
)
692 m_controlDown
= false;
702 wxKeyEvent::wxKeyEvent(const wxKeyEvent
& evt
)
708 m_keyCode
= evt
.m_keyCode
;
710 m_controlDown
= evt
.m_controlDown
;
711 m_shiftDown
= evt
.m_shiftDown
;
712 m_altDown
= evt
.m_altDown
;
713 m_metaDown
= evt
.m_metaDown
;
714 m_scanCode
= evt
.m_scanCode
;
715 m_rawCode
= evt
.m_rawCode
;
716 m_rawFlags
= evt
.m_rawFlags
;
719 m_uniChar
= evt
.m_uniChar
;
723 #if WXWIN_COMPATIBILITY_2_6
724 long wxKeyEvent::KeyCode() const
728 #endif // WXWIN_COMPATIBILITY_2_6
730 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow
*win
)
732 SetEventType(wxEVT_CREATE
);
736 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow
*win
)
738 SetEventType(wxEVT_DESTROY
);
742 wxChildFocusEvent::wxChildFocusEvent(wxWindow
*win
)
743 : wxCommandEvent(wxEVT_CHILD_FOCUS
)
748 // ----------------------------------------------------------------------------
750 // ----------------------------------------------------------------------------
753 wxHelpEvent::Origin
wxHelpEvent::GuessOrigin(Origin origin
)
755 if ( origin
== Origin_Unknown
)
757 // assume that the event comes from the help button if it's not from
758 // keyboard and that pressing F1 always results in the help event
759 origin
= wxGetKeyState(WXK_F1
) ? Origin_Keyboard
: Origin_HelpButton
;
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
;
996 // no client data (yet)
998 m_clientDataType
= wxClientData_None
;
1001 wxEvtHandler::~wxEvtHandler()
1003 // Takes itself out of the list of handlers
1004 if (m_previousHandler
)
1005 m_previousHandler
->m_nextHandler
= m_nextHandler
;
1008 m_nextHandler
->m_previousHandler
= m_previousHandler
;
1010 if (m_dynamicEvents
)
1012 for ( wxList::iterator it
= m_dynamicEvents
->begin(),
1013 end
= m_dynamicEvents
->end();
1017 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1018 wxEventTableEntry
*entry
= (wxEventTableEntry
*)*it
;
1019 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1020 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)*it
;
1021 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1023 if (entry
->m_callbackUserData
)
1024 delete entry
->m_callbackUserData
;
1027 delete m_dynamicEvents
;
1030 if (m_pendingEvents
)
1031 m_pendingEvents
->DeleteContents(true);
1032 delete m_pendingEvents
;
1035 # if !defined(__VISAGECPP__)
1036 delete m_eventsLocker
;
1039 // Remove us from wxPendingEvents if necessary.
1040 if(wxPendingEventsLocker
)
1041 wxENTER_CRIT_SECT(*wxPendingEventsLocker
);
1042 if ( wxPendingEvents
)
1044 // Delete all occurences of this from the list of pending events
1045 while (wxPendingEvents
->DeleteObject(this)) { } // Do nothing
1047 if(wxPendingEventsLocker
)
1048 wxLEAVE_CRIT_SECT(*wxPendingEventsLocker
);
1051 // we only delete object data, not untyped
1052 if ( m_clientDataType
== wxClientData_Object
)
1053 delete m_clientObject
;
1058 bool wxEvtHandler::ProcessThreadEvent(wxEvent
& event
)
1060 // check that we are really in a child thread
1061 wxASSERT_MSG( !wxThread::IsMain(),
1062 wxT("use ProcessEvent() in main thread") );
1064 AddPendingEvent(event
);
1069 void wxEvtHandler::ClearEventLocker()
1071 #if !defined(__VISAGECPP__)
1072 delete m_eventsLocker
;
1073 m_eventsLocker
= NULL
;
1077 #endif // wxUSE_THREADS
1079 void wxEvtHandler::AddPendingEvent(wxEvent
& event
)
1081 // 1) Add event to list of pending events of this event handler
1083 wxEvent
*eventCopy
= event
.Clone();
1085 // we must be able to copy the events here so the event class must
1086 // implement Clone() properly instead of just providing a NULL stab for it
1087 wxCHECK_RET( eventCopy
,
1088 _T("events of this type aren't supposed to be posted") );
1090 wxENTER_CRIT_SECT( Lock() );
1092 if ( !m_pendingEvents
)
1093 m_pendingEvents
= new wxList
;
1095 m_pendingEvents
->Append(eventCopy
);
1097 wxLEAVE_CRIT_SECT( Lock() );
1099 // 2) Add this event handler to list of event handlers that
1100 // have pending events.
1102 wxENTER_CRIT_SECT(*wxPendingEventsLocker
);
1104 if ( !wxPendingEvents
)
1105 wxPendingEvents
= new wxList
;
1106 wxPendingEvents
->Append(this);
1108 wxLEAVE_CRIT_SECT(*wxPendingEventsLocker
);
1110 // 3) Inform the system that new pending events are somewhere,
1111 // and that these should be processed in idle time.
1115 void wxEvtHandler::ProcessPendingEvents()
1117 // this method is only called by wxApp if this handler does have
1119 wxCHECK_RET( m_pendingEvents
,
1120 wxT("Please call wxApp::ProcessPendingEvents() instead") );
1122 wxENTER_CRIT_SECT( Lock() );
1124 // we leave the loop once we have processed all events that were present at
1125 // the start of ProcessPendingEvents because otherwise we could get into
1126 // infinite loop if the pending event handler execution resulted in another
1127 // event being posted
1128 size_t n
= m_pendingEvents
->size();
1129 for ( wxList::compatibility_iterator node
= m_pendingEvents
->GetFirst();
1131 node
= m_pendingEvents
->GetFirst() )
1133 wxEvent
*event
= (wxEvent
*)node
->GetData();
1135 // It's importan we remove event from list before processing it.
1136 // Else a nested event loop, for example from a modal dialog, might
1137 // process the same event again.
1139 m_pendingEvents
->Erase(node
);
1141 wxLEAVE_CRIT_SECT( Lock() );
1143 ProcessEvent(*event
);
1147 wxENTER_CRIT_SECT( Lock() );
1153 wxLEAVE_CRIT_SECT( Lock() );
1160 wxEvtHandler::ProcessEventIfMatches(const wxEventTableEntryBase
& entry
,
1161 wxEvtHandler
*handler
,
1164 int tableId1
= entry
.m_id
,
1165 tableId2
= entry
.m_lastId
;
1167 // match only if the event type is the same and the id is either -1 in
1168 // the event table (meaning "any") or the event id matches the id
1169 // specified in the event table either exactly or by falling into
1170 // range between first and last
1171 if ((tableId1
== wxID_ANY
) ||
1172 (tableId2
== wxID_ANY
&& tableId1
== event
.GetId()) ||
1173 (tableId2
!= wxID_ANY
&&
1174 (event
.GetId() >= tableId1
&& event
.GetId() <= tableId2
)))
1177 event
.m_callbackUserData
= entry
.m_callbackUserData
;
1179 #if wxUSE_EXCEPTIONS
1182 // call the handler via wxApp method which allows the user to catch
1183 // any exceptions which may be thrown by any handler in the program
1185 wxTheApp
->HandleEvent(handler
, (wxEventFunction
)entry
.m_fn
, event
);
1188 #endif // wxUSE_EXCEPTIONS
1190 // no need for an extra virtual function call
1191 (handler
->*((wxEventFunction
) (entry
.m_fn
)))(event
);
1194 if (!event
.GetSkipped())
1201 bool wxEvtHandler::TryParent(wxEvent
& event
)
1203 if ( wxTheApp
&& (this != wxTheApp
) )
1205 // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
1206 // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
1207 // processed appropriately via SearchEventTable.
1208 if ( event
.GetEventType() != wxEVT_IDLE
)
1210 if ( wxTheApp
->ProcessEvent(event
) )
1218 bool wxEvtHandler::ProcessEvent(wxEvent
& event
)
1220 // allow the application to hook into event processing
1223 int rc
= wxTheApp
->FilterEvent(event
);
1226 wxASSERT_MSG( rc
== 1 || rc
== 0,
1227 _T("unexpected wxApp::FilterEvent return value") );
1231 //else: proceed normally
1234 // An event handler can be enabled or disabled
1235 if ( GetEvtHandlerEnabled() )
1237 // if we have a validator, it has higher priority than our own event
1239 if ( TryValidator(event
) )
1242 // Handle per-instance dynamic event tables first
1243 if ( m_dynamicEvents
&& SearchDynamicEventTable(event
) )
1246 // Then static per-class event tables
1247 if ( GetEventHashTable().HandleEvent(event
, this) )
1251 // Try going down the event handler chain
1252 if ( GetNextHandler() )
1254 if ( GetNextHandler()->ProcessEvent(event
) )
1258 // Finally propagate the event upwards the window chain and/or to the
1259 // application object as necessary
1260 return TryParent(event
);
1264 bool wxEvtHandler::SearchEventTable(wxEventTable
& table
, wxEvent
& event
)
1266 const wxEventType eventType
= event
.GetEventType();
1267 for ( int i
= 0; table
.entries
[i
].m_fn
!= 0; i
++ )
1269 const wxEventTableEntry
& entry
= table
.entries
[i
];
1270 if ( eventType
== entry
.m_eventType
)
1272 if ( ProcessEventIfMatches(entry
, this, event
) )
1280 void wxEvtHandler::Connect( int id
, int lastId
,
1282 wxObjectEventFunction func
,
1284 wxEvtHandler
* eventSink
)
1286 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1287 wxEventTableEntry
*entry
= new wxEventTableEntry
;
1288 entry
->m_eventType
= eventType
;
1290 entry
->m_lastId
= lastId
;
1292 entry
->m_callbackUserData
= userData
;
1293 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1294 wxDynamicEventTableEntry
*entry
=
1295 new wxDynamicEventTableEntry(eventType
, id
, lastId
, func
, userData
, eventSink
);
1296 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1298 if (!m_dynamicEvents
)
1299 m_dynamicEvents
= new wxList
;
1301 // Insert at the front of the list so most recent additions are found first
1302 m_dynamicEvents
->Insert( (wxObject
*) entry
);
1305 bool wxEvtHandler::Disconnect( int id
, int lastId
, wxEventType eventType
,
1306 wxObjectEventFunction func
,
1308 wxEvtHandler
* eventSink
)
1310 if (!m_dynamicEvents
)
1313 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1316 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1317 wxEventTableEntry
*entry
= (wxEventTableEntry
*)node
->GetData();
1318 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1319 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1320 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1322 if ((entry
->m_id
== id
) &&
1323 ((entry
->m_lastId
== lastId
) || (lastId
== wxID_ANY
)) &&
1324 ((entry
->m_eventType
== eventType
) || (eventType
== wxEVT_NULL
)) &&
1325 ((entry
->m_fn
== func
) || (func
== (wxObjectEventFunction
)NULL
)) &&
1326 ((entry
->m_eventSink
== eventSink
) || (eventSink
== (wxEvtHandler
*)NULL
)) &&
1327 ((entry
->m_callbackUserData
== userData
) || (userData
== (wxObject
*)NULL
)))
1329 if (entry
->m_callbackUserData
)
1330 delete entry
->m_callbackUserData
;
1331 m_dynamicEvents
->Erase( node
);
1335 node
= node
->GetNext();
1340 bool wxEvtHandler::SearchDynamicEventTable( wxEvent
& event
)
1342 wxCHECK_MSG( m_dynamicEvents
, false,
1343 wxT("caller should check that we have dynamic events") );
1345 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1348 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1349 wxEventTableEntry
*entry
= (wxEventTableEntry
*)node
->GetData();
1350 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1351 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1352 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1354 // get next node before (maybe) calling the event handler as it could
1355 // call Disconnect() invalidating the current node
1356 node
= node
->GetNext();
1358 if ((event
.GetEventType() == entry
->m_eventType
) && (entry
->m_fn
!= 0))
1360 wxEvtHandler
*handler
=
1361 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
1362 entry
->m_eventSink
? entry
->m_eventSink
1367 if ( ProcessEventIfMatches(*entry
, handler
, event
) )
1377 void wxEvtHandler::DoSetClientObject( wxClientData
*data
)
1379 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1380 wxT("can't have both object and void client data") );
1382 if ( m_clientObject
)
1383 delete m_clientObject
;
1385 m_clientObject
= data
;
1386 m_clientDataType
= wxClientData_Object
;
1389 wxClientData
*wxEvtHandler::DoGetClientObject() const
1391 // it's not an error to call GetClientObject() on a window which doesn't
1392 // have client data at all - NULL will be returned
1393 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1394 wxT("this window doesn't have object client data") );
1396 return m_clientObject
;
1399 void wxEvtHandler::DoSetClientData( void *data
)
1401 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1402 wxT("can't have both object and void client data") );
1404 m_clientData
= data
;
1405 m_clientDataType
= wxClientData_Void
;
1408 void *wxEvtHandler::DoGetClientData() const
1410 // it's not an error to call GetClientData() on a window which doesn't have
1411 // client data at all - NULL will be returned
1412 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1413 wxT("this window doesn't have void client data") );
1415 return m_clientData
;
1418 #endif // wxUSE_BASE
1422 // Find a window with the focus, that is also a descendant of the given window.
1423 // This is used to determine the window to initially send commands to.
1424 wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
)
1426 // Process events starting with the window with the focus, if any.
1427 wxWindow
* focusWin
= wxWindow::FindFocus();
1428 wxWindow
* win
= focusWin
;
1430 // Check if this is a descendant of this frame.
1431 // If not, win will be set to NULL.
1434 if (win
== ancestor
)
1437 win
= win
->GetParent();
1439 if (win
== (wxWindow
*) NULL
)
1440 focusWin
= (wxWindow
*) NULL
;
1445 // ----------------------------------------------------------------------------
1447 // ----------------------------------------------------------------------------
1449 wxEventBlocker::wxEventBlocker(wxWindow
*win
, wxEventType type
)
1451 wxCHECK_RET(win
, wxT("Null window given to wxEventBlocker"));
1456 m_window
->PushEventHandler(this);
1459 wxEventBlocker::~wxEventBlocker()
1461 wxEvtHandler
*popped
= m_window
->PopEventHandler(false);
1462 wxCHECK_RET(popped
== this,
1463 wxT("Don't push other event handlers into a window managed by wxEventBlocker!"));
1466 bool wxEventBlocker::ProcessEvent(wxEvent
& event
)
1468 // should this event be blocked?
1469 for ( size_t i
= 0; i
< m_eventsToBlock
.size(); i
++ )
1471 wxEventType t
= (wxEventType
)m_eventsToBlock
[i
];
1472 if ( t
== wxEVT_ANY
|| t
== event
.GetEventType() )
1473 return true; // yes, it should: mark this event as processed