]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/dnd.h
fixing overrelease and out-of-bounds write, fixes #13725
[wxWidgets.git] / include / wx / dnd.h
index d7a4010276efb8d0371c1da106ab2b65198a4fd6..ac3c9c4f8439188fe668e3ceeea491552e1d1a97 100644 (file)
@@ -5,17 +5,13 @@
 // Modified by:
 // Created:     26.05.99
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     26.05.99
 // RCS-ID:      $Id$
-// Copyright:   (c) wxWindows Team
+// Copyright:   (c) wxWidgets Team
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DND_H_BASE_
 #define _WX_DND_H_BASE_
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DND_H_BASE_
 #define _WX_DND_H_BASE_
 
-#if defined(__GNUG__) && !defined(__APPLE__)
-    #pragma interface "dndbase.h"
-#endif
-
 #include "wx/defs.h"
 
 #if wxUSE_DRAG_AND_DROP
 #include "wx/defs.h"
 
 #if wxUSE_DRAG_AND_DROP
@@ -49,17 +45,16 @@ enum wxDragResult
     wxDragCancel    // the operation was cancelled by user (not an error)
 };
 
     wxDragCancel    // the operation was cancelled by user (not an error)
 };
 
-inline WXDLLEXPORT bool wxIsDragResultOk(wxDragResult res)
-{
-    return res == wxDragCopy || res == wxDragMove || res == wxDragLink;
-}
+// return true if res indicates that something was done during a dnd operation,
+// i.e. is neither error nor none nor cancel
+WXDLLIMPEXP_CORE bool wxIsDragResultOk(wxDragResult res);
 
 // ----------------------------------------------------------------------------
 // wxDropSource is the object you need to create (and call DoDragDrop on it)
 // to initiate a drag-and-drop operation
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // wxDropSource is the object you need to create (and call DoDragDrop on it)
 // to initiate a drag-and-drop operation
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxDropSourceBase
+class WXDLLIMPEXP_CORE wxDropSourceBase
 {
 public:
     wxDropSourceBase(const wxCursor &cursorCopy = wxNullCursor,
 {
 public:
     wxDropSourceBase(const wxCursor &cursorCopy = wxNullCursor,
@@ -68,7 +63,7 @@ public:
         : m_cursorCopy(cursorCopy),
           m_cursorMove(cursorMove),
           m_cursorStop(cursorStop)
         : m_cursorCopy(cursorCopy),
           m_cursorMove(cursorMove),
           m_cursorStop(cursorStop)
-        { m_data = (wxDataObject *)NULL; }
+        { m_data = NULL; }
     virtual ~wxDropSourceBase() { }
 
     // set the data which is transfered by drag and drop
     virtual ~wxDropSourceBase() { }
 
     // set the data which is transfered by drag and drop
@@ -97,9 +92,9 @@ public:
     virtual wxDragResult DoDragDrop(int flags = wxDrag_CopyOnly) = 0;
 
     // override to give feedback depending on the current operation result
     virtual wxDragResult DoDragDrop(int flags = wxDrag_CopyOnly) = 0;
 
     // override to give feedback depending on the current operation result
-    // "effect" and return TRUE if you did something, FALSE to let the library
+    // "effect" and return true if you did something, false to let the library
     // give the default feedback
     // give the default feedback
-    virtual bool GiveFeedback(wxDragResult WXUNUSED(effect)) { return FALSE; }
+    virtual bool GiveFeedback(wxDragResult WXUNUSED(effect)) { return false; }
 
 protected:
     const wxCursor& GetCursor(wxDragResult res) const
 
 protected:
     const wxCursor& GetCursor(wxDragResult res) const
@@ -120,7 +115,7 @@ protected:
              m_cursorMove,
              m_cursorStop;
 
              m_cursorMove,
              m_cursorStop;
 
-    DECLARE_NO_COPY_CLASS(wxDropSourceBase)
+    wxDECLARE_NO_COPY_CLASS(wxDropSourceBase);
 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------
@@ -134,14 +129,14 @@ protected:
 // OnData() is called)
 // ----------------------------------------------------------------------------
 
 // OnData() is called)
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxDropTargetBase
+class WXDLLIMPEXP_CORE wxDropTargetBase
 {
 public:
     // ctor takes a pointer to heap-allocated wxDataObject which will be owned
     // by wxDropTarget and deleted by it automatically. If you don't give it
     // here, you can use SetDataObject() later.
 {
 public:
     // ctor takes a pointer to heap-allocated wxDataObject which will be owned
     // by wxDropTarget and deleted by it automatically. If you don't give it
     // here, you can use SetDataObject() later.
-    wxDropTargetBase(wxDataObject *dataObject = (wxDataObject*)NULL)
-        { m_dataObject = dataObject; }
+    wxDropTargetBase(wxDataObject *dataObject = NULL)
+        { m_dataObject = dataObject; m_defaultAction = wxDragNone; }
     // dtor deletes our data object
     virtual ~wxDropTargetBase()
         { delete m_dataObject; }
     // dtor deletes our data object
     virtual ~wxDropTargetBase()
         { delete m_dataObject; }
@@ -177,7 +172,7 @@ public:
     virtual void OnLeave() { }
 
     // this function is called when data is dropped at position (x, y) - if it
     virtual void OnLeave() { }
 
     // this function is called when data is dropped at position (x, y) - if it
-    // returns TRUE, OnData() will be called immediately afterwards which will
+    // returns true, OnData() will be called immediately afterwards which will
     // allow to retrieve the data dropped.
     virtual bool OnDrop(wxCoord x, wxCoord y) = 0;
 
     // allow to retrieve the data dropped.
     virtual bool OnDrop(wxCoord x, wxCoord y) = 0;
 
@@ -189,13 +184,26 @@ public:
     virtual wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def) = 0;
 
     // may be called *only* from inside OnData() and will fill m_dataObject
     virtual wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def) = 0;
 
     // may be called *only* from inside OnData() and will fill m_dataObject
-    // with the data from the drop source if it returns TRUE
+    // with the data from the drop source if it returns true
     virtual bool GetData() = 0;
 
     virtual bool GetData() = 0;
 
+    // sets the default action for drag and drop:
+    // use wxDragMove or wxDragCopy to set deafult action to move or copy
+    // and use wxDragNone (default) to set default action specified by
+    // initialization of draging (see wxDropSourceBase::DoDragDrop())
+    void SetDefaultAction(wxDragResult action)
+        { m_defaultAction = action; }
+
+    // returns default action for drag and drop or
+    // wxDragNone if this not specified
+    wxDragResult GetDefaultAction()
+        { return m_defaultAction; }
+
 protected:
     wxDataObject *m_dataObject;
 protected:
     wxDataObject *m_dataObject;
+    wxDragResult m_defaultAction;
 
 
-    DECLARE_NO_COPY_CLASS(wxDropTargetBase)
+    wxDECLARE_NO_COPY_CLASS(wxDropTargetBase);
 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------
@@ -209,10 +217,12 @@ protected:
     #include "wx/motif/dnd.h"
 #elif defined(__WXX11__)
     #include "wx/x11/dnd.h"
     #include "wx/motif/dnd.h"
 #elif defined(__WXX11__)
     #include "wx/x11/dnd.h"
-#elif defined(__WXGTK__)
+#elif defined(__WXGTK20__)
     #include "wx/gtk/dnd.h"
     #include "wx/gtk/dnd.h"
+#elif defined(__WXGTK__)
+    #include "wx/gtk1/dnd.h"
 #elif defined(__WXMAC__)
 #elif defined(__WXMAC__)
-    #include "wx/mac/dnd.h"
+    #include "wx/osx/dnd.h"
 #elif defined(__WXPM__)
     #include "wx/os2/dnd.h"
 #endif
 #elif defined(__WXPM__)
     #include "wx/os2/dnd.h"
 #endif
@@ -223,7 +233,7 @@ protected:
 
 // A simple wxDropTarget derived class for text data: you only need to
 // override OnDropText() to get something working
 
 // A simple wxDropTarget derived class for text data: you only need to
 // override OnDropText() to get something working
-class WXDLLEXPORT wxTextDropTarget : public wxDropTarget
+class WXDLLIMPEXP_CORE wxTextDropTarget : public wxDropTarget
 {
 public:
     wxTextDropTarget();
 {
 public:
     wxTextDropTarget();
@@ -233,11 +243,11 @@ public:
     virtual wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def);
 
 private:
     virtual wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def);
 
 private:
-    DECLARE_NO_COPY_CLASS(wxTextDropTarget)
+    wxDECLARE_NO_COPY_CLASS(wxTextDropTarget);
 };
 
 // A drop target which accepts files (dragged from File Manager or Explorer)
 };
 
 // A drop target which accepts files (dragged from File Manager or Explorer)
-class WXDLLEXPORT wxFileDropTarget : public wxDropTarget
+class WXDLLIMPEXP_CORE wxFileDropTarget : public wxDropTarget
 {
 public:
     wxFileDropTarget();
 {
 public:
     wxFileDropTarget();
@@ -249,7 +259,7 @@ public:
     virtual wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def);
 
 private:
     virtual wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def);
 
 private:
-    DECLARE_NO_COPY_CLASS(wxFileDropTarget)
+    wxDECLARE_NO_COPY_CLASS(wxFileDropTarget);
 };
 
 #endif // wxUSE_DRAG_AND_DROP
 };
 
 #endif // wxUSE_DRAG_AND_DROP