A bugfix in the wxTreeCtrl.GetItem wrapper

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

diff --git a/include/wx/event.h b/include/wx/event.h
index 3ba1b9258a5e39e3c886b33c9eb6c4ac807ce88c..900014b7d460fbd46d96d31e64b295a38a824c50 100644 (file)
--- a/include/wx/event.h
+++ b/include/wx/event.h
@@ -23,9 +23,7 @@
     #include "wx/gdicmn.h"
 #endif
 
     #include "wx/gdicmn.h"
 #endif
 

-#if wxUSE_THREADS
-    #include "wx/thread.h"
-#endif
+#include "wx/thread.h"

 
 // ----------------------------------------------------------------------------
 // forward declarations
 
 // ----------------------------------------------------------------------------
 // forward declarations


@@ -68,6 +66,7 @@ const wxEventType wxEVT_COMMAND_VLBOX_SELECTED =            wxEVT_FIRST + 14;
 const wxEventType wxEVT_COMMAND_COMBOBOX_SELECTED =         wxEVT_FIRST + 15;
 const wxEventType wxEVT_COMMAND_TOOL_RCLICKED =             wxEVT_FIRST + 16;
 const wxEventType wxEVT_COMMAND_TOOL_ENTER =                wxEVT_FIRST + 17;
 const wxEventType wxEVT_COMMAND_COMBOBOX_SELECTED =         wxEVT_FIRST + 15;
 const wxEventType wxEVT_COMMAND_TOOL_RCLICKED =             wxEVT_FIRST + 16;
 const wxEventType wxEVT_COMMAND_TOOL_ENTER =                wxEVT_FIRST + 17;

+const wxEventType wxEVT_COMMAND_SPINCTRL_UPDATED =          wxEVT_FIRST + 18;

 
 /* Sockets send events, too */
 const wxEventType wxEVT_SOCKET =                            wxEVT_FIRST + 50;
 
 /* Sockets send events, too */
 const wxEventType wxEVT_SOCKET =                            wxEVT_FIRST + 50;


@@ -206,6 +205,8 @@ const wxEventType wxEVT_COMMAND_TREE_SEL_CHANGED =          wxEVT_FIRST + 611;
 const wxEventType wxEVT_COMMAND_TREE_SEL_CHANGING =         wxEVT_FIRST + 612;
 const wxEventType wxEVT_COMMAND_TREE_KEY_DOWN =             wxEVT_FIRST + 613;
 const wxEventType wxEVT_COMMAND_TREE_ITEM_ACTIVATED =       wxEVT_FIRST + 614;
 const wxEventType wxEVT_COMMAND_TREE_SEL_CHANGING =         wxEVT_FIRST + 612;
 const wxEventType wxEVT_COMMAND_TREE_KEY_DOWN =             wxEVT_FIRST + 613;
 const wxEventType wxEVT_COMMAND_TREE_ITEM_ACTIVATED =       wxEVT_FIRST + 614;

+const wxEventType wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK =     wxEVT_FIRST + 615;
+const wxEventType wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK =    wxEVT_FIRST + 616;

 
  /* List control event types */
 const wxEventType wxEVT_COMMAND_LIST_BEGIN_DRAG =           wxEVT_FIRST + 700;
 
  /* List control event types */
 const wxEventType wxEVT_COMMAND_LIST_BEGIN_DRAG =           wxEVT_FIRST + 700;


@@ -506,7 +507,7 @@ public:
     void CopyObject(wxObject& object_dest) const;
 public:
     int               m_commandInt;    // Additional information
     void CopyObject(wxObject& object_dest) const;
 public:
     int               m_commandInt;    // Additional information

-    long              m_extraLong;     
+    long              m_extraLong;

 };
 
 // Mouse event class
 };
 
 // Mouse event class


@@ -605,8 +606,23 @@ public:
     bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); }
 
     // Find the position of the event
     bool Leaving() const { return (m_eventType == wxEVT_LEAVE_WINDOW); }
 
     // Find the position of the event

-    void GetPosition(long *xpos, long *ypos) const { *xpos = m_x; *ypos = m_y; }
-    void Position(long *xpos, long *ypos) const { *xpos = m_x; *ypos = m_y; }
+    void GetPosition(wxCoord *xpos, wxCoord *ypos) const
+    {
+        if (xpos)
+            *xpos = m_x;
+        if (ypos)
+            *ypos = m_y;
+    }
+
+#ifndef __WIN16__
+    void GetPosition(long *xpos, long *ypos) const
+    {
+        if (xpos)
+            *xpos = (long)m_x;
+        if (ypos)
+            *ypos = (long)m_y;
+    }
+#endif

 
     // Find the position of the event
     wxPoint GetPosition() const { return wxPoint(m_x, m_y); }
 
     // Find the position of the event
     wxPoint GetPosition() const { return wxPoint(m_x, m_y); }


@@ -616,6 +632,14 @@ public:
 
     // Compatibility
 #if WXWIN_COMPATIBILITY
 
     // Compatibility
 #if WXWIN_COMPATIBILITY

+    void Position(long *xpos, long *ypos) const
+    {
+        if (xpos)
+            *xpos = (long)m_x;
+        if (ypos)
+            *ypos = (long)m_y;
+    }
+

     void Position(float *xpos, float *ypos) const
     {
         *xpos = (float) m_x; *ypos = (float) m_y;
     void Position(float *xpos, float *ypos) const
     {
         *xpos = (float) m_x; *ypos = (float) m_y;


@@ -631,8 +655,8 @@ public:
     void CopyObject(wxObject& obj) const;
 
 public:
     void CopyObject(wxObject& obj) const;
 
 public:

-    long          m_x;
-    long          m_y;
+    wxCoord m_x, m_y;
+

     bool          m_leftDown;
     bool          m_middleDown;
     bool          m_rightDown;
     bool          m_leftDown;
     bool          m_middleDown;
     bool          m_rightDown;


@@ -667,24 +691,36 @@ public:
     long KeyCode() const { return m_keyCode; }
 
     // Find the position of the event
     long KeyCode() const { return m_keyCode; }
 
     // Find the position of the event

+    void GetPosition(wxCoord *xpos, wxCoord *ypos) const
+    {
+        if (xpos) *xpos = m_x;
+        if (ypos) *ypos = m_y;
+    }
+
+#ifndef __WIN16__

     void GetPosition(long *xpos, long *ypos) const
     void GetPosition(long *xpos, long *ypos) const

-        { *xpos = m_x; *ypos = m_y; }
+    {
+        if (xpos) *xpos = (long)m_x;
+        if (ypos) *ypos = (long)m_y;
+    }
+#endif

 
     wxPoint GetPosition() const
         { return wxPoint(m_x, m_y); }
 
     // Get X position
 
     wxPoint GetPosition() const
         { return wxPoint(m_x, m_y); }
 
     // Get X position

-    long GetX() const { return m_x; }
+    wxCoord GetX() const { return m_x; }

 
     // Get Y position
 
     // Get Y position

-    long GetY() const { return m_y; }
+    wxCoord GetY() const { return m_y; }

 
     void CopyObject(wxObject& obj) const;
 
 public:
 
     void CopyObject(wxObject& obj) const;
 
 public:

-    long          m_x;
-    long          m_y;
+    wxCoord       m_x, m_y;
+

     long          m_keyCode;
     long          m_keyCode;

+

     bool          m_controlDown;
     bool          m_shiftDown;
     bool          m_altDown;
     bool          m_controlDown;
     bool          m_shiftDown;
     bool          m_altDown;


@@ -1279,6 +1315,10 @@ protected:
  wxEVT_COMPARE_ITEM
 */
 
  wxEVT_COMPARE_ITEM
 */
 

+// ============================================================================
+// event handler and related classes
+// ============================================================================
+

 typedef void (wxObject::*wxObjectEventFunction)(wxEvent&);
 
 struct WXDLLEXPORT wxEventTableEntry
 typedef void (wxObject::*wxObjectEventFunction)(wxEvent&);
 
 struct WXDLLEXPORT wxEventTableEntry


@@ -1312,31 +1352,22 @@ public:
     void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
     void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
 
     void SetNextHandler(wxEvtHandler *handler) { m_nextHandler = handler; }
     void SetPreviousHandler(wxEvtHandler *handler) { m_previousHandler = handler; }
 

-    void SetEvtHandlerEnabled(bool en) { m_enabled = en; }
+    void SetEvtHandlerEnabled(bool enabled) { m_enabled = enabled; }

     bool GetEvtHandlerEnabled() const { return m_enabled; }
 
     bool GetEvtHandlerEnabled() const { return m_enabled; }
 

-#if WXWIN_COMPATIBILITY_2
-    virtual void OnCommand(wxWindow& WXUNUSED(win),
-                           wxCommandEvent& WXUNUSED(event))
-    {
-        wxFAIL_MSG(wxT("shouldn't be called any more"));
-    }
+    // process an event right now
+    virtual bool ProcessEvent(wxEvent& event);

 
 

-    // Called if child control has no callback function
-    virtual long Default()
-        { return GetNextHandler() ? GetNextHandler()->Default() : 0; };
-#endif // WXWIN_COMPATIBILITY_2
+    // add an event to be processed later
+    void AddPendingEvent(wxEvent& event);

 
 

-#if WXWIN_COMPATIBILITY
-    virtual bool OnClose();
-#endif
+    // process all pending events
+    void ProcessPendingEvents();

 
 

+    // add a

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

-    void ProcessPendingEvents();

 #endif
 #endif

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

 
     // Dynamic association of a member function handler with the event handler,
     // id and event type
 
     // Dynamic association of a member function handler with the event handler,
     // id and event type


@@ -1350,14 +1381,50 @@ public:
                   wxObject *userData = (wxObject *) NULL )
         { Connect(id, -1, eventType, func, userData); }
 
                   wxObject *userData = (wxObject *) NULL )
         { Connect(id, -1, eventType, func, userData); }
 

+    bool Disconnect( int id, int lastId = -1, wxEventType eventType = wxEVT_NULL,
+                  wxObjectEventFunction func = NULL,
+                  wxObject *userData = (wxObject *) NULL );
+
+    // Convenience function: take just one id
+    bool Disconnect( int id, wxEventType eventType = wxEVT_NULL,
+                  wxObjectEventFunction func = NULL,
+                  wxObject *userData = (wxObject *) NULL )
+        { return Disconnect(id, -1, eventType, func, userData); }
+       
+    // implementation from now on
+    virtual bool SearchEventTable(wxEventTable& table, wxEvent& event);

     bool SearchDynamicEventTable( wxEvent& event );
 
 #if wxUSE_THREADS
     bool SearchDynamicEventTable( wxEvent& event );
 
 #if wxUSE_THREADS

-    void ClearEventLocker() { delete m_eventsLocker; m_eventsLocker = NULL; };
+    void ClearEventLocker()
+   {
+#  if !defined(__VISAGECPP__)
+      delete m_eventsLocker;
+      m_eventsLocker = NULL;
+#endif
+   };
+#endif
+
+    // old stuff
+
+#if WXWIN_COMPATIBILITY_2
+    virtual void OnCommand(wxWindow& WXUNUSED(win),
+                           wxCommandEvent& WXUNUSED(event))
+    {
+        wxFAIL_MSG(wxT("shouldn't be called any more"));
+    }
+
+    // Called if child control has no callback function
+    virtual long Default()
+        { return GetNextHandler() ? GetNextHandler()->Default() : 0; };
+#endif // WXWIN_COMPATIBILITY_2
+
+#if WXWIN_COMPATIBILITY
+    virtual bool OnClose();

 #endif
 
 private:
 #endif
 
 private:

-    static const wxEventTableEntry         sm_eventTableEntries[];
+    static const wxEventTableEntry sm_eventTableEntries[];

 
 protected:
     static const wxEventTable sm_eventTable;
 
 protected:
     static const wxEventTable sm_eventTable;


@@ -1367,16 +1434,22 @@ protected:
 protected:
     wxEvtHandler*       m_nextHandler;
     wxEvtHandler*       m_previousHandler;
 protected:
     wxEvtHandler*       m_nextHandler;
     wxEvtHandler*       m_previousHandler;

-    bool                m_enabled;           // Is event handler enabled?

     wxList*             m_dynamicEvents;
     wxList*             m_pendingEvents;
 #if wxUSE_THREADS
     wxList*             m_dynamicEvents;
     wxList*             m_pendingEvents;
 #if wxUSE_THREADS

+#if defined (__VISAGECPP__)
+    wxCriticalSection   m_eventsLocker;
+#  else

     wxCriticalSection*  m_eventsLocker;
     wxCriticalSection*  m_eventsLocker;

+#  endif

 #endif
 
     // optimization: instead of using costly IsKindOf() to decide whether we're
     // a window (which is true in 99% of cases), use this flag
     bool                m_isWindow;
 #endif
 
     // optimization: instead of using costly IsKindOf() to decide whether we're
     // a window (which is true in 99% of cases), use this flag
     bool                m_isWindow;

+
+    // Is event handler enabled?
+    bool                m_enabled;

 };
 
 typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);
 };
 
 typedef void (wxEvtHandler::*wxEventFunction)(wxEvent&);


@@ -1577,6 +1650,7 @@ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, fn) { wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
 #define EVT_TOOL_ENTER(id, fn) { wxEVT_COMMAND_TOOL_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
 #define EVT_CHECKLISTBOX(id, fn) { wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
 #define EVT_TOOL_RCLICKED_RANGE(id1, id2, fn) { wxEVT_COMMAND_TOOL_RCLICKED, id1, id2, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
 #define EVT_TOOL_ENTER(id, fn) { wxEVT_COMMAND_TOOL_ENTER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
 #define EVT_CHECKLISTBOX(id, fn) { wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },

+#define EVT_SPINCTRL(id, fn) { wxEVT_COMMAND_SPINCTRL_UPDATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },

 
 // Generic command events
 #define EVT_COMMAND_LEFT_CLICK(id, fn) { wxEVT_COMMAND_LEFT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },
 
 // Generic command events
 #define EVT_COMMAND_LEFT_CLICK(id, fn) { wxEVT_COMMAND_LEFT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) & fn, (wxObject *) NULL },


@@ -1612,6 +1686,17 @@ const wxEventTableEntry theClass::sm_eventTableEntries[] = { \
 #define EVT_UPDATE_UI(id, func) \
  { wxEVT_UPDATE_UI, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxUpdateUIEventFunction) & func, (wxObject *) NULL },\
 
 #define EVT_UPDATE_UI(id, func) \
  { wxEVT_UPDATE_UI, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxUpdateUIEventFunction) & func, (wxObject *) NULL },\
 

+// ----------------------------------------------------------------------------
+// Global data
+// ----------------------------------------------------------------------------
+
+// for pending event processing - notice that there is intentionally no
+// WXDLLEXPORT here
+extern wxList *wxPendingEvents;
+#if wxUSE_THREADS
+    extern wxCriticalSection *wxPendingEventsLocker;
+#endif
+

 // ----------------------------------------------------------------------------
 // Helper functions
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Helper functions
 // ----------------------------------------------------------------------------