1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/event.cpp
3 // Purpose: Event classes
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
33 #include "wx/stopwatch.h"
36 #include "wx/control.h"
38 #include "wx/textctrl.h"
39 #include "wx/validate.h"
43 #include "wx/module.h"
45 // ----------------------------------------------------------------------------
47 // ----------------------------------------------------------------------------
50 IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler
, wxObject
)
51 IMPLEMENT_ABSTRACT_CLASS(wxEvent
, wxObject
)
55 IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent
, wxEvent
)
56 IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent
, wxEvent
)
57 IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent
, wxCommandEvent
)
58 IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent
, wxCommandEvent
)
59 IMPLEMENT_DYNAMIC_CLASS(wxScrollWinEvent
, wxEvent
)
60 IMPLEMENT_DYNAMIC_CLASS(wxMouseEvent
, wxEvent
)
61 IMPLEMENT_DYNAMIC_CLASS(wxKeyEvent
, wxEvent
)
62 IMPLEMENT_DYNAMIC_CLASS(wxSizeEvent
, wxEvent
)
63 IMPLEMENT_DYNAMIC_CLASS(wxPaintEvent
, wxEvent
)
64 IMPLEMENT_DYNAMIC_CLASS(wxNcPaintEvent
, wxEvent
)
65 IMPLEMENT_DYNAMIC_CLASS(wxEraseEvent
, wxEvent
)
66 IMPLEMENT_DYNAMIC_CLASS(wxMoveEvent
, wxEvent
)
67 IMPLEMENT_DYNAMIC_CLASS(wxFocusEvent
, wxEvent
)
68 IMPLEMENT_DYNAMIC_CLASS(wxChildFocusEvent
, wxCommandEvent
)
69 IMPLEMENT_DYNAMIC_CLASS(wxCloseEvent
, wxEvent
)
70 IMPLEMENT_DYNAMIC_CLASS(wxShowEvent
, wxEvent
)
71 IMPLEMENT_DYNAMIC_CLASS(wxMaximizeEvent
, wxEvent
)
72 IMPLEMENT_DYNAMIC_CLASS(wxIconizeEvent
, wxEvent
)
73 IMPLEMENT_DYNAMIC_CLASS(wxMenuEvent
, wxEvent
)
74 IMPLEMENT_DYNAMIC_CLASS(wxJoystickEvent
, wxEvent
)
75 IMPLEMENT_DYNAMIC_CLASS(wxDropFilesEvent
, wxEvent
)
76 IMPLEMENT_DYNAMIC_CLASS(wxActivateEvent
, wxEvent
)
77 IMPLEMENT_DYNAMIC_CLASS(wxInitDialogEvent
, wxEvent
)
78 IMPLEMENT_DYNAMIC_CLASS(wxSetCursorEvent
, wxEvent
)
79 IMPLEMENT_DYNAMIC_CLASS(wxSysColourChangedEvent
, wxEvent
)
80 IMPLEMENT_DYNAMIC_CLASS(wxDisplayChangedEvent
, wxEvent
)
81 IMPLEMENT_DYNAMIC_CLASS(wxUpdateUIEvent
, wxCommandEvent
)
82 IMPLEMENT_DYNAMIC_CLASS(wxNavigationKeyEvent
, wxEvent
)
83 IMPLEMENT_DYNAMIC_CLASS(wxPaletteChangedEvent
, wxEvent
)
84 IMPLEMENT_DYNAMIC_CLASS(wxQueryNewPaletteEvent
, wxEvent
)
85 IMPLEMENT_DYNAMIC_CLASS(wxWindowCreateEvent
, wxEvent
)
86 IMPLEMENT_DYNAMIC_CLASS(wxWindowDestroyEvent
, wxEvent
)
87 IMPLEMENT_DYNAMIC_CLASS(wxHelpEvent
, wxCommandEvent
)
88 IMPLEMENT_DYNAMIC_CLASS(wxContextMenuEvent
, wxCommandEvent
)
89 IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureChangedEvent
, wxEvent
)
90 IMPLEMENT_DYNAMIC_CLASS(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_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 // ============================================================================
314 // ============================================================================
316 // ----------------------------------------------------------------------------
317 // event initialization
318 // ----------------------------------------------------------------------------
323 static int s_lastUsedEventType
= wxEVT_FIRST
;
325 return s_lastUsedEventType
++;
328 // ----------------------------------------------------------------------------
330 // ----------------------------------------------------------------------------
333 * General wxWidgets events, covering
334 * all interesting things that might happen (button clicking, resizing,
335 * setting text in widgets, etc.).
337 * For each completely new event type, derive a new event class.
341 wxEvent::wxEvent(int theId
, wxEventType commandType
)
343 m_eventType
= commandType
;
344 m_eventObject
= (wxObject
*) NULL
;
348 m_callbackUserData
= (wxObject
*) NULL
;
349 m_isCommandEvent
= false;
350 m_propagationLevel
= wxEVENT_PROPAGATE_NONE
;
353 wxEvent::wxEvent(const wxEvent
&src
)
355 , m_eventObject(src
.m_eventObject
)
356 , m_eventType(src
.m_eventType
)
357 , m_timeStamp(src
.m_timeStamp
)
359 , m_callbackUserData(src
.m_callbackUserData
)
360 , m_propagationLevel(src
.m_propagationLevel
)
361 , m_skipped(src
.m_skipped
)
362 , m_isCommandEvent(src
.m_isCommandEvent
)
376 // 'this' : used in base member initializer list (for m_commandString)
377 #pragma warning(disable:4355)
380 wxCommandEvent::wxCommandEvent(wxEventType commandType
, int theId
)
381 : wxEvent(theId
, commandType
)
382 #if WXWIN_COMPATIBILITY_2_4
383 , m_commandString(this)
386 m_clientData
= (char *) NULL
;
387 m_clientObject
= (wxClientData
*) NULL
;
390 m_isCommandEvent
= true;
392 // the command events are propagated upwards by default
393 m_propagationLevel
= wxEVENT_PROPAGATE_MAX
;
397 #pragma warning(default:4355)
400 wxString
wxCommandEvent::GetString() const
402 if(m_eventType
!= wxEVT_COMMAND_TEXT_UPDATED
|| !m_eventObject
)
407 wxTextCtrl
*txt
= wxDynamicCast(m_eventObject
, wxTextCtrl
);
409 return txt
->GetValue();
411 #endif // wxUSE_TEXTCTRL
421 wxLongLong
wxUpdateUIEvent::sm_lastUpdate
= 0;
424 long wxUpdateUIEvent::sm_updateInterval
= 0;
426 wxUpdateUIMode
wxUpdateUIEvent::sm_updateMode
= wxUPDATE_UI_PROCESS_ALL
;
429 bool wxUpdateUIEvent::CanUpdate(wxWindowBase
*win
)
431 // Don't update if we've switched global updating off
432 // and this window doesn't support updates.
434 (GetMode() == wxUPDATE_UI_PROCESS_SPECIFIED
&&
435 ((win
->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES
) == 0)))
438 if (sm_updateInterval
== -1)
441 if (sm_updateInterval
== 0)
444 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
445 wxLongLong now
= wxGetLocalTimeMillis();
446 if (now
> (sm_lastUpdate
+ sm_updateInterval
))
453 // If we don't have wxStopWatch or wxLongLong, we
454 // should err on the safe side and update now anyway.
459 // Reset the update time to provide a delay until the next
460 // time we should update
461 void wxUpdateUIEvent::ResetUpdateTime()
463 #if wxUSE_STOPWATCH && wxUSE_LONGLONG
464 if (sm_updateInterval
> 0)
466 wxLongLong now
= wxGetLocalTimeMillis();
467 if (now
> (sm_lastUpdate
+ sm_updateInterval
))
479 wxIdleMode
wxIdleEvent::sm_idleMode
= wxIDLE_PROCESS_ALL
;
481 // Can we send an idle event?
482 bool wxIdleEvent::CanSend(wxWindow
* win
)
484 // Don't update if we've switched global updating off
485 // and this window doesn't support updates.
487 (GetMode() == wxIDLE_PROCESS_SPECIFIED
&&
488 ((win
->GetExtraStyle() & wxWS_EX_PROCESS_IDLE
) == 0)))
498 wxScrollEvent::wxScrollEvent(wxEventType commandType
,
502 : wxCommandEvent(commandType
, id
)
504 m_extraLong
= orient
;
512 wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType
,
516 m_eventType
= commandType
;
517 m_extraLong
= orient
;
526 wxMouseEvent::wxMouseEvent(wxEventType commandType
)
528 m_eventType
= commandType
;
531 m_controlDown
= false;
535 m_middleDown
= false;
540 m_linesPerAction
= 0;
543 void wxMouseEvent::Assign(const wxMouseEvent
& event
)
545 m_eventType
= event
.m_eventType
;
550 m_leftDown
= event
.m_leftDown
;
551 m_middleDown
= event
.m_middleDown
;
552 m_rightDown
= event
.m_rightDown
;
554 m_controlDown
= event
.m_controlDown
;
555 m_shiftDown
= event
.m_shiftDown
;
556 m_altDown
= event
.m_altDown
;
557 m_metaDown
= event
.m_metaDown
;
559 m_wheelRotation
= event
.m_wheelRotation
;
560 m_wheelDelta
= event
.m_wheelDelta
;
561 m_linesPerAction
= event
.m_linesPerAction
;
564 // return true if was a button dclick event
565 bool wxMouseEvent::ButtonDClick(int but
) const
570 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDClick"));
573 case wxMOUSE_BTN_ANY
:
574 return (LeftDClick() || MiddleDClick() || RightDClick());
576 case wxMOUSE_BTN_LEFT
:
579 case wxMOUSE_BTN_MIDDLE
:
580 return MiddleDClick();
582 case wxMOUSE_BTN_RIGHT
:
583 return RightDClick();
587 // return true if was a button down event
588 bool wxMouseEvent::ButtonDown(int but
) const
593 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonDown"));
596 case wxMOUSE_BTN_ANY
:
597 return (LeftDown() || MiddleDown() || RightDown());
599 case wxMOUSE_BTN_LEFT
:
602 case wxMOUSE_BTN_MIDDLE
:
605 case wxMOUSE_BTN_RIGHT
:
610 // return true if was a button up event
611 bool wxMouseEvent::ButtonUp(int but
) const
616 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonUp"));
619 case wxMOUSE_BTN_ANY
:
620 return (LeftUp() || MiddleUp() || RightUp());
622 case wxMOUSE_BTN_LEFT
:
625 case wxMOUSE_BTN_MIDDLE
:
628 case wxMOUSE_BTN_RIGHT
:
633 // return true if the given button is currently changing state
634 bool wxMouseEvent::Button(int but
) const
639 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::Button"));
642 case wxMOUSE_BTN_ANY
:
643 return ButtonUp(wxMOUSE_BTN_ANY
) ||
644 ButtonDown(wxMOUSE_BTN_ANY
) ||
645 ButtonDClick(wxMOUSE_BTN_ANY
);
647 case wxMOUSE_BTN_LEFT
:
648 return LeftDown() || LeftUp() || LeftDClick();
650 case wxMOUSE_BTN_MIDDLE
:
651 return MiddleDown() || MiddleUp() || MiddleDClick();
653 case wxMOUSE_BTN_RIGHT
:
654 return RightDown() || RightUp() || RightDClick();
658 bool wxMouseEvent::ButtonIsDown(int but
) const
663 wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonIsDown"));
666 case wxMOUSE_BTN_ANY
:
667 return LeftIsDown() || MiddleIsDown() || RightIsDown();
669 case wxMOUSE_BTN_LEFT
:
672 case wxMOUSE_BTN_MIDDLE
:
673 return MiddleIsDown();
675 case wxMOUSE_BTN_RIGHT
:
676 return RightIsDown();
680 int wxMouseEvent::GetButton() const
682 for ( int i
= 1; i
<= 3; i
++ )
690 return wxMOUSE_BTN_NONE
;
693 // Find the logical position of the event given the DC
694 wxPoint
wxMouseEvent::GetLogicalPosition(const wxDC
& dc
) const
696 wxPoint
pt(dc
.DeviceToLogicalX(m_x
), dc
.DeviceToLogicalY(m_y
));
706 wxKeyEvent::wxKeyEvent(wxEventType type
)
710 m_controlDown
= false;
720 wxKeyEvent::wxKeyEvent(const wxKeyEvent
& evt
)
726 m_keyCode
= evt
.m_keyCode
;
728 m_controlDown
= evt
.m_controlDown
;
729 m_shiftDown
= evt
.m_shiftDown
;
730 m_altDown
= evt
.m_altDown
;
731 m_metaDown
= evt
.m_metaDown
;
732 m_scanCode
= evt
.m_scanCode
;
733 m_rawCode
= evt
.m_rawCode
;
734 m_rawFlags
= evt
.m_rawFlags
;
737 m_uniChar
= evt
.m_uniChar
;
741 #if WXWIN_COMPATIBILITY_2_6
742 long wxKeyEvent::KeyCode() const
746 #endif // WXWIN_COMPATIBILITY_2_6
748 wxWindowCreateEvent::wxWindowCreateEvent(wxWindow
*win
)
750 SetEventType(wxEVT_CREATE
);
754 wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow
*win
)
756 SetEventType(wxEVT_DESTROY
);
760 wxChildFocusEvent::wxChildFocusEvent(wxWindow
*win
)
761 : wxCommandEvent(wxEVT_CHILD_FOCUS
)
766 // ----------------------------------------------------------------------------
768 // ----------------------------------------------------------------------------
771 wxHelpEvent::Origin
wxHelpEvent::GuessOrigin(Origin origin
)
773 if ( origin
== Origin_Unknown
)
775 // assume that the event comes from the help button if it's not from
776 // keyboard and that pressing F1 always results in the help event
777 origin
= wxGetKeyState(WXK_F1
) ? Origin_Keyboard
: Origin_HelpButton
;
788 // ----------------------------------------------------------------------------
790 // ----------------------------------------------------------------------------
792 static const int EVENT_TYPE_TABLE_INIT_SIZE
= 31; // Not too big not too small...
794 wxEventHashTable
* wxEventHashTable::sm_first
= NULL
;
796 wxEventHashTable::wxEventHashTable(const wxEventTable
&table
)
800 AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE
);
804 m_next
->m_previous
= this;
808 wxEventHashTable::~wxEventHashTable()
811 m_next
->m_previous
= m_previous
;
813 m_previous
->m_next
= m_next
;
814 if (sm_first
== this)
820 void wxEventHashTable::Clear()
823 for(i
= 0; i
< m_size
; i
++)
825 EventTypeTablePointer eTTnode
= m_eventTypeTable
[i
];
832 // Necessary in order to not invoke the
833 // overloaded delete operator when statics are cleaned up
834 if (m_eventTypeTable
)
835 delete[] m_eventTypeTable
;
837 m_eventTypeTable
= NULL
;
842 void wxEventHashTable::ClearAll()
844 wxEventHashTable
* table
= sm_first
;
848 table
= table
->m_next
;
852 bool wxEventHashTable::HandleEvent(wxEvent
&event
, wxEvtHandler
*self
)
857 m_rebuildHash
= false;
860 if (!m_eventTypeTable
)
863 // Find all entries for the given event type.
864 wxEventType eventType
= event
.GetEventType();
865 const EventTypeTablePointer eTTnode
= m_eventTypeTable
[eventType
% m_size
];
866 if (eTTnode
&& eTTnode
->eventType
== eventType
)
868 // Now start the search for an event handler
869 // that can handle an event with the given ID.
870 const wxEventTableEntryPointerArray
&
871 eventEntryTable
= eTTnode
->eventEntryTable
;
873 const size_t count
= eventEntryTable
.GetCount();
874 for (size_t n
= 0; n
< count
; n
++)
877 ProcessEventIfMatches(*eventEntryTable
[n
], self
, event
) )
887 void wxEventHashTable::InitHashTable()
889 // Loop over the event tables and all its base tables.
890 const wxEventTable
*table
= &m_table
;
893 // Retrieve all valid event handler entries
894 const wxEventTableEntry
*entry
= table
->entries
;
895 while (entry
->m_fn
!= 0)
897 // Add the event entry in the Hash.
903 table
= table
->baseTable
;
906 // Lets free some memory.
908 for(i
= 0; i
< m_size
; i
++)
910 EventTypeTablePointer eTTnode
= m_eventTypeTable
[i
];
913 eTTnode
->eventEntryTable
.Shrink();
918 void wxEventHashTable::AddEntry(const wxEventTableEntry
&entry
)
920 // This might happen 'accidentally' as the app is exiting
921 if (!m_eventTypeTable
)
924 EventTypeTablePointer
*peTTnode
= &m_eventTypeTable
[entry
.m_eventType
% m_size
];
925 EventTypeTablePointer eTTnode
= *peTTnode
;
929 if (eTTnode
->eventType
!= entry
.m_eventType
)
932 GrowEventTypeTable();
933 // Try again to add it.
940 eTTnode
= new EventTypeTable
;
941 eTTnode
->eventType
= entry
.m_eventType
;
945 // Fill all hash entries between entry.m_id and entry.m_lastId...
946 eTTnode
->eventEntryTable
.Add(&entry
);
949 void wxEventHashTable::AllocEventTypeTable(size_t size
)
951 m_eventTypeTable
= new EventTypeTablePointer
[size
];
952 memset((void *)m_eventTypeTable
, 0, sizeof(EventTypeTablePointer
)*size
);
956 void wxEventHashTable::GrowEventTypeTable()
958 size_t oldSize
= m_size
;
959 EventTypeTablePointer
*oldEventTypeTable
= m_eventTypeTable
;
961 // TODO: Search the most optimal grow sequence
962 AllocEventTypeTable(/* GetNextPrime(oldSize) */oldSize
*2+1);
964 for ( size_t i
= 0; i
< oldSize
; /* */ )
966 EventTypeTablePointer eTToldNode
= oldEventTypeTable
[i
];
969 EventTypeTablePointer
*peTTnode
= &m_eventTypeTable
[eTToldNode
->eventType
% m_size
];
970 EventTypeTablePointer eTTnode
= *peTTnode
;
972 // Check for collision, we don't want any.
975 GrowEventTypeTable();
976 continue; // Don't increment the counter,
977 // as we still need to add this element.
981 // Get the old value and put it in the new table.
982 *peTTnode
= oldEventTypeTable
[i
];
989 delete[] oldEventTypeTable
;
993 // ----------------------------------------------------------------------------
995 // ----------------------------------------------------------------------------
1001 wxEvtHandler::wxEvtHandler()
1003 m_nextHandler
= (wxEvtHandler
*) NULL
;
1004 m_previousHandler
= (wxEvtHandler
*) NULL
;
1006 m_dynamicEvents
= (wxList
*) NULL
;
1007 m_pendingEvents
= (wxList
*) NULL
;
1009 # if !defined(__VISAGECPP__)
1010 m_eventsLocker
= new wxCriticalSection
;
1013 // no client data (yet)
1014 m_clientData
= NULL
;
1015 m_clientDataType
= wxClientData_None
;
1018 wxEvtHandler::~wxEvtHandler()
1020 // Takes itself out of the list of handlers
1021 if (m_previousHandler
)
1022 m_previousHandler
->m_nextHandler
= m_nextHandler
;
1025 m_nextHandler
->m_previousHandler
= m_previousHandler
;
1027 if (m_dynamicEvents
)
1029 wxList::iterator it
= m_dynamicEvents
->begin(),
1030 en
= m_dynamicEvents
->end();
1031 for (;it
!= en
; ++it
)
1033 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1034 wxEventTableEntry
*entry
= (wxEventTableEntry
*)*it
;
1035 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1036 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)*it
;
1037 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1039 if (entry
->m_callbackUserData
)
1040 delete entry
->m_callbackUserData
;
1043 delete m_dynamicEvents
;
1046 if (m_pendingEvents
)
1047 m_pendingEvents
->DeleteContents(true);
1048 delete m_pendingEvents
;
1051 # if !defined(__VISAGECPP__)
1052 delete m_eventsLocker
;
1055 // Remove us from wxPendingEvents if necessary.
1056 if(wxPendingEventsLocker
)
1057 wxENTER_CRIT_SECT(*wxPendingEventsLocker
);
1058 if ( wxPendingEvents
)
1060 // Delete all occurences of this from the list of pending events
1061 while (wxPendingEvents
->DeleteObject(this)) { } // Do nothing
1063 if(wxPendingEventsLocker
)
1064 wxLEAVE_CRIT_SECT(*wxPendingEventsLocker
);
1067 // we only delete object data, not untyped
1068 if ( m_clientDataType
== wxClientData_Object
)
1069 delete m_clientObject
;
1074 bool wxEvtHandler::ProcessThreadEvent(wxEvent
& event
)
1076 // check that we are really in a child thread
1077 wxASSERT_MSG( !wxThread::IsMain(),
1078 wxT("use ProcessEvent() in main thread") );
1080 AddPendingEvent(event
);
1085 void wxEvtHandler::ClearEventLocker()
1087 #if !defined(__VISAGECPP__)
1088 delete m_eventsLocker
;
1089 m_eventsLocker
= NULL
;
1093 #endif // wxUSE_THREADS
1095 void wxEvtHandler::AddPendingEvent(wxEvent
& event
)
1097 // 1) Add event to list of pending events of this event handler
1099 wxEvent
*eventCopy
= event
.Clone();
1101 // we must be able to copy the events here so the event class must
1102 // implement Clone() properly instead of just providing a NULL stab for it
1103 wxCHECK_RET( eventCopy
,
1104 _T("events of this type aren't supposed to be posted") );
1106 wxENTER_CRIT_SECT( Lock() );
1108 if ( !m_pendingEvents
)
1109 m_pendingEvents
= new wxList
;
1111 m_pendingEvents
->Append(eventCopy
);
1113 wxLEAVE_CRIT_SECT( Lock() );
1115 // 2) Add this event handler to list of event handlers that
1116 // have pending events.
1118 wxENTER_CRIT_SECT(*wxPendingEventsLocker
);
1120 if ( !wxPendingEvents
)
1121 wxPendingEvents
= new wxList
;
1122 wxPendingEvents
->Append(this);
1124 wxLEAVE_CRIT_SECT(*wxPendingEventsLocker
);
1126 // 3) Inform the system that new pending events are somewhere,
1127 // and that these should be processed in idle time.
1131 void wxEvtHandler::ProcessPendingEvents()
1133 // this method is only called by wxApp if this handler does have pending
1135 wxCHECK_RET( m_pendingEvents
,
1136 wxT("Please call wxApp::ProcessPendingEvents() instead") );
1138 wxENTER_CRIT_SECT( Lock() );
1140 // we leave the loop once we have processed all events that were present at
1141 // the start of ProcessPendingEvents because otherwise we could get into
1142 // infinite loop if the pending event handler execution resulted in another
1143 // event being posted
1144 size_t n
= m_pendingEvents
->size();
1145 for ( wxList::compatibility_iterator node
= m_pendingEvents
->GetFirst();
1147 node
= m_pendingEvents
->GetFirst() )
1149 wxEvent
*event
= (wxEvent
*)node
->GetData();
1151 // It's importan we remove event from list before processing it.
1152 // Else a nested event loop, for example from a modal dialog, might
1153 // process the same event again.
1154 m_pendingEvents
->Erase(node
);
1156 wxLEAVE_CRIT_SECT( Lock() );
1158 ProcessEvent(*event
);
1161 wxENTER_CRIT_SECT( Lock() );
1167 wxLEAVE_CRIT_SECT( Lock() );
1174 wxEvtHandler::ProcessEventIfMatches(const wxEventTableEntryBase
& entry
,
1175 wxEvtHandler
*handler
,
1178 int tableId1
= entry
.m_id
,
1179 tableId2
= entry
.m_lastId
;
1181 // match only if the event type is the same and the id is either -1 in
1182 // the event table (meaning "any") or the event id matches the id
1183 // specified in the event table either exactly or by falling into
1184 // range between first and last
1185 if ((tableId1
== wxID_ANY
) ||
1186 (tableId2
== wxID_ANY
&& tableId1
== event
.GetId()) ||
1187 (tableId2
!= wxID_ANY
&&
1188 (event
.GetId() >= tableId1
&& event
.GetId() <= tableId2
)))
1191 event
.m_callbackUserData
= entry
.m_callbackUserData
;
1193 #if wxUSE_EXCEPTIONS
1196 // call the handler via wxApp method which allows the user to catch
1197 // any exceptions which may be thrown by any handler in the program
1199 wxTheApp
->HandleEvent(handler
, (wxEventFunction
)entry
.m_fn
, event
);
1202 #endif // wxUSE_EXCEPTIONS
1204 // no need for an extra virtual function call
1205 (handler
->*((wxEventFunction
) (entry
.m_fn
)))(event
);
1208 if (!event
.GetSkipped())
1215 bool wxEvtHandler::TryParent(wxEvent
& event
)
1217 if ( wxTheApp
&& (this != wxTheApp
) )
1219 // Special case: don't pass wxEVT_IDLE to wxApp, since it'll always
1220 // swallow it. wxEVT_IDLE is sent explicitly to wxApp so it will be
1221 // processed appropriately via SearchEventTable.
1222 if ( event
.GetEventType() != wxEVT_IDLE
)
1224 if ( wxTheApp
->ProcessEvent(event
) )
1232 bool wxEvtHandler::ProcessEvent(wxEvent
& event
)
1234 // allow the application to hook into event processing
1237 int rc
= wxTheApp
->FilterEvent(event
);
1240 wxASSERT_MSG( rc
== 1 || rc
== 0,
1241 _T("unexpected wxApp::FilterEvent return value") );
1245 //else: proceed normally
1248 // An event handler can be enabled or disabled
1249 if ( GetEvtHandlerEnabled() )
1251 // if we have a validator, it has higher priority than our own event
1253 if ( TryValidator(event
) )
1256 // Handle per-instance dynamic event tables first
1257 if ( m_dynamicEvents
&& SearchDynamicEventTable(event
) )
1260 // Then static per-class event tables
1261 if ( GetEventHashTable().HandleEvent(event
, this) )
1265 // Try going down the event handler chain
1266 if ( GetNextHandler() )
1268 if ( GetNextHandler()->ProcessEvent(event
) )
1272 // Finally propagate the event upwards the window chain and/or to the
1273 // application object as necessary
1274 return TryParent(event
);
1278 bool wxEvtHandler::SearchEventTable(wxEventTable
& table
, wxEvent
& event
)
1280 const wxEventType eventType
= event
.GetEventType();
1281 for ( int i
= 0; table
.entries
[i
].m_fn
!= 0; i
++ )
1283 const wxEventTableEntry
& entry
= table
.entries
[i
];
1284 if ( eventType
== entry
.m_eventType
)
1286 if ( ProcessEventIfMatches(entry
, this, event
) )
1294 void wxEvtHandler::Connect( int id
, int lastId
,
1296 wxObjectEventFunction func
,
1298 wxEvtHandler
* eventSink
)
1300 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1301 wxEventTableEntry
*entry
= new wxEventTableEntry
;
1302 entry
->m_eventType
= eventType
;
1304 entry
->m_lastId
= lastId
;
1306 entry
->m_callbackUserData
= userData
;
1307 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1308 wxDynamicEventTableEntry
*entry
=
1309 new wxDynamicEventTableEntry(eventType
, id
, lastId
, func
, userData
, eventSink
);
1310 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1312 if (!m_dynamicEvents
)
1313 m_dynamicEvents
= new wxList
;
1315 // Insert at the front of the list so most recent additions are found first
1316 m_dynamicEvents
->Insert( (wxObject
*) entry
);
1319 bool wxEvtHandler::Disconnect( int id
, int lastId
, wxEventType eventType
,
1320 wxObjectEventFunction func
,
1322 wxEvtHandler
* eventSink
)
1324 if (!m_dynamicEvents
)
1327 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1330 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1331 wxEventTableEntry
*entry
= (wxEventTableEntry
*)node
->GetData();
1332 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1333 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1334 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1336 if ((entry
->m_id
== id
) &&
1337 ((entry
->m_lastId
== lastId
) || (lastId
== wxID_ANY
)) &&
1338 ((entry
->m_eventType
== eventType
) || (eventType
== wxEVT_NULL
)) &&
1339 ((entry
->m_fn
== func
) || (func
== (wxObjectEventFunction
)NULL
)) &&
1340 ((entry
->m_eventSink
== eventSink
) || (eventSink
== (wxEvtHandler
*)NULL
)) &&
1341 ((entry
->m_callbackUserData
== userData
) || (userData
== (wxObject
*)NULL
)))
1343 if (entry
->m_callbackUserData
)
1344 delete entry
->m_callbackUserData
;
1345 m_dynamicEvents
->Erase( node
);
1349 node
= node
->GetNext();
1354 bool wxEvtHandler::SearchDynamicEventTable( wxEvent
& event
)
1356 wxCHECK_MSG( m_dynamicEvents
, false,
1357 wxT("caller should check that we have dynamic events") );
1359 wxList::compatibility_iterator node
= m_dynamicEvents
->GetFirst();
1362 #if WXWIN_COMPATIBILITY_EVENT_TYPES
1363 wxEventTableEntry
*entry
= (wxEventTableEntry
*)node
->GetData();
1364 #else // !WXWIN_COMPATIBILITY_EVENT_TYPES
1365 wxDynamicEventTableEntry
*entry
= (wxDynamicEventTableEntry
*)node
->GetData();
1366 #endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES
1368 // get next node before (maybe) calling the event handler as it could
1369 // call Disconnect() invalidating the current node
1370 node
= node
->GetNext();
1372 if ((event
.GetEventType() == entry
->m_eventType
) && (entry
->m_fn
!= 0))
1374 wxEvtHandler
*handler
=
1375 #if !WXWIN_COMPATIBILITY_EVENT_TYPES
1376 entry
->m_eventSink
? entry
->m_eventSink
1381 if ( ProcessEventIfMatches(*entry
, handler
, event
) )
1391 void wxEvtHandler::DoSetClientObject( wxClientData
*data
)
1393 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1394 wxT("can't have both object and void client data") );
1396 if ( m_clientObject
)
1397 delete m_clientObject
;
1399 m_clientObject
= data
;
1400 m_clientDataType
= wxClientData_Object
;
1403 wxClientData
*wxEvtHandler::DoGetClientObject() const
1405 // it's not an error to call GetClientObject() on a window which doesn't
1406 // have client data at all - NULL will be returned
1407 wxASSERT_MSG( m_clientDataType
!= wxClientData_Void
,
1408 wxT("this window doesn't have object client data") );
1410 return m_clientObject
;
1413 void wxEvtHandler::DoSetClientData( void *data
)
1415 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1416 wxT("can't have both object and void client data") );
1418 m_clientData
= data
;
1419 m_clientDataType
= wxClientData_Void
;
1422 void *wxEvtHandler::DoGetClientData() const
1424 // it's not an error to call GetClientData() on a window which doesn't have
1425 // client data at all - NULL will be returned
1426 wxASSERT_MSG( m_clientDataType
!= wxClientData_Object
,
1427 wxT("this window doesn't have void client data") );
1429 return m_clientData
;
1432 #endif // wxUSE_BASE
1436 // Find a window with the focus, that is also a descendant of the given window.
1437 // This is used to determine the window to initially send commands to.
1438 wxWindow
* wxFindFocusDescendant(wxWindow
* ancestor
)
1440 // Process events starting with the window with the focus, if any.
1441 wxWindow
* focusWin
= wxWindow::FindFocus();
1442 wxWindow
* win
= focusWin
;
1444 // Check if this is a descendant of this frame.
1445 // If not, win will be set to NULL.
1448 if (win
== ancestor
)
1451 win
= win
->GetParent();
1453 if (win
== (wxWindow
*) NULL
)
1454 focusWin
= (wxWindow
*) NULL
;