fix wxSocket notifications under MSW after the last change

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

diff --git a/include/wx/event.h b/include/wx/event.h
index 68089351630b48e44a5a9a1078f83666ffba96bd..23f1f353766161d4875c69aec522820da80267c2 100644 (file)
--- a/include/wx/event.h
+++ b/include/wx/event.h
@@ -20,6 +20,7 @@
 #if wxUSE_GUI
     #include "wx/gdicmn.h"
     #include "wx/cursor.h"
 #if wxUSE_GUI
     #include "wx/gdicmn.h"
     #include "wx/cursor.h"

+    #include "wx/mousestate.h"

 #endif
 
 #include "wx/dynarray.h"
 #endif
 
 #include "wx/dynarray.h"


@@ -38,7 +39,24 @@ class WXDLLIMPEXP_FWD_BASE wxList;
     class WXDLLIMPEXP_FWD_CORE wxWindowBase;
 #endif // wxUSE_GUI
 
     class WXDLLIMPEXP_FWD_CORE wxWindowBase;
 #endif // wxUSE_GUI
 

-class WXDLLIMPEXP_FWD_BASE wxEvtHandler;
+// We operate with pointer to members of wxEvtHandler (such functions are used
+// as event handlers in the event tables or as arguments to Connect()) but by
+// default MSVC uses a restricted (but more efficient) representation of
+// pointers to members which can't deal with multiple base classes. To avoid
+// mysterious (as the compiler is not good enough to detect this and give a
+// sensible error message) errors in the user code as soon as it defines
+// classes inheriting from both wxEvtHandler (possibly indirectly, e.g. via
+// wxWindow) and something else (including our own wxTrackable but not limited
+// to it), we use the special MSVC keyword telling the compiler to use a more
+// general pointer to member representation for the classes inheriting from
+// wxEvtHandler.
+#ifdef __VISUALC__
+    #define wxMSVC_FWD_MULTIPLE_BASES __multiple_inheritance
+#else
+    #define wxMSVC_FWD_MULTIPLE_BASES
+#endif
+
+class WXDLLIMPEXP_FWD_BASE wxMSVC_FWD_MULTIPLE_BASES wxEvtHandler;

 class wxEventConnectionRef;
 
 // ----------------------------------------------------------------------------
 class wxEventConnectionRef;
 
 // ----------------------------------------------------------------------------


@@ -51,7 +69,7 @@ typedef int wxEventType;
 
 // this is used to make the event table entry type safe, so that for an event
 // handler only a function with proper parameter list can be given.
 
 // this is used to make the event table entry type safe, so that for an event
 // handler only a function with proper parameter list can be given.

-#define wxStaticCastEvent(type, val) wx_static_cast(type, val)
+#define wxStaticCastEvent(type, val) static_cast<type>(val)

 
 #define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
     wxEventTableEntry(type, winid, idLast, fn, obj)
 
 #define DECLARE_EVENT_TABLE_ENTRY(type, winid, idLast, fn, obj) \
     wxEventTableEntry(type, winid, idLast, fn, obj)


@@ -278,12 +296,6 @@ enum Propagation_state
 
 class WXDLLIMPEXP_BASE wxEvent : public wxObject
 {
 
 class WXDLLIMPEXP_BASE wxEvent : public wxObject
 {

-private:
-    wxEvent& operator=(const wxEvent&);
-
-protected:
-    wxEvent(const wxEvent&);                   // for implementing Clone()
-

 public:
     wxEvent(int winid = 0, wxEventType commandType = wxEVT_NULL );
 
 public:
     wxEvent(int winid = 0, wxEventType commandType = wxEVT_NULL );
 


@@ -350,10 +362,13 @@ protected:
     // backwards compatibility as it is new
     int               m_propagationLevel;
 
     // backwards compatibility as it is new
     int               m_propagationLevel;
 

-protected:

     bool              m_skipped;
     bool              m_isCommandEvent;
 
     bool              m_skipped;
     bool              m_isCommandEvent;
 

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

 private:
     // it needs to access our m_propagationLevel
     friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce;
 private:
     // it needs to access our m_propagationLevel
     friend class WXDLLIMPEXP_FWD_BASE wxPropagateOnce;


@@ -627,12 +642,17 @@ enum
     wxMOUSE_BTN_MAX
 };
 
     wxMOUSE_BTN_MAX
 };
 

-class WXDLLIMPEXP_CORE wxMouseEvent : public wxEvent
+class WXDLLIMPEXP_CORE wxMouseEvent : public wxEvent,
+                                      public wxMouseState

 {
 public:
     wxMouseEvent(wxEventType mouseType = wxEVT_NULL);
 {
 public:
     wxMouseEvent(wxEventType mouseType = wxEVT_NULL);

-    wxMouseEvent(const wxMouseEvent& event) : wxEvent(event)
-        { Assign(event); }
+    wxMouseEvent(const wxMouseEvent& event)
+        : wxEvent(event),
+          wxMouseState(event)
+    {
+        Assign(event);
+    }

 
     // Was it a button event? (*doesn't* mean: is any button *down*?)
     bool IsButton() const { return Button(wxMOUSE_BTN_ANY); }
 
     // Was it a button event? (*doesn't* mean: is any button *down*?)
     bool IsButton() const { return Button(wxMOUSE_BTN_ANY); }


@@ -655,20 +675,6 @@ public:
     // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
     int GetButton() const;
 
     // Get the button which is changing state (wxMOUSE_BTN_NONE if none)
     int GetButton() const;
 

-    // Find state of shift/control keys
-    bool ControlDown() const { return m_controlDown; }
-    bool MetaDown() const { return m_metaDown; }
-    bool AltDown() const { return m_altDown; }
-    bool ShiftDown() const { return m_shiftDown; }
-    bool CmdDown() const
-    {
-#if defined(__WXMAC__) || defined(__WXCOCOA__)
-        return MetaDown();
-#else
-        return ControlDown();
-#endif
-    }
-

     // Find which event was just generated
     bool LeftDown() const { return (m_eventType == wxEVT_LEFT_DOWN); }
     bool MiddleDown() const { return (m_eventType == wxEVT_MIDDLE_DOWN); }
     // Find which event was just generated
     bool LeftDown() const { return (m_eventType == wxEVT_LEFT_DOWN); }
     bool MiddleDown() const { return (m_eventType == wxEVT_MIDDLE_DOWN); }


@@ -775,7 +781,12 @@ public:
 
     virtual wxEvent *Clone() const { return new wxMouseEvent(*this); }
 
 
     virtual wxEvent *Clone() const { return new wxMouseEvent(*this); }
 

-    wxMouseEvent& operator=(const wxMouseEvent& event) { if (&event != this) Assign(event); return *this; }
+    wxMouseEvent& operator=(const wxMouseEvent& event)
+    {
+        if (&event != this)
+            Assign(event);
+        return *this;
+    }

 
 public:
     wxCoord m_x, m_y;
 
 public:
     wxCoord m_x, m_y;


@@ -786,11 +797,6 @@ public:
     bool          m_aux1Down;
     bool          m_aux2Down;
 
     bool          m_aux1Down;
     bool          m_aux2Down;
 

-    bool          m_controlDown;
-    bool          m_shiftDown;
-    bool          m_altDown;
-    bool          m_metaDown;
-

     int           m_clickCount;
 
     int           m_wheelAxis;
     int           m_clickCount;
 
     int           m_wheelAxis;


@@ -853,48 +859,13 @@ private:
  wxEVT_HOTKEY
  */
 
  wxEVT_HOTKEY
  */
 

-class WXDLLIMPEXP_CORE wxKeyEvent : public wxEvent
+class WXDLLIMPEXP_CORE wxKeyEvent : public wxEvent,
+                                    public wxKeyboardState

 {
 public:
     wxKeyEvent(wxEventType keyType = wxEVT_NULL);
     wxKeyEvent(const wxKeyEvent& evt);
 
 {
 public:
     wxKeyEvent(wxEventType keyType = wxEVT_NULL);
     wxKeyEvent(const wxKeyEvent& evt);
 

-    // can be used check if the key event has exactly the given modifiers:
-    // "GetModifiers() = wxMOD_CONTROL" is easier to write than "ControlDown()
-    // && !MetaDown() && !AltDown() && !ShiftDown()"
-    int GetModifiers() const
-    {
-        return (m_controlDown ? wxMOD_CONTROL : 0) |
-               (m_shiftDown ? wxMOD_SHIFT : 0) |
-               (m_metaDown ? wxMOD_META : 0) |
-               (m_altDown ? wxMOD_ALT : 0);
-    }
-
-    // Find state of shift/control keys
-    bool ControlDown() const { return m_controlDown; }
-    bool ShiftDown() const { return m_shiftDown; }
-    bool MetaDown() const { return m_metaDown; }
-    bool AltDown() const { return m_altDown; }
-
-    // "Cmd" is a pseudo key which is Control for PC and Unix platforms but
-    // Apple ("Command") key under Macs: it makes often sense to use it instead
-    // of, say, ControlDown() because Cmd key is used for the same thing under
-    // Mac as Ctrl elsewhere (but Ctrl still exists, just not used for this
-    // purpose under Mac)
-    bool CmdDown() const
-    {
-#if defined(__WXMAC__) || defined(__WXCOCOA__)
-        return MetaDown();
-#else
-        return ControlDown();
-#endif
-    }
-
-    // exclude MetaDown() from HasModifiers() because NumLock under X is often
-    // configured as mod2 modifier, yet the key events even when it is pressed
-    // should be processed normally, not like Ctrl- or Alt-key
-    bool HasModifiers() const { return ControlDown() || AltDown(); }
-

     // get the key code: an ASCII7 char or an element of wxKeyCode enum
     int GetKeyCode() const { return (int)m_keyCode; }
 
     // get the key code: an ASCII7 char or an element of wxKeyCode enum
     int GetKeyCode() const { return (int)m_keyCode; }
 


@@ -937,17 +908,19 @@ public:
     // example)
     wxKeyEvent& operator=(const wxKeyEvent& evt)
     {
     // example)
     wxKeyEvent& operator=(const wxKeyEvent& evt)
     {

-        if (&evt != this)
+        if ( &evt != this )

         {
         {

+            wxEvent::operator=(evt);
+
+            // Borland C++ 5.82 doesn't compile an explicit call to an
+            // implicitly defined operator=() so need to do it this way:
+            *static_cast<wxKeyboardState *>(this) = evt;
+

             m_x = evt.m_x;
             m_y = evt.m_y;
 
             m_keyCode = evt.m_keyCode;
 
             m_x = evt.m_x;
             m_y = evt.m_y;
 
             m_keyCode = evt.m_keyCode;
 

-            m_controlDown = evt.m_controlDown;
-            m_shiftDown = evt.m_shiftDown;
-            m_altDown = evt.m_altDown;
-            m_metaDown = evt.m_metaDown;

             m_scanCode = evt.m_scanCode;
             m_rawCode = evt.m_rawCode;
             m_rawFlags = evt.m_rawFlags;
             m_scanCode = evt.m_scanCode;
             m_rawCode = evt.m_rawCode;
             m_rawFlags = evt.m_rawFlags;


@@ -963,12 +936,6 @@ public:
 
     long          m_keyCode;
 
 
     long          m_keyCode;
 

-    // TODO: replace those with a single m_modifiers bitmask of wxMOD_XXX?
-    bool          m_controlDown;
-    bool          m_shiftDown;
-    bool          m_altDown;
-    bool          m_metaDown;
-

     // FIXME: what is this for? relation to m_rawXXX?
     bool          m_scanCode;
 
     // FIXME: what is this for? relation to m_rawXXX?
     bool          m_scanCode;
 


@@ -1349,7 +1316,13 @@ public:
     { m_show = event.m_show; }
 
     void SetShow(bool show) { m_show = show; }
     { m_show = event.m_show; }
 
     void SetShow(bool show) { m_show = show; }

-    bool GetShow() const { return m_show; }
+
+    // return true if the window was shown, false if hidden
+    bool IsShown() const { return m_show; }
+
+#if WXWIN_COMPATIBILITY_2_8
+    wxDEPRECATED( bool GetShow() const { return IsShown(); } )
+#endif

 
     virtual wxEvent *Clone() const { return new wxShowEvent(*this); }
 
 
     virtual wxEvent *Clone() const { return new wxShowEvent(*this); }
 


@@ -1374,8 +1347,11 @@ public:
         : wxEvent(event)
     { m_iconized = event.m_iconized; }
 
         : wxEvent(event)
     { m_iconized = event.m_iconized; }
 

+#if WXWIN_COMPATIBILITY_2_8
+    wxDEPRECATED( bool Iconized() const { return IsIconized(); } )
+#endif

     // return true if the frame was iconized, false if restored
     // return true if the frame was iconized, false if restored

-    bool Iconized() const { return m_iconized; }
+    bool IsIconized() const { return m_iconized; }

 
     virtual wxEvent *Clone() const { return new wxIconizeEvent(*this); }
 
 
     virtual wxEvent *Clone() const { return new wxIconizeEvent(*this); }
 


@@ -2098,10 +2074,16 @@ private:
 // event handler and related classes
 // ============================================================================
 
 // event handler and related classes
 // ============================================================================
 

-// for backwards compatibility and to prevent eVC 4 for ARM from crashing with
-// internal compiler error when compiling wx, we define wxObjectEventFunction
-// as a wxObject method even though it can only be a wxEvtHandler one
-typedef void (wxObject::*wxObjectEventFunction)(wxEvent&);
+typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
+
+// We had some trouble (specifically with eVC for ARM WinCE build) with using
+// wxEventFunction in the past so we had introduced wxObjectEventFunction which
+// used to be a typedef for a member of wxObject and not wxEvtHandler to work
+// around this but as eVC is not really supported any longer we now only keep
+// this for backwards compatibility and, despite its name, this is a typedef
+// for wxEvtHandler member now -- but if we have the same problem with another
+// compiler we can restore its old definition for it.
+typedef wxEventFunction wxObjectEventFunction;

 
 // struct containing the members common to static and dynamic event tables
 // entries
 
 // struct containing the members common to static and dynamic event tables
 // entries


@@ -2315,21 +2297,21 @@ public:
     // winid and event type
     void Connect(int winid,
                  int lastId,
     // winid and event type
     void Connect(int winid,
                  int lastId,

-                 int eventType,
+                 wxEventType eventType,

                  wxObjectEventFunction func,
                  wxObject *userData = (wxObject *) NULL,
                  wxEvtHandler *eventSink = (wxEvtHandler *) NULL);
 
     // Convenience function: take just one id
     void Connect(int winid,
                  wxObjectEventFunction func,
                  wxObject *userData = (wxObject *) NULL,
                  wxEvtHandler *eventSink = (wxEvtHandler *) NULL);
 
     // Convenience function: take just one id
     void Connect(int winid,

-                 int eventType,
+                 wxEventType eventType,

                  wxObjectEventFunction func,
                  wxObject *userData = (wxObject *) NULL,
                  wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
         { Connect(winid, wxID_ANY, eventType, func, userData, eventSink); }
 
     // Even more convenient: without id (same as using id of wxID_ANY)
                  wxObjectEventFunction func,
                  wxObject *userData = (wxObject *) NULL,
                  wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
         { Connect(winid, wxID_ANY, eventType, func, userData, eventSink); }
 
     // Even more convenient: without id (same as using id of wxID_ANY)

-    void Connect(int eventType,
+    void Connect(wxEventType eventType,

                  wxObjectEventFunction func,
                  wxObject *userData = (wxObject *) NULL,
                  wxEvtHandler *eventSink = (wxEvtHandler *) NULL)
                  wxObjectEventFunction func,
                  wxObject *userData = (wxObject *) NULL,
                  wxEvtHandler *eventSink = (wxEvtHandler *) NULL)


@@ -2364,6 +2346,10 @@ public:
     void SetClientData( void *data ) { DoSetClientData(data); }
     void *GetClientData() const { return DoGetClientData(); }
 
     void SetClientData( void *data ) { DoSetClientData(data); }
     void *GetClientData() const { return DoGetClientData(); }
 

+
+    // 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 and call the
     // handler if it does
     //


@@ -2373,7 +2359,6 @@ public:
                                       wxEvtHandler *handler,
                                       wxEvent& event);
 
                                       wxEvtHandler *handler,
                                       wxEvent& event);
 

-    // implementation from now on

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


@@ -2381,6 +2366,20 @@ public:
     void ClearEventHashTable() { GetEventHashTable().Clear(); }
     void OnSinkDestroyed( wxEvtHandler *sink );
 
     void ClearEventHashTable() { GetEventHashTable().Clear(); }
     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.
+    //
+    // 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.
+    bool ProcessEventHere(wxEvent& event);
+
+

 private:
     static const wxEventTableEntry sm_eventTableEntries[];
 
 private:
     static const wxEventTableEntry sm_eventTableEntries[];