X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9b11752c4f9e1fd4b11ba3d184246267facb3ad3..aa8166dd51a1ee24437798653580223945c8f0df:/include/wx/event.h diff --git a/include/wx/event.h b/include/wx/event.h index c8d44ee30c..ad6469b958 100644 --- a/include/wx/event.h +++ b/include/wx/event.h @@ -126,10 +126,6 @@ extern WXDLLIMPEXP_BASE wxEventType wxNewEventType(); #define wxDECLARE_EVENT( name, type ) \ wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type ); - // Try to cast the given event handler to the correct handler type: - - #define wxEVENT_HANDLER_CAST( functype, func ) \ - ( wxObjectEventFunction )( wxEventFunction )wxStaticCastEvent( functype, &func ) #else // Define/Declare a templatized event type with the corresponding event as // a nested typedef: @@ -155,13 +151,13 @@ extern WXDLLIMPEXP_BASE wxEventType wxNewEventType(); #define wxDECLARE_EVENT( name, type ) \ wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type ); - // Don't cast the given event handler so that wxEvtHandler::Connect() sees - // the actual type: - - #define wxEVENT_HANDLER_CAST( functype, func ) \ - ( &func ) #endif +// Try to cast the given event handler to the correct handler type: + +#define wxEVENT_HANDLER_CAST( functype, func ) \ + ( wxObjectEventFunction )( wxEventFunction )wxStaticCastEvent( functype, &func ) + // Template which associates the correct event object with the event type #if !wxEVENTS_COMPATIBILITY_2_8 @@ -237,12 +233,7 @@ public: m_method = method; } - virtual void operator()(wxEvtHandler *handler, wxEvent& event) - { - wxEvtHandler * const realHandler = m_handler ? m_handler : handler; - - (realHandler->*m_method)(event); - } + virtual void operator()(wxEvtHandler *handler, wxEvent& event); virtual bool Matches(const wxEventFunctor& func) const { @@ -397,7 +388,7 @@ class wxEventFunctorMethod < Class, EventArg, - wxConvertibleTo::value + wxConvertibleTo::value != 0 > { private: @@ -772,7 +763,7 @@ enum wxEventPropagation }; // The different categories for a wxEvent; see wxEvent::GetEventCategory. -// NOTE: they are used as OR-combinable flags by wxApp::Yield +// NOTE: they are used as OR-combinable flags by wxEventLoopBase::YieldFor enum wxEventCategory { // this is the category for those events which are generated to update @@ -802,10 +793,10 @@ enum wxEventCategory // implementation only - // used in the implementations of DoYield() + // used in the implementations of wxEventLoopBase::YieldFor wxEVT_CATEGORY_UNKNOWN = 32, - // a special category used as an argument to wxApp::Yield() to indicate that + // a special category used as an argument to wxEventLoopBase::YieldFor to indicate that // Yield() should leave all wxEvents on the queue while emptying the native event queue // (native events will be processed but the wxEvents they generate will be queued) wxEVT_CATEGORY_CLIPBOARD = 64, @@ -817,7 +808,7 @@ enum wxEventCategory // events of the native toolkit and which typically are not-"delayable". wxEVT_CATEGORY_NATIVE_EVENTS = wxEVT_CATEGORY_UI|wxEVT_CATEGORY_USER_INPUT, - // used in wxApp::Yield to specify all event categories should be processed: + // used in wxEventLoopBase::YieldFor to specify all event categories should be processed: wxEVT_CATEGORY_ALL = wxEVT_CATEGORY_UI|wxEVT_CATEGORY_USER_INPUT|wxEVT_CATEGORY_SOCKET| \ wxEVT_CATEGORY_TIMER|wxEVT_CATEGORY_THREAD @@ -864,7 +855,7 @@ public: // for them wouldn't work (it needs to do a copy of the event) virtual wxEvent *Clone() const = 0; - // this function is used to selectively process events in wxApp::YieldFor + // this function is used to selectively process events in wxEventLoopBase::YieldFor // NOTE: by default it returns wxEVT_CATEGORY_UI just because the major // part of wxWidgets events belong to that category. virtual wxEventCategory GetEventCategory() const @@ -963,7 +954,7 @@ private: wxEvent& m_event; int m_propagationLevelOld; - DECLARE_NO_COPY_CLASS(wxPropagationDisabler) + wxDECLARE_NO_COPY_CLASS(wxPropagationDisabler); }; /* @@ -988,7 +979,7 @@ public: private: wxEvent& m_event; - DECLARE_NO_COPY_CLASS(wxPropagateOnce) + wxDECLARE_NO_COPY_CLASS(wxPropagateOnce); }; @@ -1110,6 +1101,14 @@ public: : wxCommandEvent(eventType, id) { } + wxThreadEvent(const wxThreadEvent& event) + : wxCommandEvent(event) + { + // make sure our string member (which uses COW, aka refcounting) is not + // shared by other wxString instances: + SetString(GetString().c_str()); + } + virtual wxEvent *Clone() const { wxThreadEvent* ev = new wxThreadEvent(*this); @@ -1120,7 +1119,7 @@ public: return ev; } - // this is important to avoid that calling wxApp::Yield() thread events + // this is important to avoid that calling wxEventLoopBase::YieldFor thread events // gets processed when this is unwanted: virtual wxEventCategory GetEventCategory() const { return wxEVT_CATEGORY_THREAD; } @@ -1524,7 +1523,6 @@ public: m_keyCode = evt.m_keyCode; - m_scanCode = evt.m_scanCode; m_rawCode = evt.m_rawCode; m_rawFlags = evt.m_rawFlags; #if wxUSE_UNICODE @@ -1539,9 +1537,6 @@ public: long m_keyCode; - // FIXME: what is this for? relation to m_rawXXX? - bool m_scanCode; - #if wxUSE_UNICODE // This contains the full Unicode character // in a character events in Unicode mode @@ -2429,7 +2424,7 @@ public: virtual wxEvent *Clone() const { return new wxNavigationKeyEvent(*this); } - enum + enum wxNavigationKeyEventFlags { IsBackward = 0x0000, IsForward = 0x0001, @@ -2723,7 +2718,7 @@ struct WXDLLIMPEXP_BASE wxEventTableEntryBase wxObject* m_callbackUserData; private: - DECLARE_NO_ASSIGN_CLASS(wxEventTableEntryBase) + wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntryBase); }; // an entry from a static event table @@ -2744,7 +2739,7 @@ struct WXDLLIMPEXP_BASE wxEventTableEntry : public wxEventTableEntryBase const int& m_eventType; private: - DECLARE_NO_ASSIGN_CLASS(wxEventTableEntry) + wxDECLARE_NO_ASSIGN_CLASS(wxEventTableEntry); }; // an entry used in dynamic event table managed by wxEvtHandler::Connect() @@ -2762,7 +2757,7 @@ struct WXDLLIMPEXP_BASE wxDynamicEventTableEntry : public wxEventTableEntryBase int m_eventType; private: - DECLARE_NO_ASSIGN_CLASS(wxDynamicEventTableEntry) + wxDECLARE_NO_ASSIGN_CLASS(wxDynamicEventTableEntry); }; // ---------------------------------------------------------------------------- @@ -2835,7 +2830,7 @@ protected: wxEventHashTable* m_previous; wxEventHashTable* m_next; - DECLARE_NO_COPY_CLASS(wxEventHashTable) + wxDECLARE_NO_COPY_CLASS(wxEventHashTable); }; // ---------------------------------------------------------------------------- @@ -2978,121 +2973,44 @@ public: { return Disconnect(wxID_ANY, eventType, func, userData, eventSink); } #if !wxEVENTS_COMPATIBILITY_2_8 - // Event handling in functions (including generalized functors): - - template - void Connect(int winid, - int lastId, - const EventTag& eventType, - Functor func) - { - DoConnect(winid, lastId, eventType, - wxNewEventFunctor(eventType, func)); - } - - template - void Connect(int winid, const EventTag& eventType, Functor func) - { Connect(winid, wxID_ANY, eventType, func); } - - template - void Connect(const EventTag& eventType, Functor func) - { Connect(wxID_ANY, eventType, func); } - - - template - bool Disconnect(int winid, - int lastId, - const EventTag& eventType, - Functor func) - { - return DoDisconnect(winid, lastId, eventType, - wxMakeEventFunctor(eventType, func)); - } - - template - bool Disconnect(int winid, const EventTag& eventType, Functor func) - { return Disconnect(winid, wxID_ANY, eventType, func); } - + // Bind arbitrary functor (including just a function) to an event: template - bool Disconnect(const EventTag& eventType, Functor func) - { return Disconnect(wxID_ANY, eventType, func); } - - - - // Event handling in class methods: the object handling the event (i.e. - // this object itself by default or eventSink if specified) must be - // convertible to this class. - // - // Notice that we need to have separate overloads for the versions with and - // without eventSink because in the latter case we must check that this - // object itself derives from Class while in the former this is not - // necessarily true - - // Methods connecting/disconnecting event to this object itself - - template - void Connect(int winid, - int lastId, - const EventTag& eventType, - void (Class::*func)(EventArg&), - wxObject *userData = NULL) + void Bind(const EventTag& eventType, + Functor func, + int winid = wxID_ANY, + int lastId = wxID_ANY, + wxObject *userData = NULL) { DoConnect(winid, lastId, eventType, - wxNewEventFunctor(eventType, func, static_cast(this)), + wxNewEventFunctor(eventType, func), userData); } - template - void Connect(int winid, - const EventTag& eventType, - void (Class::*func)(EventArg&), - wxObject *userData = NULL) - { Connect(winid, wxID_ANY, eventType, func, userData); } - - template - void Connect(const EventTag& eventType, - void (Class::*func)(EventArg&), - wxObject *userData = NULL) - { Connect(wxID_ANY, eventType, func, userData); } - - template - bool Disconnect(int winid, - int lastId, - const EventTag& eventType, - void (Class::*func)(EventArg&), - wxObject *userData = NULL) + template + bool Unbind(const EventTag& eventType, + Functor func, + int winid = wxID_ANY, + int lastId = wxID_ANY, + wxObject *userData = NULL) { return DoDisconnect(winid, lastId, eventType, - wxMakeEventFunctor(eventType, func, - static_cast(this)), + wxMakeEventFunctor(eventType, func), userData); } - template - bool Disconnect(int winid, - const EventTag& eventType, - void (Class::*func)(EventArg&), - wxObject *userData = NULL) - { return Disconnect(winid, wxID_ANY, eventType, func, userData); } - - template - bool Disconnect(const EventTag& eventType, - void (Class::*func)(EventArg&), - wxObject *userData = NULL) - { return Disconnect(wxID_ANY, eventType, func, userData); } - - // Methods connecting/disconnecting event to another object + // Bind a method of a class (called on the specified eventSink which must + // be convertible to this class) object to an event: template - void Connect(int winid, - int lastId, - const EventTag& eventType, - void (Class::*func)(EventArg&), - wxObject *userData, - ObjClass *eventSink) + void Bind(const EventTag &eventType, + void (Class::*func)(EventArg &), + ObjClass *eventSink, + int winid = wxID_ANY, + int lastId = wxID_ANY, + wxObject *userData = NULL) { DoConnect(winid, lastId, eventType, wxNewEventFunctor(eventType, func, eventSink), @@ -3101,136 +3019,19 @@ public: template - void Connect(int winid, - const EventTag& eventType, - void (Class::*func)(EventArg&), - wxObject *userData, - ObjClass *eventSink) - { Connect(winid, wxID_ANY, eventType, func, userData, eventSink); } - - template - - void Connect(const EventTag& eventType, - void (Class::*func)(EventArg&), - wxObject *userData, - ObjClass *eventSink) - { Connect(wxID_ANY, eventType, func, userData, eventSink); } - - - template - - bool Disconnect(int winid, - int lastId, - const EventTag& eventType, - void (Class::*func)(EventArg&), - wxObject *userData, - ObjClass *eventSink) + bool Unbind(const EventTag &eventType, + void (Class::*func)(EventArg&), + ObjClass *eventSink, + int winid = wxID_ANY, + int lastId = wxID_ANY, + wxObject *userData = NULL ) { return DoDisconnect(winid, lastId, eventType, wxMakeEventFunctor(eventType, func, eventSink), userData); } - - template - - bool Disconnect(int winid, - const EventTag& eventType, - void (Class::*func)(EventArg&), - wxObject *userData, - ObjClass *eventSink) - { return Disconnect(winid, wxID_ANY, eventType, func, - userData, eventSink); } - - template - - bool Disconnect(const EventTag& eventType, - void (Class::*func)(EventArg&), - wxObject *userData, - ObjClass *eventSink) - { return Disconnect(wxID_ANY, eventType, func, userData, eventSink); } - - - - // Static version of Connect() which allows to specify the event source and - // event handler in a more symmetric way - template - static void Connect(ObjSource *eventSrc, - int winid, - int lastId, - const EventTag& eventType, - void (Class::*func)(EventArg&), - wxObject *userData = NULL, - ObjClass *eventSink = NULL) - { - eventSrc->Connect(winid, lastId, eventType, func, userData, eventSink); - } - - template - static void Connect(ObjSource *eventSrc, - int winid, - const EventTag& eventType, - void (Class::*func)(EventArg&), - wxObject *userData = NULL, - ObjClass *eventSink = NULL) - { - Connect(eventSrc, winid, wxID_ANY, eventType, func, userData, eventSink); - } - - template - static void Connect(ObjSource *eventSrc, - const EventTag& eventType, - void (Class::*func)(EventArg&), - wxObject *userData = NULL, - ObjClass *eventSink = NULL) - { - Connect(eventSrc, wxID_ANY, eventType, func, userData, eventSink); - } - - - template - static bool Disconnect(ObjSource *eventSrc, - int winid, - int lastId, - const EventTag& eventType, - void (Class::*func)(EventArg&), - wxObject *userData = NULL, - ObjClass *eventSink = NULL) - { - return eventSrc->Disconnect(winid, lastId, eventType, func, - userData, eventSink); - } - - template - static bool Disconnect(ObjSource *eventSrc, - int winid, - const EventTag& eventType, - void (Class::*func)(EventArg&), - wxObject *userData = NULL, - ObjClass *eventSink = NULL) - { - return Disconnect(eventSrc, winid, wxID_ANY, eventType, func, - userData, eventSink); - } - - template - static bool Disconnect(ObjSource *eventSrc, - const EventTag& eventType, - void (Class::*func)(EventArg&), - wxObject *userData = NULL, - ObjClass *eventSink = NULL) - { - return Disconnect(eventSrc, wxID_ANY, eventType, func, - userData, eventSink); - } #endif // !wxEVENTS_COMPATIBILITY_2_8 - wxList* GetDynamicEventTable() const { return m_dynamicEvents ; } // User data can be associated with each wxEvtHandler @@ -3266,7 +3067,7 @@ public: // // It is meant to be called from ProcessEvent() only and is not virtual, // additional event handlers can be hooked into the normal event processing - // logic using TryValidator() hook. + // logic using TryBefore() and TryAfter() hooks. bool ProcessEventHere(wxEvent& event); @@ -3289,21 +3090,25 @@ protected: // hooks for wxWindow used by ProcessEvent() // ----------------------------------------- - // This one is called before trying our own event table to allow plugging - // in the validators. - // - // NB: This method is intentionally *not* inside wxUSE_VALIDATORS! - // It is part of wxBase which doesn't use validators and the code - // is compiled out when building wxBase w/o GUI classes, which affects - // binary compatibility and wxBase library can't be used by GUI - // ports. - virtual bool TryValidator(wxEvent& WXUNUSED(event)) { return false; } + // this one is called before trying our own event table to allow plugging + // in the event handlers overriding the default logic, this is used by e.g. + // validators. + virtual bool TryBefore(wxEvent& event); // this one is called after failing to find the event handle in our own // table to give a chance to the other windows to process it // // base class implementation passes the event to wxTheApp - virtual bool TryParent(wxEvent& event); + virtual bool TryAfter(wxEvent& event); + +#ifdef WXWIN_COMPATIBILITY_2_8 + // deprecated method: override TryBefore() instead of this one + wxDEPRECATED_BUT_USED_INTERNALLY_INLINE( + virtual bool TryValidator(wxEvent& WXUNUSED(event)), return false; ) + + wxDEPRECATED_BUT_USED_INTERNALLY_INLINE( + virtual bool TryParent(wxEvent& event), return DoTryApp(event); ) +#endif // WXWIN_COMPATIBILITY_2_8 static const wxEventTable sm_eventTable; @@ -3351,10 +3156,13 @@ protected: wxEventConnectionRef *FindRefInTrackerList(wxEvtHandler *eventSink); private: + // pass the event to wxTheApp instance, called from TryAfter() + bool DoTryApp(wxEvent& event); + DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler) }; -WX_DEFINE_EXPORTED_ARRAY_PTR(wxEvtHandler*, wxEvtHandlerArray); +WX_DEFINE_ARRAY_WITH_DECL_PTR(wxEvtHandler *, wxEvtHandlerArray, class WXDLLIMPEXP_BASE); // ---------------------------------------------------------------------------- // wxEventConnectionRef represents all connections between two event handlers @@ -3402,9 +3210,16 @@ private: friend class wxEvtHandler; - DECLARE_NO_ASSIGN_CLASS(wxEventConnectionRef) + wxDECLARE_NO_ASSIGN_CLASS(wxEventConnectionRef); }; +inline void wxObjectEventFunctor::operator()(wxEvtHandler *handler, wxEvent& event) +{ + wxEvtHandler * const realHandler = m_handler ? m_handler : handler; + + (realHandler->*m_method)(event); +} + // Post a message to the given event handler which will be processed during the // next event loop iteration. // @@ -3457,7 +3272,7 @@ protected: wxArrayInt m_eventsToBlock; wxWindow *m_window; - DECLARE_NO_COPY_CLASS(wxEventBlocker) + wxDECLARE_NO_COPY_CLASS(wxEventBlocker); }; typedef void (wxEvtHandler::*wxCommandEventFunction)(wxCommandEvent&); @@ -3986,26 +3801,43 @@ typedef void (wxEvtHandler::*wxClipboardTextEventFunction)(wxClipboardTextEvent& #define EVT_THREAD(id, func) wx__DECLARE_EVT1(wxEVT_COMMAND_THREAD, id, wxThreadEventHandler(func)) // ---------------------------------------------------------------------------- -// Global data +// Helper functions // ---------------------------------------------------------------------------- -// list containing event handlers with pending events for them +// This is an ugly hack to allow the use of Bind() instead of Connect() inside +// the library code if the library was built with support for it, here is how +// it is used: // -// notice that each event handler should occur at most once in this list -extern WXDLLIMPEXP_BASE wxList *wxHandlersWithPendingEvents; -extern WXDLLIMPEXP_BASE wxList *wxHandlersWithPendingDelayedEvents; -#if wxUSE_THREADS - // this critical section protectes both the lists above - extern WXDLLIMPEXP_BASE wxCriticalSection *wxHandlersWithPendingEventsLocker; -#endif - -// old list names: -#define wxPendingEvents wxHandlersWithPendingEvents -#define wxPendingEventsLocker wxHandlersWithPendingEventsLocker - -// ---------------------------------------------------------------------------- -// Helper functions -// ---------------------------------------------------------------------------- +// class SomeEventHandlingClass : wxBIND_OR_CONNECT_HACK_BASE_CLASS +// public SomeBaseClass +// { +// public: +// SomeEventHandlingClass(wxWindow *win) +// { +// // connect to the event for the given window +// wxBIND_OR_CONNECT_HACK(win, wxEVT_SOMETHING, wxSomeEventHandler, +// SomeEventHandlingClass::OnSomeEvent, this); +// } +// +// private: +// void OnSomeEvent(wxSomeEvent&) { ... } +// }; +// +// This is *not* meant to be used by library users, it is only defined here +// (and not in a private header) because the base class must be visible from +// other public headers, please do NOT use this in your code, it will be +// removed from future wx versions without warning. +#if wxEVENTS_COMPATIBILITY_2_8 + #define wxBIND_OR_CONNECT_HACK_BASE_CLASS public wxEvtHandler, + #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS : public wxEvtHandler + #define wxBIND_OR_CONNECT_HACK(w, evt, handler, func, obj) \ + win->Connect(evt, handler(func), NULL, obj) +#else // wxEVENTS_COMPATIBILITY_2_8 + #define wxBIND_OR_CONNECT_HACK_BASE_CLASS + #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS + #define wxBIND_OR_CONNECT_HACK(w, evt, handler, func, obj) \ + win->Bind(evt, &func, obj) +#endif // wxEVENTS_COMPATIBILITY_2_8/!wxEVENTS_COMPATIBILITY_2_8 #if wxUSE_GUI