Add wxDataFormat GetMatchingPair() which wxGTK and wxMSW already had under different...

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

diff --git a/include/wx/event.h b/include/wx/event.h
index 6c77cf54677446123fb30377b153cc4a3441078f..42c5406b1398372c6c3e48f4d27449be8f3b3a0f 100644 (file)
--- a/include/wx/event.h
+++ b/include/wx/event.h
@@ -94,6 +94,11 @@ typedef int wxEventType;
 // generate a new unique event type
 extern WXDLLIMPEXP_BASE wxEventType wxNewEventType();
 
 // generate a new unique event type
 extern WXDLLIMPEXP_BASE wxEventType wxNewEventType();
 

+// FIXME: currently the new events code is disabled because it creates too
+//        many problems, it should be reenabled a.s.a.p. or removed
+#undef wxEVENTS_COMPATIBILITY_2_8
+#define wxEVENTS_COMPATIBILITY_2_8 1
+

 // macros to create an event type depending on whether type safe events are
 // enabled.
 
 // macros to create an event type depending on whether type safe events are
 // enabled.
 


@@ -105,10 +110,10 @@ extern WXDLLIMPEXP_BASE wxEventType wxNewEventType();
         extern const expdecl wxEventType name;
 
     #define wxDEFINE_EVENT_REFERENCE( name, type, value ) \
         extern const expdecl wxEventType name;
 
     #define wxDEFINE_EVENT_REFERENCE( name, type, value ) \

-        const wxEventType &name( value );
+        const wxEventType& name = value;

 
     #define wxDECLARE_EXPORTED_EVENT_REFERENCE( expdecl, name, type ) \
 
     #define wxDECLARE_EXPORTED_EVENT_REFERENCE( expdecl, name, type ) \

-        extern const expdecl wxEventType &name;
+        extern const expdecl wxEventType& name;

 
     #define wxDECLARE_LOCAL_EVENT( name, type ) \
         wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )
 
     #define wxDECLARE_LOCAL_EVENT( name, type ) \
         wxDECLARE_EXPORTED_EVENT( wxEMPTY_PARAMETER_VALUE, name, type )


@@ -199,9 +204,12 @@ class WXDLLIMPEXP_BASE wxEventFunctor
 public:
     virtual ~wxEventFunctor();
 
 public:
     virtual ~wxEventFunctor();
 

+    // this operator is used to actually invoke the event handler

     virtual void operator()(wxEvtHandler *, wxEvent &) = 0;
 
     virtual void operator()(wxEvtHandler *, wxEvent &) = 0;
 

-    virtual bool operator==(const wxEventFunctor& other) const = 0;
+    // this function tests whether this functor is matched, for the purpose of
+    // finding it in an event table in Disconnect(), by the given func
+    virtual bool Matches(const wxEventFunctor& func) const = 0;

 
     virtual wxEvtHandler *GetHandler() const { return NULL; }
 
 
     virtual wxEvtHandler *GetHandler() const { return NULL; }
 


@@ -225,13 +233,12 @@ public:
         (realHandler->*m_method)(event);
     }
 
         (realHandler->*m_method)(event);
     }
 

-    virtual bool operator==(const wxEventFunctor& other) const
+    virtual bool Matches(const wxEventFunctor& other) const

     {
         wxEvtHandler * const handler = other.GetHandler();
     {
         wxEvtHandler * const handler = other.GetHandler();

-        const wxObjectEventFunction method = other.GetMethod();

 
         return (m_handler == handler || !handler) &&
 
         return (m_handler == handler || !handler) &&

-               (m_method == method || !method);
+               (m_method == other.GetMethod());

     }
 
     virtual wxEvtHandler *GetHandler() const { return m_handler; }
     }
 
     virtual wxEvtHandler *GetHandler() const { return m_handler; }


@@ -242,6 +249,25 @@ private:
     wxObjectEventFunction m_method;
 };
 
     wxObjectEventFunction m_method;
 };
 

+// Create a functor for the legacy events: handler can be NULL and its default
+// value is used by the event table macros
+
+inline wxObjectEventFunctor *
+wxNewEventFunctor(const wxEventType& WXUNUSED(evtType),
+                  wxObjectEventFunction method,
+                  wxEvtHandler *handler = NULL)
+{
+    return new wxObjectEventFunctor(method, handler);
+}
+
+inline wxObjectEventFunctor
+wxConstructEventFunctor(const wxEventType& WXUNUSED(evtType),
+                        wxObjectEventFunction method,
+                        wxEvtHandler *handler)
+{
+    return wxObjectEventFunctor(method, handler);
+}
+

 #if !wxEVENTS_COMPATIBILITY_2_8
 
 template <typename EventType>
 #if !wxEVENTS_COMPATIBILITY_2_8
 
 template <typename EventType>


@@ -262,7 +288,7 @@ public:
         ( *m_handler )( dynamic_cast< typename EventType::CorrespondingEvent & >( event ));
     }
 
         ( *m_handler )( dynamic_cast< typename EventType::CorrespondingEvent & >( event ));
     }
 

-    virtual bool operator == ( const wxEventFunctor &right ) const
+    virtual bool Matches( const wxEventFunctor &right ) const

     {
         wxEventFunctorFunction const &other = dynamic_cast< wxEventFunctorFunction const & >( right );
 
     {
         wxEventFunctorFunction const &other = dynamic_cast< wxEventFunctorFunction const & >( right );
 


@@ -307,7 +333,7 @@ public:
         ( realHandler->*m_method )( dynamic_cast< typename EventType::CorrespondingEvent & >( event ));
     }
 
         ( realHandler->*m_method )( dynamic_cast< typename EventType::CorrespondingEvent & >( event ));
     }
 

-    virtual bool operator == ( const wxEventFunctor &right ) const
+    virtual bool Matches( const wxEventFunctor &right ) const

     {
         wxEventFunctorMethod const &other = dynamic_cast< wxEventFunctorMethod const & >( right );
 
     {
         wxEventFunctorMethod const &other = dynamic_cast< wxEventFunctorMethod const & >( right );
 


@@ -355,7 +381,7 @@ public:
         m_functor( dynamic_cast< typename EventType::CorrespondingEvent & >( event ));
     }
 
         m_functor( dynamic_cast< typename EventType::CorrespondingEvent & >( event ));
     }
 

-    virtual bool operator == ( const wxEventFunctor &right ) const
+    virtual bool Matches( const wxEventFunctor &right ) const

     {
         wxEventFunctorAdapter const &other = dynamic_cast< wxEventFunctorAdapter const & >( right );
 
     {
         wxEventFunctorAdapter const &other = dynamic_cast< wxEventFunctorAdapter const & >( right );
 


@@ -366,28 +392,6 @@ private:
     Functor m_functor;
 };
 
     Functor m_functor;
 };
 

-#endif // wxEVENTS_COMPATIBILITY_2_8
-
-// Create a functor for the legacy events:
-
-inline wxObjectEventFunctor *
-wxNewEventFunctor(wxEventType WXUNUSED(evtType),
-                  wxObjectEventFunction method,
-                  wxEvtHandler *handler = NULL)
-{
-    return new wxObjectEventFunctor(method, handler);
-}
-
-inline wxObjectEventFunctor
-wxConstructEventFunctor(wxEventType WXUNUSED(evtType),
-                        wxObjectEventFunction method,
-                        wxEvtHandler *handler = NULL)
-{
-    return wxObjectEventFunctor(method, handler);
-}
-
-#if !wxEVENTS_COMPATIBILITY_2_8
-

 //
 // Create functors for the templatized events (needed in wxEvtHandler::Connect):
 //
 //
 // Create functors for the templatized events (needed in wxEvtHandler::Connect):
 //


@@ -714,7 +718,7 @@ public:
     void Skip(bool skip = true) { m_skipped = skip; }
     bool GetSkipped() const { return m_skipped; }
 
     void Skip(bool skip = true) { m_skipped = skip; }
     bool GetSkipped() const { return m_skipped; }
 

-    // this function is used to create a copy of the event polymorphically and
+    // This function is used to create a copy of the event polymorphically and

     // all derived classes must implement it because otherwise wxPostEvent()
     // for them wouldn't work (it needs to do a copy of the event)
     virtual wxEvent *Clone() const = 0;
     // all derived classes must implement it because otherwise wxPostEvent()
     // for them wouldn't work (it needs to do a copy of the event)
     virtual wxEvent *Clone() const = 0;


@@ -743,6 +747,20 @@ public:
         m_propagationLevel = propagationLevel;
     }
 
         m_propagationLevel = propagationLevel;
     }
 

+
+    // This is for internal use only and is only called by
+    // wxEvtHandler::ProcessEvent() to check whether it's the first time this
+    // event is being processed
+    bool WasProcessed()
+    {
+        if ( m_wasProcessed )
+            return true;
+
+        m_wasProcessed = true;
+
+        return false;
+    }
+

 protected:
     wxObject*         m_eventObject;
     wxEventType       m_eventType;
 protected:
     wxObject*         m_eventObject;
     wxEventType       m_eventType;


@@ -764,6 +782,12 @@ protected:
     bool              m_skipped;
     bool              m_isCommandEvent;
 
     bool              m_skipped;
     bool              m_isCommandEvent;
 

+    // initially false but becomes true as soon as WasProcessed() is called for
+    // the first time, as this is done only by ProcessEvent() it explains the
+    // variable name: it becomes true after ProcessEvent() was called at least
+    // once for this event
+    bool m_wasProcessed;
+

 protected:
     wxEvent(const wxEvent&);            // for implementing Clone()
     wxEvent& operator=(const wxEvent&); // for derived classes operator=()
 protected:
     wxEvent(const wxEvent&);            // for implementing Clone()
     wxEvent& operator=(const wxEvent&); // for derived classes operator=()


@@ -1495,7 +1519,7 @@ private:
 class WXDLLIMPEXP_CORE wxEraseEvent : public wxEvent
 {
 public:
 class WXDLLIMPEXP_CORE wxEraseEvent : public wxEvent
 {
 public:

-    wxEraseEvent(int Id = 0, wxDC *dc = (wxDC *) NULL)
+    wxEraseEvent(int Id = 0, wxDC *dc = NULL)

         : wxEvent(Id, wxEVT_ERASE_BACKGROUND),
           m_dc(dc)
         { }
         : wxEvent(Id, wxEVT_ERASE_BACKGROUND),
           m_dc(dc)
         { }


@@ -1890,7 +1914,7 @@ public:
 
     wxDropFilesEvent(wxEventType type = wxEVT_NULL,
                      int noFiles = 0,
 
     wxDropFilesEvent(wxEventType type = wxEVT_NULL,
                      int noFiles = 0,

-                     wxString *files = (wxString *) NULL)
+                     wxString *files = NULL)

         : wxEvent(0, type),
           m_noFiles(noFiles),
           m_pos(),
         : wxEvent(0, type),
           m_noFiles(noFiles),
           m_pos(),


@@ -2123,7 +2147,7 @@ class WXDLLIMPEXP_CORE wxPaletteChangedEvent : public wxEvent
 public:
     wxPaletteChangedEvent(wxWindowID winid = 0)
         : wxEvent(winid, wxEVT_PALETTE_CHANGED),
 public:
     wxPaletteChangedEvent(wxWindowID winid = 0)
         : wxEvent(winid, wxEVT_PALETTE_CHANGED),

-          m_changedWindow((wxWindow *) NULL)
+          m_changedWindow(NULL)

         { }
 
     wxPaletteChangedEvent(const wxPaletteChangedEvent& event)
         { }
 
     wxPaletteChangedEvent(const wxPaletteChangedEvent& event)


@@ -2184,7 +2208,7 @@ public:
     wxNavigationKeyEvent()
         : wxEvent(0, wxEVT_NAVIGATION_KEY),
           m_flags(IsForward | FromTab),    // defaults are for TAB
     wxNavigationKeyEvent()
         : wxEvent(0, wxEVT_NAVIGATION_KEY),
           m_flags(IsForward | FromTab),    // defaults are for TAB

-          m_focus((wxWindow *)NULL)
+          m_focus(NULL)

         {
             m_propagationLevel = wxEVENT_PROPAGATE_NONE;
         }
         {
             m_propagationLevel = wxEVENT_PROPAGATE_NONE;
         }


@@ -2695,8 +2719,8 @@ public:
                  int lastId,
                  wxEventType eventType,
                  wxObjectEventFunction func,
                  int lastId,
                  wxEventType eventType,
                  wxObjectEventFunction func,

-                 wxObject *userData = (wxObject *) NULL,
-                 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
+                 wxObject *userData = NULL,
+                 wxEvtHandler *eventSink = NULL)

     {
         wxObjectEventFunctor *functor = wxNewEventFunctor( eventType, func, eventSink );
 
     {
         wxObjectEventFunctor *functor = wxNewEventFunctor( eventType, func, eventSink );
 


@@ -2707,23 +2731,23 @@ public:
     void Connect(int winid,
                  wxEventType eventType,
                  wxObjectEventFunction func,
     void Connect(int winid,
                  wxEventType eventType,
                  wxObjectEventFunction func,

-                 wxObject *userData = (wxObject *) NULL,
-                 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
+                 wxObject *userData = NULL,
+                 wxEvtHandler *eventSink = NULL)

         { Connect(winid, wxID_ANY, eventType, func, userData, eventSink); }
 
     // Even more convenient: without id (same as using id of wxID_ANY)
     void Connect(wxEventType eventType,
                  wxObjectEventFunction func,
         { Connect(winid, wxID_ANY, eventType, func, userData, eventSink); }
 
     // Even more convenient: without id (same as using id of wxID_ANY)
     void Connect(wxEventType eventType,
                  wxObjectEventFunction func,

-                 wxObject *userData = (wxObject *) NULL,
-                 wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
+                 wxObject *userData = NULL,
+                 wxEvtHandler *eventSink = NULL)

         { Connect(wxID_ANY, wxID_ANY, eventType, func, userData, eventSink); }
 
     bool Disconnect(int winid,
                     int lastId,
                     wxEventType eventType,
                     wxObjectEventFunction func = NULL,
         { Connect(wxID_ANY, wxID_ANY, eventType, func, userData, eventSink); }
 
     bool Disconnect(int winid,
                     int lastId,
                     wxEventType eventType,
                     wxObjectEventFunction func = NULL,

-                    wxObject *userData = (wxObject *) NULL,
-                    wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
+                    wxObject *userData = NULL,
+                    wxEvtHandler *eventSink = NULL)

     {
         wxObjectEventFunctor functor = wxConstructEventFunctor( eventType, func, eventSink );
 
     {
         wxObjectEventFunctor functor = wxConstructEventFunctor( eventType, func, eventSink );
 


@@ -2733,14 +2757,14 @@ public:
     bool Disconnect(int winid = wxID_ANY,
                     wxEventType eventType = wxEVT_NULL,
                     wxObjectEventFunction func = NULL,
     bool Disconnect(int winid = wxID_ANY,
                     wxEventType eventType = wxEVT_NULL,
                     wxObjectEventFunction func = NULL,

-                    wxObject *userData = (wxObject *) NULL,
-                    wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
+                    wxObject *userData = NULL,
+                    wxEvtHandler *eventSink = NULL)

         { return Disconnect(winid, wxID_ANY, eventType, func, userData, eventSink); }
 
     bool Disconnect(wxEventType eventType,
                     wxObjectEventFunction func,
         { return Disconnect(winid, wxID_ANY, eventType, func, userData, eventSink); }
 
     bool Disconnect(wxEventType eventType,
                     wxObjectEventFunction func,

-                    wxObject *userData = (wxObject *) NULL,
-                    wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
+                    wxObject *userData = NULL,
+                    wxEvtHandler *eventSink = NULL)

         { return Disconnect(wxID_ANY, eventType, func, userData, eventSink); }
 
 
         { return Disconnect(wxID_ANY, eventType, func, userData, eventSink); }
 
 


@@ -3059,14 +3083,15 @@ public:
     // implementation from now on
     // --------------------------
 
     // implementation from now on
     // --------------------------
 

-    // check if the given event table entry matches this event and call the
-    // handler if it does
+    // check if the given event table entry matches this event by id (the check
+    // for the event type should be done by caller) and call the handler if it
+    // does

     //
     // return true if the event was processed, false otherwise (no match or the
     // handler decided to skip the event)
     //
     // return true if the event was processed, false otherwise (no match or the
     // handler decided to skip the event)

-    static bool ProcessEventIfMatches(const wxEventTableEntryBase& tableEntry,
-                                      wxEvtHandler *handler,
-                                      wxEvent& event);
+    static bool ProcessEventIfMatchesId(const wxEventTableEntryBase& tableEntry,
+                                        wxEvtHandler *handler,
+                                        wxEvent& event);

 
     virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
     bool SearchDynamicEventTable( wxEvent& event );
 
     virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);
     bool SearchDynamicEventTable( wxEvent& event );


@@ -3076,12 +3101,7 @@ public:
     void OnSinkDestroyed( wxEvtHandler *sink );
 
 
     void OnSinkDestroyed( wxEvtHandler *sink );
 
 

-    // The method processing the event in this event handler (or rather in this
-    // event handler chain as it also tries the next handler and so on), i.e.
-    // it returns true if we processed this event or false if we didn't but
-    // does not call TryParent() in the latter case. It also doesn't call
-    // wxApp::FilterEvent() before processing it, this is supposed to be done
-    // by the public ProcessEvent() only once for every event we handle.
+    // The method tries to process the event in this event handler.

     //
     // 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