Extract X11 Display wrapper class in a private header.

[wxWidgets.git] / interface / wx / event.h

diff --git a/interface/wx/event.h b/interface/wx/event.h
index 8f76631f11c0a9985fe047118ea2702ca70a70b8..ce3793bd082399d36043e86c4bc4c2d4e6a411f8 100644 (file)
--- a/interface/wx/event.h
+++ b/interface/wx/event.h
@@ -4,9 +4,68 @@
 //              wxEvent-derived classes
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 //              wxEvent-derived classes
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+/**
+    The predefined constants for the number of times we propagate event
+    upwards window child-parent chain.
+*/
+enum wxEventPropagation
+{
+    /// don't propagate it at all
+    wxEVENT_PROPAGATE_NONE = 0,
+
+    /// propagate it until it is processed
+    wxEVENT_PROPAGATE_MAX = INT_MAX
+};
+
+/**
+    The different categories for a wxEvent; see wxEvent::GetEventCategory.
+
+    @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
+        the appearance of the GUI but which (usually) do not comport data
+        processing, i.e. which do not provide input or output data
+        (e.g. size events, scroll events, etc).
+        They are events NOT directly generated by the user's input devices.
+    */
+    wxEVT_CATEGORY_UI = 1,
+
+    /**
+        This category groups those events which are generated directly from the
+        user through input devices like mouse and keyboard and usually result in
+        data to be processed from the application
+        (e.g. mouse clicks, key presses, etc).
+    */
+    wxEVT_CATEGORY_USER_INPUT = 2,
+
+    /// This category is for wxSocketEvent
+    wxEVT_CATEGORY_SOCKET = 4,
+
+    /// This category is for wxTimerEvent
+    wxEVT_CATEGORY_TIMER = 8,
+
+    /**
+        This category is for any event used to send notifications from the
+        secondary threads to the main one or in general for notifications among
+        different threads (which may or may not be user-generated).
+        See e.g. wxThreadEvent.
+    */
+    wxEVT_CATEGORY_THREAD = 16,
+
+    /**
+        This mask is used in wxEventLoopBase::YieldFor to specify that 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
+};

 
 /**
     @class wxEvent
 
 /**
     @class wxEvent


@@ -17,7 +76,7 @@
     wxEvent used to be a multipurpose event object, and is an abstract base class
     for other event classes (see below).
 
     wxEvent used to be a multipurpose event object, and is an abstract base class
     for other event classes (see below).
 

-    For more information about events, see the @ref overview_eventhandling overview.
+    For more information about events, see the @ref overview_events overview.

 
     @beginWxPerlOnly
     In wxPerl custom event classes should be derived from
 
     @beginWxPerlOnly
     In wxPerl custom event classes should be derived from


@@ -87,6 +146,14 @@ public:
     */
     wxEventType GetEventType() const;
 
     */
     wxEventType GetEventType() const;
 

+    /**
+        Returns a generic category for this event.
+        wxEvent implementation returns @c wxEVT_CATEGORY_UI by default.
+
+        This function is used to selectively process events in wxEventLoopBase::YieldFor.
+    */
+    virtual wxEventCategory GetEventCategory() const;
+

     /**
         Returns the identifier associated with this event, such as a button command id.
     */
     /**
         Returns the identifier associated with this event, such as a button command id.
     */


@@ -220,7 +287,7 @@ protected:
     @library{wxcore}
     @category{events}
 
     @library{wxcore}
     @category{events}
 

-    @see @ref overview_eventhandling, wxEvtHandler
+    @see @ref overview_events_processing, wxEvtHandler

 */
 class wxEventBlocker : public wxEvtHandler
 {
 */
 class wxEventBlocker : public wxEvtHandler
 {


@@ -258,7 +325,7 @@ public:
     wxWindow is (and therefore all window classes are) derived from this class.
 
     When events are received, wxEvtHandler invokes the method listed in the
     wxWindow is (and therefore all window classes are) derived from this class.
 
     When events are received, wxEvtHandler invokes the method listed in the

-    event table using itself as the object.  When using multiple inheritance
+    event table using itself as the object. When using multiple inheritance

     <b>it is imperative that the wxEvtHandler(-derived) class is the first
     class inherited</b> such that the @c this pointer for the overall object
     will be identical to the @c this pointer of the wxEvtHandler portion.
     <b>it is imperative that the wxEvtHandler(-derived) class is the first
     class inherited</b> such that the @c this pointer for the overall object
     will be identical to the @c this pointer of the wxEvtHandler portion.


@@ -266,9 +333,9 @@ public:
     @library{wxbase}
     @category{events}
 
     @library{wxbase}
     @category{events}
 

-    @see @ref overview_eventhandling
+    @see @ref overview_events_processing, wxEventBlocker, wxEventLoopBase

 */
 */

-class wxEvtHandler : public wxObject
+class wxEvtHandler : public wxObject, public wxTrackable

 {
 public:
     /**
 {
 public:
     /**


@@ -279,8 +346,8 @@ public:
     /**
         Destructor.
 
     /**
         Destructor.
 

-        If the handler is part of a chain, the destructor will unlink itself and
-        restore the previous and next handlers so that they point to each other.
+        If the handler is part of a chain, the destructor will unlink itself
+        (see Unlink()).

     */
     virtual ~wxEvtHandler();
 
     */
     virtual ~wxEvtHandler();
 


@@ -313,7 +380,7 @@ public:
         fields of this object are used by it, notably any wxString members of
         the event object must not be shallow copies of another wxString object
         as this would result in them still using the same string buffer behind
         fields of this object are used by it, notably any wxString members of
         the event object must not be shallow copies of another wxString object
         as this would result in them still using the same string buffer behind

-        the scenes. For example
+        the scenes. For example:

         @code
             void FunctionInAWorkerThread(const wxString& str)
             {
         @code
             void FunctionInAWorkerThread(const wxString& str)
             {


@@ -326,6 +393,20 @@ public:
             }
         @endcode
 
             }
         @endcode
 

+        Note that you can use wxThreadEvent instead of wxCommandEvent
+        to avoid this problem:
+        @code
+            void FunctionInAWorkerThread(const wxString& str)
+            {
+                wxThreadEvent evt;
+                evt->SetString(str);
+
+                // wxThreadEvent::Clone() makes sure that the internal wxString
+                // member is not shared by other wxString instances:
+                wxTheApp->QueueEvent( evt.Clone() );
+            }
+        @endcode
+

         Finally notice that this method automatically wakes up the event loop
         if it is currently idle by calling ::wxWakeUpIdle() so there is no need
         to do it manually when using it.
         Finally notice that this method automatically wakes up the event loop
         if it is currently idle by calling ::wxWakeUpIdle() so there is no need
         to do it manually when using it.


@@ -372,39 +453,81 @@ public:
         (such as a new control) where you define new event types, as opposed to
         allowing the user to override virtual functions.
 
         (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:
 
         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.
+        -# TryBefore() is called (this is where wxValidator are taken into
+           account for wxWindow objects). If this returns @true, the function exits.

         -# If the object is disabled (via a call to wxEvtHandler::SetEvtHandlerEnabled)
         -# 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).
+        -# Dynamic event table of the handlers bound 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 bound 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
         -# The search is applied down the entire chain of event handlers (usually the

-            chain has a length of one). If this succeeds, 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.
+           chain has a length of one). This chain can be formed using wxEvtHandler::SetNextHandler():
+              @image html overview_events_chain.png
+           (referring to the image, if @c A->ProcessEvent is called and it doesn't handle
+            the event, @c B->ProcessEvent will be called and so on...).
+           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.
+        -# 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 ProcessEventLocally()
+        which is called by this function.

 
         @param event
             Event to process.
 
         @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);
 
 
         @see SearchEventTable()
     */
     virtual bool ProcessEvent(wxEvent& event);
 

+    /**
+        Try to process the event in this handler and all those chained to it.
+
+        As explained in ProcessEvent() documentation, the event handlers may be
+        chained in a doubly-linked list. This function tries to process the
+        event in this handler (including performing any pre-processing done in
+        TryBefore(), e.g. applying validators) and all those following it in
+        the chain until the event is processed or the chain is exhausted.
+
+        This function is called from ProcessEvent() and, in turn, calls
+        TryThis() for each handler in turn. It is not virtual and so cannot be
+        overridden but can, and should, be called to forward an event to
+        another handler instead of ProcessEvent() which would result in a
+        duplicate call to TryAfter(), e.g. resulting in all unprocessed events
+        being sent to the application object multiple times.
+
+        @since 2.9.1
+
+        @param event
+            Event to process.
+        @return
+            @true if this handler of one of those chained to it processed the
+            event.
+     */
+    bool ProcessEventLocally(wxEvent& event);
+

     /**
         Processes an event by calling ProcessEvent() and handles any exceptions
         that occur in the process.
     /**
         Processes an event by calling ProcessEvent() and handles any exceptions
         that occur in the process.


@@ -420,6 +543,31 @@ public:
     */
     bool SafelyProcessEvent(wxEvent& event);
 
     */
     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.
     /**
         Searches the event table, executing an event handler function if an appropriate
         one is found.


@@ -442,6 +590,9 @@ public:
                  If a suitable function is called but calls wxEvent::Skip, this
                  function will fail, and searching will continue.
 
                  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,
         @see ProcessEvent()
     */
     virtual bool SearchEventTable(wxEventTable& table,


@@ -456,10 +607,25 @@ public:
     //@{
 
     /**
     //@{
 
     /**

-        Connects the given function dynamically with the event handler, id and event type.
-        This is an alternative to the use of static event tables.
+        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().

 
 

-        See the @ref page_samples_event sample for usage.
+        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
+        is impossible to do directly with the event tables -- the events can be
+        only handled in another object if they are propagated upwards to it).
+        Do make sure to specify the correct @a eventSink when connecting to an
+        event of a different object.
+
+        See @ref overview_events_bind for more detailed explanation
+        of this function and the @ref page_samples_event sample for usage
+        examples.

 
         This specific overload allows you to connect an event handler to a @e range
         of @e source IDs.
 
         This specific overload allows you to connect an event handler to a @e range
         of @e source IDs.


@@ -484,8 +650,17 @@ public:
         @param userData
             Data to be associated with the event table entry.
         @param eventSink
         @param userData
             Data to be associated with the event table entry.
         @param eventSink

-            Object whose member function should be called.
-            If this is @NULL, @c *this will be used.
+            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.
+
+        @beginWxPerlOnly
+        In wxPerl this function takes 4 arguments: @a id, @a lastid,
+        @a type, @a method; if @a method is undef, the handler is
+        disconnected.}
+        @endWxPerlOnly
+
+        @see Bind<>()

     */
     void Connect(int id, int lastId, wxEventType eventType,
                  wxObjectEventFunction function,
     */
     void Connect(int id, int lastId, wxEventType eventType,
                  wxObjectEventFunction function,


@@ -504,6 +679,10 @@ public:
                         wxEVT_COMMAND_MENU_SELECTED,
                         wxCommandEventHandler(MyFrame::OnQuit) );
         @endcode
                         wxEVT_COMMAND_MENU_SELECTED,
                         wxCommandEventHandler(MyFrame::OnQuit) );
         @endcode

+
+        @beginWxPerlOnly
+        Not supported by wxPerl.
+        @endWxPerlOnly

     */
     void Connect(int id, wxEventType eventType,
                  wxObjectEventFunction function,
     */
     void Connect(int id, wxEventType eventType,
                  wxObjectEventFunction function,


@@ -516,6 +695,10 @@ public:
 
         This overload will connect the given event handler so that regardless of the
         ID of the event source, the handler will be called.
 
         This overload will connect the given event handler so that regardless of the
         ID of the event source, the handler will be called.

+
+        @beginWxPerlOnly
+        Not supported by wxPerl.
+        @endWxPerlOnly

     */
     void Connect(wxEventType eventType,
                  wxObjectEventFunction function,
     */
     void Connect(wxEventType eventType,
                  wxObjectEventFunction function,


@@ -539,6 +722,10 @@ public:
             Data associated with the event table entry.
         @param eventSink
             Object whose member function should be called.
             Data associated with the event table entry.
         @param eventSink
             Object whose member function should be called.

+
+        @beginWxPerlOnly
+        Not supported by wxPerl.
+        @endWxPerlOnly

     */
     bool Disconnect(wxEventType eventType,
                     wxObjectEventFunction function,
     */
     bool Disconnect(wxEventType eventType,
                     wxObjectEventFunction function,


@@ -550,6 +737,10 @@ public:
         overload for more info.
 
         This overload takes the additional @a id parameter.
         overload for more info.
 
         This overload takes the additional @a id parameter.

+
+        @beginWxPerlOnly
+        Not supported by wxPerl.
+        @endWxPerlOnly

     */
     bool Disconnect(int id = wxID_ANY,
                     wxEventType eventType = wxEVT_NULL,
     */
     bool Disconnect(int id = wxID_ANY,
                     wxEventType eventType = wxEVT_NULL,


@@ -562,6 +753,11 @@ public:
         overload for more info.
 
         This overload takes an additional range of source IDs.
         overload for more info.
 
         This overload takes an additional range of source IDs.

+
+        @beginWxPerlOnly
+        In wxPerl this function takes 3 arguments: @a id,
+        @a lastid, @a type.
+        @endWxPerlOnly

     */
     bool Disconnect(int id, int lastId,
                     wxEventType eventType,
     */
     bool Disconnect(int id, int lastId,
                     wxEventType eventType,


@@ -571,6 +767,151 @@ 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.
+
+        @see @ref overview_cpp_rtti_disabled
+
+        @since 2.9.0
+    */
+    template <typename EventTag, typename Functor>
+    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.
+
+        @see @ref overview_cpp_rtti_disabled
+
+        @since 2.9.0
+    */
+    template <typename EventTag, typename Class, typename EventArg, typename EventHandler>
+    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 bound 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.
+
+        @see @ref overview_cpp_rtti_disabled
+
+        @since 2.9.0
+    */
+    template <typename EventTag, typename Functor>
+    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.
+
+        @see @ref overview_cpp_rtti_disabled
+
+        @since 2.9.0
+    */
+    template <typename EventTag, typename Class, typename EventArg, typename EventHandler>
+    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
     */
     /**
         @name User-supplied data
     */


@@ -620,7 +961,10 @@ public:
 
 
     /**
 
 
     /**

-        @name Event handler chain
+        @name Event handler chaining
+
+        wxEvtHandler can be arranged in a double-linked list of handlers
+        which is automatically iterated by ProcessEvent() if needed.

     */
     //@{
 
     */
     //@{
 


@@ -664,30 +1008,178 @@ public:
     /**
         Sets the pointer to the next handler.
 
     /**
         Sets the pointer to the next handler.
 

+        @remarks
+        See ProcessEvent() for more info about how the chains of event handlers
+        are internally used.
+        Also remember that wxEvtHandler uses double-linked lists and thus if you
+        use this function, you should also call SetPreviousHandler() on the
+        argument passed to this function:
+        @code
+            handlerA->SetNextHandler(handlerB);
+            handlerB->SetPreviousHandler(handlerA);
+        @endcode
+

         @param handler
         @param handler

-            Event handler to be set as the next handler.
+            The event handler to be set as the next handler.
+            Cannot be @NULL.

 
 

-        @see GetNextHandler(), SetPreviousHandler(), GetPreviousHandler(),
-             wxWindow::PushEventHandler, wxWindow::PopEventHandler
+        @see @ref overview_events_processing

     */
     */

-    void SetNextHandler(wxEvtHandler* handler);
+    virtual void SetNextHandler(wxEvtHandler* handler);

 
     /**
         Sets the pointer to the previous handler.
 
     /**
         Sets the pointer to the previous handler.

+        All remarks about SetNextHandler() apply to this function as well.

 
         @param handler
 
         @param handler

-            Event handler to be set as the previous handler.
+            The event handler to be set as the previous handler.
+            Cannot be @NULL.
+
+        @see @ref overview_events_processing
+    */
+    virtual void SetPreviousHandler(wxEvtHandler* handler);
+
+    /**
+        Unlinks this event handler from the chain it's part of (if any);
+        then links the "previous" event handler to the "next" one
+        (so that the chain won't be interrupted).
+
+        E.g. if before calling Unlink() you have the following chain:
+            @image html evthandler_unlink_before.png
+        then after calling @c B->Unlink() you'll have:
+            @image html evthandler_unlink_after.png
+
+        @since 2.9.0

     */
     */

-    void SetPreviousHandler(wxEvtHandler* handler);
+    void Unlink();
+
+    /**
+        Returns @true if the next and the previous handler pointers of this
+        event handler instance are @NULL.
+
+        @since 2.9.0
+
+        @see SetPreviousHandler(), SetNextHandler()
+    */
+    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()
+     */
+    virtual bool TryBefore(wxEvent& event);
+
+    /**
+        Try to process the event in this event handler.
+
+        This method is called from ProcessEventLocally() and thus, indirectly,
+        from ProcessEvent(), please see the detailed description of the event
+        processing logic there.
+
+        It is currently @em not virtual and so may not be overridden.
+
+        @since 2.9.1
+
+        @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 TryThis(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()
+     */
+    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

 };
 
 
 /**
     @class wxKeyEvent
 
 };
 
 
 /**
     @class wxKeyEvent
 

-    This event class contains information about keypress (character) events.
+    This event class contains information about key press and release events.

 
     Notice that there are three different kinds of keyboard events in wxWidgets:
     key down and up events and char events. The difference between the first two
 
     Notice that there are three different kinds of keyboard events in wxWidgets:
     key down and up events and char events. The difference between the first two


@@ -697,13 +1189,12 @@ public:
     generated) down events but only one up so it is wrong to assume that there is
     one up event corresponding to each down one.
 
     generated) down events but only one up so it is wrong to assume that there is
     one up event corresponding to each down one.
 

-    Both key events provide untranslated key codes while the char event carries
-    the translated one. The untranslated code for alphanumeric keys is always
-    an upper case value. For the other keys it is one of @c WXK_XXX values
-    from the @ref page_keycodes.
-    The translated key is, in general, the character the user expects to appear
-    as the result of the key combination when typing the text into a text entry
-    zone, for example.
+    Both key down and up events provide untranslated key codes while the char
+    event carries the translated one. The untranslated code for alphanumeric
+    keys is always an upper case value. For the other keys it is one of @c
+    WXK_XXX values from the ::wxKeyCode enumeration. The translated key is, in
+    general, the character the user expects to appear as the result of the key
+    combination when typing the text into a text entry zone, for example.

 
     A few examples to clarify this (all assume that CAPS LOCK is unpressed
     and the standard US keyboard): when the @c 'A' key is pressed, the key down
 
     A few examples to clarify this (all assume that CAPS LOCK is unpressed
     and the standard US keyboard): when the @c 'A' key is pressed, the key down


@@ -715,18 +1206,29 @@ public:
 
     Although in this simple case it is clear that the correct key code could be
     found in the key down event handler by checking the value returned by
 
     Although in this simple case it is clear that the correct key code could be
     found in the key down event handler by checking the value returned by

-    wxKeyEvent::ShiftDown(), in general you should use @c EVT_CHAR for this as
-    for non-alphanumeric keys the translation is keyboard-layout dependent and
-    can only be done properly by the system itself.
+    wxKeyEvent::ShiftDown(), in general you should use @c EVT_CHAR if you need
+    the translated key as for non-alphanumeric keys the translation is
+    keyboard-layout dependent and can only be done properly by the system
+    itself.

 
     Another kind of translation is done when the control key is pressed: for
     example, for CTRL-A key press the key down event still carries the
     same key code @c 'a' as usual but the char event will have key code of 1,
     the ASCII value of this key combination.
 
 
     Another kind of translation is done when the control key is pressed: for
     example, for CTRL-A key press the key down event still carries the
     same key code @c 'a' as usual but the char event will have key code of 1,
     the ASCII value of this key combination.
 

+    Notice that while pressing any key will generate a key down event (except
+    in presence of IME perhaps) a few special keys don't generate a char event:
+    currently, Shift, Control (or Command), Alt (or Menu or Meta) and Caps, Num
+    and Scroll Lock keys don't do it. For all the other keys you have the
+    choice about whether to choose key down or char event for handling it and
+    either can be used. However it is advised to use char events only for the
+    keys that are supposed to generate characters on screen and key down events
+    for all the rest.
+
+

     You may discover how the other keys on your system behave interactively by
     You may discover how the other keys on your system behave interactively by

-    running the @ref page_samples_text wxWidgets sample and pressing some keys
-    in any of the text controls shown in it.
+    running the @ref page_samples_keyboard wxWidgets sample and pressing some
+    keys in it.

 
     @b Tip: be sure to call @c event.Skip() for events that you don't process in
     key event function, otherwise menu shortcuts may cease to work under Windows.
 
     @b Tip: be sure to call @c event.Skip() for events that you don't process in
     key event function, otherwise menu shortcuts may cease to work under Windows.


@@ -740,16 +1242,18 @@ public:
     @note For Windows programmers: The key and char events in wxWidgets are
           similar to but slightly different from Windows @c WM_KEYDOWN and
           @c WM_CHAR events. In particular, Alt-x combination will generate a
     @note For Windows programmers: The key and char events in wxWidgets are
           similar to but slightly different from Windows @c WM_KEYDOWN and
           @c WM_CHAR events. In particular, Alt-x combination will generate a

-          char event in wxWidgets (unless it is used as an accelerator).
+          char event in wxWidgets (unless it is used as an accelerator) and
+          almost all keys, including ones without ASCII equivalents, generate
+          char events too.

 
 
     @beginEventTable{wxKeyEvent}
     @event{EVT_KEY_DOWN(func)}
 
 
     @beginEventTable{wxKeyEvent}
     @event{EVT_KEY_DOWN(func)}

-           Process a wxEVT_KEY_DOWN event (any key has been pressed).
+        Process a @c wxEVT_KEY_DOWN event (any key has been pressed).

     @event{EVT_KEY_UP(func)}
     @event{EVT_KEY_UP(func)}

-           Process a wxEVT_KEY_UP event (any key has been released).
+        Process a @c wxEVT_KEY_UP event (any key has been released).

     @event{EVT_CHAR(func)}
     @event{EVT_CHAR(func)}

-           Process a wxEVT_CHAR event.
+        Process a @c wxEVT_CHAR event.

     @endEventTable
 
     @see wxKeyboardState
     @endEventTable
 
     @see wxKeyboardState


@@ -769,15 +1273,26 @@ public:
 
     /**
         Returns the virtual key code. ASCII events return normal ASCII values,
 
     /**
         Returns the virtual key code. ASCII events return normal ASCII values,

-        while non-ASCII events return values such as @b WXK_LEFT for the left cursor
-        key. See @ref page_keycodes for a full list of the virtual key codes.
+        while non-ASCII events return values such as @b WXK_LEFT for the left
+        cursor key. See ::wxKeyCode for a full list of the virtual key codes.

 
 

-        Note that in Unicode build, the returned value is meaningful only if the
-        user entered a character that can be represented in current locale's default
-        charset. You can obtain the corresponding Unicode character using GetUnicodeKey().
+        Note that in Unicode build, the returned value is meaningful only if
+        the user entered a character that can be represented in current
+        locale's default charset. You can obtain the corresponding Unicode
+        character using GetUnicodeKey().

     */
     int GetKeyCode() const;
 
     */
     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.
     //@{
     /**
         Obtains the position (in client coordinates) at which the key was pressed.


@@ -807,6 +1322,9 @@ public:
     /**
         Returns the Unicode character corresponding to this key event.
 
     /**
         Returns the Unicode character corresponding to this key event.
 

+        If the key pressed doesn't have any character value (e.g. a cursor key)
+        this method will return 0.
+

         This function is only available in Unicode build, i.e. when
         @c wxUSE_UNICODE is 1.
     */
         This function is only available in Unicode build, i.e. when
         @c wxUSE_UNICODE is 1.
     */


@@ -832,15 +1350,15 @@ public:
     events received by windows.
 
     @beginEventTable{wxJoystickEvent}
     events received by windows.
 
     @beginEventTable{wxJoystickEvent}

-    @style{EVT_JOY_BUTTON_DOWN(func)}
-        Process a wxEVT_JOY_BUTTON_DOWN event.
-    @style{EVT_JOY_BUTTON_UP(func)}
-        Process a wxEVT_JOY_BUTTON_UP event.
-    @style{EVT_JOY_MOVE(func)}
-        Process a wxEVT_JOY_MOVE event.
-    @style{EVT_JOY_ZMOVE(func)}
-        Process a wxEVT_JOY_ZMOVE event.
-    @style{EVT_JOYSTICK_EVENTS(func)}
+    @event{EVT_JOY_BUTTON_DOWN(func)}
+        Process a @c wxEVT_JOY_BUTTON_DOWN event.
+    @event{EVT_JOY_BUTTON_UP(func)}
+        Process a @c wxEVT_JOY_BUTTON_UP event.
+    @event{EVT_JOY_MOVE(func)}
+        Process a @c wxEVT_JOY_MOVE event.
+    @event{EVT_JOY_ZMOVE(func)}
+        Process a @c wxEVT_JOY_ZMOVE event.
+    @event{EVT_JOYSTICK_EVENTS(func)}

         Processes all joystick events.
     @endEventTable
 
         Processes all joystick events.
     @endEventTable
 


@@ -942,10 +1460,10 @@ public:
 
     A scroll event holds information about events sent from scrolling windows.
 
 
     A scroll event holds information about events sent from scrolling windows.
 

+    Note that you can use the EVT_SCROLLWIN* macros for intercepting scroll window events
+    from the receiving window.

 
     @beginEventTable{wxScrollWinEvent}
 
     @beginEventTable{wxScrollWinEvent}

-    You can use the EVT_SCROLLWIN* macros for intercepting scroll window events
-    from the receiving window.

     @event{EVT_SCROLLWIN(func)}
         Process all scroll events.
     @event{EVT_SCROLLWIN_TOP(func)}
     @event{EVT_SCROLLWIN(func)}
         Process all scroll events.
     @event{EVT_SCROLLWIN_TOP(func)}


@@ -971,7 +1489,7 @@ public:
     @library{wxcore}
     @category{events}
 
     @library{wxcore}
     @category{events}
 

-    @see wxScrollEvent, @ref overview_eventhandling
+    @see wxScrollEvent, @ref overview_events

 */
 class wxScrollWinEvent : public wxEvent
 {
 */
 class wxScrollWinEvent : public wxEvent
 {


@@ -1016,13 +1534,13 @@ public:
 
     @beginEventTable{wxSysColourChangedEvent}
     @event{EVT_SYS_COLOUR_CHANGED(func)}
 
     @beginEventTable{wxSysColourChangedEvent}
     @event{EVT_SYS_COLOUR_CHANGED(func)}

-        Process a wxEVT_SYS_COLOUR_CHANGED event.
+        Process a @c wxEVT_SYS_COLOUR_CHANGED event.

     @endEventTable
 
     @library{wxcore}
     @category{events}
 
     @endEventTable
 
     @library{wxcore}
     @category{events}
 

-    @see @ref overview_eventhandling
+    @see @ref overview_events

 */
 class wxSysColourChangedEvent : public wxEvent
 {
 */
 class wxSysColourChangedEvent : public wxEvent
 {


@@ -1046,13 +1564,13 @@ public:
 
     @beginEventTable{wxWindowCreateEvent}
     @event{EVT_WINDOW_CREATE(func)}
 
     @beginEventTable{wxWindowCreateEvent}
     @event{EVT_WINDOW_CREATE(func)}

-        Process a wxEVT_CREATE event.
+        Process a @c wxEVT_CREATE event.

     @endEventTable
 
     @library{wxcore}
     @category{events}
 
     @endEventTable
 
     @library{wxcore}
     @category{events}
 

-    @see @ref overview_eventhandling, wxWindowDestroyEvent
+    @see @ref overview_events, wxWindowDestroyEvent

 */
 class wxWindowCreateEvent : public wxCommandEvent
 {
 */
 class wxWindowCreateEvent : public wxCommandEvent
 {


@@ -1073,16 +1591,8 @@ public:
 
     A paint event is sent when a window's contents needs to be repainted.
 
 
     A paint event is sent when a window's contents needs to be repainted.
 

-    Please notice that in general it is impossible to change the drawing of a
-    standard control (such as wxButton) and so you shouldn't attempt to handle
-    paint events for them as even if it might work on some platforms, this is
-    inherently not portable and won't work everywhere.
-
-    @remarks
-    Note that in a paint event handler, the application must always create a
-    wxPaintDC object, even if you do not use it. Otherwise, under MS Windows,
-    refreshing for this and other windows will go wrong.
-    For example:
+    The handler of this event must create a wxPaintDC object and use it for
+    painting the window contents. For example:

     @code
     void MyWindow::OnPaint(wxPaintEvent& event)
     {
     @code
     void MyWindow::OnPaint(wxPaintEvent& event)
     {


@@ -1091,6 +1601,12 @@ public:
         DrawMyDocument(dc);
     }
     @endcode
         DrawMyDocument(dc);
     }
     @endcode

+
+    Notice that you must @e not create other kinds of wxDC (e.g. wxClientDC or
+    wxWindowDC) in EVT_PAINT handlers and also don't create wxPaintDC outside
+    of this event handlers.
+
+

     You can optimize painting by retrieving the rectangles that have been damaged
     and only repainting these. The rectangles are in terms of the client area,
     and are unscrolled, so you will need to do some calculations using the current
     You can optimize painting by retrieving the rectangles that have been damaged
     and only repainting these. The rectangles are in terms of the client area,
     and are unscrolled, so you will need to do some calculations using the current


@@ -1127,16 +1643,22 @@ public:
     }
     @endcode
 
     }
     @endcode
 

+    @remarks
+    Please notice that in general it is impossible to change the drawing of a
+    standard control (such as wxButton) and so you shouldn't attempt to handle
+    paint events for them as even if it might work on some platforms, this is
+    inherently not portable and won't work everywhere.
+

 
     @beginEventTable{wxPaintEvent}
     @event{EVT_PAINT(func)}
 
     @beginEventTable{wxPaintEvent}
     @event{EVT_PAINT(func)}

-        Process a wxEVT_PAINT event.
+        Process a @c wxEVT_PAINT event.

     @endEventTable
 
     @library{wxcore}
     @category{events}
 
     @endEventTable
 
     @library{wxcore}
     @category{events}
 

-    @see @ref overview_eventhandling
+    @see @ref overview_events

 */
 class wxPaintEvent : public wxEvent
 {
 */
 class wxPaintEvent : public wxEvent
 {


@@ -1158,13 +1680,13 @@ public:
 
     @beginEventTable{wxMaximizeEvent}
     @event{EVT_MAXIMIZE(func)}
 
     @beginEventTable{wxMaximizeEvent}
     @event{EVT_MAXIMIZE(func)}

-        Process a wxEVT_MAXIMIZE event.
+        Process a @c wxEVT_MAXIMIZE event.

     @endEventTable
 
     @library{wxcore}
     @category{events}
 
     @endEventTable
 
     @library{wxcore}
     @category{events}
 

-    @see @ref overview_eventhandling, wxTopLevelWindow::Maximize,
+    @see @ref overview_events, wxTopLevelWindow::Maximize,

          wxTopLevelWindow::IsMaximized
 */
 class wxMaximizeEvent : public wxEvent
          wxTopLevelWindow::IsMaximized
 */
 class wxMaximizeEvent : public wxEvent


@@ -1237,15 +1759,15 @@ enum wxUpdateUIMode
 
     @beginEventTable{wxUpdateUIEvent}
     @event{EVT_UPDATE_UI(id, func)}
 
     @beginEventTable{wxUpdateUIEvent}
     @event{EVT_UPDATE_UI(id, func)}

-        Process a wxEVT_UPDATE_UI event for the command with the given id.
+        Process a @c wxEVT_UPDATE_UI event for the command with the given id.

     @event{EVT_UPDATE_UI_RANGE(id1, id2, func)}
     @event{EVT_UPDATE_UI_RANGE(id1, id2, func)}

-        Process a wxEVT_UPDATE_UI event for any command with id included in the given range.
+        Process a @c wxEVT_UPDATE_UI event for any command with id included in the given range.

     @endEventTable
 
     @library{wxcore}
     @category{events}
 
     @endEventTable
 
     @library{wxcore}
     @category{events}
 

-    @see @ref overview_eventhandling
+    @see @ref overview_events

 */
 class wxUpdateUIEvent : public wxCommandEvent
 {
 */
 class wxUpdateUIEvent : public wxCommandEvent
 {


@@ -1474,57 +1996,59 @@ 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
           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}
     @event{EVT_LEFT_DOWN(func)}
 
 
     @beginEventTable{wxMouseEvent}
     @event{EVT_LEFT_DOWN(func)}

-        Process a wxEVT_LEFT_DOWN event. The handler of this event should normally
+        Process a @c wxEVT_LEFT_DOWN event. The handler of this event should normally

         call event.Skip() to allow the default processing to take place as otherwise
         the window under mouse wouldn't get the focus.
     @event{EVT_LEFT_UP(func)}
         call event.Skip() to allow the default processing to take place as otherwise
         the window under mouse wouldn't get the focus.
     @event{EVT_LEFT_UP(func)}

-        Process a wxEVT_LEFT_UP event.
+        Process a @c wxEVT_LEFT_UP event.

     @event{EVT_LEFT_DCLICK(func)}
     @event{EVT_LEFT_DCLICK(func)}

-        Process a wxEVT_LEFT_DCLICK event.
+        Process a @c wxEVT_LEFT_DCLICK event.

     @event{EVT_MIDDLE_DOWN(func)}
     @event{EVT_MIDDLE_DOWN(func)}

-        Process a wxEVT_MIDDLE_DOWN event.
+        Process a @c wxEVT_MIDDLE_DOWN event.

     @event{EVT_MIDDLE_UP(func)}
     @event{EVT_MIDDLE_UP(func)}

-        Process a wxEVT_MIDDLE_UP event.
+        Process a @c wxEVT_MIDDLE_UP event.

     @event{EVT_MIDDLE_DCLICK(func)}
     @event{EVT_MIDDLE_DCLICK(func)}

-        Process a wxEVT_MIDDLE_DCLICK event.
+        Process a @c wxEVT_MIDDLE_DCLICK event.

     @event{EVT_RIGHT_DOWN(func)}
     @event{EVT_RIGHT_DOWN(func)}

-        Process a wxEVT_RIGHT_DOWN event.
+        Process a @c wxEVT_RIGHT_DOWN event.

     @event{EVT_RIGHT_UP(func)}
     @event{EVT_RIGHT_UP(func)}

-        Process a wxEVT_RIGHT_UP event.
+        Process a @c wxEVT_RIGHT_UP event.

     @event{EVT_RIGHT_DCLICK(func)}
     @event{EVT_RIGHT_DCLICK(func)}

-        Process a wxEVT_RIGHT_DCLICK event.
+        Process a @c wxEVT_RIGHT_DCLICK event.

     @event{EVT_MOUSE_AUX1_DOWN(func)}
     @event{EVT_MOUSE_AUX1_DOWN(func)}

-        Process a wxEVT_MOUSE_AUX1_DOWN event.
+        Process a @c wxEVT_AUX1_DOWN event.

     @event{EVT_MOUSE_AUX1_UP(func)}
     @event{EVT_MOUSE_AUX1_UP(func)}

-        Process a wxEVT_MOUSE_AUX1_UP event.
+        Process a @c wxEVT_AUX1_UP event.

     @event{EVT_MOUSE_AUX1_DCLICK(func)}
     @event{EVT_MOUSE_AUX1_DCLICK(func)}

-        Process a wxEVT_MOUSE_AUX1_DCLICK event.
+        Process a @c wxEVT_AUX1_DCLICK event.

     @event{EVT_MOUSE_AUX2_DOWN(func)}
     @event{EVT_MOUSE_AUX2_DOWN(func)}

-        Process a wxEVT_MOUSE_AUX2_DOWN event.
+        Process a @c wxEVT_AUX2_DOWN event.

     @event{EVT_MOUSE_AUX2_UP(func)}
     @event{EVT_MOUSE_AUX2_UP(func)}

-        Process a wxEVT_MOUSE_AUX2_UP event.
+        Process a @c wxEVT_AUX2_UP event.

     @event{EVT_MOUSE_AUX2_DCLICK(func)}
     @event{EVT_MOUSE_AUX2_DCLICK(func)}

-        Process a wxEVT_MOUSE_AUX2_DCLICK event.
+        Process a @c wxEVT_AUX2_DCLICK event.

     @event{EVT_MOTION(func)}
     @event{EVT_MOTION(func)}

-        Process a wxEVT_MOTION event.
+        Process a @c wxEVT_MOTION event.

     @event{EVT_ENTER_WINDOW(func)}
     @event{EVT_ENTER_WINDOW(func)}

-        Process a wxEVT_ENTER_WINDOW event.
+        Process a @c wxEVT_ENTER_WINDOW event.

     @event{EVT_LEAVE_WINDOW(func)}
     @event{EVT_LEAVE_WINDOW(func)}

-        Process a wxEVT_LEAVE_WINDOW event.
+        Process a @c wxEVT_LEAVE_WINDOW event.

     @event{EVT_MOUSEWHEEL(func)}
     @event{EVT_MOUSEWHEEL(func)}

-        Process a wxEVT_MOUSEWHEEL event.
+        Process a @c wxEVT_MOUSEWHEEL event.

     @event{EVT_MOUSE_EVENTS(func)}
         Process all mouse events.
     @endEventTable
     @event{EVT_MOUSE_EVENTS(func)}
         Process all mouse events.
     @endEventTable


@@ -1573,12 +2097,6 @@ public:
     */
     bool Aux1Down() const;
 
     */
     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.
     */
     /**
         Returns @true if the first extra button mouse button changed to up.
     */


@@ -1594,52 +2112,38 @@ public:
     */
     bool Aux2Down() const;
 
     */
     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 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).
     */
 
     /**
         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).
     */
 
     /**
         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).
     */
 
     /**
         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).
 
     /**
         Returns @true if this was a dragging event (motion while a button is depressed).


@@ -1689,20 +2193,6 @@ public:
     */
     wxPoint GetLogicalPosition(const wxDC& dc) const;
 
     */
     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.
 
     /**
         Get wheel delta, normally 120.
 


@@ -1731,16 +2221,6 @@ public:
     */
     int GetWheelAxis() const;
 
     */
     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()).
     /**
         Returns @true if the event was a mouse button event (not necessarily a button
         down event - that may be tested using ButtonDown()).


@@ -1770,21 +2250,6 @@ public:
     */
     bool LeftDown() const;
 
     */
     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.
     */
     /**
         Returns @true if the left mouse button changed to up.
     */


@@ -1805,12 +2270,6 @@ public:
     */
     bool MiddleDown() const;
 
     */
     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.
     */
     /**
         Returns @true if the middle mouse button changed to up.
     */


@@ -1833,12 +2292,6 @@ public:
     */
     bool RightDown() const;
 
     */
     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.
     */
     /**
         Returns @true if the right mouse button changed to up.
     */


@@ -1862,7 +2315,7 @@ public:
 
     @beginEventTable{wxDropFilesEvent}
     @event{EVT_DROP_FILES(func)}
 
     @beginEventTable{wxDropFilesEvent}
     @event{EVT_DROP_FILES(func)}

-        Process a wxEVT_DROP_FILES event.
+        Process a @c wxEVT_DROP_FILES event.

     @endEventTable
 
     @onlyfor{wxmsw}
     @endEventTable
 
     @onlyfor{wxmsw}


@@ -1870,7 +2323,7 @@ public:
     @library{wxcore}
     @category{events}
 
     @library{wxcore}
     @category{events}
 

-    @see @ref overview_eventhandling
+    @see @ref overview_events

 */
 class wxDropFilesEvent : public wxEvent
 {
 */
 class wxDropFilesEvent : public wxEvent
 {


@@ -1906,6 +2359,11 @@ public:
     This event class contains information about command events, which originate
     from a variety of simple controls.
 
     This event class contains information about command events, which originate
     from a variety of simple controls.
 

+    Note that wxCommandEvents and wxCommandEvent-derived event classes by default
+    and unlike other wxEvent-derived classes propagate upward from the source
+    window (the window which emits the event) up to the first parent which processes
+    the event. Be sure to read @ref overview_events_propagation.
+

     More complex controls, such as wxTreeCtrl, have separate command event classes.
 
     @beginEventTable{wxCommandEvent}
     More complex controls, such as wxTreeCtrl, have separate command event classes.
 
     @beginEventTable{wxCommandEvent}


@@ -1927,6 +2385,8 @@ public:
         Process a @c wxEVT_COMMAND_LISTBOX_SELECTED command, which is generated by a wxListBox control.
     @event{EVT_LISTBOX_DCLICK(id, func)}
         Process a @c wxEVT_COMMAND_LISTBOX_DOUBLECLICKED command, which is generated by a wxListBox control.
         Process a @c wxEVT_COMMAND_LISTBOX_SELECTED command, which is generated by a wxListBox control.
     @event{EVT_LISTBOX_DCLICK(id, func)}
         Process a @c wxEVT_COMMAND_LISTBOX_DOUBLECLICKED command, which is generated by a wxListBox control.

+    @event{EVT_CHECKLISTBOX(id, func)}
+        Process a @c wxEVT_COMMAND_CHECKLISTBOX_TOGGLED command, which is generated by a wxCheckListBox control.

     @event{EVT_MENU(id, func)}
         Process a @c wxEVT_COMMAND_MENU_SELECTED command, which is generated by a menu item.
     @event{EVT_MENU_RANGE(id1, id2, func)}
     @event{EVT_MENU(id, func)}
         Process a @c wxEVT_COMMAND_MENU_SELECTED command, which is generated by a menu item.
     @event{EVT_MENU_RANGE(id1, id2, func)}


@@ -1962,13 +2422,13 @@ public:
     @event{EVT_TOOL_RANGE(id1, id2, func)}
         Process a @c wxEVT_COMMAND_TOOL_CLICKED event for a range of identifiers. Pass the ids of the tools.
     @event{EVT_TOOL_RCLICKED(id, func)}
     @event{EVT_TOOL_RANGE(id1, id2, func)}
         Process a @c wxEVT_COMMAND_TOOL_CLICKED event for a range of identifiers. Pass the ids of the tools.
     @event{EVT_TOOL_RCLICKED(id, func)}

-        Process a @c wxEVT_COMMAND_TOOL_RCLICKED event. Pass the id of the tool.
+        Process a @c wxEVT_COMMAND_TOOL_RCLICKED event. Pass the id of the tool.  (Not available on wxOSX.)

     @event{EVT_TOOL_RCLICKED_RANGE(id1, id2, func)}
     @event{EVT_TOOL_RCLICKED_RANGE(id1, id2, func)}

-        Process a @c wxEVT_COMMAND_TOOL_RCLICKED event for a range of ids. Pass the ids of the tools.
+        Process a @c wxEVT_COMMAND_TOOL_RCLICKED event for a range of ids. Pass the ids of the tools.  (Not available on wxOSX.)

     @event{EVT_TOOL_ENTER(id, func)}
         Process a @c wxEVT_COMMAND_TOOL_ENTER event. Pass the id of the toolbar itself.
         The value of wxCommandEvent::GetSelection() is the tool id, or -1 if the mouse cursor
     @event{EVT_TOOL_ENTER(id, func)}
         Process a @c wxEVT_COMMAND_TOOL_ENTER event. Pass the id of the toolbar itself.
         The value of wxCommandEvent::GetSelection() is the tool id, or -1 if the mouse cursor

-        has moved off a tool.
+        has moved off a tool.  (Not available on wxOSX.)

     @event{EVT_COMMAND_LEFT_CLICK(id, func)}
         Process a @c wxEVT_COMMAND_LEFT_CLICK command, which is generated by a control (wxMSW only).
     @event{EVT_COMMAND_LEFT_DCLICK(id, func)}
     @event{EVT_COMMAND_LEFT_CLICK(id, func)}
         Process a @c wxEVT_COMMAND_LEFT_CLICK command, which is generated by a control (wxMSW only).
     @event{EVT_COMMAND_LEFT_DCLICK(id, func)}


@@ -2095,9 +2555,10 @@ public:
 
     @beginEventTable{wxActivateEvent}
     @event{EVT_ACTIVATE(func)}
 
     @beginEventTable{wxActivateEvent}
     @event{EVT_ACTIVATE(func)}

-        Process a wxEVT_ACTIVATE event.
+        Process a @c wxEVT_ACTIVATE event.

     @event{EVT_ACTIVATE_APP(func)}
     @event{EVT_ACTIVATE_APP(func)}

-        Process a wxEVT_ACTIVATE_APP event.
+        Process a @c wxEVT_ACTIVATE_APP event.
+        This event is received by the wxApp-derived instance only.

     @event{EVT_HIBERNATE(func)}
         Process a hibernate event, supplying the member function. This event applies
         to wxApp only, and only on Windows SmartPhone and PocketPC.
     @event{EVT_HIBERNATE(func)}
         Process a hibernate event, supplying the member function. This event applies
         to wxApp only, and only on Windows SmartPhone and PocketPC.


@@ -2106,11 +2567,10 @@ public:
         a wxEVT_ACTIVATE or wxEVT_ACTIVATE_APP event.
     @endEventTable
 
         a wxEVT_ACTIVATE or wxEVT_ACTIVATE_APP event.
     @endEventTable
 

-

     @library{wxcore}
     @category{events}
 
     @library{wxcore}
     @category{events}
 

-    @see @ref overview_eventhandling, wxApp::IsActive
+    @see @ref overview_events, wxApp::IsActive

 */
 class wxActivateEvent : public wxEvent
 {
 */
 class wxActivateEvent : public wxEvent
 {


@@ -2133,7 +2593,7 @@ public:
     @class wxContextMenuEvent
 
     This class is used for context menu events, sent to give
     @class wxContextMenuEvent
 
     This class is used for context menu events, sent to give

-    the application a chance to show a context (popup) menu.
+    the application a chance to show a context (popup) menu for a wxWindow.

 
     Note that if wxContextMenuEvent::GetPosition returns wxDefaultPosition, this
     means that the event originated from a keyboard context button event, and you
 
     Note that if wxContextMenuEvent::GetPosition returns wxDefaultPosition, this
     means that the event originated from a keyboard context button event, and you


@@ -2154,7 +2614,7 @@ public:
     @library{wxcore}
     @category{events}
 
     @library{wxcore}
     @category{events}
 

-    @see wxCommandEvent, @ref overview_eventhandling
+    @see wxCommandEvent, @ref overview_events

 */
 class wxContextMenuEvent : public wxCommandEvent
 {
 */
 class wxContextMenuEvent : public wxCommandEvent
 {


@@ -2207,13 +2667,13 @@ public:
 
     @beginEventTable{wxEraseEvent}
     @event{EVT_ERASE_BACKGROUND(func)}
 
     @beginEventTable{wxEraseEvent}
     @event{EVT_ERASE_BACKGROUND(func)}

-        Process a wxEVT_ERASE_BACKGROUND event.
+        Process a @c wxEVT_ERASE_BACKGROUND event.

     @endEventTable
 
     @library{wxcore}
     @category{events}
 
     @endEventTable
 
     @library{wxcore}
     @category{events}
 

-    @see @ref overview_eventhandling
+    @see @ref overview_events

 */
 class wxEraseEvent : public wxEvent
 {
 */
 class wxEraseEvent : public wxEvent
 {


@@ -2243,15 +2703,15 @@ public:
 
     @beginEventTable{wxFocusEvent}
     @event{EVT_SET_FOCUS(func)}
 
     @beginEventTable{wxFocusEvent}
     @event{EVT_SET_FOCUS(func)}

-        Process a wxEVT_SET_FOCUS event.
+        Process a @c wxEVT_SET_FOCUS event.

     @event{EVT_KILL_FOCUS(func)}
     @event{EVT_KILL_FOCUS(func)}

-        Process a wxEVT_KILL_FOCUS event.
+        Process a @c wxEVT_KILL_FOCUS event.

     @endEventTable
 
     @library{wxcore}
     @category{events}
 
     @endEventTable
 
     @library{wxcore}
     @category{events}
 

-    @see @ref overview_eventhandling
+    @see @ref overview_events

 */
 class wxFocusEvent : public wxEvent
 {
 */
 class wxFocusEvent : public wxEvent
 {


@@ -2285,13 +2745,13 @@ public:
 
     @beginEventTable{wxChildFocusEvent}
     @event{EVT_CHILD_FOCUS(func)}
 
     @beginEventTable{wxChildFocusEvent}
     @event{EVT_CHILD_FOCUS(func)}

-        Process a wxEVT_CHILD_FOCUS event.
+        Process a @c wxEVT_CHILD_FOCUS event.

     @endEventTable
 
     @library{wxcore}
     @category{events}
 
     @endEventTable
 
     @library{wxcore}
     @category{events}
 

-    @see @ref overview_eventhandling
+    @see @ref overview_events

 */
 class wxChildFocusEvent : public wxCommandEvent
 {
 */
 class wxChildFocusEvent : public wxCommandEvent
 {


@@ -2332,7 +2792,7 @@ public:
 
     @beginEventTable{wxMouseCaptureLostEvent}
     @event{EVT_MOUSE_CAPTURE_LOST(func)}
 
     @beginEventTable{wxMouseCaptureLostEvent}
     @event{EVT_MOUSE_CAPTURE_LOST(func)}

-        Process a wxEVT_MOUSE_CAPTURE_LOST event.
+        Process a @c wxEVT_MOUSE_CAPTURE_LOST event.

     @endEventTable
 
     @onlyfor{wxmsw}
     @endEventTable
 
     @onlyfor{wxmsw}


@@ -2340,8 +2800,8 @@ public:
     @library{wxcore}
     @category{events}
 
     @library{wxcore}
     @category{events}
 

-    @see wxMouseCaptureChangedEvent, @ref overview_eventhandling,
-    wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
+    @see wxMouseCaptureChangedEvent, @ref overview_events,
+         wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture

 */
 class wxMouseCaptureLostEvent : public wxEvent
 {
 */
 class wxMouseCaptureLostEvent : public wxEvent
 {


@@ -2402,18 +2862,79 @@ public:
 };
 
 
 };
 
 

+/**
+    @class wxThreadEvent
+
+    This class adds some simple functionalities to wxCommandEvent coinceived
+    for inter-threads communications.
+
+    This event is not natively emitted by any control/class: this is just
+    an helper class for the user.
+    Its most important feature is the GetEventCategory() implementation which
+    allows thread events to @b NOT be processed by wxEventLoopBase::YieldFor calls
+    (unless the @c wxEVT_CATEGORY_THREAD is specified - which is never in wx code).

 
 

+    @library{wxcore}
+    @category{events,threading}

 
 

-enum wxHelpEventOrigin
+    @see @ref overview_thread, wxEventLoopBase::YieldFor
+*/
+class wxThreadEvent : public wxCommandEvent

 {
 {

-    wxHE_ORIGIN_UNKNOWN = -1,
-    wxHE_ORIGIN_KEYBOARD,
+public:
+    /**
+        Constructor.
+    */
+    wxThreadEvent(wxEventType eventType = wxEVT_COMMAND_THREAD, int id = wxID_ANY);

 
 

-    /** event generated by wxContextHelp or from the [?] button on
-        the title bar (Windows). */
-    wxHE_ORIGIN_HELPBUTTON
+    /**
+        Clones this event making sure that all internal members which use
+        COW (only @c m_commandString for now; see @ref overview_refcount)
+        are unshared (see wxObject::UnShare).
+    */
+    virtual wxEvent *Clone() const;
+
+    /**
+        Returns @c wxEVT_CATEGORY_THREAD.
+
+        This is important to avoid unwanted processing of thread events
+        when calling wxEventLoopBase::YieldFor().
+    */
+    virtual wxEventCategory GetEventCategory() const;
+
+    /**
+        Sets custom data payload.
+
+        The @a payload argument may be of any type that wxAny can handle
+        (i.e. pretty much anything). Note that T's copy constructor must be
+        thread-safe, i.e. create a copy that doesn't share anything with
+        the original (see Clone()).
+
+        @note This method is not available with Visual C++ 6.
+
+        @since 2.9.1
+
+        @see GetPayload(), wxAny
+     */
+    template<typename T>
+    void SetPayload(const T& payload);
+
+    /**
+        Get custom data payload.
+
+        Correct type is checked in debug builds.
+
+        @note This method is not available with Visual C++ 6.
+
+        @since 2.9.1
+
+        @see SetPayload(), wxAny
+     */
+    template<typename T>
+    T GetPayload() const;

 };
 
 };
 

+

 /**
     @class wxHelpEvent
 
 /**
     @class wxHelpEvent
 


@@ -2437,15 +2958,15 @@ enum wxHelpEventOrigin
 
     @beginEventTable{wxHelpEvent}
     @event{EVT_HELP(id, func)}
 
     @beginEventTable{wxHelpEvent}
     @event{EVT_HELP(id, func)}

-        Process a wxEVT_HELP event.
+        Process a @c wxEVT_HELP event.

     @event{EVT_HELP_RANGE(id1, id2, func)}
     @event{EVT_HELP_RANGE(id1, id2, func)}

-        Process a wxEVT_HELP event for a range of ids.
+        Process a @c wxEVT_HELP event for a range of ids.

     @endEventTable
 
     @library{wxcore}
     @category{events}
 
     @endEventTable
 
     @library{wxcore}
     @category{events}
 

-    @see wxContextHelp, wxDialog, @ref overview_eventhandling
+    @see wxContextHelp, wxDialog, @ref overview_events

 */
 class wxHelpEvent : public wxCommandEvent
 {
 */
 class wxHelpEvent : public wxCommandEvent
 {


@@ -2585,7 +3106,7 @@ public:
     @library{wxcore}
     @category{events}
 
     @library{wxcore}
     @category{events}
 

-    @see wxScrollBar, wxSlider, wxSpinButton, wxScrollWinEvent, @ref overview_eventhandling
+    @see wxScrollBar, wxSlider, wxSpinButton, wxScrollWinEvent, @ref overview_events

 */
 class wxScrollEvent : public wxCommandEvent
 {
 */
 class wxScrollEvent : public wxCommandEvent
 {


@@ -2644,13 +3165,13 @@ enum wxIdleMode
 
     @beginEventTable{wxIdleEvent}
     @event{EVT_IDLE(func)}
 
     @beginEventTable{wxIdleEvent}
     @event{EVT_IDLE(func)}

-        Process a wxEVT_IDLE event.
+        Process a @c wxEVT_IDLE event.

     @endEventTable
 
     @library{wxbase}
     @category{events}
 
     @endEventTable
 
     @library{wxbase}
     @category{events}
 

-    @see @ref overview_eventhandling, wxUpdateUIEvent, wxWindow::OnInternalIdle
+    @see @ref overview_events, wxUpdateUIEvent, wxWindow::OnInternalIdle

 */
 class wxIdleEvent : public wxEvent
 {
 */
 class wxIdleEvent : public wxEvent
 {


@@ -2730,13 +3251,13 @@ public:
 
     @beginEventTable{wxInitDialogEvent}
     @event{EVT_INIT_DIALOG(func)}
 
     @beginEventTable{wxInitDialogEvent}
     @event{EVT_INIT_DIALOG(func)}

-        Process a wxEVT_INIT_DIALOG event.
+        Process a @c wxEVT_INIT_DIALOG event.

     @endEventTable
 
     @library{wxcore}
     @category{events}
 
     @endEventTable
 
     @library{wxcore}
     @category{events}
 

-    @see @ref overview_eventhandling
+    @see @ref overview_events

 */
 class wxInitDialogEvent : public wxEvent
 {
 */
 class wxInitDialogEvent : public wxEvent
 {


@@ -2773,7 +3294,7 @@ public:
     @library{wxcore}
     @category{events}
 
     @library{wxcore}
     @category{events}
 

-    @see @ref overview_eventhandling, wxWindowCreateEvent
+    @see @ref overview_events, wxWindowCreateEvent

 */
 class wxWindowDestroyEvent : public wxCommandEvent
 {
 */
 class wxWindowDestroyEvent : public wxCommandEvent
 {


@@ -2788,18 +3309,6 @@ public:
 };
 
 
 };
 
 

-/**
-    The possible flag values for a wxNavigationKeyEvent.
-*/
-enum wxNavigationKeyEventFlags
-{
-    wxNKEF_IS_BACKWARD = 0x0000,
-    wxNKEF_IS_FORWARD = 0x0001,
-    wxNKEF_WINCHANGE = 0x0002,
-    wxNKEF_FROMTAB = 0x0004
-};
-
-

 /**
     @class wxNavigationKeyEvent
 
 /**
     @class wxNavigationKeyEvent
 


@@ -2824,6 +3333,17 @@ enum wxNavigationKeyEventFlags
 class wxNavigationKeyEvent : public wxEvent
 {
 public:
 class wxNavigationKeyEvent : public wxEvent
 {
 public:

+    /**
+        Flags which can be used with wxNavigationKeyEvent.
+    */
+    enum wxNavigationKeyEventFlags
+    {
+        IsBackward = 0x0000,
+        IsForward = 0x0001,
+        WinChange = 0x0002,
+        FromTab = 0x0004
+    };
+

     wxNavigationKeyEvent();
     wxNavigationKeyEvent(const wxNavigationKeyEvent& event);
 
     wxNavigationKeyEvent();
     wxNavigationKeyEvent(const wxNavigationKeyEvent& event);
 


@@ -2883,7 +3403,7 @@ public:
     @class wxMouseCaptureChangedEvent
 
     An mouse capture changed event is sent to a window that loses its
     @class wxMouseCaptureChangedEvent
 
     An mouse capture changed event is sent to a window that loses its

-    mouse capture. This is called even if wxWindow::ReleaseCapture
+    mouse capture. This is called even if wxWindow::ReleaseMouse

     was called by the application code. Handling this event allows
     an application to cater for unexpected capture releases which
     might otherwise confuse mouse handling code.
     was called by the application code. Handling this event allows
     an application to cater for unexpected capture releases which
     might otherwise confuse mouse handling code.


@@ -2892,14 +3412,14 @@ public:
 
     @beginEventTable{wxMouseCaptureChangedEvent}
     @event{EVT_MOUSE_CAPTURE_CHANGED(func)}
 
     @beginEventTable{wxMouseCaptureChangedEvent}
     @event{EVT_MOUSE_CAPTURE_CHANGED(func)}

-        Process a wxEVT_MOUSE_CAPTURE_CHANGED event.
+        Process a @c wxEVT_MOUSE_CAPTURE_CHANGED event.

     @endEventTable
 
     @library{wxcore}
     @category{events}
 
     @endEventTable
 
     @library{wxcore}
     @category{events}
 

-    @see wxMouseCaptureLostEvent, @ref overview_eventhandling,
-    wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
+    @see wxMouseCaptureLostEvent, @ref overview_events,
+         wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture

 */
 class wxMouseCaptureChangedEvent : public wxEvent
 {
 */
 class wxMouseCaptureChangedEvent : public wxEvent
 {


@@ -2976,13 +3496,13 @@ public:
 
     @beginEventTable{wxCloseEvent}
     @event{EVT_CLOSE(func)}
 
     @beginEventTable{wxCloseEvent}
     @event{EVT_CLOSE(func)}

-        Process a close event, supplying the member function.
+        Process a @c wxEVT_CLOSE_WINDOW command event, supplying the member function.

         This event applies to wxFrame and wxDialog classes.
     @event{EVT_QUERY_END_SESSION(func)}
         This event applies to wxFrame and wxDialog classes.
     @event{EVT_QUERY_END_SESSION(func)}

-        Process a query end session event, supplying the member function.
+        Process a @c wxEVT_QUERY_END_SESSION session event, supplying the member function.

         This event can be handled in wxApp-derived class only.
     @event{EVT_END_SESSION(func)}
         This event can be handled in wxApp-derived class only.
     @event{EVT_END_SESSION(func)}

-        Process an end session event, supplying the member function.
+        Process a @c wxEVT_END_SESSION session event, supplying the member function.

         This event can be handled in wxApp-derived class only.
     @endEventTable
 
         This event can be handled in wxApp-derived class only.
     @endEventTable
 


@@ -3060,7 +3580,7 @@ public:
     @library{wxcore}
     @category{events}
 
     @library{wxcore}
     @category{events}
 

-    @see wxCommandEvent, @ref overview_eventhandling
+    @see wxCommandEvent, @ref overview_events

 */
 class wxMenuEvent : public wxEvent
 {
 */
 class wxMenuEvent : public wxEvent
 {


@@ -3096,6 +3616,11 @@ public:
     @class wxShowEvent
 
     An event being sent when the window is shown or hidden.
     @class wxShowEvent
 
     An event being sent when the window is shown or hidden.

+    The event is triggered by calls to wxWindow::Show(), and any user
+    action showing a previously hidden window or vice versa (if allowed by
+    the current platform and/or window manager).
+    Notice that the event is not triggered when the application is iconized
+    (minimized) or restored under wxMSW.

 
     Currently only wxMSW, wxGTK and wxOS2 generate such events.
 
 
     Currently only wxMSW, wxGTK and wxOS2 generate such events.
 


@@ -3103,13 +3628,13 @@ public:
 
     @beginEventTable{wxShowEvent}
     @event{EVT_SHOW(func)}
 
     @beginEventTable{wxShowEvent}
     @event{EVT_SHOW(func)}

-        Process a wxEVT_SHOW event.
+        Process a @c wxEVT_SHOW event.

     @endEventTable
 
     @library{wxcore}
     @category{events}
 
     @endEventTable
 
     @library{wxcore}
     @category{events}
 

-    @see @ref overview_eventhandling, wxWindow::Show,
+    @see @ref overview_events, wxWindow::Show,

          wxWindow::IsShown
 */
 
          wxWindow::IsShown
 */
 


@@ -3151,13 +3676,13 @@ public:
 
     @beginEventTable{wxIconizeEvent}
     @event{EVT_ICONIZE(func)}
 
     @beginEventTable{wxIconizeEvent}
     @event{EVT_ICONIZE(func)}

-        Process a wxEVT_ICONIZE event.
+        Process a @c wxEVT_ICONIZE event.

     @endEventTable
 
     @library{wxcore}
     @category{events}
 
     @endEventTable
 
     @library{wxcore}
     @category{events}
 

-    @see @ref overview_eventhandling, wxTopLevelWindow::Iconize,
+    @see @ref overview_events, wxTopLevelWindow::Iconize,

          wxTopLevelWindow::IsIconized
 */
 class wxIconizeEvent : public wxEvent
          wxTopLevelWindow::IsIconized
 */
 class wxIconizeEvent : public wxEvent


@@ -3185,23 +3710,23 @@ public:
 /**
     @class wxMoveEvent
 
 /**
     @class wxMoveEvent
 

-    A move event holds information about move change events.
+    A move event holds information about wxTopLevelWindow move change events.

 
     @beginEventTable{wxMoveEvent}
     @event{EVT_MOVE(func)}
 
     @beginEventTable{wxMoveEvent}
     @event{EVT_MOVE(func)}

-        Process a wxEVT_MOVE event, which is generated when a window is moved.
+        Process a @c wxEVT_MOVE event, which is generated when a window is moved.

     @event{EVT_MOVE_START(func)}
     @event{EVT_MOVE_START(func)}

-        Process a wxEVT_MOVE_START event, which is generated when the user starts
+        Process a @c wxEVT_MOVE_START event, which is generated when the user starts

         to move or size a window. wxMSW only.
     @event{EVT_MOVE_END(func)}
         to move or size a window. wxMSW only.
     @event{EVT_MOVE_END(func)}

-        Process a wxEVT_MOVE_END event, which is generated when the user stops
+        Process a @c wxEVT_MOVE_END event, which is generated when the user stops

         moving or sizing a window. wxMSW only.
     @endEventTable
 
     @library{wxcore}
     @category{events}
 
         moving or sizing a window. wxMSW only.
     @endEventTable
 
     @library{wxcore}
     @category{events}
 

-    @see wxPoint, @ref overview_eventhandling
+    @see wxPoint, @ref overview_events

 */
 class wxMoveEvent : public wxEvent
 {
 */
 class wxMoveEvent : public wxEvent
 {


@@ -3221,13 +3746,13 @@ public:
 /**
     @class wxSizeEvent
 
 /**
     @class wxSizeEvent
 

-    A size event holds information about size change events.
+    A size event holds information about size change events of wxWindow.

 
     The EVT_SIZE handler function will be called when the window has been resized.
 
     You may wish to use this for frames to resize their child windows as appropriate.
 
 
     The EVT_SIZE handler function will be called when the window has been resized.
 
     You may wish to use this for frames to resize their child windows as appropriate.
 

-    Note that the size passed is of the whole window: call wxWindow::GetClientSize
+    Note that the size passed is of the whole window: call wxWindow::GetClientSize()

     for the area which may be used by the application.
 
     When a window is resized, usually only a small part of the window is damaged
     for the area which may be used by the application.
 
     When a window is resized, usually only a small part of the window is damaged


@@ -3237,13 +3762,13 @@ public:
 
     @beginEventTable{wxSizeEvent}
     @event{EVT_SIZE(func)}
 
     @beginEventTable{wxSizeEvent}
     @event{EVT_SIZE(func)}

-        Process a wxEVT_SIZE event.
+        Process a @c wxEVT_SIZE event.

     @endEventTable
 
     @library{wxcore}
     @category{events}
 
     @endEventTable
 
     @library{wxcore}
     @category{events}
 

-    @see wxSize, @ref overview_eventhandling
+    @see wxSize, @ref overview_events

 */
 class wxSizeEvent : public wxEvent
 {
 */
 class wxSizeEvent : public wxEvent
 {


@@ -3255,6 +3780,11 @@ public:
 
     /**
         Returns the entire size of the window generating the size change event.
 
     /**
         Returns the entire size of the window generating the size change event.

+
+        This is the new total size of the window, i.e. the same size as would
+        be returned by wxWindow::GetSize() if it were called now. Use
+        wxWindow::GetClientSize() if you catch this event in a top level window
+        such as wxFrame to find the size available for the window contents.

     */
     wxSize GetSize() const;
 };
     */
     wxSize GetSize() const;
 };


@@ -3264,8 +3794,8 @@ public:
 /**
     @class wxSetCursorEvent
 
 /**
     @class wxSetCursorEvent
 

-    A wxSetCursorEvent is generated when the mouse cursor is about to be set as a
-    result of mouse motion.
+    A wxSetCursorEvent is generated from wxWindow when the mouse cursor is about
+    to be set as a result of mouse motion.

 
     This event gives the application the chance to perform specific mouse cursor
     processing based on the current position of the mouse within the window.
 
     This event gives the application the chance to perform specific mouse cursor
     processing based on the current position of the mouse within the window.


@@ -3273,7 +3803,7 @@ public:
 
     @beginEventTable{wxSetCursorEvent}
     @event{EVT_SET_CURSOR(func)}
 
     @beginEventTable{wxSetCursorEvent}
     @event{EVT_SET_CURSOR(func)}

-        Process a wxEVT_SET_CURSOR event.
+        Process a @c wxEVT_SET_CURSOR event.

     @endEventTable
 
     @library{wxcore}
     @endEventTable
 
     @library{wxcore}


@@ -3328,6 +3858,17 @@ public:
 /** @addtogroup group_funcmacro_events */
 //@{
 
 /** @addtogroup group_funcmacro_events */
 //@{
 

+/**
+    A value uniquely identifying the type of the event.
+
+    The values of this type should only be created using wxNewEventType().
+
+    See the macro DEFINE_EVENT_TYPE() for more info.
+
+    @see @ref overview_events_introduction
+*/
+typedef int wxEventType;
+

 /**
     A special event type usually used to indicate that some wxEvent has yet
     no type assigned.
 /**
     A special event type usually used to indicate that some wxEvent has yet
     no type assigned.


@@ -3335,54 +3876,166 @@ public:
 wxEventType wxEVT_NULL;
 
 /**
 wxEventType wxEVT_NULL;
 
 /**

-    Each wxEvent-derived class has an @e event-type associated.
-    See the macro DEFINE_EVENT_TYPE() for more info.
+    Generates a new unique event type.

 
 

-    @see @ref overview_eventhandling_custom
+    Usually this function is only used by wxDEFINE_EVENT() and not called
+    directly.

 */
 */

-typedef int wxEventType;
+wxEventType wxNewEventType();

 
 /**
 
 /**

-    Initializes a new event type using wxNewEventType().
+    Define a new event type associated with the specified event class.
+
+    This macro defines a new unique event type @a name associated with the
+    event class @a cls.
+
+    For example:
+    @code
+    wxDEFINE_EVENT(MY_COMMAND_EVENT, wxCommandEvent);
+
+    class MyCustomEvent : public wxEvent { ... };
+    wxDEFINE_EVENT(MY_CUSTOM_EVENT, MyCustomEvent);
+    @endcode
+
+    @see wxDECLARE_EVENT(), @ref overview_events_custom
+ */
+#define wxDEFINE_EVENT(name, cls) \
+    const wxEventTypeTag< cls > name(wxNewEventType())
+
+/**
+    Declares a custom event type.
+
+    This macro declares a variable called @a name which must be defined
+    elsewhere using wxDEFINE_EVENT().
+
+    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)
+
+/**
+    Variant of wxDECLARE_EVENT() used for event types defined inside a shared
+    library.
+
+    This is mostly used by wxWidgets internally, e.g.
+    @code
+    wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEvent)
+    @endcode
+ */
+#define wxDECLARE_EXPORTED_EVENT( expdecl, name, cls ) \
+    extern const expdecl wxEventTypeTag< cls > name;
+
+/**
+    Helper macro for definition of custom event table macros.
+
+    This macro must only be used if wxEVENTS_COMPATIBILITY_2_8 is 1, otherwise
+    it is better and more clear to just use the address of the function
+    directly as this is all this macro does in this case. However it needs to
+    explicitly cast @a func to @a functype, which is the type of wxEvtHandler
+    member function taking the custom event argument when
+    wxEVENTS_COMPATIBILITY_2_8 is 0.
+
+    See wx__DECLARE_EVT0 for an example of use.
+
+    @see @ref overview_events_custom_ownclass
+ */
+#define wxEVENT_HANDLER_CAST(functype, func) (&func)
+
+/**
+    This macro is used to define event table macros for handling custom
+    events.
+
+    Example of use:
+    @code
+    class MyEvent : public wxEvent { ... };
+
+    // note that this is not necessary unless using old compilers: for the
+    // reasonably new ones just use &func instead of MyEventHandler(func)
+    typedef void (wxEvtHandler::*MyEventFunction)(MyEvent&);
+    #define MyEventHandler(func) wxEVENT_HANDLER_CAST(MyEventFunction, func)
+
+    wxDEFINE_EVENT(MY_EVENT_TYPE, MyEvent);
+
+    #define EVT_MY(id, func) \
+        wx__DECLARE_EVT1(MY_EVENT_TYPE, id, MyEventHandler(func))
+
+    ...
+
+    wxBEGIN_EVENT_TABLE(MyFrame, wxFrame)
+        EVT_MY(wxID_ANY, MyFrame::OnMyEvent)
+    wxEND_EVENT_TABLE()
+    @endcode
+
+    @param evt
+        The event type to handle.
+    @param id
+        The identifier of events to handle.
+    @param fn
+        The event handler method.
+ */
+#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 DEFINE_EVENT_TYPE(name)     const wxEventType name = wxNewEventType();
+#define wx__DECLARE_EVT2(evt, id1, id2, fn) \
+    DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),

 
 /**
 
 /**

-    Generates a new unique event type.
+    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.

 */
 */

-wxEventType wxNewEventType();
+#define wx__DECLARE_EVT0(evt, fn) \
+    wx__DECLARE_EVT1(evt, wxID_ANY, fn)

 
 /**
     Use this macro inside a class declaration to declare a @e static event table
     for that class.
 
 
 /**
     Use this macro inside a class declaration to declare a @e static event table
     for that class.
 

-    In the implementation file you'll need to use the BEGIN_EVENT_TABLE()
-    and the END_EVENT_TABLE() macros, plus some additional @c EVT_xxx macro
+    In the implementation file you'll need to use the wxBEGIN_EVENT_TABLE()
+    and the wxEND_EVENT_TABLE() macros, plus some additional @c EVT_xxx macro

     to capture events.
     to capture events.

+    
+    Note that this macro requires a final semicolon.

 
 

-    @see @ref overview_eventhandling_eventtables
+    @see @ref overview_events_eventtables

 */
 */

-#define DECLARE_EVENT_TABLE()
+#define wxDECLARE_EVENT_TABLE()

 
 /**
     Use this macro in a source file to start listing @e static event handlers
     for a specific class.
 
 
 /**
     Use this macro in a source file to start listing @e static event handlers
     for a specific class.
 

-    Use END_EVENT_TABLE() to terminate the event-declaration block.
+    Use wxEND_EVENT_TABLE() to terminate the event-declaration block.

 
 

-    @see @ref overview_eventhandling_eventtables
+    @see @ref overview_events_eventtables

 */
 */

-#define BEGIN_EVENT_TABLE(theClass, baseClass)
+#define wxBEGIN_EVENT_TABLE(theClass, baseClass)

 
 /**
     Use this macro in a source file to end listing @e static event handlers
     for a specific class.
 
 
 /**
     Use this macro in a source file to end listing @e static event handlers
     for a specific class.
 

-    Use BEGIN_EVENT_TABLE() to start the event-declaration block.
+    Use wxBEGIN_EVENT_TABLE() to start the event-declaration block.

 
 

-    @see @ref overview_eventhandling_eventtables
+    @see @ref overview_events_eventtables

 */
 */

-#define END_EVENT_TABLE()
+#define wxEND_EVENT_TABLE()

 
 /**
     In a GUI application, this function posts @a event to the specified @e dest
 
 /**
     In a GUI application, this function posts @a event to the specified @e dest