wxTreeCtrl has colours and fonts too now

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

diff --git a/include/wx/dnd.h b/include/wx/dnd.h
index 17ae097d0caa681166e28778ca5abcb0c867a131..6233f1525a2c51a37f64424207489ed70d3101d9 100644 (file)
--- a/include/wx/dnd.h
+++ b/include/wx/dnd.h
@@ -17,6 +17,7 @@
 #if wxUSE_DRAG_AND_DROP
 
 #include "wx/dataobj.h"
+#include "wx/cursor.h"
 
 // ----------------------------------------------------------------------------
 // constants
@@ -32,6 +33,11 @@ enum wxDragResult
     wxDragCancel    // the operation was cancelled by user (not an error)
 };
 
+inline WXDLLEXPORT bool wxIsDragResultOk(wxDragResult res)
+{
+    return res == wxDragCopy || res == wxDragMove;
+}
+
 // ----------------------------------------------------------------------------
 // wxDropSource is the object you need to create (and call DoDragDrop on it)
 // to initiate a drag-and-drop operation
@@ -40,7 +46,13 @@ 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
@@ -50,21 +62,42 @@ public:
     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;
 };
 
 // ----------------------------------------------------------------------------
@@ -127,8 +160,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 +173,6 @@ protected:
     wxDataObject *m_dataObject;
 };
 
-// ----------------------------------------------------------------------------
-// the platform-specific headers also define standard wxDropTarget
-// implementations wxTextDropTarget and wxFileDropTarget
-// ----------------------------------------------------------------------------
-
 // ----------------------------------------------------------------------------
 // include platform dependent class declarations
 // ----------------------------------------------------------------------------
@@ -164,6 +194,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_