X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3c99e2fd1b3432974b892be508c0757da5b6ad49..08c1613f889a3239c6392b4828c07dd4a00bac22:/interface/wx/event.h diff --git a/interface/wx/event.h b/interface/wx/event.h index 021e0da342..9ac341c576 100644 --- a/interface/wx/event.h +++ b/interface/wx/event.h @@ -333,9 +333,9 @@ public: @library{wxbase} @category{events} - @see @ref overview_events_processing + @see @ref overview_events_processing, wxEventBlocker, wxEventLoopBase */ -class wxEvtHandler : public wxObject +class wxEvtHandler : public wxObject, public wxTrackable { public: /** @@ -453,22 +453,29 @@ public: (such as a new control) where you define new event types, as opposed to allowing the user to override virtual functions. - An instance where you might actually override the ProcessEvent() function is where - you want to direct event processing to event handlers not normally noticed by - wxWidgets. For example, in the document/view architecture, documents and views - are potential event handlers. When an event reaches a frame, ProcessEvent() will - need to be called on the associated document and view in case event handler functions - are associated with these objects. The property classes library (wxProperty) also - overrides ProcessEvent() for similar reasons. + Notice that you don't usually need to override ProcessEvent() to + customize the event handling, overriding the specially provided + TryBefore() and TryAfter() functions is usually enough. For example, + wxMDIParentFrame may override TryBefore() to ensure that the menu + events are processed in the active child frame before being processed + in the parent frame itself. The normal order of event table searching is as follows: + -# wxApp::FilterEvent() is called. If it returns anything but @c -1 + (default) the processing stops here. -# If the object is disabled (via a call to wxEvtHandler::SetEvtHandlerEnabled) - the function skips to step (6). - -# If the object is a wxWindow, ProcessEvent() is recursively called on the - window's wxValidator. If this returns @true, the function exits. - -# SearchEventTable() is called for this event handler. If this fails, the base - class table is tried, and so on until no more tables exist or an appropriate - function was found, in which case the function exits. + the function skips to step (7). + -# TryBefore() is called (this is where wxValidator are taken into + account for wxWindow objects). If this returns @true, the function exits. + -# Dynamic event table of the handlers binded using Bind<>() is + searched. If a handler is found, it is executed and the function + returns @true unless the handler used wxEvent::Skip() to indicate + that it didn't handle the event in which case the search continues. + -# Static events table of the handlers binded using event table + macros is searched for this event handler. If this fails, the base + class event table table is tried, and so on until no more tables + exist or an appropriate function was found. If a handler is found, + the same logic as in the previous step applies. -# The search is applied down the entire chain of event handlers (usually the chain has a length of one). This chain can be formed using wxEvtHandler::SetNextHandler(): @image html overview_events_chain.png @@ -477,21 +484,41 @@ public: Note that in the case of wxWindow you can build a stack of event handlers (see wxWindow::PushEventHandler() for more info). If any of the handlers of the chain return @true, the function exits. - -# If the object is a wxWindow and the event is a wxCommandEvent, ProcessEvent() - is recursively applied to the parent window's event handler. - If this returns @true, the function exits. - -# Finally, ProcessEvent() is called on the wxApp object. + -# TryAfter() is called: for the wxWindow object this may propagate the + event to the window parent (recursively). If the event is still not + processed, ProcessEvent() on wxTheApp object is called as the last + step. + + Notice that steps (2)-(6) are performed in ProcessEventHere() which is + called by this function. @param event Event to process. - - @return @true if a suitable event handler function was found and - executed, and the function did not call wxEvent::Skip. + @return + @true if a suitable event handler function was found and executed, + and the function did not call wxEvent::Skip. @see SearchEventTable() */ virtual bool ProcessEvent(wxEvent& event); + /** + Try to process the event in this event handler. + + This method is called from ProcessEvent(), please see the detailed + description of the event processing logic there. + + It is @em not virtual and so may not be overridden but it does call + virtual TryBefore() which may be overridden. + + @param event + Event to process. + @return + @true if this object itself defines a handler for this event and + the handler didn't skip the event. + */ + bool ProcessEventHere(wxEvent& event); + /** Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process. @@ -507,6 +534,31 @@ public: */ bool SafelyProcessEvent(wxEvent& event); + /** + Processes the pending events previously queued using QueueEvent() or + AddPendingEvent(); you must call this function only if you are sure + there are pending events for this handler, otherwise a @c wxCHECK + will fail. + + The real processing still happens in ProcessEvent() which is called by this + function. + + Note that this function needs a valid application object (see + wxAppConsole::GetInstance()) because wxApp holds the list of the event + handlers with pending events and this function manipulates that list. + */ + void ProcessPendingEvents(); + + /** + Deletes all events queued on this event handler using QueueEvent() or + AddPendingEvent(). + + Use with care because the events which are deleted are (obviously) not + processed and this may have unwanted consequences (e.g. user actions events + will be lost). + */ + void DeletePendingEvents(); + /** Searches the event table, executing an event handler function if an appropriate one is found. @@ -529,6 +581,9 @@ public: If a suitable function is called but calls wxEvent::Skip, this function will fail, and searching will continue. + @todo this function in the header is listed as an "implementation only" function; + are we sure we want to document it? + @see ProcessEvent() */ virtual bool SearchEventTable(wxEventTable& table, @@ -546,6 +601,11 @@ public: Connects the given function dynamically with the event handler, id and event type. + Notice that Bind() provides a more flexible and safer way to do the + same thing as Connect(), please use it in any new code -- while + Connect() is not formally deprecated due to its existing widespread + usage, it has no advantages compared to Bind(). + This is an alternative to the use of static event tables. It is more flexible as it allows to connect events generated by some object to an event handler defined in a different object of a different class (which @@ -554,7 +614,7 @@ public: Do make sure to specify the correct @a eventSink when connecting to an event of a different object. - See @ref overview_events_connect for more detailed explanation + See @ref overview_events_bind for more detailed explanation of this function and the @ref page_samples_event sample for usage examples. @@ -584,6 +644,8 @@ public: Object whose member function should be called. It must be specified when connecting an event generated by one object to a member function of a different object. If it is omitted, @c this is used. + + @see Bind<>() */ void Connect(int id, int lastId, wxEventType eventType, wxObjectEventFunction function, @@ -669,6 +731,143 @@ public: //@} + /** + @name Binding and Unbinding + */ + //@{ + + /** + Binds the given function, functor or method dynamically with the event. + + This offers basically the same functionality as Connect(), but it is + more flexible as it also allows you to use ordinary functions and + arbitrary functors as event handlers. It is also less restrictive then + Connect() because you can use an arbitrary method as an event handler, + where as Connect() requires a wxEvtHandler derived handler. + + See @ref overview_events_bind for more detailed explanation + of this function and the @ref page_samples_event sample for usage + examples. + + @param eventType + The event type to be associated with this event handler. + @param functor + The event handler functor. This can be an ordinary function but also + an arbitrary functor like boost::function<>. + @param id + The first ID of the identifier range to be associated with the event + handler. + @param lastId + The last ID of the identifier range to be associated with the event + handler. + @param userData + Data to be associated with the event table entry. + + @since 2.9.0 + */ + template + void Bind(const EventTag& eventType, + Functor functor, + int id = wxID_ANY, + int lastId = wxID_ANY, + wxObject *userData = NULL); + + /** + See the Bind<>(const EventTag&, Functor, int, int, wxObject*) overload for + more info. + + This overload will bind the given method as the event handler. + + @param eventType + The event type to be associated with this event handler. + @param method + The event handler method. This can be an arbitrary method (doesn't need + to be from a wxEvtHandler derived class). + @param handler + Object whose method should be called. It must always be specified + so it can be checked at compile time whether the given method is an + actual member of the given handler. + @param id + The first ID of the identifier range to be associated with the event + handler. + @param lastId + The last ID of the identifier range to be associated with the event + handler. + @param userData + Data to be associated with the event table entry. + + @since 2.9.0 + */ + template + void Bind(const EventTag &eventType, + void (Class::*method)(EventArg &), + EventHandler *handler, + int id = wxID_ANY, + int lastId = wxID_ANY, + wxObject *userData = NULL); + /** + Unbinds the given function, functor or method dynamically from the + event handler, using the specified parameters as search criteria and + returning @true if a matching function has been found and removed. + + This method can only unbind functions, functors or methods which have + been added using the Bind<>() method. There is no way to unbind + functions binded using the (static) event tables. + + @param eventType + The event type associated with this event handler. + @param functor + The event handler functor. This can be an ordinary function but also + an arbitrary functor like boost::function<>. + @param id + The first ID of the identifier range associated with the event + handler. + @param lastId + The last ID of the identifier range associated with the event + handler. + @param userData + Data associated with the event table entry. + + @since 2.9.0 + */ + template + bool Unbind(const EventTag& eventType, + Functor functor, + int id = wxID_ANY, + int lastId = wxID_ANY, + wxObject *userData = NULL); + + /** + See the Unbind<>(const EventTag&, Functor, int, int, wxObject*) + overload for more info. + + This overload unbinds the given method from the event.. + + @param eventType + The event type associated with this event handler. + @param method + The event handler method associated with this event. + @param handler + Object whose method was called. + @param id + The first ID of the identifier range associated with the event + handler. + @param lastId + The last ID of the identifier range associated with the event + handler. + @param userData + Data associated with the event table entry. + + @since 2.9.0 + */ + template + bool Unbind(const EventTag &eventType, + void (Class::*method)(EventArg&), + EventHandler *handler, + int id = wxID_ANY, + int lastId = wxID_ANY, + wxObject *userData = NULL ); + //@} /** @name User-supplied data */ @@ -821,6 +1020,96 @@ public: bool IsUnlinked() const; //@} + +protected: + /** + Method called by ProcessEvent() before examining this object event + tables. + + This method can be overridden to hook into the event processing logic + as early as possible. You should usually call the base class version + when overriding this method, even if wxEvtHandler itself does nothing + here, some derived classes do use this method, e.g. wxWindow implements + support for wxValidator in it. + + Example: + @code + class MyClass : public BaseClass // inheriting from wxEvtHandler + { + ... + protected: + virtual bool TryBefore(wxEvent& event) + { + if ( MyPreProcess(event) ) + return true; + + return BaseClass::TryBefore(event); + } + }; + @endcode + + @see ProcessEvent(), ProcessEventHere() + */ + virtual bool TryBefore(wxEvent& event); + + /** + Method called by ProcessEvent() as last resort. + + This method can be overridden to implement post-processing for the + events which were not processed anywhere else. + + The base class version handles forwarding the unprocessed events to + wxApp at wxEvtHandler level and propagating them upwards the window + child-parent chain at wxWindow level and so should usually be called + when overriding this method: + @code + class MyClass : public BaseClass // inheriting from wxEvtHandler + { + ... + protected: + virtual bool TryAfter(wxEvent& event) + { + if ( BaseClass::TryAfter(event) ) + return true; + + return MyPostProcess(event); + } + }; + @endcode + + @see ProcessEvent(), ProcessEventHere() + */ + virtual bool TryAfter(wxEvent& event); +}; + + +/** + Flags for categories of keys. + + These values are used by wxKeyEvent::IsKeyInCategory(). They may be + combined via the bitwise operators |, &, and ~. + + @since 2.9.1 +*/ +enum wxKeyCategoryFlags +{ + /// arrow keys, on and off numeric keypads + WXK_CATEGORY_ARROW, + + /// page up and page down keys, on and off numeric keypads + WXK_CATEGORY_PAGING, + + /// home and end keys, on and off numeric keypads + WXK_CATEGORY_JUMP, + + /// tab key, on and off numeric keypads + WXK_CATEGORY_TAB, + + /// backspace and delete keys, on and off numeric keypads + WXK_CATEGORY_CUT, + + /// union of WXK_CATEGORY_ARROW, WXK_CATEGORY_PAGING, and WXK_CATEGORY_JUMP categories + WXK_CATEGORY_NAVIGATION }; @@ -918,6 +1207,16 @@ public: */ int GetKeyCode() const; + /** + Returns true if the key is in the given key category. + + @param category + A bitwise combination of named ::wxKeyCategoryFlags constants. + + @since 2.9.1 + */ + bool IsKeyInCategory(int category) const; + //@{ /** Obtains the position (in client coordinates) at which the key was pressed. @@ -1614,14 +1913,16 @@ public: left the window and the state variables for it may have changed during this time. @note Note the difference between methods like wxMouseEvent::LeftDown and - wxMouseEvent::LeftIsDown: the former returns @true when the event corresponds - to the left mouse button click while the latter returns @true if the left - mouse button is currently being pressed. For example, when the user is dragging - the mouse you can use wxMouseEvent::LeftIsDown to test whether the left mouse - button is (still) depressed. Also, by convention, if wxMouseEvent::LeftDown - returns @true, wxMouseEvent::LeftIsDown will also return @true in wxWidgets - whatever the underlying GUI behaviour is (which is platform-dependent). - The same applies, of course, to other mouse buttons as well. + the inherited wxMouseState::LeftIsDown: the former returns @true when + the event corresponds to the left mouse button click while the latter + returns @true if the left mouse button is currently being pressed. + For example, when the user is dragging the mouse you can use + wxMouseEvent::LeftIsDown to test whether the left mouse button is + (still) depressed. Also, by convention, if wxMouseEvent::LeftDown + returns @true, wxMouseEvent::LeftIsDown will also return @true in + wxWidgets whatever the underlying GUI behaviour is (which is + platform-dependent). The same applies, of course, to other mouse + buttons as well. @beginEventTable{wxMouseEvent} @@ -1713,12 +2014,6 @@ public: */ bool Aux1Down() const; - /** - Returns @true if the first extra button mouse button is currently down, - independent of the current event type. - */ - bool Aux1IsDown() const; - /** Returns @true if the first extra button mouse button changed to up. */ @@ -1734,52 +2029,38 @@ public: */ bool Aux2Down() const; - /** - Returns @true if the second extra button mouse button is currently down, - independent of the current event type. - */ - bool Aux2IsDown() const; - /** Returns @true if the second extra button mouse button changed to up. */ bool Aux2Up() const; /** - Returns @true if the identified mouse button is changing state. - Valid values of @a button are: + Returns @true if the event was generated by the specified button. - @li @c wxMOUSE_BTN_LEFT: check if left button was pressed - @li @c wxMOUSE_BTN_MIDDLE: check if middle button was pressed - @li @c wxMOUSE_BTN_RIGHT: check if right button was pressed - @li @c wxMOUSE_BTN_AUX1: check if the first extra button was pressed - @li @c wxMOUSE_BTN_AUX2: check if the second extra button was pressed - @li @c wxMOUSE_BTN_ANY: check if any button was pressed - - @todo introduce wxMouseButton enum + @see wxMouseState::ButtoinIsDown() */ - bool Button(int button) const; + bool Button(wxMouseButton but) const; /** If the argument is omitted, this returns @true if the event was a mouse double click event. Otherwise the argument specifies which double click event was generated (see Button() for the possible values). */ - bool ButtonDClick(int but = wxMOUSE_BTN_ANY) const; + bool ButtonDClick(wxMouseButton but = wxMOUSE_BTN_ANY) const; /** If the argument is omitted, this returns @true if the event was a mouse button down event. Otherwise the argument specifies which button-down event was generated (see Button() for the possible values). */ - bool ButtonDown(int = wxMOUSE_BTN_ANY) const; + bool ButtonDown(wxMouseButton but = wxMOUSE_BTN_ANY) const; /** If the argument is omitted, this returns @true if the event was a mouse button up event. Otherwise the argument specifies which button-up event was generated (see Button() for the possible values). */ - bool ButtonUp(int = wxMOUSE_BTN_ANY) const; + bool ButtonUp(wxMouseButton but = wxMOUSE_BTN_ANY) const; /** Returns @true if this was a dragging event (motion while a button is depressed). @@ -1829,20 +2110,6 @@ public: */ wxPoint GetLogicalPosition(const wxDC& dc) const; - //@{ - /** - Sets *x and *y to the position at which the event occurred. - Returns the physical mouse position in pixels. - - Note that if the mouse event has been artificially generated from a special - keyboard combination (e.g. under Windows when the "menu" key is pressed), the - returned position is ::wxDefaultPosition. - */ - wxPoint GetPosition() const; - void GetPosition(wxCoord* x, wxCoord* y) const; - void GetPosition(long* x, long* y) const; - //@} - /** Get wheel delta, normally 120. @@ -1871,16 +2138,6 @@ public: */ int GetWheelAxis() const; - /** - Returns X coordinate of the physical mouse event position. - */ - wxCoord GetX() const; - - /** - Returns Y coordinate of the physical mouse event position. - */ - wxCoord GetY() const; - /** Returns @true if the event was a mouse button event (not necessarily a button down event - that may be tested using ButtonDown()). @@ -1910,21 +2167,6 @@ public: */ bool LeftDown() const; - /** - Returns @true if the left mouse button is currently down, independent - of the current event type. - - Please notice that it is not the same as LeftDown() which returns @true if the - event was generated by the left mouse button being pressed. Rather, it simply - describes the state of the left mouse button at the time when the event was - generated (so while it will be @true for a left click event, it can also be @true - for a right click if it happened while the left mouse button was pressed). - - This event is usually used in the mouse event handlers which process "move - mouse" messages to determine whether the user is (still) dragging the mouse. - */ - bool LeftIsDown() const; - /** Returns @true if the left mouse button changed to up. */ @@ -1945,12 +2187,6 @@ public: */ bool MiddleDown() const; - /** - Returns @true if the middle mouse button is currently down, independent - of the current event type. - */ - bool MiddleIsDown() const; - /** Returns @true if the middle mouse button changed to up. */ @@ -1973,12 +2209,6 @@ public: */ bool RightDown() const; - /** - Returns @true if the right mouse button is currently down, independent - of the current event type. - */ - bool RightIsDown() const; - /** Returns @true if the right mouse button changed to up. */ @@ -3564,6 +3794,14 @@ wxEventType wxNewEventType(); The class @a cls must be the wxEvent-derived class associated with the events of this type and its full declaration must be visible from the point of use of this macro. + + For example: + @code + wxDECLARE_EVENT(MY_COMMAND_EVENT, wxCommandEvent); + + class MyCustomEvent : public wxEvent { ... }; + wxDECLARE_EVENT(MY_CUSTOM_EVENT, MyCustomEvent); + @endcode */ #define wxDECLARE_EVENT(name, cls) \ wxDECLARE_EXPORTED_EVENT(wxEMPTY_PARAMETER_VALUE, name, cls) @@ -3596,9 +3834,8 @@ wxEventType wxNewEventType(); */ #define wxEVENT_HANDLER_CAST(functype, func) (&func) -//@{ /** - These macros are used to define event table macros for handling custom + This macro is used to define event table macros for handling custom events. Example of use: @@ -3626,20 +3863,28 @@ wxEventType wxNewEventType(); The event type to handle. @param id The identifier of events to handle. - @param id1 - The first identifier of the range. - @param id2 - The second identifier of the range. @param fn The event handler method. */ -#define wx__DECLARE_EVT2(evt, id1, id2, fn) \ - DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL), #define wx__DECLARE_EVT1(evt, id, fn) \ wx__DECLARE_EVT2(evt, id, wxID_ANY, fn) + +/** + Generalized version of the wx__DECLARE_EVT1() macro taking a range of + IDs instead of a single one. + Argument @a id1 is the first identifier of the range, @a id2 is the + second identifier of the range. +*/ +#define wx__DECLARE_EVT2(evt, id1, id2, fn) \ + DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL), + +/** + Simplified version of the wx__DECLARE_EVT1() macro, to be used when the + event type must be handled regardless of the ID associated with the + specific event instances. +*/ #define wx__DECLARE_EVT0(evt, fn) \ wx__DECLARE_EVT1(evt, wxID_ANY, fn) -//@} /**