X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/924b84ab9461c95cf5c5386d1091ae0f7a8e7ce7..74a8f67d96591cec101def2a7d47c64072aff7fd:/src/common/event.cpp diff --git a/src/common/event.cpp b/src/common/event.cpp index 648c80e2b7..31e6e6adef 100644 --- a/src/common/event.cpp +++ b/src/common/event.cpp @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: event.cpp +// Name: src/common/event.cpp // Purpose: Event classes // Author: Julian Smart // Modified by: @@ -17,17 +17,6 @@ // headers // ---------------------------------------------------------------------------- -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) && !defined(__EMX__) -// Some older compilers (such as EMX) cannot handle -// #pragma interface/implementation correctly, iff -// #pragma implementation is used in _two_ translation -// units (as created by e.g. event.cpp compiled for -// libwx_base and event.cpp compiled for libwx_gui_core). -// So we must not use those pragmas for those compilers in -// such files. - #pragma implementation "event.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -35,28 +24,35 @@ #pragma hdrstop #endif +#include "wx/event.h" +#include "wx/evtloop.h" + #ifndef WX_PRECOMP - #include "wx/defs.h" - #include "wx/app.h" #include "wx/list.h" + #include "wx/log.h" + #include "wx/app.h" + #include "wx/utils.h" + #include "wx/stopwatch.h" + #include "wx/module.h" #if wxUSE_GUI + #include "wx/window.h" #include "wx/control.h" - #include "wx/utils.h" #include "wx/dc.h" + #include "wx/spinbutt.h" #include "wx/textctrl.h" + #include "wx/validate.h" #endif // wxUSE_GUI #endif -#include "wx/event.h" -#include "wx/module.h" +#include "wx/thread.h" -#if wxUSE_GUI - #include "wx/validate.h" -#if wxUSE_STOPWATCH - #include "wx/stopwatch.h" -#endif -#endif // wxUSE_GUI +#if wxUSE_BASE + #include "wx/scopedptr.h" + + wxDECLARE_SCOPED_PTR(wxEvent, wxEventPtr) + wxDEFINE_SCOPED_PTR(wxEvent, wxEventPtr) +#endif // wxUSE_BASE // ---------------------------------------------------------------------------- // wxWin macros @@ -65,10 +61,11 @@ #if wxUSE_BASE IMPLEMENT_DYNAMIC_CLASS(wxEvtHandler, wxObject) IMPLEMENT_ABSTRACT_CLASS(wxEvent, wxObject) + IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent) + IMPLEMENT_DYNAMIC_CLASS(wxThreadEvent, wxEvent) #endif // wxUSE_BASE #if wxUSE_GUI - IMPLEMENT_DYNAMIC_CLASS(wxIdleEvent, wxEvent) IMPLEMENT_DYNAMIC_CLASS(wxCommandEvent, wxEvent) IMPLEMENT_DYNAMIC_CLASS(wxNotifyEvent, wxCommandEvent) IMPLEMENT_DYNAMIC_CLASS(wxScrollEvent, wxCommandEvent) @@ -103,6 +100,8 @@ IMPLEMENT_DYNAMIC_CLASS(wxHelpEvent, wxCommandEvent) IMPLEMENT_DYNAMIC_CLASS(wxContextMenuEvent, wxCommandEvent) IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureChangedEvent, wxEvent) + IMPLEMENT_DYNAMIC_CLASS(wxMouseCaptureLostEvent, wxEvent) + IMPLEMENT_DYNAMIC_CLASS(wxClipboardTextEvent, wxCommandEvent) #endif // wxUSE_GUI #if wxUSE_BASE @@ -119,206 +118,209 @@ wxEventHashTable &wxEvtHandler::GetEventHashTable() const wxEventHashTable wxEvtHandler::sm_eventHashTable(wxEvtHandler::sm_eventTable); const wxEventTableEntry wxEvtHandler::sm_eventTableEntries[] = - { DECLARE_EVENT_TABLE_ENTRY(wxEVT_NULL, 0, 0, (wxObjectEventFunction)NULL, NULL) }; + { wxDECLARE_EVENT_TABLE_TERMINATOR() }; -#ifdef __WXDEBUG__ -// Clear up event hash table contents or we can get problems -// when C++ is cleaning up the static object +// wxUSE_MEMORY_TRACING considers memory freed from the static objects dtors +// leaked, so we need to manually clean up all event tables before checking for +// the memory leaks when using it, however this breaks re-initializing the +// library (i.e. repeated calls to wxInitialize/wxUninitialize) because the +// event tables won't be rebuilt the next time, so disable this by default +#if wxUSE_MEMORY_TRACING + class wxEventTableEntryModule: public wxModule { -DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule) public: - wxEventTableEntryModule() {} - bool OnInit() { return true; } - void OnExit() - { - wxEventHashTable::ClearAll(); - } + wxEventTableEntryModule() { } + virtual bool OnInit() { return true; } + virtual void OnExit() { wxEventHashTable::ClearAll(); } + + DECLARE_DYNAMIC_CLASS(wxEventTableEntryModule) }; + IMPLEMENT_DYNAMIC_CLASS(wxEventTableEntryModule, wxModule) -#endif + +#endif // wxUSE_MEMORY_TRACING // ---------------------------------------------------------------------------- // global variables // ---------------------------------------------------------------------------- -// To put pending event handlers -wxList *wxPendingEvents = (wxList *)NULL; - -#if wxUSE_THREADS - // protects wxPendingEvents list - wxCriticalSection *wxPendingEventsLocker = (wxCriticalSection *)NULL; -#endif - -#if !WXWIN_COMPATIBILITY_EVENT_TYPES - // common event types are defined here, other event types are defined by the // components which use them const wxEventType wxEVT_FIRST = 10000; const wxEventType wxEVT_USER_FIRST = wxEVT_FIRST + 2000; +const wxEventType wxEVT_NULL = wxNewEventType(); -DEFINE_EVENT_TYPE(wxEVT_NULL) -DEFINE_EVENT_TYPE(wxEVT_IDLE) -DEFINE_EVENT_TYPE(wxEVT_SOCKET) +wxDEFINE_EVENT( wxEVT_IDLE, wxIdleEvent ); -#endif // !WXWIN_COMPATIBILITY_EVENT_TYPES +// Thread event +wxDEFINE_EVENT( wxEVT_THREAD, wxThreadEvent ); #endif // wxUSE_BASE #if wxUSE_GUI -#if !WXWIN_COMPATIBILITY_EVENT_TYPES - -DEFINE_EVENT_TYPE(wxEVT_COMMAND_BUTTON_CLICKED) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKBOX_CLICKED) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHOICE_SELECTED) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_SELECTED) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_MENU_SELECTED) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_SLIDER_UPDATED) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBOX_SELECTED) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_RADIOBUTTON_SELECTED) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_SCROLLBAR_UPDATED) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_VLBOX_SELECTED) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_COMBOBOX_SELECTED) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_RCLICKED) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_TOOL_ENTER) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPINCTRL_UPDATED) - -// Sockets and timers send events, too -DEFINE_EVENT_TYPE(wxEVT_TIMER) +wxDEFINE_EVENT( wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_CHECKBOX_CLICKED, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_CHOICE_SELECTED, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_LISTBOX_SELECTED, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_MENU_SELECTED, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_SLIDER_UPDATED, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_RADIOBOX_SELECTED, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_RADIOBUTTON_SELECTED, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_SCROLLBAR_UPDATED, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_VLBOX_SELECTED, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_COMBOBOX_SELECTED, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_TOOL_RCLICKED, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_TOOL_ENTER, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_SPINCTRL_UPDATED, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_COMBOBOX_DROPDOWN, wxCommandEvent); +wxDEFINE_EVENT( wxEVT_COMMAND_COMBOBOX_CLOSEUP, wxCommandEvent); // Mouse event types -DEFINE_EVENT_TYPE(wxEVT_LEFT_DOWN) -DEFINE_EVENT_TYPE(wxEVT_LEFT_UP) -DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DOWN) -DEFINE_EVENT_TYPE(wxEVT_MIDDLE_UP) -DEFINE_EVENT_TYPE(wxEVT_RIGHT_DOWN) -DEFINE_EVENT_TYPE(wxEVT_RIGHT_UP) -DEFINE_EVENT_TYPE(wxEVT_MOTION) -DEFINE_EVENT_TYPE(wxEVT_ENTER_WINDOW) -DEFINE_EVENT_TYPE(wxEVT_LEAVE_WINDOW) -DEFINE_EVENT_TYPE(wxEVT_LEFT_DCLICK) -DEFINE_EVENT_TYPE(wxEVT_MIDDLE_DCLICK) -DEFINE_EVENT_TYPE(wxEVT_RIGHT_DCLICK) -DEFINE_EVENT_TYPE(wxEVT_SET_FOCUS) -DEFINE_EVENT_TYPE(wxEVT_KILL_FOCUS) -DEFINE_EVENT_TYPE(wxEVT_CHILD_FOCUS) -DEFINE_EVENT_TYPE(wxEVT_MOUSEWHEEL) - -// Non-client mouse events -DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DOWN) -DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_UP) -DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DOWN) -DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_UP) -DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DOWN) -DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_UP) -DEFINE_EVENT_TYPE(wxEVT_NC_MOTION) -DEFINE_EVENT_TYPE(wxEVT_NC_ENTER_WINDOW) -DEFINE_EVENT_TYPE(wxEVT_NC_LEAVE_WINDOW) -DEFINE_EVENT_TYPE(wxEVT_NC_LEFT_DCLICK) -DEFINE_EVENT_TYPE(wxEVT_NC_MIDDLE_DCLICK) -DEFINE_EVENT_TYPE(wxEVT_NC_RIGHT_DCLICK) +wxDEFINE_EVENT( wxEVT_LEFT_DOWN, wxMouseEvent ); +wxDEFINE_EVENT( wxEVT_LEFT_UP, wxMouseEvent ); +wxDEFINE_EVENT( wxEVT_MIDDLE_DOWN, wxMouseEvent ); +wxDEFINE_EVENT( wxEVT_MIDDLE_UP, wxMouseEvent ); +wxDEFINE_EVENT( wxEVT_RIGHT_DOWN, wxMouseEvent ); +wxDEFINE_EVENT( wxEVT_RIGHT_UP, wxMouseEvent ); +wxDEFINE_EVENT( wxEVT_MOTION, wxMouseEvent ); +wxDEFINE_EVENT( wxEVT_ENTER_WINDOW, wxMouseEvent ); +wxDEFINE_EVENT( wxEVT_LEAVE_WINDOW, wxMouseEvent ); +wxDEFINE_EVENT( wxEVT_LEFT_DCLICK, wxMouseEvent ); +wxDEFINE_EVENT( wxEVT_MIDDLE_DCLICK, wxMouseEvent ); +wxDEFINE_EVENT( wxEVT_RIGHT_DCLICK, wxMouseEvent ); +wxDEFINE_EVENT( wxEVT_SET_FOCUS, wxFocusEvent ); +wxDEFINE_EVENT( wxEVT_KILL_FOCUS, wxFocusEvent ); +wxDEFINE_EVENT( wxEVT_CHILD_FOCUS, wxChildFocusEvent ); +wxDEFINE_EVENT( wxEVT_MOUSEWHEEL, wxMouseEvent ); +wxDEFINE_EVENT( wxEVT_AUX1_DOWN, wxMouseEvent ); +wxDEFINE_EVENT( wxEVT_AUX1_UP, wxMouseEvent ); +wxDEFINE_EVENT( wxEVT_AUX1_DCLICK, wxMouseEvent ); +wxDEFINE_EVENT( wxEVT_AUX2_DOWN, wxMouseEvent ); +wxDEFINE_EVENT( wxEVT_AUX2_UP, wxMouseEvent ); +wxDEFINE_EVENT( wxEVT_AUX2_DCLICK, wxMouseEvent ); // Character input event type -DEFINE_EVENT_TYPE(wxEVT_CHAR) -DEFINE_EVENT_TYPE(wxEVT_CHAR_HOOK) -DEFINE_EVENT_TYPE(wxEVT_NAVIGATION_KEY) -DEFINE_EVENT_TYPE(wxEVT_KEY_DOWN) -DEFINE_EVENT_TYPE(wxEVT_KEY_UP) +wxDEFINE_EVENT( wxEVT_CHAR, wxKeyEvent ); +wxDEFINE_EVENT( wxEVT_AFTER_CHAR, wxKeyEvent ); +wxDEFINE_EVENT( wxEVT_CHAR_HOOK, wxKeyEvent ); +wxDEFINE_EVENT( wxEVT_NAVIGATION_KEY, wxNavigationKeyEvent ); +wxDEFINE_EVENT( wxEVT_KEY_DOWN, wxKeyEvent ); +wxDEFINE_EVENT( wxEVT_KEY_UP, wxKeyEvent ); #if wxUSE_HOTKEY -DEFINE_EVENT_TYPE(wxEVT_HOTKEY) +wxDEFINE_EVENT( wxEVT_HOTKEY, wxKeyEvent ); #endif // Set cursor event -DEFINE_EVENT_TYPE(wxEVT_SET_CURSOR) +wxDEFINE_EVENT( wxEVT_SET_CURSOR, wxSetCursorEvent ); // wxScrollbar and wxSlider event identifiers -DEFINE_EVENT_TYPE(wxEVT_SCROLL_TOP) -DEFINE_EVENT_TYPE(wxEVT_SCROLL_BOTTOM) -DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEUP) -DEFINE_EVENT_TYPE(wxEVT_SCROLL_LINEDOWN) -DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEUP) -DEFINE_EVENT_TYPE(wxEVT_SCROLL_PAGEDOWN) -DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBTRACK) -DEFINE_EVENT_TYPE(wxEVT_SCROLL_THUMBRELEASE) -DEFINE_EVENT_TYPE(wxEVT_SCROLL_CHANGED) +wxDEFINE_EVENT( wxEVT_SCROLL_TOP, wxScrollEvent ); +wxDEFINE_EVENT( wxEVT_SCROLL_BOTTOM, wxScrollEvent ); +wxDEFINE_EVENT( wxEVT_SCROLL_LINEUP, wxScrollEvent ); +wxDEFINE_EVENT( wxEVT_SCROLL_LINEDOWN, wxScrollEvent ); +wxDEFINE_EVENT( wxEVT_SCROLL_PAGEUP, wxScrollEvent ); +wxDEFINE_EVENT( wxEVT_SCROLL_PAGEDOWN, wxScrollEvent ); +wxDEFINE_EVENT( wxEVT_SCROLL_THUMBTRACK, wxScrollEvent ); +wxDEFINE_EVENT( wxEVT_SCROLL_THUMBRELEASE, wxScrollEvent ); +wxDEFINE_EVENT( wxEVT_SCROLL_CHANGED, wxScrollEvent ); + +// Due to a bug in older wx versions, wxSpinEvents were being sent with type of +// wxEVT_SCROLL_LINEUP, wxEVT_SCROLL_LINEDOWN and wxEVT_SCROLL_THUMBTRACK. But +// with the type-safe events in place, these event types are associated with +// wxScrollEvent. To allow handling of spin events, new event types have been +// defined in spinbutt.h/spinnbuttcmn.cpp. To maintain backward compatibility +// the spin event types are being initialized with the scroll event types. + +#if wxUSE_SPINBTN + +wxDEFINE_EVENT_ALIAS( wxEVT_SPIN_UP, wxSpinEvent, wxEVT_SCROLL_LINEUP ); +wxDEFINE_EVENT_ALIAS( wxEVT_SPIN_DOWN, wxSpinEvent, wxEVT_SCROLL_LINEDOWN ); +wxDEFINE_EVENT_ALIAS( wxEVT_SPIN, wxSpinEvent, wxEVT_SCROLL_THUMBTRACK ); + +#endif // wxUSE_SPINBTN // Scroll events from wxWindow -DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_TOP) -DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_BOTTOM) -DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEUP) -DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_LINEDOWN) -DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEUP) -DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_PAGEDOWN) -DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBTRACK) -DEFINE_EVENT_TYPE(wxEVT_SCROLLWIN_THUMBRELEASE) +wxDEFINE_EVENT( wxEVT_SCROLLWIN_TOP, wxScrollWinEvent ); +wxDEFINE_EVENT( wxEVT_SCROLLWIN_BOTTOM, wxScrollWinEvent ); +wxDEFINE_EVENT( wxEVT_SCROLLWIN_LINEUP, wxScrollWinEvent ); +wxDEFINE_EVENT( wxEVT_SCROLLWIN_LINEDOWN, wxScrollWinEvent ); +wxDEFINE_EVENT( wxEVT_SCROLLWIN_PAGEUP, wxScrollWinEvent ); +wxDEFINE_EVENT( wxEVT_SCROLLWIN_PAGEDOWN, wxScrollWinEvent ); +wxDEFINE_EVENT( wxEVT_SCROLLWIN_THUMBTRACK, wxScrollWinEvent ); +wxDEFINE_EVENT( wxEVT_SCROLLWIN_THUMBRELEASE, wxScrollWinEvent ); // System events -DEFINE_EVENT_TYPE(wxEVT_SIZE) -DEFINE_EVENT_TYPE(wxEVT_SIZING) -DEFINE_EVENT_TYPE(wxEVT_MOVE) -DEFINE_EVENT_TYPE(wxEVT_MOVING) -DEFINE_EVENT_TYPE(wxEVT_CLOSE_WINDOW) -DEFINE_EVENT_TYPE(wxEVT_END_SESSION) -DEFINE_EVENT_TYPE(wxEVT_QUERY_END_SESSION) -DEFINE_EVENT_TYPE(wxEVT_HIBERNATE) -DEFINE_EVENT_TYPE(wxEVT_ACTIVATE_APP) -DEFINE_EVENT_TYPE(wxEVT_POWER) -DEFINE_EVENT_TYPE(wxEVT_ACTIVATE) -DEFINE_EVENT_TYPE(wxEVT_CREATE) -DEFINE_EVENT_TYPE(wxEVT_DESTROY) -DEFINE_EVENT_TYPE(wxEVT_SHOW) -DEFINE_EVENT_TYPE(wxEVT_ICONIZE) -DEFINE_EVENT_TYPE(wxEVT_MAXIMIZE) -DEFINE_EVENT_TYPE(wxEVT_MOUSE_CAPTURE_CHANGED) -DEFINE_EVENT_TYPE(wxEVT_PAINT) -DEFINE_EVENT_TYPE(wxEVT_ERASE_BACKGROUND) -DEFINE_EVENT_TYPE(wxEVT_NC_PAINT) -DEFINE_EVENT_TYPE(wxEVT_PAINT_ICON) -DEFINE_EVENT_TYPE(wxEVT_MENU_OPEN) -DEFINE_EVENT_TYPE(wxEVT_MENU_CLOSE) -DEFINE_EVENT_TYPE(wxEVT_MENU_HIGHLIGHT) -DEFINE_EVENT_TYPE(wxEVT_CONTEXT_MENU) -DEFINE_EVENT_TYPE(wxEVT_SYS_COLOUR_CHANGED) -DEFINE_EVENT_TYPE(wxEVT_DISPLAY_CHANGED) -DEFINE_EVENT_TYPE(wxEVT_SETTING_CHANGED) -DEFINE_EVENT_TYPE(wxEVT_QUERY_NEW_PALETTE) -DEFINE_EVENT_TYPE(wxEVT_PALETTE_CHANGED) -DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_DOWN) -DEFINE_EVENT_TYPE(wxEVT_JOY_BUTTON_UP) -DEFINE_EVENT_TYPE(wxEVT_JOY_MOVE) -DEFINE_EVENT_TYPE(wxEVT_JOY_ZMOVE) -DEFINE_EVENT_TYPE(wxEVT_DROP_FILES) -DEFINE_EVENT_TYPE(wxEVT_DRAW_ITEM) -DEFINE_EVENT_TYPE(wxEVT_MEASURE_ITEM) -DEFINE_EVENT_TYPE(wxEVT_COMPARE_ITEM) -DEFINE_EVENT_TYPE(wxEVT_INIT_DIALOG) -DEFINE_EVENT_TYPE(wxEVT_UPDATE_UI) +wxDEFINE_EVENT( wxEVT_SIZE, wxSizeEvent ); +wxDEFINE_EVENT( wxEVT_SIZING, wxSizeEvent ); +wxDEFINE_EVENT( wxEVT_MOVE, wxMoveEvent ); +wxDEFINE_EVENT( wxEVT_MOVING, wxMoveEvent ); +wxDEFINE_EVENT( wxEVT_MOVE_START, wxMoveEvent ); +wxDEFINE_EVENT( wxEVT_MOVE_END, wxMoveEvent ); +wxDEFINE_EVENT( wxEVT_CLOSE_WINDOW, wxCloseEvent ); +wxDEFINE_EVENT( wxEVT_END_SESSION, wxCloseEvent ); +wxDEFINE_EVENT( wxEVT_QUERY_END_SESSION, wxCloseEvent ); +wxDEFINE_EVENT( wxEVT_HIBERNATE, wxActivateEvent ); +wxDEFINE_EVENT( wxEVT_ACTIVATE_APP, wxActivateEvent ); +wxDEFINE_EVENT( wxEVT_ACTIVATE, wxActivateEvent ); +wxDEFINE_EVENT( wxEVT_CREATE, wxWindowCreateEvent ); +wxDEFINE_EVENT( wxEVT_DESTROY, wxWindowDestroyEvent ); +wxDEFINE_EVENT( wxEVT_SHOW, wxShowEvent ); +wxDEFINE_EVENT( wxEVT_ICONIZE, wxIconizeEvent ); +wxDEFINE_EVENT( wxEVT_MAXIMIZE, wxMaximizeEvent ); +wxDEFINE_EVENT( wxEVT_MOUSE_CAPTURE_CHANGED, wxMouseCaptureChangedEvent ); +wxDEFINE_EVENT( wxEVT_MOUSE_CAPTURE_LOST, wxMouseCaptureLostEvent ); +wxDEFINE_EVENT( wxEVT_PAINT, wxPaintEvent ); +wxDEFINE_EVENT( wxEVT_ERASE_BACKGROUND, wxEraseEvent ); +wxDEFINE_EVENT( wxEVT_NC_PAINT, wxNcPaintEvent ); +wxDEFINE_EVENT( wxEVT_MENU_OPEN, wxMenuEvent ); +wxDEFINE_EVENT( wxEVT_MENU_CLOSE, wxMenuEvent ); +wxDEFINE_EVENT( wxEVT_MENU_HIGHLIGHT, wxMenuEvent ); +wxDEFINE_EVENT( wxEVT_CONTEXT_MENU, wxContextMenuEvent ); +wxDEFINE_EVENT( wxEVT_SYS_COLOUR_CHANGED, wxSysColourChangedEvent ); +wxDEFINE_EVENT( wxEVT_DISPLAY_CHANGED, wxDisplayChangedEvent ); +wxDEFINE_EVENT( wxEVT_QUERY_NEW_PALETTE, wxQueryNewPaletteEvent ); +wxDEFINE_EVENT( wxEVT_PALETTE_CHANGED, wxPaletteChangedEvent ); +wxDEFINE_EVENT( wxEVT_JOY_BUTTON_DOWN, wxJoystickEvent ); +wxDEFINE_EVENT( wxEVT_JOY_BUTTON_UP, wxJoystickEvent ); +wxDEFINE_EVENT( wxEVT_JOY_MOVE, wxJoystickEvent ); +wxDEFINE_EVENT( wxEVT_JOY_ZMOVE, wxJoystickEvent ); +wxDEFINE_EVENT( wxEVT_DROP_FILES, wxDropFilesEvent ); +wxDEFINE_EVENT( wxEVT_INIT_DIALOG, wxInitDialogEvent ); +wxDEFINE_EVENT( wxEVT_UPDATE_UI, wxUpdateUIEvent ); + +// Clipboard events +wxDEFINE_EVENT( wxEVT_COMMAND_TEXT_COPY, wxClipboardTextEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_TEXT_CUT, wxClipboardTextEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_TEXT_PASTE, wxClipboardTextEvent ); // Generic command events // Note: a click is a higher-level event than button down/up -DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_CLICK) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_LEFT_DCLICK) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_CLICK) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_RIGHT_DCLICK) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_SET_FOCUS) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_KILL_FOCUS) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_ENTER) +wxDEFINE_EVENT( wxEVT_COMMAND_LEFT_CLICK, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_LEFT_DCLICK, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_RIGHT_CLICK, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_RIGHT_DCLICK, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_SET_FOCUS, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_KILL_FOCUS, wxCommandEvent ); +wxDEFINE_EVENT( wxEVT_COMMAND_ENTER, wxCommandEvent ); // Help events -DEFINE_EVENT_TYPE(wxEVT_HELP) -DEFINE_EVENT_TYPE(wxEVT_DETAILED_HELP) - -#endif // !WXWIN_COMPATIBILITY_EVENT_TYPES +wxDEFINE_EVENT( wxEVT_HELP, wxHelpEvent ); +wxDEFINE_EVENT( wxEVT_DETAILED_HELP, wxHelpEvent ); #endif // wxUSE_GUI #if wxUSE_BASE +wxIdleMode wxIdleEvent::sm_idleMode = wxIDLE_PROCESS_ALL; + // ============================================================================ // implementation // ============================================================================ @@ -334,53 +336,81 @@ int wxNewEventType() return s_lastUsedEventType++; } +// ---------------------------------------------------------------------------- +// wxEventFunctor +// ---------------------------------------------------------------------------- + +wxEventFunctor::~wxEventFunctor() +{ +} // ---------------------------------------------------------------------------- // wxEvent // ---------------------------------------------------------------------------- /* - * General wxWidgets events, covering - * all interesting things that might happen (button clicking, resizing, - * setting text in widgets, etc.). + * General wxWidgets events, covering all interesting things that might happen + * (button clicking, resizing, setting text in widgets, etc.). * * For each completely new event type, derive a new event class. * */ -wxEvent::wxEvent(int theId, wxEventType commandType ) +wxEvent::wxEvent(int theId, wxEventType commandType) { m_eventType = commandType; - m_eventObject = (wxObject *) NULL; + m_eventObject = NULL; m_timeStamp = 0; m_id = theId; m_skipped = false; - m_callbackUserData = (wxObject *) NULL; + m_callbackUserData = NULL; + m_handlerToProcessOnlyIn = NULL; m_isCommandEvent = false; m_propagationLevel = wxEVENT_PROPAGATE_NONE; + m_wasProcessed = false; } -wxEvent::wxEvent(const wxEvent &src) - : wxObject() +wxEvent::wxEvent(const wxEvent& src) + : wxObject(src) , m_eventObject(src.m_eventObject) , m_eventType(src.m_eventType) , m_timeStamp(src.m_timeStamp) , m_id(src.m_id) , m_callbackUserData(src.m_callbackUserData) + , m_handlerToProcessOnlyIn(NULL) , m_propagationLevel(src.m_propagationLevel) , m_skipped(src.m_skipped) , m_isCommandEvent(src.m_isCommandEvent) + , m_wasProcessed(false) { } +wxEvent& wxEvent::operator=(const wxEvent& src) +{ + wxObject::operator=(src); + + m_eventObject = src.m_eventObject; + m_eventType = src.m_eventType; + m_timeStamp = src.m_timeStamp; + m_id = src.m_id; + m_callbackUserData = src.m_callbackUserData; + m_handlerToProcessOnlyIn = NULL; + m_propagationLevel = src.m_propagationLevel; + m_skipped = src.m_skipped; + m_isCommandEvent = src.m_isCommandEvent; + + // don't change m_wasProcessed + + return *this; +} + #endif // wxUSE_BASE #if wxUSE_GUI -/* - * Command events - * - */ +// ---------------------------------------------------------------------------- +// wxCommandEvent +// ---------------------------------------------------------------------------- #ifdef __VISUALC__ // 'this' : used in base member initializer list (for m_commandString) @@ -389,14 +419,9 @@ wxEvent::wxEvent(const wxEvent &src) wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId) : wxEvent(theId, commandType) -#if WXWIN_COMPATIBILITY_2_4 - , m_commandString(this) -#endif { - m_clientData = (char *) NULL; - m_clientObject = (wxClientData *) NULL; - m_extraLong = 0; - m_commandInt = 0; + m_clientData = NULL; + m_clientObject = NULL; m_isCommandEvent = true; // the command events are propagated upwards by default @@ -409,13 +434,15 @@ wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId) wxString wxCommandEvent::GetString() const { - if(m_eventType != wxEVT_COMMAND_TEXT_UPDATED || !m_eventObject) + if (m_eventType != wxEVT_COMMAND_TEXT_UPDATED || !m_eventObject) + { return m_cmdString; + } else { #if wxUSE_TEXTCTRL wxTextCtrl *txt = wxDynamicCast(m_eventObject, wxTextCtrl); - if(txt) + if ( txt ) return txt->GetValue(); else #endif // wxUSE_TEXTCTRL @@ -423,9 +450,9 @@ wxString wxCommandEvent::GetString() const } } -/* - * UI update events - */ +// ---------------------------------------------------------------------------- +// wxUpdateUIEvent +// ---------------------------------------------------------------------------- #if wxUSE_LONGLONG wxLongLong wxUpdateUIEvent::sm_lastUpdate = 0; @@ -445,6 +472,13 @@ bool wxUpdateUIEvent::CanUpdate(wxWindowBase *win) ((win->GetExtraStyle() & wxWS_EX_PROCESS_UI_UPDATES) == 0))) return false; + // Don't update children of the hidden windows: this is useless as any + // change to their state won't be seen by the user anyhow. Notice that this + // argument doesn't apply to the hidden windows (with visible parent) + // themselves as they could be shown by their EVT_UPDATE_UI handler. + if ( win->GetParent() && !win->GetParent()->IsShownOnScreen() ) + return false; + if (sm_updateInterval == -1) return false; @@ -482,28 +516,9 @@ void wxUpdateUIEvent::ResetUpdateTime() #endif } -/* - * Idle events - */ - -wxIdleMode wxIdleEvent::sm_idleMode = wxIDLE_PROCESS_ALL; - -// Can we send an idle event? -bool wxIdleEvent::CanSend(wxWindow* win) -{ - // Don't update if we've switched global updating off - // and this window doesn't support updates. - if (win && - (GetMode() == wxIDLE_PROCESS_SPECIFIED && - ((win->GetExtraStyle() & wxWS_EX_PROCESS_IDLE) == 0))) - return false; - - return true; -} - -/* - * Scroll events - */ +// ---------------------------------------------------------------------------- +// wxScrollEvent +// ---------------------------------------------------------------------------- wxScrollEvent::wxScrollEvent(wxEventType commandType, int id, @@ -515,9 +530,9 @@ wxScrollEvent::wxScrollEvent(wxEventType commandType, m_commandInt = pos; } -/* - * ScrollWin events - */ +// ---------------------------------------------------------------------------- +// wxScrollWinEvent +// ---------------------------------------------------------------------------- wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType, int pos, @@ -528,31 +543,38 @@ wxScrollWinEvent::wxScrollWinEvent(wxEventType commandType, m_commandInt = pos; } -/* - * Mouse events - * - */ +// ---------------------------------------------------------------------------- +// wxMouseEvent +// ---------------------------------------------------------------------------- wxMouseEvent::wxMouseEvent(wxEventType commandType) { m_eventType = commandType; - m_metaDown = false; - m_altDown = false; - m_controlDown = false; - m_shiftDown = false; - m_leftDown = false; - m_rightDown = false; - m_middleDown = false; + m_x = 0; m_y = 0; + + m_leftDown = false; + m_middleDown = false; + m_rightDown = false; + m_aux1Down = false; + m_aux2Down = false; + + m_clickCount = -1; + m_wheelRotation = 0; m_wheelDelta = 0; m_linesPerAction = 0; + m_wheelAxis = 0; } void wxMouseEvent::Assign(const wxMouseEvent& event) { - m_eventType = event.m_eventType; + wxEvent::operator=(event); + + // Borland C++ 5.82 doesn't compile an explicit call to an implicitly + // defined operator=() so need to do it this way: + *static_cast(this) = event; m_x = event.m_x; m_y = event.m_y; @@ -560,15 +582,13 @@ void wxMouseEvent::Assign(const wxMouseEvent& event) m_leftDown = event.m_leftDown; m_middleDown = event.m_middleDown; m_rightDown = event.m_rightDown; - - m_controlDown = event.m_controlDown; - m_shiftDown = event.m_shiftDown; - m_altDown = event.m_altDown; - m_metaDown = event.m_metaDown; + m_aux1Down = event.m_aux1Down; + m_aux2Down = event.m_aux2Down; m_wheelRotation = event.m_wheelRotation; m_wheelDelta = event.m_wheelDelta; m_linesPerAction = event.m_linesPerAction; + m_wheelAxis = event.m_wheelAxis; } // return true if was a button dclick event @@ -581,7 +601,8 @@ bool wxMouseEvent::ButtonDClick(int but) const // fall through case wxMOUSE_BTN_ANY: - return (LeftDClick() || MiddleDClick() || RightDClick()); + return (LeftDClick() || MiddleDClick() || RightDClick() || + Aux1DClick() || Aux2DClick()); case wxMOUSE_BTN_LEFT: return LeftDClick(); @@ -591,6 +612,12 @@ bool wxMouseEvent::ButtonDClick(int but) const case wxMOUSE_BTN_RIGHT: return RightDClick(); + + case wxMOUSE_BTN_AUX1: + return Aux1DClick(); + + case wxMOUSE_BTN_AUX2: + return Aux2DClick(); } } @@ -604,7 +631,8 @@ bool wxMouseEvent::ButtonDown(int but) const // fall through case wxMOUSE_BTN_ANY: - return (LeftDown() || MiddleDown() || RightDown()); + return (LeftDown() || MiddleDown() || RightDown() || + Aux1Down() || Aux2Down()); case wxMOUSE_BTN_LEFT: return LeftDown(); @@ -614,6 +642,12 @@ bool wxMouseEvent::ButtonDown(int but) const case wxMOUSE_BTN_RIGHT: return RightDown(); + + case wxMOUSE_BTN_AUX1: + return Aux1Down(); + + case wxMOUSE_BTN_AUX2: + return Aux2Down(); } } @@ -627,7 +661,8 @@ bool wxMouseEvent::ButtonUp(int but) const // fall through case wxMOUSE_BTN_ANY: - return (LeftUp() || MiddleUp() || RightUp()); + return (LeftUp() || MiddleUp() || RightUp() || + Aux1Up() || Aux2Up()); case wxMOUSE_BTN_LEFT: return LeftUp(); @@ -637,6 +672,12 @@ bool wxMouseEvent::ButtonUp(int but) const case wxMOUSE_BTN_RIGHT: return RightUp(); + + case wxMOUSE_BTN_AUX1: + return Aux1Up(); + + case wxMOUSE_BTN_AUX2: + return Aux2Up(); } } @@ -662,34 +703,18 @@ bool wxMouseEvent::Button(int but) const case wxMOUSE_BTN_RIGHT: return RightDown() || RightUp() || RightDClick(); - } -} - -bool wxMouseEvent::ButtonIsDown(int but) const -{ - switch (but) - { - default: - wxFAIL_MSG(wxT("invalid parameter in wxMouseEvent::ButtonIsDown")); - // fall through - - case wxMOUSE_BTN_ANY: - return LeftIsDown() || MiddleIsDown() || RightIsDown(); - case wxMOUSE_BTN_LEFT: - return LeftIsDown(); - - case wxMOUSE_BTN_MIDDLE: - return MiddleIsDown(); + case wxMOUSE_BTN_AUX1: + return Aux1Down() || Aux1Up() || Aux1DClick(); - case wxMOUSE_BTN_RIGHT: - return RightIsDown(); + case wxMOUSE_BTN_AUX2: + return Aux2Down() || Aux2Up() || Aux2DClick(); } } int wxMouseEvent::GetButton() const { - for ( int i = 1; i <= 3; i++ ) + for ( int i = 1; i < wxMOUSE_BTN_MAX; i++ ) { if ( Button(i) ) { @@ -707,39 +732,27 @@ wxPoint wxMouseEvent::GetLogicalPosition(const wxDC& dc) const return pt; } - -/* - * Keyboard event - * - */ +// ---------------------------------------------------------------------------- +// wxKeyEvent +// ---------------------------------------------------------------------------- wxKeyEvent::wxKeyEvent(wxEventType type) { m_eventType = type; - m_shiftDown = false; - m_controlDown = false; - m_metaDown = false; - m_altDown = false; - m_keyCode = 0; - m_scanCode = 0; + m_keyCode = WXK_NONE; #if wxUSE_UNICODE - m_uniChar = 0; + m_uniChar = WXK_NONE; #endif } wxKeyEvent::wxKeyEvent(const wxKeyEvent& evt) - : wxEvent(evt) + : wxEvent(evt), + wxKeyboardState(evt) { m_x = evt.m_x; m_y = evt.m_y; m_keyCode = evt.m_keyCode; - - m_controlDown = evt.m_controlDown; - m_shiftDown = evt.m_shiftDown; - m_altDown = evt.m_altDown; - m_metaDown = evt.m_metaDown; - m_scanCode = evt.m_scanCode; m_rawCode = evt.m_rawCode; m_rawFlags = evt.m_rawFlags; @@ -748,29 +761,93 @@ wxKeyEvent::wxKeyEvent(const wxKeyEvent& evt) #endif } -long wxKeyEvent::KeyCode() const +bool wxKeyEvent::IsKeyInCategory(int category) const { - return m_keyCode; + switch ( GetKeyCode() ) + { + case WXK_LEFT: + case WXK_RIGHT: + case WXK_UP: + case WXK_DOWN: + case WXK_NUMPAD_LEFT: + case WXK_NUMPAD_RIGHT: + case WXK_NUMPAD_UP: + case WXK_NUMPAD_DOWN: + return (category & WXK_CATEGORY_ARROW) != 0; + + case WXK_PAGEDOWN: + case WXK_END: + case WXK_NUMPAD_PAGEUP: + case WXK_NUMPAD_PAGEDOWN: + return (category & WXK_CATEGORY_PAGING) != 0; + + case WXK_HOME: + case WXK_PAGEUP: + case WXK_NUMPAD_HOME: + case WXK_NUMPAD_END: + return (category & WXK_CATEGORY_JUMP) != 0; + + case WXK_TAB: + case WXK_NUMPAD_TAB: + return (category & WXK_CATEGORY_TAB) != 0; + + case WXK_BACK: + case WXK_DELETE: + case WXK_NUMPAD_DELETE: + return (category & WXK_CATEGORY_CUT) != 0; + + default: + return false; + } } +// ---------------------------------------------------------------------------- +// wxWindowCreateEvent +// ---------------------------------------------------------------------------- + wxWindowCreateEvent::wxWindowCreateEvent(wxWindow *win) { SetEventType(wxEVT_CREATE); SetEventObject(win); } +// ---------------------------------------------------------------------------- +// wxWindowDestroyEvent +// ---------------------------------------------------------------------------- + wxWindowDestroyEvent::wxWindowDestroyEvent(wxWindow *win) { SetEventType(wxEVT_DESTROY); SetEventObject(win); } +// ---------------------------------------------------------------------------- +// wxChildFocusEvent +// ---------------------------------------------------------------------------- + wxChildFocusEvent::wxChildFocusEvent(wxWindow *win) : wxCommandEvent(wxEVT_CHILD_FOCUS) { SetEventObject(win); } +// ---------------------------------------------------------------------------- +// wxHelpEvent +// ---------------------------------------------------------------------------- + +/* static */ +wxHelpEvent::Origin wxHelpEvent::GuessOrigin(Origin origin) +{ + if ( origin == Origin_Unknown ) + { + // assume that the event comes from the help button if it's not from + // keyboard and that pressing F1 always results in the help event + origin = wxGetKeyState(WXK_F1) ? Origin_Keyboard : Origin_HelpButton; + } + + return origin; +} + #endif // wxUSE_GUI @@ -810,25 +887,19 @@ wxEventHashTable::~wxEventHashTable() void wxEventHashTable::Clear() { - size_t i; - for(i = 0; i < m_size; i++) + for ( size_t i = 0; i < m_size; i++ ) { EventTypeTablePointer eTTnode = m_eventTypeTable[i]; - if (eTTnode) - { - delete eTTnode; - } + delete eTTnode; } - // Necessary in order to not invoke the - // overloaded delete operator when statics are cleaned up - if (m_eventTypeTable) - delete[] m_eventTypeTable; + wxDELETEA(m_eventTypeTable); - m_eventTypeTable = NULL; m_size = 0; } +#if wxUSE_MEMORY_TRACING + // Clear all tables void wxEventHashTable::ClearAll() { @@ -840,6 +911,8 @@ void wxEventHashTable::ClearAll() } } +#endif // wxUSE_MEMORY_TRACING + bool wxEventHashTable::HandleEvent(wxEvent &event, wxEvtHandler *self) { if (m_rebuildHash) @@ -864,11 +937,9 @@ bool wxEventHashTable::HandleEvent(wxEvent &event, wxEvtHandler *self) const size_t count = eventEntryTable.GetCount(); for (size_t n = 0; n < count; n++) { - if ( wxEvtHandler:: - ProcessEventIfMatches(*eventEntryTable[n], self, event) ) - { + const wxEventTableEntry& entry = *eventEntryTable[n]; + if ( wxEvtHandler::ProcessEventIfMatchesId(entry, self, event) ) return true; - } } } @@ -894,7 +965,7 @@ void wxEventHashTable::InitHashTable() table = table->baseTable; } - // Lets free some memory. + // Let's free some memory. size_t i; for(i = 0; i < m_size; i++) { @@ -980,27 +1051,18 @@ void wxEventHashTable::GrowEventTypeTable() delete[] oldEventTypeTable; } - // ---------------------------------------------------------------------------- // wxEvtHandler // ---------------------------------------------------------------------------- -/* - * Event handler - */ - wxEvtHandler::wxEvtHandler() { - m_nextHandler = (wxEvtHandler *) NULL; - m_previousHandler = (wxEvtHandler *) NULL; + m_nextHandler = NULL; + m_previousHandler = NULL; m_enabled = true; - m_dynamicEvents = (wxList *) NULL; - m_pendingEvents = (wxList *) NULL; -#if wxUSE_THREADS -# if !defined(__VISAGECPP__) - m_eventsLocker = new wxCriticalSection; -# endif -#endif + m_dynamicEvents = NULL; + m_pendingEvents = NULL; + // no client data (yet) m_clientData = NULL; m_clientDataType = wxClientData_None; @@ -1008,59 +1070,71 @@ wxEvtHandler::wxEvtHandler() wxEvtHandler::~wxEvtHandler() { - // Takes itself out of the list of handlers - if (m_previousHandler) - m_previousHandler->m_nextHandler = m_nextHandler; - - if (m_nextHandler) - m_nextHandler->m_previousHandler = m_previousHandler; + Unlink(); if (m_dynamicEvents) { - wxList::iterator it = m_dynamicEvents->begin(), - en = m_dynamicEvents->end(); - for (;it != en; ++it) + for ( wxList::iterator it = m_dynamicEvents->begin(), + end = m_dynamicEvents->end(); + it != end; + ++it ) { -#if WXWIN_COMPATIBILITY_EVENT_TYPES - wxEventTableEntry *entry = (wxEventTableEntry*)*it; -#else // !WXWIN_COMPATIBILITY_EVENT_TYPES wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)*it; -#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES - if (entry->m_callbackUserData) - delete entry->m_callbackUserData; + // Remove ourselves from sink destructor notifications + // (this has usually been done, in wxTrackable destructor) + wxEvtHandler *eventSink = entry->m_fn->GetEvtHandler(); + if ( eventSink ) + { + wxEventConnectionRef * const + evtConnRef = FindRefInTrackerList(eventSink); + if ( evtConnRef ) + { + eventSink->RemoveNode(evtConnRef); + delete evtConnRef; + } + } + + delete entry->m_callbackUserData; delete entry; } delete m_dynamicEvents; - }; + } - delete m_pendingEvents; + // Remove us from the list of the pending events if necessary. + if (wxTheApp) + wxTheApp->RemovePendingEventHandler(this); -#if wxUSE_THREADS -# if !defined(__VISAGECPP__) - delete m_eventsLocker; -# endif - - // Remove us from wxPendingEvents if necessary. - if(wxPendingEventsLocker) - wxENTER_CRIT_SECT(*wxPendingEventsLocker); - if ( wxPendingEvents ) - { - // Delete all occurences of this from the list of pending events - while (wxPendingEvents->DeleteObject(this)) { } // Do nothing - } - if(wxPendingEventsLocker) - wxLEAVE_CRIT_SECT(*wxPendingEventsLocker); -#endif + DeletePendingEvents(); // we only delete object data, not untyped if ( m_clientDataType == wxClientData_Object ) delete m_clientObject; } +void wxEvtHandler::Unlink() +{ + // this event handler must take itself out of the chain of handlers: + + if (m_previousHandler) + m_previousHandler->SetNextHandler(m_nextHandler); + + if (m_nextHandler) + m_nextHandler->SetPreviousHandler(m_previousHandler); + + m_nextHandler = NULL; + m_previousHandler = NULL; +} + +bool wxEvtHandler::IsUnlinked() const +{ + return m_previousHandler == NULL && + m_nextHandler == NULL; +} + #if wxUSE_THREADS -bool wxEvtHandler::ProcessThreadEvent(wxEvent& event) +bool wxEvtHandler::ProcessThreadEvent(const wxEvent& event) { // check that we are really in a child thread wxASSERT_MSG( !wxThread::IsMain(), @@ -1071,103 +1145,132 @@ bool wxEvtHandler::ProcessThreadEvent(wxEvent& event) return true; } -void wxEvtHandler::ClearEventLocker() -{ -#if !defined(__VISAGECPP__) - delete m_eventsLocker; - m_eventsLocker = NULL; -#endif -}; - #endif // wxUSE_THREADS -#if wxUSE_EXCEPTIONS -void wxEvtHandler::DoHandleEvent(wxEventFunction func, wxEvent& event) +void wxEvtHandler::QueueEvent(wxEvent *event) { - // by default, just call then handler - (this->*func)(event); -} -#endif // wxUSE_EXCEPTIONS + wxCHECK_RET( event, "NULL event can't be posted" ); -void wxEvtHandler::AddPendingEvent(wxEvent& event) -{ - // 1) Add event to list of pending events of this event handler + if (!wxTheApp) + { + // we need an event loop which manages the list of event handlers with + // pending events... cannot proceed without it! + wxLogDebug("No application object! Cannot queue this event!"); - wxEvent *eventCopy = event.Clone(); + // anyway delete the given event to avoid memory leaks + delete event; - // we must be able to copy the events here so the event class must - // implement Clone() properly instead of just providing a NULL stab for it - wxCHECK_RET( eventCopy, - _T("events of this type aren't supposed to be posted") ); + return; + } - wxENTER_CRIT_SECT( Lock() ); + // 1) Add this event to our list of pending events + wxENTER_CRIT_SECT( m_pendingEventsLock ); if ( !m_pendingEvents ) - m_pendingEvents = new wxList; + m_pendingEvents = new wxList; - m_pendingEvents->Append(eventCopy); - - wxLEAVE_CRIT_SECT( Lock() ); + m_pendingEvents->Append(event); // 2) Add this event handler to list of event handlers that // have pending events. - wxENTER_CRIT_SECT(*wxPendingEventsLocker); - - if ( !wxPendingEvents ) - wxPendingEvents = new wxList; - wxPendingEvents->Append(this); + wxTheApp->AppendPendingEventHandler(this); - wxLEAVE_CRIT_SECT(*wxPendingEventsLocker); + // only release m_pendingEventsLock now because otherwise there is a race + // condition as described in the ticket #9093: we could process the event + // just added to m_pendingEvents in our ProcessPendingEvents() below before + // we had time to append this pointer to wxHandlersWithPendingEvents list; thus + // breaking the invariant that a handler should be in the list iff it has + // any pending events to process + wxLEAVE_CRIT_SECT( m_pendingEventsLock ); - // 3) Inform the system that new pending events are somwehere, + // 3) Inform the system that new pending events are somewhere, // and that these should be processed in idle time. wxWakeUpIdle(); } +void wxEvtHandler::DeletePendingEvents() +{ + if (m_pendingEvents) + m_pendingEvents->DeleteContents(true); + wxDELETE(m_pendingEvents); +} + void wxEvtHandler::ProcessPendingEvents() { - // this method is only called by wxApp if this handler does have pending - // events - wxCHECK_RET( m_pendingEvents, - wxT("Please call wxApp::ProcessPendingEvents() instead") ); - - wxENTER_CRIT_SECT( Lock() ); - - // we leave the loop once we have processed all events that were present at - // the start of ProcessPendingEvents because otherwise we could get into - // infinite loop if the pending event handler execution resulted in another - // event being posted - size_t n = m_pendingEvents->size(); - for ( wxList::compatibility_iterator node = m_pendingEvents->GetFirst(); - node; - node = m_pendingEvents->GetFirst() ) + if (!wxTheApp) { - wxEvent *event = (wxEvent *)node->GetData(); + // we need an event loop which manages the list of event handlers with + // pending events... cannot proceed without it! + wxLogDebug("No application object! Cannot process pending events!"); + return; + } - m_pendingEvents->Erase(node); + // we need to process only a single pending event in this call because + // each call to ProcessEvent() could result in the destruction of this + // same event handler (see the comment at the end of this function) - wxLEAVE_CRIT_SECT( Lock() ); + wxENTER_CRIT_SECT( m_pendingEventsLock ); - ProcessEvent(*event); - delete event; + // this method is only called by wxApp if this handler does have + // pending events + wxCHECK_RET( m_pendingEvents && !m_pendingEvents->IsEmpty(), + "should have pending events if called" ); - wxENTER_CRIT_SECT( Lock() ); + wxList::compatibility_iterator node = m_pendingEvents->GetFirst(); + wxEvent* pEvent = static_cast(node->GetData()); - if ( !--n ) - break; + // find the first event which can be processed now: + wxEventLoopBase* evtLoop = wxEventLoopBase::GetActive(); + if (evtLoop && evtLoop->IsYielding()) + { + while (node && pEvent && !evtLoop->IsEventAllowedInsideYield(pEvent->GetEventCategory())) + { + node = node->GetNext(); + pEvent = node ? static_cast(node->GetData()) : NULL; + } + + if (!node) + { + // all our events are NOT processable now... signal this: + wxTheApp->DelayPendingEventHandler(this); + + // see the comment at the beginning of evtloop.h header for the + // logic behind YieldFor() and behind DelayPendingEventHandler() + + wxLEAVE_CRIT_SECT( m_pendingEventsLock ); + + return; + } + } + + wxEventPtr event(pEvent); + + // it's important we remove event from list before processing it, else a + // nested event loop, for example from a modal dialog, might process the + // same event again. + m_pendingEvents->Erase(node); + + if ( m_pendingEvents->IsEmpty() ) + { + // if there are no more pending events left, we don't need to + // stay in this list + wxTheApp->RemovePendingEventHandler(this); } - wxLEAVE_CRIT_SECT( Lock() ); + wxLEAVE_CRIT_SECT( m_pendingEventsLock ); + + ProcessEvent(*event); + + // careful: this object could have been deleted by the event handler + // executed by the above ProcessEvent() call, so we can't access any fields + // of this object any more } -/* - * Event table stuff - */ -/* static */ bool -wxEvtHandler::ProcessEventIfMatches(const wxEventTableEntryBase& entry, - wxEvtHandler *handler, - wxEvent& event) +/* static */ +bool wxEvtHandler::ProcessEventIfMatchesId(const wxEventTableEntryBase& entry, + wxEvtHandler *handler, + wxEvent& event) { int tableId1 = entry.m_id, tableId2 = entry.m_lastId; @@ -1190,13 +1293,12 @@ wxEvtHandler::ProcessEventIfMatches(const wxEventTableEntryBase& entry, // call the handler via wxApp method which allows the user to catch // any exceptions which may be thrown by any handler in the program // in one place - wxTheApp->HandleEvent(handler, (wxEventFunction)entry.m_fn, event); + wxTheApp->CallEventHandler(handler, *entry.m_fn, event); } else #endif // wxUSE_EXCEPTIONS { - // no need for an extra virtual function call - (handler->*((wxEventFunction) (entry.m_fn)))(event); + (*entry.m_fn)(handler, event); } if (!event.GetSkipped()) @@ -1206,7 +1308,7 @@ wxEvtHandler::ProcessEventIfMatches(const wxEventTableEntryBase& entry, return false; } -bool wxEvtHandler::TryParent(wxEvent& event) +bool wxEvtHandler::DoTryApp(wxEvent& event) { if ( wxTheApp && (this != wxTheApp) ) { @@ -1223,51 +1325,212 @@ bool wxEvtHandler::TryParent(wxEvent& event) return false; } +bool wxEvtHandler::TryBefore(wxEvent& event) +{ +#if WXWIN_COMPATIBILITY_2_8 + // call the old virtual function to keep the code overriding it working + return TryValidator(event); +#else + wxUnusedVar(event); + return false; +#endif +} + +bool wxEvtHandler::TryAfter(wxEvent& event) +{ + // We only want to pass the window to the application object once even if + // there are several chained handlers. Ensure that this is what happens by + // only calling DoTryApp() if there is no next handler (which would do it). + // + // Notice that, unlike simply calling TryAfter() on the last handler in the + // chain only from ProcessEvent(), this also works with wxWindow object in + // the middle of the chain: its overridden TryAfter() will still be called + // and propagate the event upwards the window hierarchy even if it's not + // the last one in the chain (which, admittedly, shouldn't happen often). + if ( GetNextHandler() ) + return GetNextHandler()->TryAfter(event); + +#if WXWIN_COMPATIBILITY_2_8 + // as above, call the old virtual function for compatibility + return TryParent(event); +#else + return DoTryApp(event); +#endif +} + bool wxEvtHandler::ProcessEvent(wxEvent& event) { - // allow the application to hook into event processing - if ( wxTheApp ) + // The very first thing we do is to allow the application to hook into + // event processing in order to globally pre-process all events. + // + // Note that we should only do it if we're the first event handler called + // to avoid calling FilterEvent() multiple times as the event goes through + // the event handler chain and possibly upwards the window hierarchy. + if ( !event.WasProcessed() ) { - int rc = wxTheApp->FilterEvent(event); - if ( rc != -1 ) + if ( wxTheApp ) { - wxASSERT_MSG( rc == 1 || rc == 0, - _T("unexpected wxApp::FilterEvent return value") ); + int rc = wxTheApp->FilterEvent(event); + if ( rc != -1 ) + { + wxASSERT_MSG( rc == 1 || rc == 0, + "unexpected wxApp::FilterEvent return value" ); - return rc != 0; + return rc != 0; + } + //else: proceed normally } - //else: proceed normally } - // An event handler can be enabled or disabled - if ( GetEvtHandlerEnabled() ) + // Short circuit the event processing logic if we're requested to process + // this event in this handler only, see DoTryChain() for more details. + if ( event.ShouldProcessOnlyIn(this) ) + return TryBeforeAndHere(event); + + + // Try to process the event in this handler itself. + if ( ProcessEventLocally(event) ) + { + // It is possible that DoTryChain() called from ProcessEventLocally() + // returned true but the event was not really processed: this happens + // if a custom handler ignores the request to process the event in this + // handler only and in this case we should skip the post processing + // done in TryAfter() but still return the correct value ourselves to + // indicate whether we did or did not find a handler for this event. + return !event.GetSkipped(); + } + + // If we still didn't find a handler, propagate the event upwards the + // window chain and/or to the application object. + if ( TryAfter(event) ) + return true; + + + // No handler found anywhere, bail out. + return false; +} + +bool wxEvtHandler::ProcessEventLocally(wxEvent& event) +{ + // Try the hooks which should be called before our own handlers and this + // handler itself first. Notice that we should not call ProcessEvent() on + // this one as we're already called from it, which explains why we do it + // here and not in DoTryChain() + return TryBeforeAndHere(event) || DoTryChain(event); +} + +bool wxEvtHandler::DoTryChain(wxEvent& event) +{ + for ( wxEvtHandler *h = GetNextHandler(); h; h = h->GetNextHandler() ) { - // if we have a validator, it has higher priority than our own event - // table - if ( TryValidator(event) ) - return true; + // We need to process this event at the level of this handler only + // right now, the pre-/post-processing was either already done by + // ProcessEvent() from which we were called or will be done by it when + // we return. + // + // However we must call ProcessEvent() and not TryHereOnly() because the + // existing code (including some in wxWidgets itself) expects the + // overridden ProcessEvent() in its custom event handlers pushed on a + // window to be called. + // + // So we must call ProcessEvent() but it must not do what it usually + // does. To resolve this paradox we set up a special flag inside the + // object itself to let ProcessEvent() know that it shouldn't do any + // pre/post-processing for this event if it gets it. Note that this + // only applies to this handler, if the event is passed to another one + // by explicitly calling its ProcessEvent(), pre/post-processing should + // be done as usual. + // + // Final complication is that if the implementation of ProcessEvent() + // called wxEvent::DidntHonourProcessOnlyIn() (as the gross hack that + // is wxScrollHelperEvtHandler::ProcessEvent() does) and ignored our + // request to process event in this handler only, we have to compensate + // for it by not processing the event further because this was already + // done by that rogue event handler. + wxEventProcessInHandlerOnly processInHandlerOnly(event, h); + if ( h->ProcessEvent(event) ) + { + // Make sure "skipped" flag is not set as the event was really + // processed in this case. Normally it shouldn't be set anyhow but + // make sure just in case the user code does something strange. + event.Skip(false); - // Handle per-instance dynamic event tables first - if ( m_dynamicEvents && SearchDynamicEventTable(event) ) return true; + } + + if ( !event.ShouldProcessOnlyIn(h) ) + { + // Still return true to indicate that no further processing should + // be undertaken but ensure that "skipped" flag is set so that the + // caller knows that the event was not really processed. + event.Skip(); - // Then static per-class event tables - if ( GetEventHashTable().HandleEvent(event, this) ) return true; + } } - // Try going down the event handler chain - if ( GetNextHandler() ) + return false; +} + +bool wxEvtHandler::TryHereOnly(wxEvent& event) +{ + // If the event handler is disabled it doesn't process any events + if ( !GetEvtHandlerEnabled() ) + return false; + + // Handle per-instance dynamic event tables first + if ( m_dynamicEvents && SearchDynamicEventTable(event) ) + return true; + + // Then static per-class event tables + if ( GetEventHashTable().HandleEvent(event, this) ) + return true; + + // We don't have a handler for this event. + return false; +} + +bool wxEvtHandler::SafelyProcessEvent(wxEvent& event) +{ +#if wxUSE_EXCEPTIONS + try { - if ( GetNextHandler()->ProcessEvent(event) ) - return true; +#endif + return ProcessEvent(event); +#if wxUSE_EXCEPTIONS } + catch ( ... ) + { + // notice that we do it in 2 steps to avoid warnings about possibly + // uninitialized loop variable from some versions of g++ which are not + // smart enough to figure out that GetActive() doesn't throw and so + // that loop will always be initialized + wxEventLoopBase *loop = NULL; + try + { + loop = wxEventLoopBase::GetActive(); - // Finally propagate the event upwards the window chain and/or to the - // application object as necessary - return TryParent(event); -} + if ( !wxTheApp || !wxTheApp->OnExceptionInMainLoop() ) + { + if ( loop ) + loop->Exit(); + } + //else: continue running current event loop + return false; + } + catch ( ... ) + { + // OnExceptionInMainLoop() threw, possibly rethrowing the same + // exception again: very good, but we still need Exit() to + // be called + if ( loop ) + loop->Exit(); + throw; + } + } +#endif // wxUSE_EXCEPTIONS +} bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event) { @@ -1277,7 +1540,7 @@ bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event) const wxEventTableEntry& entry = table.entries[i]; if ( eventType == entry.m_eventType ) { - if ( ProcessEventIfMatches(entry, this, event) ) + if ( ProcessEventIfMatchesId(entry, this, event) ) return true; } } @@ -1285,57 +1548,64 @@ bool wxEvtHandler::SearchEventTable(wxEventTable& table, wxEvent& event) return false; } -void wxEvtHandler::Connect( int id, int lastId, - int eventType, - wxObjectEventFunction func, - wxObject *userData, - wxEvtHandler* eventSink ) -{ -#if WXWIN_COMPATIBILITY_EVENT_TYPES - wxEventTableEntry *entry = new wxEventTableEntry; - entry->m_eventType = eventType; - entry->m_id = id; - entry->m_lastId = lastId; - entry->m_fn = func; - entry->m_callbackUserData = userData; -#else // !WXWIN_COMPATIBILITY_EVENT_TYPES +void wxEvtHandler::DoBind(int id, + int lastId, + wxEventType eventType, + wxEventFunctor *func, + wxObject *userData) +{ wxDynamicEventTableEntry *entry = - new wxDynamicEventTableEntry(eventType, id, lastId, func, userData, eventSink); -#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES + new wxDynamicEventTableEntry(eventType, id, lastId, func, userData); if (!m_dynamicEvents) m_dynamicEvents = new wxList; // Insert at the front of the list so most recent additions are found first m_dynamicEvents->Insert( (wxObject*) entry ); + + // Make sure we get to know when a sink is destroyed + wxEvtHandler *eventSink = func->GetEvtHandler(); + if ( eventSink && eventSink != this ) + { + wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink); + if ( evtConnRef ) + evtConnRef->IncRef( ); + else + new wxEventConnectionRef(this, eventSink); + } } -bool wxEvtHandler::Disconnect( int id, int lastId, wxEventType eventType, - wxObjectEventFunction func, - wxObject *userData, - wxEvtHandler* eventSink ) +bool +wxEvtHandler::DoUnbind(int id, + int lastId, + wxEventType eventType, + const wxEventFunctor& func, + wxObject *userData) { if (!m_dynamicEvents) return false; + // Remove connection from tracker node (wxEventConnectionRef) + wxEvtHandler *eventSink = func.GetEvtHandler(); + if ( eventSink && eventSink != this ) + { + wxEventConnectionRef *evtConnRef = FindRefInTrackerList(eventSink); + if ( evtConnRef ) + evtConnRef->DecRef(); + } + wxList::compatibility_iterator node = m_dynamicEvents->GetFirst(); while (node) { -#if WXWIN_COMPATIBILITY_EVENT_TYPES - wxEventTableEntry *entry = (wxEventTableEntry*)node->GetData(); -#else // !WXWIN_COMPATIBILITY_EVENT_TYPES - wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData(); -#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES + wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData(); if ((entry->m_id == id) && ((entry->m_lastId == lastId) || (lastId == wxID_ANY)) && ((entry->m_eventType == eventType) || (eventType == wxEVT_NULL)) && - ((entry->m_fn == func) || (func == (wxObjectEventFunction)NULL)) && - ((entry->m_eventSink == eventSink) || (eventSink == (wxEvtHandler*)NULL)) && - ((entry->m_callbackUserData == userData) || (userData == (wxObject*)NULL))) + entry->m_fn->IsMatching(func) && + ((entry->m_callbackUserData == userData) || !userData)) { - if (entry->m_callbackUserData) - delete entry->m_callbackUserData; + delete entry->m_callbackUserData; m_dynamicEvents->Erase( node ); delete entry; return true; @@ -1353,32 +1623,24 @@ bool wxEvtHandler::SearchDynamicEventTable( wxEvent& event ) wxList::compatibility_iterator node = m_dynamicEvents->GetFirst(); while (node) { -#if WXWIN_COMPATIBILITY_EVENT_TYPES - wxEventTableEntry *entry = (wxEventTableEntry*)node->GetData(); -#else // !WXWIN_COMPATIBILITY_EVENT_TYPES wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData(); -#endif // WXWIN_COMPATIBILITY_EVENT_TYPES/!WXWIN_COMPATIBILITY_EVENT_TYPES - if ((event.GetEventType() == entry->m_eventType) && (entry->m_fn != 0)) - { - wxEvtHandler *handler = -#if !WXWIN_COMPATIBILITY_EVENT_TYPES - entry->m_eventSink ? entry->m_eventSink - : -#endif - this; + // get next node before (maybe) calling the event handler as it could + // call Disconnect() invalidating the current node + node = node->GetNext(); - if ( ProcessEventIfMatches(*entry, handler, event) ) - { + if ( event.GetEventType() == entry->m_eventType ) + { + wxEvtHandler *handler = entry->m_fn->GetEvtHandler(); + if ( !handler ) + handler = this; + if ( ProcessEventIfMatchesId(*entry, handler, event) ) return true; - } } - - node = node->GetNext(); } return false; -}; +} void wxEvtHandler::DoSetClientObject( wxClientData *data ) { @@ -1421,6 +1683,45 @@ void *wxEvtHandler::DoGetClientData() const return m_clientData; } +// A helper to find an wxEventConnectionRef object +wxEventConnectionRef * +wxEvtHandler::FindRefInTrackerList(wxEvtHandler *eventSink) +{ + for ( wxTrackerNode *node = eventSink->GetFirst(); node; node = node->m_nxt ) + { + // we only want wxEventConnectionRef nodes here + wxEventConnectionRef *evtConnRef = node->ToEventConnection(); + if ( evtConnRef && evtConnRef->m_src == this ) + { + wxASSERT( evtConnRef->m_sink==eventSink ); + return evtConnRef; + } + } + + return NULL; +} + +void wxEvtHandler::OnSinkDestroyed( wxEvtHandler *sink ) +{ + wxASSERT(m_dynamicEvents); + + // remove all connections with this sink + wxList::compatibility_iterator node = m_dynamicEvents->GetFirst(), node_nxt; + while (node) + { + wxDynamicEventTableEntry *entry = (wxDynamicEventTableEntry*)node->GetData(); + node_nxt = node->GetNext(); + + if ( entry->m_fn->GetEvtHandler() == sink ) + { + delete entry->m_callbackUserData; + m_dynamicEvents->Erase( node ); + delete entry; + } + node = node_nxt; + } +} + #endif // wxUSE_BASE #if wxUSE_GUI @@ -1442,10 +1743,45 @@ wxWindow* wxFindFocusDescendant(wxWindow* ancestor) else win = win->GetParent(); } - if (win == (wxWindow*) NULL) - focusWin = (wxWindow*) NULL; + if (win == NULL) + focusWin = NULL; return focusWin; } +// ---------------------------------------------------------------------------- +// wxEventBlocker +// ---------------------------------------------------------------------------- + +wxEventBlocker::wxEventBlocker(wxWindow *win, wxEventType type) +{ + wxCHECK_RET(win, wxT("Null window given to wxEventBlocker")); + + m_window = win; + + Block(type); + m_window->PushEventHandler(this); +} + +wxEventBlocker::~wxEventBlocker() +{ + wxEvtHandler *popped = m_window->PopEventHandler(false); + wxCHECK_RET(popped == this, + wxT("Don't push other event handlers into a window managed by wxEventBlocker!")); +} + +bool wxEventBlocker::ProcessEvent(wxEvent& event) +{ + // should this event be blocked? + for ( size_t i = 0; i < m_eventsToBlock.size(); i++ ) + { + wxEventType t = (wxEventType)m_eventsToBlock[i]; + if ( t == wxEVT_ANY || t == event.GetEventType() ) + return true; // yes, it should: mark this event as processed + } + + return false; +} + #endif // wxUSE_GUI +