streamlining code

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

diff --git a/include/wx/event.h b/include/wx/event.h
index 0d9fb86e18bd063a2bfaeda950f7d3c9d03c1ab0..cc363146e4051f840de527e51cf3f99ad39210a3 100644 (file)
--- a/include/wx/event.h
+++ b/include/wx/event.h
@@ -381,7 +381,7 @@ struct HandlerImpl<T, A, false>
 // allowed to handle different events in the same handler taking wxEvent&, for
 // example
 template
 // allowed to handle different events in the same handler taking wxEvent&, for
 // example
 template

-  <typename EventTag, typename Class, typename EventArg, typename ObjClass>
+  <typename EventTag, typename Class, typename EventArg, typename EventHandler>

 class wxEventFunctorMethod
     : public wxEventFunctor,
       private wxPrivate::HandlerImpl
 class wxEventFunctorMethod
     : public wxEventFunctor,
       private wxPrivate::HandlerImpl


@@ -399,7 +399,7 @@ public:
     typedef typename wxPrivate::EventClassOf<EventTag>::type EventClass;
 
 
     typedef typename wxPrivate::EventClassOf<EventTag>::type EventClass;
 
 

-    wxEventFunctorMethod(void (Class::*method)(EventArg&), ObjClass *handler)
+    wxEventFunctorMethod(void (Class::*method)(EventArg&), EventHandler *handler)

     {
         wxASSERT_MSG( handler || this->IsEvtHandler(),
                       "handlers defined in non-wxEvtHandler-derived classes "
     {
         wxASSERT_MSG( handler || this->IsEvtHandler(),
                       "handlers defined in non-wxEvtHandler-derived classes "


@@ -457,17 +457,15 @@ public:
     }
 
 private:
     }
 
 private:

-    ObjClass *m_handler;
+    EventHandler *m_handler;

     void (Class::*m_method)(EventArg&);
 };
 
 
     void (Class::*m_method)(EventArg&);
 };
 
 

-//

 // Create functors for the templatized events, either allocated on the heap for
 // Create functors for the templatized events, either allocated on the heap for

-// wxNewXXX() variants (this is needed in wxEvtHandler::Connect() to store them
+// wxNewXXX() variants (this is needed in wxEvtHandler::Bind<>() to store them

 // in dynamic event table) or just by returning them as temporary objects (this
 // in dynamic event table) or just by returning them as temporary objects (this

-// is enough for Disconnect() and we allocate unnecessary heap allocation like
-// this)
+// is enough for Unbind<>() and we avoid unnecessary heap allocation like this).

 
 
 // Create functors wrapping other functors (including functions):
 
 
 // Create functors wrapping other functors (including functions):


@@ -488,29 +486,29 @@ wxMakeEventFunctor(const EventTag&, Functor func)
 
 // Create functors for methods:
 template
 
 // Create functors for methods:
 template

-  <typename EventTag, typename Class, typename EventArg, typename ObjClass>
-inline wxEventFunctorMethod<EventTag, Class, EventArg, ObjClass> *
+  <typename EventTag, typename Class, typename EventArg, typename EventHandler>
+inline wxEventFunctorMethod<EventTag, Class, EventArg, EventHandler> *

 wxNewEventFunctor(const EventTag&,
                   void (Class::*method)(EventArg&),
 wxNewEventFunctor(const EventTag&,
                   void (Class::*method)(EventArg&),

-                  ObjClass *handler)
+                  EventHandler *handler)

 {
 {

-    return new wxEventFunctorMethod<EventTag, Class, EventArg, ObjClass>(
+    return new wxEventFunctorMethod<EventTag, Class, EventArg, EventHandler>(

                 method, handler);
 }
 
 template
                 method, handler);
 }
 
 template

-    <typename EventTag, typename Class, typename EventArg, typename ObjClass>
-inline wxEventFunctorMethod<EventTag, Class, EventArg, ObjClass>
+    <typename EventTag, typename Class, typename EventArg, typename EventHandler>
+inline wxEventFunctorMethod<EventTag, Class, EventArg, EventHandler>

 wxMakeEventFunctor(const EventTag&,
                    void (Class::*method)(EventArg&),
 wxMakeEventFunctor(const EventTag&,
                    void (Class::*method)(EventArg&),

-                   ObjClass *handler)
+                   EventHandler *handler)

 {
 {

-    return wxEventFunctorMethod<EventTag, Class, EventArg, ObjClass>(
+    return wxEventFunctorMethod<EventTag, Class, EventArg, EventHandler>(

                 method, handler);
 }
 
 // Special case for the wxNewEventFunctor() calls used inside the event table
                 method, handler);
 }
 
 // Special case for the wxNewEventFunctor() calls used inside the event table

-// macros: they don't specify the handler so ObjClass can't be deduced
+// macros: they don't specify the handler so EventHandler can't be deduced

 template <typename EventTag, typename Class, typename EventArg>
 inline wxEventFunctorMethod<EventTag, Class, EventArg, Class> *
 wxNewEventFunctor(const EventTag&, void (Class::*method)(EventArg&))
 template <typename EventTag, typename Class, typename EventArg>
 inline wxEventFunctorMethod<EventTag, Class, EventArg, Class> *
 wxNewEventFunctor(const EventTag&, void (Class::*method)(EventArg&))


@@ -520,7 +518,7 @@ wxNewEventFunctor(const EventTag&, void (Class::*method)(EventArg&))
 }
 
 template
 }
 
 template

-    <typename EventTag, typename Class, typename EventArg, typename ObjClass>
+    <typename EventTag, typename Class, typename EventArg, typename EventHandler>

 inline wxEventFunctorMethod<EventTag, Class, EventArg, Class>
 wxMakeEventFunctor(const EventTag&, void (Class::*method)(EventArg&))
 {
 inline wxEventFunctorMethod<EventTag, Class, EventArg, Class>
 wxMakeEventFunctor(const EventTag&, void (Class::*method)(EventArg&))
 {


@@ -598,6 +596,8 @@ wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_COMBOBOX_SELECTED, wxCo
 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TOOL_RCLICKED, wxCommandEvent);
 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, wxCommandEvent);
 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TOOL_ENTER, wxCommandEvent);
 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TOOL_RCLICKED, wxCommandEvent);
 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, wxCommandEvent);
 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TOOL_ENTER, wxCommandEvent);

+wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_COMBOBOX_DROPDOWN, wxCommandEvent);
+wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_COMBOBOX_CLOSEUP, wxCommandEvent);

 
     // Thread events
 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_THREAD, wxThreadEvent);
 
     // Thread events
 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_THREAD, wxThreadEvent);


@@ -811,7 +811,8 @@ enum wxEventCategory
     // used in wxEventLoopBase::YieldFor to specify all event categories should be processed:
     wxEVT_CATEGORY_ALL =
         wxEVT_CATEGORY_UI|wxEVT_CATEGORY_USER_INPUT|wxEVT_CATEGORY_SOCKET| \
     // used in wxEventLoopBase::YieldFor to specify all event categories should be processed:
     wxEVT_CATEGORY_ALL =
         wxEVT_CATEGORY_UI|wxEVT_CATEGORY_USER_INPUT|wxEVT_CATEGORY_SOCKET| \

-        wxEVT_CATEGORY_TIMER|wxEVT_CATEGORY_THREAD
+        wxEVT_CATEGORY_TIMER|wxEVT_CATEGORY_THREAD|wxEVT_CATEGORY_UNKNOWN| \
+        wxEVT_CATEGORY_CLIPBOARD

 };
 
 /*
 };
 
 /*


@@ -1635,7 +1636,9 @@ private:
  wxEVT_PAINT_ICON
  */
 
  wxEVT_PAINT_ICON
  */
 

-#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
+#if wxDEBUG_LEVEL && (defined(__WXMSW__) || defined(__WXPM__))
+    #define wxHAS_PAINT_DEBUG
+

     // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
     extern WXDLLIMPEXP_CORE int g_isPainting;
 #endif // debug
     // see comments in src/msw|os2/dcclient.cpp where g_isPainting is defined
     extern WXDLLIMPEXP_CORE int g_isPainting;
 #endif // debug


@@ -1646,15 +1649,15 @@ public:
     wxPaintEvent(int Id = 0)
         : wxEvent(Id, wxEVT_PAINT)
     {
     wxPaintEvent(int Id = 0)
         : wxEvent(Id, wxEVT_PAINT)
     {

-#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
-        // set the internal flag for the duration of processing of WM_PAINT
+#ifdef wxHAS_PAINT_DEBUG
+        // set the internal flag for the duration of redrawing

         g_isPainting++;
 #endif // debug
     }
 
     // default copy ctor and dtor are normally fine, we only need them to keep
     // g_isPainting updated in debug build
         g_isPainting++;
 #endif // debug
     }
 
     // default copy ctor and dtor are normally fine, we only need them to keep
     // g_isPainting updated in debug build

-#if defined(__WXDEBUG__) && (defined(__WXMSW__) || defined(__WXPM__))
+#ifdef wxHAS_PAINT_DEBUG

     wxPaintEvent(const wxPaintEvent& event)
             : wxEvent(event)
     {
     wxPaintEvent(const wxPaintEvent& event)
             : wxEvent(event)
     {


@@ -2803,10 +2806,11 @@ public:
     // Clear table
     void Clear();
 
     // Clear table
     void Clear();
 

-#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
-    // Clear all tables
+#if wxUSE_MEMORY_TRACING
+    // Clear all tables: only used to work around problems in memory tracing
+    // code

     static void ClearAll();
     static void ClearAll();

-#endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
+#endif // wxUSE_MEMORY_TRACING

 
 protected:
     // Init the hash table with the entries of the static event table.
 
 protected:
     // Init the hash table with the entries of the static event table.


@@ -2864,7 +2868,6 @@ public:
     // Event queuing and processing
     // ----------------------------
 
     // Event queuing and processing
     // ----------------------------
 

-

     // Process an event right now: this can only be called from the main
     // thread, use QueueEvent() for scheduling the events for
     // processing from other threads.
     // Process an event right now: this can only be called from the main
     // thread, use QueueEvent() for scheduling the events for
     // processing from other threads.


@@ -2900,9 +2903,11 @@ public:
     void ProcessPendingEvents();
         // NOTE: uses ProcessEvent()
 
     void ProcessPendingEvents();
         // NOTE: uses ProcessEvent()
 

+    void DeletePendingEvents();
+

 #if wxUSE_THREADS
     bool ProcessThreadEvent(const wxEvent& event);
 #if wxUSE_THREADS
     bool ProcessThreadEvent(const wxEvent& event);

-        // NOTE: uses AddPendingEvent()
+        // NOTE: uses AddPendingEvent(); call only from secondary threads

 #endif
 
 
 #endif
 
 


@@ -2976,58 +2981,56 @@ public:
     // Bind arbitrary functor (including just a function) to an event:
     template <typename EventTag, typename Functor>
     void Bind(const EventTag& eventType,
     // Bind arbitrary functor (including just a function) to an event:
     template <typename EventTag, typename Functor>
     void Bind(const EventTag& eventType,

-              Functor func,
+              Functor functor,

               int winid = wxID_ANY,
               int lastId = wxID_ANY,
               wxObject *userData = NULL)
     {
         DoConnect(winid, lastId, eventType,
               int winid = wxID_ANY,
               int lastId = wxID_ANY,
               wxObject *userData = NULL)
     {
         DoConnect(winid, lastId, eventType,

-                  wxNewEventFunctor(eventType, func),
+                  wxNewEventFunctor(eventType, functor),

                   userData);
     }
 
 
     template <typename EventTag, typename Functor>
     bool Unbind(const EventTag& eventType,
                   userData);
     }
 
 
     template <typename EventTag, typename Functor>
     bool Unbind(const EventTag& eventType,

-                Functor func,
+                Functor functor,

                 int winid = wxID_ANY,
                 int lastId = wxID_ANY,
                 wxObject *userData = NULL)
     {
         return DoDisconnect(winid, lastId, eventType,
                 int winid = wxID_ANY,
                 int lastId = wxID_ANY,
                 wxObject *userData = NULL)
     {
         return DoDisconnect(winid, lastId, eventType,

-                            wxMakeEventFunctor(eventType, func),
+                            wxMakeEventFunctor(eventType, functor),

                             userData);
     }
 
 
                             userData);
     }
 
 

-    // Bind a method of a class (called on the specified eventSink which must
+    // Bind a method of a class (called on the specified handler which must

     // be convertible to this class) object to an event:
 
     // be convertible to this class) object to an event:
 

-    template
-      <typename EventTag, typename Class, typename EventArg, typename ObjClass>
+    template <typename EventTag, typename Class, typename EventArg, typename EventHandler>

     void Bind(const EventTag &eventType,
     void Bind(const EventTag &eventType,

-              void (Class::*func)(EventArg &),
-              ObjClass *eventSink,
+              void (Class::*method)(EventArg &),
+              EventHandler *handler,

               int winid = wxID_ANY,
               int lastId = wxID_ANY,
               wxObject *userData = NULL)
     {
         DoConnect(winid, lastId, eventType,
               int winid = wxID_ANY,
               int lastId = wxID_ANY,
               wxObject *userData = NULL)
     {
         DoConnect(winid, lastId, eventType,

-                  wxNewEventFunctor(eventType, func, eventSink),
+                  wxNewEventFunctor(eventType, method, handler),

                   userData);
     }
 
                   userData);
     }
 

-    template
-      <typename EventTag, typename Class, typename EventArg, typename ObjClass>
+    template <typename EventTag, typename Class, typename EventArg, typename EventHandler>

     bool Unbind(const EventTag &eventType,
     bool Unbind(const EventTag &eventType,

-                void (Class::*func)(EventArg&),
-                ObjClass *eventSink,
+                void (Class::*method)(EventArg&),
+                EventHandler *handler,

                 int winid = wxID_ANY,
                 int lastId = wxID_ANY,
                 wxObject *userData = NULL )
     {
         return DoDisconnect(winid, lastId, eventType,
                 int winid = wxID_ANY,
                 int lastId = wxID_ANY,
                 wxObject *userData = NULL )
     {
         return DoDisconnect(winid, lastId, eventType,

-                            wxMakeEventFunctor(eventType, func, eventSink),
+                            wxMakeEventFunctor(eventType, method, handler),

                             userData);
     }
 #endif // !wxEVENTS_COMPATIBILITY_2_8
                             userData);
     }
 #endif // !wxEVENTS_COMPATIBILITY_2_8


@@ -3067,7 +3070,7 @@ public:
     //
     // It is meant to be called from ProcessEvent() only and is not virtual,
     // additional event handlers can be hooked into the normal event processing
     //
     // It is meant to be called from ProcessEvent() only and is not virtual,
     // additional event handlers can be hooked into the normal event processing

-    // logic using TryValidator() hook.
+    // logic using TryBefore() and TryAfter() hooks.

     bool ProcessEventHere(wxEvent& event);
 
 
     bool ProcessEventHere(wxEvent& event);
 
 


@@ -3090,21 +3093,25 @@ protected:
     // hooks for wxWindow used by ProcessEvent()
     // -----------------------------------------
 
     // hooks for wxWindow used by ProcessEvent()
     // -----------------------------------------
 

-    // This one is called before trying our own event table to allow plugging
-    // in the validators.
-    //
-    // NB: This method is intentionally *not* inside wxUSE_VALIDATORS!
-    //     It is part of wxBase which doesn't use validators and the code
-    //     is compiled out when building wxBase w/o GUI classes, which affects
-    //     binary compatibility and wxBase library can't be used by GUI
-    //     ports.
-    virtual bool TryValidator(wxEvent& WXUNUSED(event)) { return false; }
+    // this one is called before trying our own event table to allow plugging
+    // in the event handlers overriding the default logic, this is used by e.g.
+    // validators.
+    virtual bool TryBefore(wxEvent& event);

 
     // this one is called after failing to find the event handle in our own
     // table to give a chance to the other windows to process it
     //
     // base class implementation passes the event to wxTheApp
 
     // this one is called after failing to find the event handle in our own
     // table to give a chance to the other windows to process it
     //
     // base class implementation passes the event to wxTheApp

-    virtual bool TryParent(wxEvent& event);
+    virtual bool TryAfter(wxEvent& event);
+
+#ifdef WXWIN_COMPATIBILITY_2_8
+    // deprecated method: override TryBefore() instead of this one
+    wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
+        virtual bool TryValidator(wxEvent& WXUNUSED(event)), return false; )
+
+    wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
+        virtual bool TryParent(wxEvent& event), return DoTryApp(event); )
+#endif // WXWIN_COMPATIBILITY_2_8

 
 
     static const wxEventTable sm_eventTable;
 
 
     static const wxEventTable sm_eventTable;


@@ -3149,13 +3156,16 @@ protected:
     virtual void *DoGetClientData() const;
 
     // Search tracker objects for event connection with this sink
     virtual void *DoGetClientData() const;
 
     // Search tracker objects for event connection with this sink

-    wxEventConnectionRef *FindRefInTrackerList(wxEvtHandler *eventSink);
+    wxEventConnectionRef *FindRefInTrackerList(wxEvtHandler *handler);

 
 private:
 
 private:

+    // pass the event to wxTheApp instance, called from TryAfter()
+    bool DoTryApp(wxEvent& event);
+

     DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler)
 };
 
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler)
 };
 

-WX_DEFINE_ARRAY_WITH_DECL_PTR(wxEvtHandler *, wxEvtHandlerArray, WXDLLIMPEXP_BASE);
+WX_DEFINE_ARRAY_WITH_DECL_PTR(wxEvtHandler *, wxEvtHandlerArray, class WXDLLIMPEXP_BASE);

 
 // ----------------------------------------------------------------------------
 // wxEventConnectionRef represents all connections between two event handlers
 
 // ----------------------------------------------------------------------------
 // wxEventConnectionRef represents all connections between two event handlers


@@ -3744,6 +3754,8 @@ typedef void (wxEvtHandler::*wxClipboardTextEventFunction)(wxClipboardTextEvent&
 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
 #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
 #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))
 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, func) wx__DECLARE_EVT2(wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, wxCommandEventHandler(func))
 #define EVT_TOOL_ENTER(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_TOOL_ENTER, winid, wxCommandEventHandler(func))
 #define EVT_CHECKLISTBOX(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, winid, wxCommandEventHandler(func))

+#define EVT_COMBOBOX_DROPDOWN(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_DROPDOWN, winid, wxCommandEventHandler(func))
+#define EVT_COMBOBOX_CLOSEUP(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_COMBOBOX_CLOSEUP, winid, wxCommandEventHandler(func))

 
 // Generic command events
 #define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))
 
 // Generic command events
 #define EVT_COMMAND_LEFT_CLICK(winid, func) wx__DECLARE_EVT1(wxEVT_COMMAND_LEFT_CLICK, winid, wxCommandEventHandler(func))


@@ -3797,6 +3809,41 @@ typedef void (wxEvtHandler::*wxClipboardTextEventFunction)(wxClipboardTextEvent&
 // Helper functions
 // ----------------------------------------------------------------------------
 
 // Helper functions
 // ----------------------------------------------------------------------------
 

+// This is an ugly hack to allow the use of Bind() instead of Connect() inside
+// the library code if the library was built with support for it, here is how
+// it is used:
+//
+// class SomeEventHandlingClass : wxBIND_OR_CONNECT_HACK_BASE_CLASS
+//                                public SomeBaseClass
+// {
+// public:
+//     SomeEventHandlingClass(wxWindow *win)
+//     {
+//         // connect to the event for the given window
+//         wxBIND_OR_CONNECT_HACK(win, wxEVT_SOMETHING, wxSomeEventHandler,
+//                                SomeEventHandlingClass::OnSomeEvent, this);
+//     }
+//
+// private:
+//     void OnSomeEvent(wxSomeEvent&) { ... }
+// };
+//
+// This is *not* meant to be used by library users, it is only defined here
+// (and not in a private header) because the base class must be visible from
+// other public headers, please do NOT use this in your code, it will be
+// removed from future wx versions without warning.
+#if wxEVENTS_COMPATIBILITY_2_8
+    #define wxBIND_OR_CONNECT_HACK_BASE_CLASS public wxEvtHandler,
+    #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS : public wxEvtHandler
+    #define wxBIND_OR_CONNECT_HACK(w, evt, handler, func, obj) \
+        win->Connect(evt, handler(func), NULL, obj)
+#else // wxEVENTS_COMPATIBILITY_2_8
+    #define wxBIND_OR_CONNECT_HACK_BASE_CLASS
+    #define wxBIND_OR_CONNECT_HACK_ONLY_BASE_CLASS
+    #define wxBIND_OR_CONNECT_HACK(w, evt, handler, func, obj) \
+        win->Bind(evt, &func, obj)
+#endif // wxEVENTS_COMPATIBILITY_2_8/!wxEVENTS_COMPATIBILITY_2_8
+

 #if wxUSE_GUI
 
 // Find a window with the focus, that is also a descendant of the given window.
 #if wxUSE_GUI
 
 // Find a window with the focus, that is also a descendant of the given window.