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
)
54 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
)
151 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
157 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
159 DEFINE_EVENT_TYPE(wxEVT_COMMAND_BUTTON_CLICKED
)
160 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKBOX_CLICKED
)
161 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHOICE_SELECTED
)
162 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_SELECTED
)
163 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
)
164 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
)
165 DEFINE_EVENT_TYPE(wxEVT_COMMAND_MENU_SELECTED
)
166 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SLIDER_UPDATED
)
167 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBOX_SELECTED
)
168 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBUTTON_SELECTED
)
169 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SCROLLBAR_UPDATED
)
170 DEFINE_EVENT_TYPE(wxEVT_COMMAND_VLBOX_SELECTED
)
171 DEFINE_EVENT_TYPE(wxEVT_COMMAND_COMBOBOX_SELECTED
)
172 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED
)
173 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER
)
174 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED
)
176 // Sockets and timers send events, too
177 DEFINE_EVENT_TYPE(wxEVT_TIMER
)
180 DEFINE_EVENT_TYPE(wxEVT_LEFT_DOWN
)
181 DEFINE_EVENT_TYPE(wxEVT_LEFT_UP
)
182 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DOWN
)
183 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_UP
)
184 DEFINE_EVENT_TYPE(wxEVT_RIGHT_DOWN
)
185 DEFINE_EVENT_TYPE(wxEVT_RIGHT_UP
)
186 DEFINE_EVENT_TYPE(wxEVT_MOTION
)
187 DEFINE_EVENT_TYPE(wxEVT_ENTER_WINDOW
)
188 DEFINE_EVENT_TYPE(wxEVT_LEAVE_WINDOW
)
189 DEFINE_EVENT_TYPE(wxEVT_LEFT_DCLICK
)
190 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DCLICK
)
191 DEFINE_EVENT_TYPE(wxEVT_RIGHT_DCLICK
)
192 DEFINE_EVENT_TYPE(wxEVT_SET_FOCUS
)
193 DEFINE_EVENT_TYPE(wxEVT_KILL_FOCUS
)
194 DEFINE_EVENT_TYPE(wxEVT_CHILD_FOCUS
)
195 DEFINE_EVENT_TYPE(wxEVT_MOUSEWHEEL
)
197 // Non-client mouse events
198 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN
)
199 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_UP
)
200 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DOWN
)
201 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_UP
)
202 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DOWN
)
203 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_UP
)
204 DEFINE_EVENT_TYPE(wxEVT_NC_MOTION
)
205 DEFINE_EVENT_TYPE(wxEVT_NC_ENTER_WINDOW
)
206 DEFINE_EVENT_TYPE(wxEVT_NC_LEAVE_WINDOW
)
207 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DCLICK
)
208 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DCLICK
)
209 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DCLICK
)
211 // Character input event type
212 DEFINE_EVENT_TYPE(wxEVT_CHAR
)
213 DEFINE_EVENT_TYPE(wxEVT_CHAR_HOOK
)
214 DEFINE_EVENT_TYPE(wxEVT_NAVIGATION_KEY
)
215 DEFINE_EVENT_TYPE(wxEVT_KEY_DOWN
)
216 DEFINE_EVENT_TYPE(wxEVT_KEY_UP
)
218 DEFINE_EVENT_TYPE(wxEVT_HOTKEY
)
222 DEFINE_EVENT_TYPE(wxEVT_SET_CURSOR
)
224 // wxScrollbar and wxSlider event identifiers
225 DEFINE_EVENT_TYPE(wxEVT_SCROLL_TOP
)
226 DEFINE_EVENT_TYPE(wxEVT_SCROLL_BOTTOM
)
227 DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEUP
)
228 DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEDOWN
)
229 DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEUP
)
230 DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN
)
231 DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK
)
232 DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE
)
233 DEFINE_EVENT_TYPE(wxEVT_SCROLL_CHANGED
)
235 // Scroll events from wxWindow
236 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP
)
237 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_BOTTOM
)
238 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEUP
)
239 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEDOWN
)
240 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEUP
)
241 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEDOWN
)
242 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBTRACK
)
243 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBRELEASE
)
246 DEFINE_EVENT_TYPE(wxEVT_SIZE
)
247 DEFINE_EVENT_TYPE(wxEVT_SIZING
)
248 DEFINE_EVENT_TYPE(wxEVT_MOVE
)
249 DEFINE_EVENT_TYPE(wxEVT_MOVING
)
250 DEFINE_EVENT_TYPE(wxEVT_CLOSE_WINDOW
)
251 DEFINE_EVENT_TYPE(wxEVT_END_SESSION
)
252 DEFINE_EVENT_TYPE(wxEVT_QUERY_END_SESSION
)
253 DEFINE_EVENT_TYPE(wxEVT_HIBERNATE
)
254 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE_APP
)
255 DEFINE_EVENT_TYPE(wxEVT_POWER
)
256 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE
)
257 DEFINE_EVENT_TYPE(wxEVT_CREATE
)
258 DEFINE_EVENT_TYPE(wxEVT_DESTROY
)
259 DEFINE_EVENT_TYPE(wxEVT_SHOW
)
260 DEFINE_EVENT_TYPE(wxEVT_ICONIZE
)
261 DEFINE_EVENT_TYPE(wxEVT_MAXIMIZE
)
262 DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED
)
263 DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_LOST
)
264 DEFINE_EVENT_TYPE(wxEVT_PAINT
)
265 DEFINE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND
)
266 DEFINE_EVENT_TYPE(wxEVT_NC_PAINT
)
267 DEFINE_EVENT_TYPE(wxEVT_PAINT_ICON
)
268 DEFINE_EVENT_TYPE(wxEVT_MENU_OPEN
)
269 DEFINE_EVENT_TYPE(wxEVT_MENU_CLOSE
)
270 DEFINE_EVENT_TYPE(wxEVT_MENU_HIGHLIGHT
)
271 DEFINE_EVENT_TYPE(wxEVT_CONTEXT_MENU
)
272 DEFINE_EVENT_TYPE(wxEVT_SYS_COLOUR_CHANGED
)
273 DEFINE_EVENT_TYPE(wxEVT_DISPLAY_CHANGED
)
274 DEFINE_EVENT_TYPE(wxEVT_SETTING_CHANGED
)
275 DEFINE_EVENT_TYPE(wxEVT_QUERY_NEW_PALETTE
)
276 DEFINE_EVENT_TYPE(wxEVT_PALETTE_CHANGED
)
277 DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_DOWN
)
278 DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_UP
)
279 DEFINE_EVENT_TYPE(wxEVT_JOY_MOVE
)
280 DEFINE_EVENT_TYPE(wxEVT_JOY_ZMOVE
)
281 DEFINE_EVENT_TYPE(wxEVT_DROP_FILES
)
282 DEFINE_EVENT_TYPE(wxEVT_DRAW_ITEM
)
283 DEFINE_EVENT_TYPE(wxEVT_MEASURE_ITEM
)
284 DEFINE_EVENT_TYPE(wxEVT_COMPARE_ITEM
)
285 DEFINE_EVENT_TYPE(wxEVT_INIT_DIALOG
)
286 DEFINE_EVENT_TYPE(wxEVT_UPDATE_UI
)
289 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_COPY
)
290 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_CUT
)
291 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_PASTE
)
293 // Generic command events
294 // Note: a click is a higher-level event than button down/up
295 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK
)
296 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_DCLICK
)
297 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_CLICK
)
298 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_DCLICK
)
299 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SET_FOCUS
)
300 DEFINE_EVENT_TYPE(wxEVT_COMMAND_KILL_FOCUS
)
301 DEFINE_EVENT_TYPE(wxEVT_COMMAND_ENTER
)
304 DEFINE_EVENT_TYPE(wxEVT_HELP
)
305 DEFINE_EVENT_TYPE(wxEVT_DETAILED_HELP
)
307 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
313 // ============================================================================
315 // ============================================================================
317 // ----------------------------------------------------------------------------
318 // event initialization
319 // ----------------------------------------------------------------------------
324 static int s_lastUsedEventType
= wxEVT_FIRST
;
326 return s_lastUsedEventType
++;
329 // ----------------------------------------------------------------------------
331 // ----------------------------------------------------------------------------
334 * General wxWidgets events, covering
335 * all interesting things that might happen (button clicking, resizing,
336 * setting text in widgets, etc.).
338 * For each completely new event type, derive a new event class.
342 wxEvent::wxEvent(int theId
, wxEventType commandType
)
344 m_eventType
= commandType
;
345 m_eventObject
= (wxObject
*) NULL
;
349 m_callbackUserData
= (wxObject
*) NULL
;
350 m_isCommandEvent
= false;
351 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
354 wxEvent::wxEvent(const wxEvent
&src
)
356 , m_eventObject(src
.m_eventObject
)
357 , m_eventType(src
.m_eventType
)
358 , m_timeStamp(src
.m_timeStamp
)
360 , m_callbackUserData(src
.m_callbackUserData
)
361 , m_propagationLevel(src
.m_propagationLevel
)
362 , m_skipped(src
.m_skipped
)
363 , m_isCommandEvent(src
.m_isCommandEvent
)
377 // 'this' : used in base member initializer list (for m_commandString)
378 #pragma warning(disable:4355)
381 wxCommandEvent::wxCommandEvent(wxEventType commandType
, int theId
)
382 : wxEvent(theId
, commandType
)
383 #if WXWIN_COMPATIBILITY_2_4
384 , m_commandString(this)
387 m_clientData
= (char *) NULL
;
388 m_clientObject
= (wxClientData
*) NULL
;
391 m_isCommandEvent
= true;
393 // the command events are propagated upwards by default
394 m_propagationLevel
= wxEVENT_PROPAGATE_MAX
;
398 #pragma warning(default:4355)
401 wxString
wxCommandEvent::GetString() const
403 if(m_eventType
!= wxEVT_COMMAND_TEXT_UPDATED
|| !m_eventObject
)
408 wxTextCtrl
*txt
= wxDynamicCast(m_eventObject
, wxTextCtrl
);
410 return txt
->GetValue();
412 #endif // wxUSE_TEXTCTRL
422 wxLongLong
wxUpdateUIEvent::sm_lastUpdate
= 0;
425 long wxUpdateUIEvent::sm_updateInterval
= 0;
427 wxUpdateUIMode
wxUpdateUIEvent::sm_updateMode
= wxUPDATE_UI_PROCESS_ALL
;
430 bool wxUpdateUIEvent::CanUpdate(wxWindowBase
*win
)
432 // Don't update if we've switched global updating off
433 // and this window doesn't support updates.
435 (GetMode() == wxUPDATE_UI_PROCESS_SPECIFIED
&&
436 ((win
->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES
) == 0)))
439 if (sm_updateInterval
== -1)
442 if (sm_updateInterval
== 0)
445 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
446 wxLongLong now
= wxGetLocalTimeMillis();
447 if (now
> (sm_lastUpdate
+ sm_updateInterval
))
454 // If we don't have wxStopWatch or wxLongLong, we
455 // should err on the safe side and update now anyway.
460 // Reset the update time to provide a delay until the next
461 // time we should update
462 void wxUpdateUIEvent::ResetUpdateTime()
464 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
465 if (sm_updateInterval
> 0)
467 wxLongLong now
= wxGetLocalTimeMillis();
468 if (now
> (sm_lastUpdate
+ sm_updateInterval
))
480 wxIdleMode
wxIdleEvent::sm_idleMode
= wxIDLE_PROCESS_ALL
;
482 // Can we send an idle event?
483 bool wxIdleEvent::CanSend(wxWindow
* win
)
485 // Don't update if we've switched global updating off
486 // and this window doesn't support updates.
488 (GetMode() == wxIDLE_PROCESS_SPECIFIED
&&
489 ((win
->GetExtraStyle() & wxWS_EX_PROCESS_IDLE
) == 0)))
499 wxScrollEvent::wxScrollEvent(wxEventType commandType
,
503 : wxCommandEvent(commandType
, id
)
505 m_extraLong
= orient
;
513 wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType
,
517 m_eventType
= commandType
;
518 m_extraLong
= orient
;
527 wxMouseEvent::wxMouseEvent(wxEventType commandType
)
529 m_eventType
= commandType
;
532 m_controlDown
= false;
536 m_middleDown
= false;
541 m_linesPerAction
= 0;
544 void wxMouseEvent::Assign(const wxMouseEvent
& event
)
546 m_eventType
= event
.m_eventType
;
551 m_leftDown
= event
.m_leftDown
;
552 m_middleDown
= event
.m_middleDown
;
553 m_rightDown
= event
.m_rightDown
;
555 m_controlDown
= event
.m_controlDown
;
556 m_shiftDown
= event
.m_shiftDown
;
557 m_altDown
= event
.m_altDown
;
558 m_metaDown
= event
.m_metaDown
;
560 m_wheelRotation
= event
.m_wheelRotation
;
561 m_wheelDelta
= event
.m_wheelDelta
;
562 m_linesPerAction
= event
.m_linesPerAction
;
565 // return true if was a button dclick event
566 bool wxMouseEvent::ButtonDClick(int but
) const
571 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
574 case wxMOUSE_BTN_ANY
:
575 return (LeftDClick() || MiddleDClick() || RightDClick());
577 case wxMOUSE_BTN_LEFT
:
580 case wxMOUSE_BTN_MIDDLE
:
581 return MiddleDClick();
583 case wxMOUSE_BTN_RIGHT
:
584 return RightDClick();
588 // return true if was a button down event
589 bool wxMouseEvent::ButtonDown(int but
) const
594 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
597 case wxMOUSE_BTN_ANY
:
598 return (LeftDown() || MiddleDown() || RightDown());
600 case wxMOUSE_BTN_LEFT
:
603 case wxMOUSE_BTN_MIDDLE
:
606 case wxMOUSE_BTN_RIGHT
:
611 // return true if was a button up event
612 bool wxMouseEvent::ButtonUp(int but
) const
617 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
620 case wxMOUSE_BTN_ANY
:
621 return (LeftUp() || MiddleUp() || RightUp());
623 case wxMOUSE_BTN_LEFT
:
626 case wxMOUSE_BTN_MIDDLE
:
629 case wxMOUSE_BTN_RIGHT
:
634 // return true if the given button is currently changing state
635 bool wxMouseEvent::Button(int but
) const
640 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
643 case wxMOUSE_BTN_ANY
:
644 return ButtonUp(wxMOUSE_BTN_ANY
) ||
645 ButtonDown(wxMOUSE_BTN_ANY
) ||
646 ButtonDClick(wxMOUSE_BTN_ANY
);
648 case wxMOUSE_BTN_LEFT
:
649 return LeftDown() || LeftUp() || LeftDClick();
651 case wxMOUSE_BTN_MIDDLE
:
652 return MiddleDown() || MiddleUp() || MiddleDClick();
654 case wxMOUSE_BTN_RIGHT
:
655 return RightDown() || RightUp() || RightDClick();
659 bool wxMouseEvent::ButtonIsDown(int but
) const
664 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonIsDown"));
667 case wxMOUSE_BTN_ANY
:
668 return LeftIsDown() || MiddleIsDown() || RightIsDown();
670 case wxMOUSE_BTN_LEFT
:
673 case wxMOUSE_BTN_MIDDLE
:
674 return MiddleIsDown();
676 case wxMOUSE_BTN_RIGHT
:
677 return RightIsDown();
681 int wxMouseEvent::GetButton() const
683 for ( int i
= 1; i
<= 3; i
++ )
691 return wxMOUSE_BTN_NONE
;
694 // Find the logical position of the event given the DC
695 wxPoint
wxMouseEvent::GetLogicalPosition(const wxDC
& dc
) const
697 wxPoint
pt(dc
.DeviceToLogicalX(m_x
), dc
.DeviceToLogicalY(m_y
));
707 wxKeyEvent::wxKeyEvent(wxEventType type
)
711 m_controlDown
= false;
721 wxKeyEvent::wxKeyEvent(const wxKeyEvent
& evt
)
727 m_keyCode
= evt
.m_keyCode
;
729 m_controlDown
= evt
.m_controlDown
;
730 m_shiftDown
= evt
.m_shiftDown
;
731 m_altDown
= evt
.m_altDown
;
732 m_metaDown
= evt
.m_metaDown
;
733 m_scanCode
= evt
.m_scanCode
;
734 m_rawCode
= evt
.m_rawCode
;
735 m_rawFlags
= evt
.m_rawFlags
;
738 m_uniChar
= evt
.m_uniChar
;
742 #if WXWIN_COMPATIBILITY_2_6
743 long wxKeyEvent::KeyCode() const
747 #endif // WXWIN_COMPATIBILITY_2_6
749 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow
*win
)
751 SetEventType(wxEVT_CREATE
);
755 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow
*win
)
757 SetEventType(wxEVT_DESTROY
);
761 wxChildFocusEvent::wxChildFocusEvent(wxWindow
*win
)
762 : wxCommandEvent(wxEVT_CHILD_FOCUS
)
767 // ----------------------------------------------------------------------------
769 // ----------------------------------------------------------------------------
772 wxHelpEvent::Origin
wxHelpEvent::GuessOrigin(Origin origin
)
774 if ( origin
== Origin_Unknown
)
776 // assume that the event comes from the help button if it's not from
777 // keyboard and that pressing F1 always results in the help event
778 origin
= wxGetKeyState(WXK_F1
) ? Origin_Keyboard
: Origin_HelpButton
;
789 // ----------------------------------------------------------------------------
791 // ----------------------------------------------------------------------------
793 static const int EVENT_TYPE_TABLE_INIT_SIZE
= 31; // Not too big not too small...
795 wxEventHashTable
* wxEventHashTable::sm_first
= NULL
;
797 wxEventHashTable::wxEventHashTable(const wxEventTable
&table
)
801 AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE
);
805 m_next
->m_previous
= this;
809 wxEventHashTable::~wxEventHashTable()
812 m_next
->m_previous
= m_previous
;
814 m_previous
->m_next
= m_next
;
815 if (sm_first
== this)
821 void wxEventHashTable::Clear()
824 for(i
= 0; i
< m_size
; i
++)
826 EventTypeTablePointer eTTnode
= m_eventTypeTable
[i
];
833 // Necessary in order to not invoke the
834 // overloaded delete operator when statics are cleaned up
835 if (m_eventTypeTable
)
836 delete[] m_eventTypeTable
;
838 m_eventTypeTable
= NULL
;
843 void wxEventHashTable::ClearAll()
845 wxEventHashTable
* table
= sm_first
;
849 table
= table
->m_next
;
853 bool wxEventHashTable::HandleEvent(wxEvent
&event
, wxEvtHandler
*self
)
858 m_rebuildHash
= false;
861 if (!m_eventTypeTable
)
864 // Find all entries for the given event type.
865 wxEventType eventType
= event
.GetEventType();
866 const EventTypeTablePointer eTTnode
= m_eventTypeTable
[eventType
% m_size
];
867 if (eTTnode
&& eTTnode
->eventType
== eventType
)
869 // Now start the search for an event handler
870 // that can handle an event with the given ID.
871 const wxEventTableEntryPointerArray
&
872 eventEntryTable
= eTTnode
->eventEntryTable
;
874 const size_t count
= eventEntryTable
.GetCount();
875 for (size_t n
= 0; n
< count
; n
++)
878 ProcessEventIfMatches(*eventEntryTable
[n
], self
, event
) )
888 void wxEventHashTable::InitHashTable()
890 // Loop over the event tables and all its base tables.
891 const wxEventTable
*table
= &m_table
;
894 // Retrieve all valid event handler entries
895 const wxEventTableEntry
*entry
= table
->entries
;
896 while (entry
->m_fn
!= 0)
898 // Add the event entry in the Hash.
904 table
= table
->baseTable
;
907 // Lets free some memory.
909 for(i
= 0; i
< m_size
; i
++)
911 EventTypeTablePointer eTTnode
= m_eventTypeTable
[i
];
914 eTTnode
->eventEntryTable
.Shrink();
919 void wxEventHashTable::AddEntry(const wxEventTableEntry
&entry
)
921 // This might happen 'accidentally' as the app is exiting
922 if (!m_eventTypeTable
)
925 EventTypeTablePointer
*peTTnode
= &m_eventTypeTable
[entry
.m_eventType
% m_size
];
926 EventTypeTablePointer eTTnode
= *peTTnode
;
930 if (eTTnode
->eventType
!= entry
.m_eventType
)
933 GrowEventTypeTable();
934 // Try again to add it.
941 eTTnode
= new EventTypeTable
;
942 eTTnode
->eventType
= entry
.m_eventType
;
946 // Fill all hash entries between entry.m_id and entry.m_lastId...
947 eTTnode
->eventEntryTable
.Add(&entry
);
950 void wxEventHashTable::AllocEventTypeTable(size_t size
)
952 m_eventTypeTable
= new EventTypeTablePointer
[size
];
953 memset((void *)m_eventTypeTable
, 0, sizeof(EventTypeTablePointer
)*size
);
957 void wxEventHashTable::GrowEventTypeTable()
959 size_t oldSize
= m_size
;
960 EventTypeTablePointer
*oldEventTypeTable
= m_eventTypeTable
;
962 // TODO: Search the most optimal grow sequence
963 AllocEventTypeTable(/* GetNextPrime(oldSize) */oldSize
*2+1);
965 for ( size_t i
= 0; i
< oldSize
; /* */ )
967 EventTypeTablePointer eTToldNode
= oldEventTypeTable
[i
];
970 EventTypeTablePointer
*peTTnode
= &m_eventTypeTable
[eTToldNode
->eventType
% m_size
];
971 EventTypeTablePointer eTTnode
= *peTTnode
;
973 // Check for collision, we don't want any.
976 GrowEventTypeTable();
977 continue; // Don't increment the counter,
978 // as we still need to add this element.
982 // Get the old value and put it in the new table.
983 *peTTnode
= oldEventTypeTable
[i
];
990 delete[] oldEventTypeTable
;
994 // ----------------------------------------------------------------------------
996 // ----------------------------------------------------------------------------
1002 wxEvtHandler::wxEvtHandler()
1004 m_nextHandler
= (wxEvtHandler
*) NULL
;
1005 m_previousHandler
= (wxEvtHandler
*) NULL
;
1007 m_dynamicEvents
= (wxList
*) NULL
;
1008 m_pendingEvents
= (wxList
*) NULL
;
1010 # if !defined(__VISAGECPP__)
1011 m_eventsLocker
= new wxCriticalSection
;
1014 // reentrace not allowed by default
1015 m_reentranceAllowed
= false;
1016 m_eventHandlingInProgress
= false;
1018 // no client data (yet)
1019 m_clientData
= NULL
;
1020 m_clientDataType
= wxClientData_None
;
1023 wxEvtHandler::~wxEvtHandler()
1025 // Takes itself out of the list of handlers
1026 if (m_previousHandler
)
1027 m_previousHandler
->m_nextHandler
= m_nextHandler
;
1030 m_nextHandler
->m_previousHandler
= m_previousHandler
;
1032 if (m_dynamicEvents
)
1034 wxList::iterator it
= m_dynamicEvents
->begin(),
1035 en
= m_dynamicEvents
->end();
1036 for (;it
!= en
; ++it
)
1038 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1039 wxEventTableEntry
*entry
= (wxEventTableEntry
*)*it
;
1040 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1041 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)*it
;
1042 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1044 if (entry
->m_callbackUserData
)
1045 delete entry
->m_callbackUserData
;
1048 delete m_dynamicEvents
;
1051 if (m_pendingEvents
)
1052 m_pendingEvents
->DeleteContents(true);
1053 delete m_pendingEvents
;
1056 # if !defined(__VISAGECPP__)
1057 delete m_eventsLocker
;
1060 // Remove us from wxPendingEvents if necessary.
1061 if(wxPendingEventsLocker
)
1062 wxENTER_CRIT_SECT(*wxPendingEventsLocker
);
1063 if ( wxPendingEvents
)
1065 // Delete all occurences of this from the list of pending events
1066 while (wxPendingEvents
->DeleteObject(this)) { } // Do nothing
1068 if(wxPendingEventsLocker
)
1069 wxLEAVE_CRIT_SECT(*wxPendingEventsLocker
);
1072 // we only delete object data, not untyped
1073 if ( m_clientDataType
== wxClientData_Object
)
1074 delete m_clientObject
;
1079 bool wxEvtHandler::ProcessThreadEvent(wxEvent
& event
)
1081 // check that we are really in a child thread
1082 wxASSERT_MSG( !wxThread::IsMain(),
1083 wxT("use ProcessEvent() in main thread") );
1085 AddPendingEvent(event
);
1090 void wxEvtHandler::ClearEventLocker()
1092 #if !defined(__VISAGECPP__)
1093 delete m_eventsLocker
;
1094 m_eventsLocker
= NULL
;
1098 #endif // wxUSE_THREADS
1100 void wxEvtHandler::AddPendingEvent(wxEvent
& event
)
1102 // 1) Add event to list of pending events of this event handler
1104 wxEvent
*eventCopy
= event
.Clone();
1106 // we must be able to copy the events here so the event class must
1107 // implement Clone() properly instead of just providing a NULL stab for it
1108 wxCHECK_RET( eventCopy
,
1109 _T("events of this type aren't supposed to be posted") );
1111 wxENTER_CRIT_SECT( Lock() );
1113 if ( !m_pendingEvents
)
1114 m_pendingEvents
= new wxList
;
1116 m_pendingEvents
->Append(eventCopy
);
1118 wxLEAVE_CRIT_SECT( Lock() );
1120 // 2) Add this event handler to list of event handlers that
1121 // have pending events.
1123 wxENTER_CRIT_SECT(*wxPendingEventsLocker
);
1125 if ( !wxPendingEvents
)
1126 wxPendingEvents
= new wxList
;
1127 wxPendingEvents
->Append(this);
1129 wxLEAVE_CRIT_SECT(*wxPendingEventsLocker
);
1131 // 3) Inform the system that new pending events are somewhere,
1132 // and that these should be processed in idle time.
1136 void wxEvtHandler::ProcessPendingEvents()
1138 // this method is only called by wxApp if this handler does have
1140 wxCHECK_RET( m_pendingEvents
,
1141 wxT("Please call wxApp::ProcessPendingEvents() instead") );
1143 // eventhandling is now in progess
1144 m_eventHandlingInProgress
= true;
1146 wxENTER_CRIT_SECT( Lock() );
1148 // we leave the loop once we have processed all events that were present at
1149 // the start of ProcessPendingEvents because otherwise we could get into
1150 // infinite loop if the pending event handler execution resulted in another
1151 // event being posted
1152 size_t n
= m_pendingEvents
->size();
1153 for ( wxList::compatibility_iterator node
= m_pendingEvents
->GetFirst();
1155 node
= m_pendingEvents
->GetFirst() )
1157 wxEvent
*event
= (wxEvent
*)node
->GetData();
1159 // It's importan we remove event from list before processing it.
1160 // Else a nested event loop, for example from a modal dialog, might
1161 // process the same event again.
1163 m_pendingEvents
->Erase(node
);
1165 wxLEAVE_CRIT_SECT( Lock() );
1167 ProcessEvent(*event
);
1171 wxENTER_CRIT_SECT( Lock() );
1177 wxLEAVE_CRIT_SECT( Lock() );
1179 // eventhandling no longer in progess
1180 m_eventHandlingInProgress
= false;
1187 wxEvtHandler::ProcessEventIfMatches(const wxEventTableEntryBase
& entry
,
1188 wxEvtHandler
*handler
,
1191 int tableId1
= entry
.m_id
,
1192 tableId2
= entry
.m_lastId
;
1194 // match only if the event type is the same and the id is either -1 in
1195 // the event table (meaning "any") or the event id matches the id
1196 // specified in the event table either exactly or by falling into
1197 // range between first and last
1198 if ((tableId1
== wxID_ANY
) ||
1199 (tableId2
== wxID_ANY
&& tableId1
== event
.GetId()) ||
1200 (tableId2
!= wxID_ANY
&&
1201 (event
.GetId() >= tableId1
&& event
.GetId() <= tableId2
)))
1204 event
.m_callbackUserData
= entry
.m_callbackUserData
;
1206 #if wxUSE_EXCEPTIONS
1209 // call the handler via wxApp method which allows the user to catch
1210 // any exceptions which may be thrown by any handler in the program
1212 wxTheApp
->HandleEvent(handler
, (wxEventFunction
)entry
.m_fn
, event
);
1215 #endif // wxUSE_EXCEPTIONS
1217 // no need for an extra virtual function call
1218 (handler
->*((wxEventFunction
) (entry
.m_fn
)))(event
);
1221 if (!event
.GetSkipped())
1228 bool wxEvtHandler::TryParent(wxEvent
& event
)
1230 if ( wxTheApp
&& (this != wxTheApp
) )
1232 // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
1233 // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
1234 // processed appropriately via SearchEventTable.
1235 if ( event
.GetEventType() != wxEVT_IDLE
)
1237 if ( wxTheApp
->ProcessEvent(event
) )
1245 bool wxEvtHandler::ProcessEvent(wxEvent
& event
)
1247 // allow the application to hook into event processing
1250 int rc
= wxTheApp
->FilterEvent(event
);
1253 wxASSERT_MSG( rc
== 1 || rc
== 0,
1254 _T("unexpected wxApp::FilterEvent return value") );
1258 //else: proceed normally
1261 // An event handler can be enabled or disabled
1262 if ( GetEvtHandlerEnabled() )
1264 // if we have a validator, it has higher priority than our own event
1266 if ( TryValidator(event
) )
1269 // Handle per-instance dynamic event tables first
1270 if ( m_dynamicEvents
&& SearchDynamicEventTable(event
) )
1273 // Then static per-class event tables
1274 if ( GetEventHashTable().HandleEvent(event
, this) )
1278 // Try going down the event handler chain
1279 if ( GetNextHandler() )
1281 if ( GetNextHandler()->ProcessEvent(event
) )
1285 // Finally propagate the event upwards the window chain and/or to the
1286 // application object as necessary
1287 return TryParent(event
);
1291 bool wxEvtHandler::SearchEventTable(wxEventTable
& table
, wxEvent
& event
)
1293 const wxEventType eventType
= event
.GetEventType();
1294 for ( int i
= 0; table
.entries
[i
].m_fn
!= 0; i
++ )
1296 const wxEventTableEntry
& entry
= table
.entries
[i
];
1297 if ( eventType
== entry
.m_eventType
)
1299 if ( ProcessEventIfMatches(entry
, this, event
) )
1307 void wxEvtHandler::Connect( int id
, int lastId
,
1309 wxObjectEventFunction func
,
1311 wxEvtHandler
* eventSink
)
1313 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1314 wxEventTableEntry
*entry
= new wxEventTableEntry
;
1315 entry
->m_eventType
= eventType
;
1317 entry
->m_lastId
= lastId
;
1319 entry
->m_callbackUserData
= userData
;
1320 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1321 wxDynamicEventTableEntry
*entry
=
1322 new wxDynamicEventTableEntry(eventType
, id
, lastId
, func
, userData
, eventSink
);
1323 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1325 if (!m_dynamicEvents
)
1326 m_dynamicEvents
= new wxList
;
1328 // Insert at the front of the list so most recent additions are found first
1329 m_dynamicEvents
->Insert( (wxObject
*) entry
);
1332 bool wxEvtHandler::Disconnect( int id
, int lastId
, wxEventType eventType
,
1333 wxObjectEventFunction func
,
1335 wxEvtHandler
* eventSink
)
1337 if (!m_dynamicEvents
)
1340 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1343 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1344 wxEventTableEntry
*entry
= (wxEventTableEntry
*)node
->GetData();
1345 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1346 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1347 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1349 if ((entry
->m_id
== id
) &&
1350 ((entry
->m_lastId
== lastId
) || (lastId
== wxID_ANY
)) &&
1351 ((entry
->m_eventType
== eventType
) || (eventType
== wxEVT_NULL
)) &&
1352 ((entry
->m_fn
== func
) || (func
== (wxObjectEventFunction
)NULL
)) &&
1353 ((entry
->m_eventSink
== eventSink
) || (eventSink
== (wxEvtHandler
*)NULL
)) &&
1354 ((entry
->m_callbackUserData
== userData
) || (userData
== (wxObject
*)NULL
)))
1356 if (entry
->m_callbackUserData
)
1357 delete entry
->m_callbackUserData
;
1358 m_dynamicEvents
->Erase( node
);
1362 node
= node
->GetNext();
1367 bool wxEvtHandler::SearchDynamicEventTable( wxEvent
& event
)
1369 wxCHECK_MSG( m_dynamicEvents
, false,
1370 wxT("caller should check that we have dynamic events") );
1372 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1375 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1376 wxEventTableEntry
*entry
= (wxEventTableEntry
*)node
->GetData();
1377 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1378 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1379 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1381 // get next node before (maybe) calling the event handler as it could
1382 // call Disconnect() invalidating the current node
1383 node
= node
->GetNext();
1385 if ((event
.GetEventType() == entry
->m_eventType
) && (entry
->m_fn
!= 0))
1387 wxEvtHandler
*handler
=
1388 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
1389 entry
->m_eventSink
? entry
->m_eventSink
1394 if ( ProcessEventIfMatches(*entry
, handler
, event
) )
1404 void wxEvtHandler::DoSetClientObject( wxClientData
*data
)
1406 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1407 wxT("can't have both object and void client data") );
1409 if ( m_clientObject
)
1410 delete m_clientObject
;
1412 m_clientObject
= data
;
1413 m_clientDataType
= wxClientData_Object
;
1416 wxClientData
*wxEvtHandler::DoGetClientObject() const
1418 // it's not an error to call GetClientObject() on a window which doesn't
1419 // have client data at all - NULL will be returned
1420 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1421 wxT("this window doesn't have object client data") );
1423 return m_clientObject
;
1426 void wxEvtHandler::DoSetClientData( void *data
)
1428 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1429 wxT("can't have both object and void client data") );
1431 m_clientData
= data
;
1432 m_clientDataType
= wxClientData_Void
;
1435 void *wxEvtHandler::DoGetClientData() const
1437 // it's not an error to call GetClientData() on a window which doesn't have
1438 // client data at all - NULL will be returned
1439 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1440 wxT("this window doesn't have void client data") );
1442 return m_clientData
;
1445 #endif // wxUSE_BASE
1449 // Find a window with the focus, that is also a descendant of the given window.
1450 // This is used to determine the window to initially send commands to.
1451 wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
)
1453 // Process events starting with the window with the focus, if any.
1454 wxWindow
* focusWin
= wxWindow::FindFocus();
1455 wxWindow
* win
= focusWin
;
1457 // Check if this is a descendant of this frame.
1458 // If not, win will be set to NULL.
1461 if (win
== ancestor
)
1464 win
= win
->GetParent();
1466 if (win
== (wxWindow
*) NULL
)
1467 focusWin
= (wxWindow
*) NULL
;