added default values for SetSizeHints() arguments, as in wxMSW

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

diff --git a/include/wx/dnd.h b/include/wx/dnd.h
index 82fb690739cdd2add729cb0ab37a4a7e20a17d56..23530a666d833ea2cd3b6e28f83d5ed2ff59218a 100644 (file)
--- a/include/wx/dnd.h
+++ b/include/wx/dnd.h
@@ -12,11 +12,16 @@
 #ifndef _WX_DND_H_BASE_
 #define _WX_DND_H_BASE_
 
 #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/defs.h"
 
 #if wxUSE_DRAG_AND_DROP
 
 #include "wx/dataobj.h"

+#include "wx/cursor.h"

 
 // ----------------------------------------------------------------------------
 // constants
 
 // ----------------------------------------------------------------------------
 // constants


@@ -32,6 +37,11 @@ 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;
+}
+

 // ----------------------------------------------------------------------------
 // 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


@@ -40,13 +50,32 @@ enum wxDragResult
 class WXDLLEXPORT wxDropSourceBase
 {
 public:
 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
     virtual ~wxDropSourceBase() { }
 
     // set the data which is transfered by drag and drop

-    void SetData(wxDataObject& data) 
-      { if (m_data) delete m_data; 
-        m_data = &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
     //
 
     // start drag action, see enum wxDragResult for return value description
     //


@@ -54,15 +83,25 @@ public:
     virtual wxDragResult DoDragDrop(bool bAllowMove = FALSE) = 0;
 
     // override to give feedback depending on the current operation result
     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;
     wxDataObject *m_data;

+
+    // the cursors to use for feedback
+    wxCursor      m_cursorCopy, m_cursorMove, m_cursorStop;

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -92,23 +131,32 @@ public:
     wxDataObject *GetDataObject() const
         { return m_dataObject; }
     void SetDataObject(wxDataObject *dataObject)
     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; }

 
 

-    // called when mouse enters/leaves the window: might be used to give
-    // some visual feedback to the user
+    // these functions are called when data is moved over position (x, y) and
+    // may return either wxDragCopy, wxDragMove or wxDragNone depending on
+    // what would happen if the data were dropped here.
+    //
+    // the last parameter is what would happen by default and is determined by
+    // the platform-specific logic (for example, under Windows it's wxDragCopy
+    // if Ctrl key is pressed and wxDragMove otherwise) except that it will
+    // always be wxDragNone if the carried data is in an unsupported format.
+
+    // called when the mouse enters the window (only once until OnLeave())
+    virtual wxDragResult OnEnter(wxCoord x, wxCoord y, wxDragResult def)
+        { return OnDragOver(x, y, def); }
+
+    // called when the mouse moves in the window - shouldn't take long to
+    // execute or otherwise mouse movement would be too slow
+    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() { }
     virtual void OnLeave() { }

-    
-    // this function is called when data enters over position (x, y) - if it
-    // returns TRUE, the dragging icon can indicate that the window would
-    // accept a drop here
-    virtual bool OnEnter(wxCoord x, wxCoord y) = 0;
-
-    // this function is called when data is move over position (x, y) - if it
-    // returns TRUE, the dragging icon can indicate that the window would
-    // accept a drop here
-    virtual bool OnMove(wxCoord x, wxCoord y) = 0;
-    
+

     // 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.
     // 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.


@@ -116,8 +164,10 @@ public:
 
     // called after OnDrop() returns TRUE: you will usually just call
     // GetData() from here and, probably, also refresh something to update the
 
     // 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
 
     // may be called *only* from inside OnData() and will fill m_dataObject
     // with the data from the drop source if it returns TRUE


@@ -127,11 +177,6 @@ protected:
     wxDataObject *m_dataObject;
 };
 
     wxDataObject *m_dataObject;
 };
 

-// ----------------------------------------------------------------------------
-// the platform-specific headers also define standard wxDropTarget
-// implementations wxTextDropTarget and wxFileDropTarget
-// ----------------------------------------------------------------------------
-

 // ----------------------------------------------------------------------------
 // include platform dependent class declarations
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // include platform dependent class declarations
 // ----------------------------------------------------------------------------


@@ -153,6 +198,35 @@ protected:
     #include "wx/stubs/dnd.h"
 #endif
 
     #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_
 #endif // wxUSE_DRAG_AND_DROP
 
 #endif // _WX_DND_H_BASE_