X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c9057ae1c565cc4ae6c2cf84dd19d65a64ee2b7b..0ff8e4b5c9a0e32768f645b2546cec9ec018cfa7:/include/wx/dnd.h

diff --git a/include/wx/dnd.h b/include/wx/dnd.h
index 2106b00a4c..b0c68b3b54 100644
--- a/include/wx/dnd.h
+++ b/include/wx/dnd.h
@@ -12,11 +12,16 @@
 #ifndef _WX_DND_H_BASE_
 #define _WX_DND_H_BASE_
 
+#ifdef __GNUG__
+    #pragma interface "dndbase.h"
+#endif
+
 #include "wx/defs.h"
 
 #if wxUSE_DRAG_AND_DROP
 
 #include "wx/dataobj.h"
+#include "wx/cursor.h"
 
 // ----------------------------------------------------------------------------
 // constants
@@ -29,9 +34,15 @@ enum wxDragResult
     wxDragNone,     // drag target didn't accept the data
     wxDragCopy,     // the data was successfully copied
     wxDragMove,     // the data was successfully moved (MSW only)
+    wxDragLink,     // operation is a drag-link
     wxDragCancel    // the operation was cancelled by user (not an error)
 };
 
+inline WXDLLEXPORT bool wxIsDragResultOk(wxDragResult res)
+{
+    return res == wxDragCopy || res == wxDragMove || res == wxDragLink;
+}
+
 // ----------------------------------------------------------------------------
 // wxDropSource is the object you need to create (and call DoDragDrop on it)
 // to initiate a drag-and-drop operation
@@ -40,31 +51,58 @@ enum wxDragResult
 class WXDLLEXPORT wxDropSourceBase
 {
 public:
-    wxDropSourceBase() { m_data = (wxDataObject *)NULL; }
+    wxDropSourceBase(const wxCursor &cursorCopy = wxNullCursor,
+                     const wxCursor &cursorMove = wxNullCursor,
+                     const wxCursor &cursorStop = wxNullCursor)
+        : m_cursorCopy(cursorCopy),
+          m_cursorMove(cursorMove),
+          m_cursorStop(cursorStop)
+        { m_data = (wxDataObject *)NULL; }
     virtual ~wxDropSourceBase() { }
 
     // set the data which is transfered by drag and drop
-    void SetData(wxDataObject& data) 
+    void SetData(wxDataObject& data)
       { m_data = &data; }
-      
+
     wxDataObject *GetDataObject()
       { return m_data; }
 
+    // set the icon corresponding to given drag result
+    void SetCursor(wxDragResult res, const wxCursor& cursor)
+    {
+        if ( res == wxDragCopy )
+            m_cursorCopy = cursor;
+        else if ( res == wxDragMove )
+            m_cursorMove = cursor;
+        else
+            m_cursorStop = cursor;
+    }
+
     // start drag action, see enum wxDragResult for return value description
     //
     // if bAllowMove is TRUE, data can be moved, if not - only copied
     virtual wxDragResult DoDragDrop(bool bAllowMove = FALSE) = 0;
 
     // override to give feedback depending on the current operation result
-    // "effect"
-    virtual bool GiveFeedback( wxDragResult WXUNUSED(effect),
-                               bool WXUNUSED(bScrolling) )
+    // "effect" and return TRUE if you did something, FALSE to let the library
+    // give the default feedback
+    virtual bool GiveFeedback(wxDragResult WXUNUSED(effect)) { return FALSE; }
+
+protected:
+    const wxCursor& GetCursor(wxDragResult res) const
     {
-        return TRUE;
+        if ( res == wxDragCopy )
+            return m_cursorCopy;
+        else if ( res == wxDragMove )
+            return m_cursorMove;
+        else
+            return m_cursorStop;
     }
 
-protected:
     wxDataObject *m_data;
+
+    // the cursors to use for feedback
+    wxCursor      m_cursorCopy, m_cursorMove, m_cursorStop;
 };
 
 // ----------------------------------------------------------------------------
@@ -94,8 +132,8 @@ public:
     wxDataObject *GetDataObject() const
         { return m_dataObject; }
     void SetDataObject(wxDataObject *dataObject)
-        { if (m_dataObject) delete m_dataObject; 
-	  m_dataObject = dataObject; }
+        { if (m_dataObject) delete m_dataObject;
+    m_dataObject = dataObject; }
 
     // these functions are called when data is moved over position (x, y) and
     // may return either wxDragCopy, wxDragMove or wxDragNone depending on
@@ -115,11 +153,11 @@ public:
     virtual wxDragResult OnDragOver(wxCoord WXUNUSED(x), wxCoord WXUNUSED(y),
                                     wxDragResult def)
         { return def; }
-    
+
     // called when mouse leaves the window: might be used to remove the
     // feedback which was given in OnEnter()
     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
     // allow to retrieve the data dropped.
@@ -127,8 +165,10 @@ public:
 
     // called after OnDrop() returns TRUE: you will usually just call
     // GetData() from here and, probably, also refresh something to update the
-    // new data
-    virtual bool OnData(wxCoord x, wxCoord y) = 0;
+    // new data and, finally, return the code indicating how did the operation
+    // complete (returning default value in case of success and wxDragError on
+    // failure is usually ok)
+    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
@@ -138,11 +178,6 @@ protected:
     wxDataObject *m_dataObject;
 };
 
-// ----------------------------------------------------------------------------
-// the platform-specific headers also define standard wxDropTarget
-// implementations wxTextDropTarget and wxFileDropTarget
-// ----------------------------------------------------------------------------
-
 // ----------------------------------------------------------------------------
 // include platform dependent class declarations
 // ----------------------------------------------------------------------------
@@ -154,8 +189,6 @@ protected:
     #include "wx/motif/dnd.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk/dnd.h"
-#elif defined(__WXQT__)
-    #include "wx/qt/dnd.h"
 #elif defined(__WXMAC__)
     #include "wx/mac/dnd.h"
 #elif defined(__WXPM__)
@@ -164,6 +197,35 @@ protected:
     #include "wx/stubs/dnd.h"
 #endif
 
+// ----------------------------------------------------------------------------
+// standard wxDropTarget implementations (implemented in common/dobjcmn.cpp)
+// ----------------------------------------------------------------------------
+
+// A simple wxDropTarget derived class for text data: you only need to
+// override OnDropText() to get something working
+class WXDLLEXPORT wxTextDropTarget : public wxDropTarget
+{
+public:
+    wxTextDropTarget();
+
+    virtual bool OnDropText(wxCoord x, wxCoord y, const wxString& text) = 0;
+
+    virtual wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def);
+};
+
+// A drop target which accepts files (dragged from File Manager or Explorer)
+class WXDLLEXPORT wxFileDropTarget : public wxDropTarget
+{
+public:
+    wxFileDropTarget();
+
+    // parameters are the number of files and the array of file names
+    virtual bool OnDropFiles(wxCoord x, wxCoord y,
+                             const wxArrayString& filenames) = 0;
+
+    virtual wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def);
+};
+
 #endif // wxUSE_DRAG_AND_DROP
 
 #endif // _WX_DND_H_BASE_