1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/event.cpp
3 // Purpose: Event classes
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
35 #include "wx/control.h"
37 #include "wx/textctrl.h"
38 #include "wx/validate.h"
42 #include "wx/module.h"
44 #if wxUSE_GUI && wxUSE_STOPWATCH
45 #include "wx/stopwatch.h"
46 #endif // wxUSE_GUI && wxUSE_STOPWATCH
48 // ----------------------------------------------------------------------------
50 // ----------------------------------------------------------------------------
53 IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler
, wxObject
)
54 IMPLEMENT_ABSTRACT_CLASS(wxEvent
, wxObject
)
58 IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent
, wxEvent
)
59 IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent
, wxEvent
)
60 IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent
, wxCommandEvent
)
61 IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent
, wxCommandEvent
)
62 IMPLEMENT_DYNAMIC_CLASS(wxScrollWinEvent
, wxEvent
)
63 IMPLEMENT_DYNAMIC_CLASS(wxMouseEvent
, wxEvent
)
64 IMPLEMENT_DYNAMIC_CLASS(wxKeyEvent
, wxEvent
)
65 IMPLEMENT_DYNAMIC_CLASS(wxSizeEvent
, wxEvent
)
66 IMPLEMENT_DYNAMIC_CLASS(wxPaintEvent
, wxEvent
)
67 IMPLEMENT_DYNAMIC_CLASS(wxNcPaintEvent
, wxEvent
)
68 IMPLEMENT_DYNAMIC_CLASS(wxEraseEvent
, wxEvent
)
69 IMPLEMENT_DYNAMIC_CLASS(wxMoveEvent
, wxEvent
)
70 IMPLEMENT_DYNAMIC_CLASS(wxFocusEvent
, wxEvent
)
71 IMPLEMENT_DYNAMIC_CLASS(wxChildFocusEvent
, wxCommandEvent
)
72 IMPLEMENT_DYNAMIC_CLASS(wxCloseEvent
, wxEvent
)
73 IMPLEMENT_DYNAMIC_CLASS(wxShowEvent
, wxEvent
)
74 IMPLEMENT_DYNAMIC_CLASS(wxMaximizeEvent
, wxEvent
)
75 IMPLEMENT_DYNAMIC_CLASS(wxIconizeEvent
, wxEvent
)
76 IMPLEMENT_DYNAMIC_CLASS(wxMenuEvent
, wxEvent
)
77 IMPLEMENT_DYNAMIC_CLASS(wxJoystickEvent
, wxEvent
)
78 IMPLEMENT_DYNAMIC_CLASS(wxDropFilesEvent
, wxEvent
)
79 IMPLEMENT_DYNAMIC_CLASS(wxActivateEvent
, wxEvent
)
80 IMPLEMENT_DYNAMIC_CLASS(wxInitDialogEvent
, wxEvent
)
81 IMPLEMENT_DYNAMIC_CLASS(wxSetCursorEvent
, wxEvent
)
82 IMPLEMENT_DYNAMIC_CLASS(wxSysColourChangedEvent
, wxEvent
)
83 IMPLEMENT_DYNAMIC_CLASS(wxDisplayChangedEvent
, wxEvent
)
84 IMPLEMENT_DYNAMIC_CLASS(wxUpdateUIEvent
, wxCommandEvent
)
85 IMPLEMENT_DYNAMIC_CLASS(wxNavigationKeyEvent
, wxEvent
)
86 IMPLEMENT_DYNAMIC_CLASS(wxPaletteChangedEvent
, wxEvent
)
87 IMPLEMENT_DYNAMIC_CLASS(wxQueryNewPaletteEvent
, wxEvent
)
88 IMPLEMENT_DYNAMIC_CLASS(wxWindowCreateEvent
, wxEvent
)
89 IMPLEMENT_DYNAMIC_CLASS(wxWindowDestroyEvent
, wxEvent
)
90 IMPLEMENT_DYNAMIC_CLASS(wxHelpEvent
, wxCommandEvent
)
91 IMPLEMENT_DYNAMIC_CLASS(wxContextMenuEvent
, wxCommandEvent
)
92 IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureChangedEvent
, wxEvent
)
93 IMPLEMENT_DYNAMIC_CLASS(wxClipboardTextEvent
, wxCommandEvent
)
98 const wxEventTable
*wxEvtHandler::GetEventTable() const
99 { return &wxEvtHandler::sm_eventTable
; }
101 const wxEventTable
wxEvtHandler::sm_eventTable
=
102 { (const wxEventTable
*)NULL
, &wxEvtHandler::sm_eventTableEntries
[0] };
104 wxEventHashTable
&wxEvtHandler::GetEventHashTable() const
105 { return wxEvtHandler::sm_eventHashTable
; }
107 wxEventHashTable
wxEvtHandler::sm_eventHashTable(wxEvtHandler::sm_eventTable
);
109 const wxEventTableEntry
wxEvtHandler::sm_eventTableEntries
[] =
110 { DECLARE_EVENT_TABLE_ENTRY(wxEVT_NULL
, 0, 0, (wxObjectEventFunction
)NULL
, NULL
) };
114 // Clear up event hash table contents or we can get problems
115 // when C++ is cleaning up the static object
116 class wxEventTableEntryModule
: public wxModule
118 DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule
)
120 wxEventTableEntryModule() {}
121 bool OnInit() { return true; }
124 wxEventHashTable::ClearAll();
127 IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule
, wxModule
)
130 // ----------------------------------------------------------------------------
132 // ----------------------------------------------------------------------------
134 // To put pending event handlers
135 wxList
*wxPendingEvents
= (wxList
*)NULL
;
138 // protects wxPendingEvents list
139 wxCriticalSection
*wxPendingEventsLocker
= (wxCriticalSection
*)NULL
;
142 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
144 // common event types are defined here, other event types are defined by the
145 // components which use them
147 const wxEventType wxEVT_FIRST
= 10000;
148 const wxEventType wxEVT_USER_FIRST
= wxEVT_FIRST
+ 2000;
150 DEFINE_EVENT_TYPE(wxEVT_NULL
)
151 DEFINE_EVENT_TYPE(wxEVT_IDLE
)
152 DEFINE_EVENT_TYPE(wxEVT_SOCKET
)
154 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
160 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
162 DEFINE_EVENT_TYPE(wxEVT_COMMAND_BUTTON_CLICKED
)
163 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKBOX_CLICKED
)
164 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHOICE_SELECTED
)
165 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_SELECTED
)
166 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
)
167 DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
)
168 DEFINE_EVENT_TYPE(wxEVT_COMMAND_MENU_SELECTED
)
169 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SLIDER_UPDATED
)
170 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBOX_SELECTED
)
171 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBUTTON_SELECTED
)
172 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SCROLLBAR_UPDATED
)
173 DEFINE_EVENT_TYPE(wxEVT_COMMAND_VLBOX_SELECTED
)
174 DEFINE_EVENT_TYPE(wxEVT_COMMAND_COMBOBOX_SELECTED
)
175 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED
)
176 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER
)
177 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED
)
179 // Sockets and timers send events, too
180 DEFINE_EVENT_TYPE(wxEVT_TIMER
)
183 DEFINE_EVENT_TYPE(wxEVT_LEFT_DOWN
)
184 DEFINE_EVENT_TYPE(wxEVT_LEFT_UP
)
185 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DOWN
)
186 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_UP
)
187 DEFINE_EVENT_TYPE(wxEVT_RIGHT_DOWN
)
188 DEFINE_EVENT_TYPE(wxEVT_RIGHT_UP
)
189 DEFINE_EVENT_TYPE(wxEVT_MOTION
)
190 DEFINE_EVENT_TYPE(wxEVT_ENTER_WINDOW
)
191 DEFINE_EVENT_TYPE(wxEVT_LEAVE_WINDOW
)
192 DEFINE_EVENT_TYPE(wxEVT_LEFT_DCLICK
)
193 DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DCLICK
)
194 DEFINE_EVENT_TYPE(wxEVT_RIGHT_DCLICK
)
195 DEFINE_EVENT_TYPE(wxEVT_SET_FOCUS
)
196 DEFINE_EVENT_TYPE(wxEVT_KILL_FOCUS
)
197 DEFINE_EVENT_TYPE(wxEVT_CHILD_FOCUS
)
198 DEFINE_EVENT_TYPE(wxEVT_MOUSEWHEEL
)
200 // Non-client mouse events
201 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN
)
202 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_UP
)
203 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DOWN
)
204 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_UP
)
205 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DOWN
)
206 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_UP
)
207 DEFINE_EVENT_TYPE(wxEVT_NC_MOTION
)
208 DEFINE_EVENT_TYPE(wxEVT_NC_ENTER_WINDOW
)
209 DEFINE_EVENT_TYPE(wxEVT_NC_LEAVE_WINDOW
)
210 DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DCLICK
)
211 DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DCLICK
)
212 DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DCLICK
)
214 // Character input event type
215 DEFINE_EVENT_TYPE(wxEVT_CHAR
)
216 DEFINE_EVENT_TYPE(wxEVT_CHAR_HOOK
)
217 DEFINE_EVENT_TYPE(wxEVT_NAVIGATION_KEY
)
218 DEFINE_EVENT_TYPE(wxEVT_KEY_DOWN
)
219 DEFINE_EVENT_TYPE(wxEVT_KEY_UP
)
221 DEFINE_EVENT_TYPE(wxEVT_HOTKEY
)
225 DEFINE_EVENT_TYPE(wxEVT_SET_CURSOR
)
227 // wxScrollbar and wxSlider event identifiers
228 DEFINE_EVENT_TYPE(wxEVT_SCROLL_TOP
)
229 DEFINE_EVENT_TYPE(wxEVT_SCROLL_BOTTOM
)
230 DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEUP
)
231 DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEDOWN
)
232 DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEUP
)
233 DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN
)
234 DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK
)
235 DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE
)
236 DEFINE_EVENT_TYPE(wxEVT_SCROLL_CHANGED
)
238 // Scroll events from wxWindow
239 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP
)
240 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_BOTTOM
)
241 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEUP
)
242 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEDOWN
)
243 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEUP
)
244 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEDOWN
)
245 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBTRACK
)
246 DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBRELEASE
)
249 DEFINE_EVENT_TYPE(wxEVT_SIZE
)
250 DEFINE_EVENT_TYPE(wxEVT_SIZING
)
251 DEFINE_EVENT_TYPE(wxEVT_MOVE
)
252 DEFINE_EVENT_TYPE(wxEVT_MOVING
)
253 DEFINE_EVENT_TYPE(wxEVT_CLOSE_WINDOW
)
254 DEFINE_EVENT_TYPE(wxEVT_END_SESSION
)
255 DEFINE_EVENT_TYPE(wxEVT_QUERY_END_SESSION
)
256 DEFINE_EVENT_TYPE(wxEVT_HIBERNATE
)
257 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE_APP
)
258 DEFINE_EVENT_TYPE(wxEVT_POWER
)
259 DEFINE_EVENT_TYPE(wxEVT_ACTIVATE
)
260 DEFINE_EVENT_TYPE(wxEVT_CREATE
)
261 DEFINE_EVENT_TYPE(wxEVT_DESTROY
)
262 DEFINE_EVENT_TYPE(wxEVT_SHOW
)
263 DEFINE_EVENT_TYPE(wxEVT_ICONIZE
)
264 DEFINE_EVENT_TYPE(wxEVT_MAXIMIZE
)
265 DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED
)
266 DEFINE_EVENT_TYPE(wxEVT_PAINT
)
267 DEFINE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND
)
268 DEFINE_EVENT_TYPE(wxEVT_NC_PAINT
)
269 DEFINE_EVENT_TYPE(wxEVT_PAINT_ICON
)
270 DEFINE_EVENT_TYPE(wxEVT_MENU_OPEN
)
271 DEFINE_EVENT_TYPE(wxEVT_MENU_CLOSE
)
272 DEFINE_EVENT_TYPE(wxEVT_MENU_HIGHLIGHT
)
273 DEFINE_EVENT_TYPE(wxEVT_CONTEXT_MENU
)
274 DEFINE_EVENT_TYPE(wxEVT_SYS_COLOUR_CHANGED
)
275 DEFINE_EVENT_TYPE(wxEVT_DISPLAY_CHANGED
)
276 DEFINE_EVENT_TYPE(wxEVT_SETTING_CHANGED
)
277 DEFINE_EVENT_TYPE(wxEVT_QUERY_NEW_PALETTE
)
278 DEFINE_EVENT_TYPE(wxEVT_PALETTE_CHANGED
)
279 DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_DOWN
)
280 DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_UP
)
281 DEFINE_EVENT_TYPE(wxEVT_JOY_MOVE
)
282 DEFINE_EVENT_TYPE(wxEVT_JOY_ZMOVE
)
283 DEFINE_EVENT_TYPE(wxEVT_DROP_FILES
)
284 DEFINE_EVENT_TYPE(wxEVT_DRAW_ITEM
)
285 DEFINE_EVENT_TYPE(wxEVT_MEASURE_ITEM
)
286 DEFINE_EVENT_TYPE(wxEVT_COMPARE_ITEM
)
287 DEFINE_EVENT_TYPE(wxEVT_INIT_DIALOG
)
288 DEFINE_EVENT_TYPE(wxEVT_UPDATE_UI
)
291 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_COPY
)
292 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_CUT
)
293 DEFINE_EVENT_TYPE(wxEVT_COMMAND_TEXT_PASTE
)
295 // Generic command events
296 // Note: a click is a higher-level event than button down/up
297 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK
)
298 DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_DCLICK
)
299 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_CLICK
)
300 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_DCLICK
)
301 DEFINE_EVENT_TYPE(wxEVT_COMMAND_SET_FOCUS
)
302 DEFINE_EVENT_TYPE(wxEVT_COMMAND_KILL_FOCUS
)
303 DEFINE_EVENT_TYPE(wxEVT_COMMAND_ENTER
)
306 DEFINE_EVENT_TYPE(wxEVT_HELP
)
307 DEFINE_EVENT_TYPE(wxEVT_DETAILED_HELP
)
309 #endif // !WXWIN_COMPATIBILITY_EVENT_TYPES
315 // ============================================================================
317 // ============================================================================
319 // ----------------------------------------------------------------------------
320 // event initialization
321 // ----------------------------------------------------------------------------
326 static int s_lastUsedEventType
= wxEVT_FIRST
;
328 return s_lastUsedEventType
++;
331 // ----------------------------------------------------------------------------
333 // ----------------------------------------------------------------------------
336 * General wxWidgets events, covering
337 * all interesting things that might happen (button clicking, resizing,
338 * setting text in widgets, etc.).
340 * For each completely new event type, derive a new event class.
344 wxEvent::wxEvent(int theId
, wxEventType commandType
)
346 m_eventType
= commandType
;
347 m_eventObject
= (wxObject
*) NULL
;
351 m_callbackUserData
= (wxObject
*) NULL
;
352 m_isCommandEvent
= false;
353 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
356 wxEvent::wxEvent(const wxEvent
&src
)
358 , m_eventObject(src
.m_eventObject
)
359 , m_eventType(src
.m_eventType
)
360 , m_timeStamp(src
.m_timeStamp
)
362 , m_callbackUserData(src
.m_callbackUserData
)
363 , m_propagationLevel(src
.m_propagationLevel
)
364 , m_skipped(src
.m_skipped
)
365 , m_isCommandEvent(src
.m_isCommandEvent
)
379 // 'this' : used in base member initializer list (for m_commandString)
380 #pragma warning(disable:4355)
383 wxCommandEvent::wxCommandEvent(wxEventType commandType
, int theId
)
384 : wxEvent(theId
, commandType
)
385 #if WXWIN_COMPATIBILITY_2_4
386 , m_commandString(this)
389 m_clientData
= (char *) NULL
;
390 m_clientObject
= (wxClientData
*) NULL
;
393 m_isCommandEvent
= true;
395 // the command events are propagated upwards by default
396 m_propagationLevel
= wxEVENT_PROPAGATE_MAX
;
400 #pragma warning(default:4355)
403 wxString
wxCommandEvent::GetString() const
405 if(m_eventType
!= wxEVT_COMMAND_TEXT_UPDATED
|| !m_eventObject
)
410 wxTextCtrl
*txt
= wxDynamicCast(m_eventObject
, wxTextCtrl
);
412 return txt
->GetValue();
414 #endif // wxUSE_TEXTCTRL
424 wxLongLong
wxUpdateUIEvent::sm_lastUpdate
= 0;
427 long wxUpdateUIEvent::sm_updateInterval
= 0;
429 wxUpdateUIMode
wxUpdateUIEvent::sm_updateMode
= wxUPDATE_UI_PROCESS_ALL
;
432 bool wxUpdateUIEvent::CanUpdate(wxWindowBase
*win
)
434 // Don't update if we've switched global updating off
435 // and this window doesn't support updates.
437 (GetMode() == wxUPDATE_UI_PROCESS_SPECIFIED
&&
438 ((win
->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES
) == 0)))
441 if (sm_updateInterval
== -1)
444 if (sm_updateInterval
== 0)
447 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
448 wxLongLong now
= wxGetLocalTimeMillis();
449 if (now
> (sm_lastUpdate
+ sm_updateInterval
))
456 // If we don't have wxStopWatch or wxLongLong, we
457 // should err on the safe side and update now anyway.
462 // Reset the update time to provide a delay until the next
463 // time we should update
464 void wxUpdateUIEvent::ResetUpdateTime()
466 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
467 if (sm_updateInterval
> 0)
469 wxLongLong now
= wxGetLocalTimeMillis();
470 if (now
> (sm_lastUpdate
+ sm_updateInterval
))
482 wxIdleMode
wxIdleEvent::sm_idleMode
= wxIDLE_PROCESS_ALL
;
484 // Can we send an idle event?
485 bool wxIdleEvent::CanSend(wxWindow
* win
)
487 // Don't update if we've switched global updating off
488 // and this window doesn't support updates.
490 (GetMode() == wxIDLE_PROCESS_SPECIFIED
&&
491 ((win
->GetExtraStyle() & wxWS_EX_PROCESS_IDLE
) == 0)))
501 wxScrollEvent::wxScrollEvent(wxEventType commandType
,
505 : wxCommandEvent(commandType
, id
)
507 m_extraLong
= orient
;
515 wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType
,
519 m_eventType
= commandType
;
520 m_extraLong
= orient
;
529 wxMouseEvent::wxMouseEvent(wxEventType commandType
)
531 m_eventType
= commandType
;
534 m_controlDown
= false;
538 m_middleDown
= false;
543 m_linesPerAction
= 0;
546 void wxMouseEvent::Assign(const wxMouseEvent
& event
)
548 m_eventType
= event
.m_eventType
;
553 m_leftDown
= event
.m_leftDown
;
554 m_middleDown
= event
.m_middleDown
;
555 m_rightDown
= event
.m_rightDown
;
557 m_controlDown
= event
.m_controlDown
;
558 m_shiftDown
= event
.m_shiftDown
;
559 m_altDown
= event
.m_altDown
;
560 m_metaDown
= event
.m_metaDown
;
562 m_wheelRotation
= event
.m_wheelRotation
;
563 m_wheelDelta
= event
.m_wheelDelta
;
564 m_linesPerAction
= event
.m_linesPerAction
;
567 // return true if was a button dclick event
568 bool wxMouseEvent::ButtonDClick(int but
) const
573 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
576 case wxMOUSE_BTN_ANY
:
577 return (LeftDClick() || MiddleDClick() || RightDClick());
579 case wxMOUSE_BTN_LEFT
:
582 case wxMOUSE_BTN_MIDDLE
:
583 return MiddleDClick();
585 case wxMOUSE_BTN_RIGHT
:
586 return RightDClick();
590 // return true if was a button down event
591 bool wxMouseEvent::ButtonDown(int but
) const
596 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
599 case wxMOUSE_BTN_ANY
:
600 return (LeftDown() || MiddleDown() || RightDown());
602 case wxMOUSE_BTN_LEFT
:
605 case wxMOUSE_BTN_MIDDLE
:
608 case wxMOUSE_BTN_RIGHT
:
613 // return true if was a button up event
614 bool wxMouseEvent::ButtonUp(int but
) const
619 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
622 case wxMOUSE_BTN_ANY
:
623 return (LeftUp() || MiddleUp() || RightUp());
625 case wxMOUSE_BTN_LEFT
:
628 case wxMOUSE_BTN_MIDDLE
:
631 case wxMOUSE_BTN_RIGHT
:
636 // return true if the given button is currently changing state
637 bool wxMouseEvent::Button(int but
) const
642 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
645 case wxMOUSE_BTN_ANY
:
646 return ButtonUp(wxMOUSE_BTN_ANY
) ||
647 ButtonDown(wxMOUSE_BTN_ANY
) ||
648 ButtonDClick(wxMOUSE_BTN_ANY
);
650 case wxMOUSE_BTN_LEFT
:
651 return LeftDown() || LeftUp() || LeftDClick();
653 case wxMOUSE_BTN_MIDDLE
:
654 return MiddleDown() || MiddleUp() || MiddleDClick();
656 case wxMOUSE_BTN_RIGHT
:
657 return RightDown() || RightUp() || RightDClick();
661 bool wxMouseEvent::ButtonIsDown(int but
) const
666 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonIsDown"));
669 case wxMOUSE_BTN_ANY
:
670 return LeftIsDown() || MiddleIsDown() || RightIsDown();
672 case wxMOUSE_BTN_LEFT
:
675 case wxMOUSE_BTN_MIDDLE
:
676 return MiddleIsDown();
678 case wxMOUSE_BTN_RIGHT
:
679 return RightIsDown();
683 int wxMouseEvent::GetButton() const
685 for ( int i
= 1; i
<= 3; i
++ )
693 return wxMOUSE_BTN_NONE
;
696 // Find the logical position of the event given the DC
697 wxPoint
wxMouseEvent::GetLogicalPosition(const wxDC
& dc
) const
699 wxPoint
pt(dc
.DeviceToLogicalX(m_x
), dc
.DeviceToLogicalY(m_y
));
709 wxKeyEvent::wxKeyEvent(wxEventType type
)
713 m_controlDown
= false;
723 wxKeyEvent::wxKeyEvent(const wxKeyEvent
& evt
)
729 m_keyCode
= evt
.m_keyCode
;
731 m_controlDown
= evt
.m_controlDown
;
732 m_shiftDown
= evt
.m_shiftDown
;
733 m_altDown
= evt
.m_altDown
;
734 m_metaDown
= evt
.m_metaDown
;
735 m_scanCode
= evt
.m_scanCode
;
736 m_rawCode
= evt
.m_rawCode
;
737 m_rawFlags
= evt
.m_rawFlags
;
740 m_uniChar
= evt
.m_uniChar
;
744 #if WXWIN_COMPATIBILITY_2_6
745 long wxKeyEvent::KeyCode() const
749 #endif // WXWIN_COMPATIBILITY_2_6
751 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow
*win
)
753 SetEventType(wxEVT_CREATE
);
757 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow
*win
)
759 SetEventType(wxEVT_DESTROY
);
763 wxChildFocusEvent::wxChildFocusEvent(wxWindow
*win
)
764 : wxCommandEvent(wxEVT_CHILD_FOCUS
)
769 // ----------------------------------------------------------------------------
771 // ----------------------------------------------------------------------------
774 wxHelpEvent::Origin
wxHelpEvent::GuessOrigin(Origin origin
)
776 if ( origin
== Origin_Unknown
)
778 // assume that the event comes from the help button if it's not from
779 // keyboard and that pressing F1 always results in the help event
780 origin
= wxGetKeyState(WXK_F1
) ? Origin_Keyboard
: Origin_HelpButton
;
791 // ----------------------------------------------------------------------------
793 // ----------------------------------------------------------------------------
795 static const int EVENT_TYPE_TABLE_INIT_SIZE
= 31; // Not too big not too small...
797 wxEventHashTable
* wxEventHashTable::sm_first
= NULL
;
799 wxEventHashTable::wxEventHashTable(const wxEventTable
&table
)
803 AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE
);
807 m_next
->m_previous
= this;
811 wxEventHashTable::~wxEventHashTable()
814 m_next
->m_previous
= m_previous
;
816 m_previous
->m_next
= m_next
;
817 if (sm_first
== this)
823 void wxEventHashTable::Clear()
826 for(i
= 0; i
< m_size
; i
++)
828 EventTypeTablePointer eTTnode
= m_eventTypeTable
[i
];
835 // Necessary in order to not invoke the
836 // overloaded delete operator when statics are cleaned up
837 if (m_eventTypeTable
)
838 delete[] m_eventTypeTable
;
840 m_eventTypeTable
= NULL
;
845 void wxEventHashTable::ClearAll()
847 wxEventHashTable
* table
= sm_first
;
851 table
= table
->m_next
;
855 bool wxEventHashTable::HandleEvent(wxEvent
&event
, wxEvtHandler
*self
)
860 m_rebuildHash
= false;
863 if (!m_eventTypeTable
)
866 // Find all entries for the given event type.
867 wxEventType eventType
= event
.GetEventType();
868 const EventTypeTablePointer eTTnode
= m_eventTypeTable
[eventType
% m_size
];
869 if (eTTnode
&& eTTnode
->eventType
== eventType
)
871 // Now start the search for an event handler
872 // that can handle an event with the given ID.
873 const wxEventTableEntryPointerArray
&
874 eventEntryTable
= eTTnode
->eventEntryTable
;
876 const size_t count
= eventEntryTable
.GetCount();
877 for (size_t n
= 0; n
< count
; n
++)
880 ProcessEventIfMatches(*eventEntryTable
[n
], self
, event
) )
890 void wxEventHashTable::InitHashTable()
892 // Loop over the event tables and all its base tables.
893 const wxEventTable
*table
= &m_table
;
896 // Retrieve all valid event handler entries
897 const wxEventTableEntry
*entry
= table
->entries
;
898 while (entry
->m_fn
!= 0)
900 // Add the event entry in the Hash.
906 table
= table
->baseTable
;
909 // Lets free some memory.
911 for(i
= 0; i
< m_size
; i
++)
913 EventTypeTablePointer eTTnode
= m_eventTypeTable
[i
];
916 eTTnode
->eventEntryTable
.Shrink();
921 void wxEventHashTable::AddEntry(const wxEventTableEntry
&entry
)
923 // This might happen 'accidentally' as the app is exiting
924 if (!m_eventTypeTable
)
927 EventTypeTablePointer
*peTTnode
= &m_eventTypeTable
[entry
.m_eventType
% m_size
];
928 EventTypeTablePointer eTTnode
= *peTTnode
;
932 if (eTTnode
->eventType
!= entry
.m_eventType
)
935 GrowEventTypeTable();
936 // Try again to add it.
943 eTTnode
= new EventTypeTable
;
944 eTTnode
->eventType
= entry
.m_eventType
;
948 // Fill all hash entries between entry.m_id and entry.m_lastId...
949 eTTnode
->eventEntryTable
.Add(&entry
);
952 void wxEventHashTable::AllocEventTypeTable(size_t size
)
954 m_eventTypeTable
= new EventTypeTablePointer
[size
];
955 memset((void *)m_eventTypeTable
, 0, sizeof(EventTypeTablePointer
)*size
);
959 void wxEventHashTable::GrowEventTypeTable()
961 size_t oldSize
= m_size
;
962 EventTypeTablePointer
*oldEventTypeTable
= m_eventTypeTable
;
964 // TODO: Search the most optimal grow sequence
965 AllocEventTypeTable(/* GetNextPrime(oldSize) */oldSize
*2+1);
967 for ( size_t i
= 0; i
< oldSize
; /* */ )
969 EventTypeTablePointer eTToldNode
= oldEventTypeTable
[i
];
972 EventTypeTablePointer
*peTTnode
= &m_eventTypeTable
[eTToldNode
->eventType
% m_size
];
973 EventTypeTablePointer eTTnode
= *peTTnode
;
975 // Check for collision, we don't want any.
978 GrowEventTypeTable();
979 continue; // Don't increment the counter,
980 // as we still need to add this element.
984 // Get the old value and put it in the new table.
985 *peTTnode
= oldEventTypeTable
[i
];
992 delete[] oldEventTypeTable
;
996 // ----------------------------------------------------------------------------
998 // ----------------------------------------------------------------------------
1004 wxEvtHandler::wxEvtHandler()
1006 m_nextHandler
= (wxEvtHandler
*) NULL
;
1007 m_previousHandler
= (wxEvtHandler
*) NULL
;
1009 m_dynamicEvents
= (wxList
*) NULL
;
1010 m_pendingEvents
= (wxList
*) NULL
;
1012 # if !defined(__VISAGECPP__)
1013 m_eventsLocker
= new wxCriticalSection
;
1016 // no client data (yet)
1017 m_clientData
= NULL
;
1018 m_clientDataType
= wxClientData_None
;
1021 wxEvtHandler::~wxEvtHandler()
1023 // Takes itself out of the list of handlers
1024 if (m_previousHandler
)
1025 m_previousHandler
->m_nextHandler
= m_nextHandler
;
1028 m_nextHandler
->m_previousHandler
= m_previousHandler
;
1030 if (m_dynamicEvents
)
1032 wxList::iterator it
= m_dynamicEvents
->begin(),
1033 en
= m_dynamicEvents
->end();
1034 for (;it
!= en
; ++it
)
1036 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1037 wxEventTableEntry
*entry
= (wxEventTableEntry
*)*it
;
1038 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1039 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)*it
;
1040 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1042 if (entry
->m_callbackUserData
)
1043 delete entry
->m_callbackUserData
;
1046 delete m_dynamicEvents
;
1049 if (m_pendingEvents
)
1050 m_pendingEvents
->DeleteContents(true);
1051 delete m_pendingEvents
;
1054 # if !defined(__VISAGECPP__)
1055 delete m_eventsLocker
;
1058 // Remove us from wxPendingEvents if necessary.
1059 if(wxPendingEventsLocker
)
1060 wxENTER_CRIT_SECT(*wxPendingEventsLocker
);
1061 if ( wxPendingEvents
)
1063 // Delete all occurences of this from the list of pending events
1064 while (wxPendingEvents
->DeleteObject(this)) { } // Do nothing
1066 if(wxPendingEventsLocker
)
1067 wxLEAVE_CRIT_SECT(*wxPendingEventsLocker
);
1070 // we only delete object data, not untyped
1071 if ( m_clientDataType
== wxClientData_Object
)
1072 delete m_clientObject
;
1077 bool wxEvtHandler::ProcessThreadEvent(wxEvent
& event
)
1079 // check that we are really in a child thread
1080 wxASSERT_MSG( !wxThread::IsMain(),
1081 wxT("use ProcessEvent() in main thread") );
1083 AddPendingEvent(event
);
1088 void wxEvtHandler::ClearEventLocker()
1090 #if !defined(__VISAGECPP__)
1091 delete m_eventsLocker
;
1092 m_eventsLocker
= NULL
;
1096 #endif // wxUSE_THREADS
1098 void wxEvtHandler::AddPendingEvent(wxEvent
& event
)
1100 // 1) Add event to list of pending events of this event handler
1102 wxEvent
*eventCopy
= event
.Clone();
1104 // we must be able to copy the events here so the event class must
1105 // implement Clone() properly instead of just providing a NULL stab for it
1106 wxCHECK_RET( eventCopy
,
1107 _T("events of this type aren't supposed to be posted") );
1109 wxENTER_CRIT_SECT( Lock() );
1111 if ( !m_pendingEvents
)
1112 m_pendingEvents
= new wxList
;
1114 m_pendingEvents
->Append(eventCopy
);
1116 wxLEAVE_CRIT_SECT( Lock() );
1118 // 2) Add this event handler to list of event handlers that
1119 // have pending events.
1121 wxENTER_CRIT_SECT(*wxPendingEventsLocker
);
1123 if ( !wxPendingEvents
)
1124 wxPendingEvents
= new wxList
;
1125 wxPendingEvents
->Append(this);
1127 wxLEAVE_CRIT_SECT(*wxPendingEventsLocker
);
1129 // 3) Inform the system that new pending events are somewhere,
1130 // and that these should be processed in idle time.
1134 void wxEvtHandler::ProcessPendingEvents()
1136 // this method is only called by wxApp if this handler does have pending
1138 wxCHECK_RET( m_pendingEvents
,
1139 wxT("Please call wxApp::ProcessPendingEvents() instead") );
1141 wxENTER_CRIT_SECT( Lock() );
1143 // we leave the loop once we have processed all events that were present at
1144 // the start of ProcessPendingEvents because otherwise we could get into
1145 // infinite loop if the pending event handler execution resulted in another
1146 // event being posted
1147 size_t n
= m_pendingEvents
->size();
1148 for ( wxList::compatibility_iterator node
= m_pendingEvents
->GetFirst();
1150 node
= m_pendingEvents
->GetFirst() )
1152 wxEvent
*event
= (wxEvent
*)node
->GetData();
1154 // It's importan we remove event from list before processing it.
1155 // Else a nested event loop, for example from a modal dialog, might
1156 // process the same event again.
1157 m_pendingEvents
->Erase(node
);
1159 wxLEAVE_CRIT_SECT( Lock() );
1161 ProcessEvent(*event
);
1164 wxENTER_CRIT_SECT( Lock() );
1170 wxLEAVE_CRIT_SECT( Lock() );
1177 wxEvtHandler::ProcessEventIfMatches(const wxEventTableEntryBase
& entry
,
1178 wxEvtHandler
*handler
,
1181 int tableId1
= entry
.m_id
,
1182 tableId2
= entry
.m_lastId
;
1184 // match only if the event type is the same and the id is either -1 in
1185 // the event table (meaning "any") or the event id matches the id
1186 // specified in the event table either exactly or by falling into
1187 // range between first and last
1188 if ((tableId1
== wxID_ANY
) ||
1189 (tableId2
== wxID_ANY
&& tableId1
== event
.GetId()) ||
1190 (tableId2
!= wxID_ANY
&&
1191 (event
.GetId() >= tableId1
&& event
.GetId() <= tableId2
)))
1194 event
.m_callbackUserData
= entry
.m_callbackUserData
;
1196 #if wxUSE_EXCEPTIONS
1199 // call the handler via wxApp method which allows the user to catch
1200 // any exceptions which may be thrown by any handler in the program
1202 wxTheApp
->HandleEvent(handler
, (wxEventFunction
)entry
.m_fn
, event
);
1205 #endif // wxUSE_EXCEPTIONS
1207 // no need for an extra virtual function call
1208 (handler
->*((wxEventFunction
) (entry
.m_fn
)))(event
);
1211 if (!event
.GetSkipped())
1218 bool wxEvtHandler::TryParent(wxEvent
& event
)
1220 if ( wxTheApp
&& (this != wxTheApp
) )
1222 // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
1223 // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
1224 // processed appropriately via SearchEventTable.
1225 if ( event
.GetEventType() != wxEVT_IDLE
)
1227 if ( wxTheApp
->ProcessEvent(event
) )
1235 bool wxEvtHandler::ProcessEvent(wxEvent
& event
)
1237 // allow the application to hook into event processing
1240 int rc
= wxTheApp
->FilterEvent(event
);
1243 wxASSERT_MSG( rc
== 1 || rc
== 0,
1244 _T("unexpected wxApp::FilterEvent return value") );
1248 //else: proceed normally
1251 // An event handler can be enabled or disabled
1252 if ( GetEvtHandlerEnabled() )
1254 // if we have a validator, it has higher priority than our own event
1256 if ( TryValidator(event
) )
1259 // Handle per-instance dynamic event tables first
1260 if ( m_dynamicEvents
&& SearchDynamicEventTable(event
) )
1263 // Then static per-class event tables
1264 if ( GetEventHashTable().HandleEvent(event
, this) )
1268 // Try going down the event handler chain
1269 if ( GetNextHandler() )
1271 if ( GetNextHandler()->ProcessEvent(event
) )
1275 // Finally propagate the event upwards the window chain and/or to the
1276 // application object as necessary
1277 return TryParent(event
);
1281 bool wxEvtHandler::SearchEventTable(wxEventTable
& table
, wxEvent
& event
)
1283 const wxEventType eventType
= event
.GetEventType();
1284 for ( int i
= 0; table
.entries
[i
].m_fn
!= 0; i
++ )
1286 const wxEventTableEntry
& entry
= table
.entries
[i
];
1287 if ( eventType
== entry
.m_eventType
)
1289 if ( ProcessEventIfMatches(entry
, this, event
) )
1297 void wxEvtHandler::Connect( int id
, int lastId
,
1299 wxObjectEventFunction func
,
1301 wxEvtHandler
* eventSink
)
1303 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1304 wxEventTableEntry
*entry
= new wxEventTableEntry
;
1305 entry
->m_eventType
= eventType
;
1307 entry
->m_lastId
= lastId
;
1309 entry
->m_callbackUserData
= userData
;
1310 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1311 wxDynamicEventTableEntry
*entry
=
1312 new wxDynamicEventTableEntry(eventType
, id
, lastId
, func
, userData
, eventSink
);
1313 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1315 if (!m_dynamicEvents
)
1316 m_dynamicEvents
= new wxList
;
1318 // Insert at the front of the list so most recent additions are found first
1319 m_dynamicEvents
->Insert( (wxObject
*) entry
);
1322 bool wxEvtHandler::Disconnect( int id
, int lastId
, wxEventType eventType
,
1323 wxObjectEventFunction func
,
1325 wxEvtHandler
* eventSink
)
1327 if (!m_dynamicEvents
)
1330 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1333 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1334 wxEventTableEntry
*entry
= (wxEventTableEntry
*)node
->GetData();
1335 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1336 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1337 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1339 if ((entry
->m_id
== id
) &&
1340 ((entry
->m_lastId
== lastId
) || (lastId
== wxID_ANY
)) &&
1341 ((entry
->m_eventType
== eventType
) || (eventType
== wxEVT_NULL
)) &&
1342 ((entry
->m_fn
== func
) || (func
== (wxObjectEventFunction
)NULL
)) &&
1343 ((entry
->m_eventSink
== eventSink
) || (eventSink
== (wxEvtHandler
*)NULL
)) &&
1344 ((entry
->m_callbackUserData
== userData
) || (userData
== (wxObject
*)NULL
)))
1346 if (entry
->m_callbackUserData
)
1347 delete entry
->m_callbackUserData
;
1348 m_dynamicEvents
->Erase( node
);
1352 node
= node
->GetNext();
1357 bool wxEvtHandler::SearchDynamicEventTable( wxEvent
& event
)
1359 wxCHECK_MSG( m_dynamicEvents
, false,
1360 wxT("caller should check that we have dynamic events") );
1362 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1365 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1366 wxEventTableEntry
*entry
= (wxEventTableEntry
*)node
->GetData();
1367 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1368 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1369 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1371 // get next node before (maybe) calling the event handler as it could
1372 // call Disconnect() invalidating the current node
1373 node
= node
->GetNext();
1375 if ((event
.GetEventType() == entry
->m_eventType
) && (entry
->m_fn
!= 0))
1377 wxEvtHandler
*handler
=
1378 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
1379 entry
->m_eventSink
? entry
->m_eventSink
1384 if ( ProcessEventIfMatches(*entry
, handler
, event
) )
1394 void wxEvtHandler::DoSetClientObject( wxClientData
*data
)
1396 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1397 wxT("can't have both object and void client data") );
1399 if ( m_clientObject
)
1400 delete m_clientObject
;
1402 m_clientObject
= data
;
1403 m_clientDataType
= wxClientData_Object
;
1406 wxClientData
*wxEvtHandler::DoGetClientObject() const
1408 // it's not an error to call GetClientObject() on a window which doesn't
1409 // have client data at all - NULL will be returned
1410 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1411 wxT("this window doesn't have object client data") );
1413 return m_clientObject
;
1416 void wxEvtHandler::DoSetClientData( void *data
)
1418 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1419 wxT("can't have both object and void client data") );
1421 m_clientData
= data
;
1422 m_clientDataType
= wxClientData_Void
;
1425 void *wxEvtHandler::DoGetClientData() const
1427 // it's not an error to call GetClientData() on a window which doesn't have
1428 // client data at all - NULL will be returned
1429 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1430 wxT("this window doesn't have void client data") );
1432 return m_clientData
;
1435 #endif // wxUSE_BASE
1439 // Find a window with the focus, that is also a descendant of the given window.
1440 // This is used to determine the window to initially send commands to.
1441 wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
)
1443 // Process events starting with the window with the focus, if any.
1444 wxWindow
* focusWin
= wxWindow::FindFocus();
1445 wxWindow
* win
= focusWin
;
1447 // Check if this is a descendant of this frame.
1448 // If not, win will be set to NULL.
1451 if (win
== ancestor
)
1454 win
= win
->GetParent();
1456 if (win
== (wxWindow
*) NULL
)
1457 focusWin
= (wxWindow
*) NULL
;