add a critical section protecting ms_prev variables (replaces patch 1819224)

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

diff --git a/include/wx/dnd.h b/include/wx/dnd.h
index 23530a666d833ea2cd3b6e28f83d5ed2ff59218a..498bbc7afe3321faf016af12353a7eea97679fb5 100644 (file)
--- a/include/wx/dnd.h
+++ b/include/wx/dnd.h
@@ -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
-// Licence:     wxWindows license
+// Copyright:   (c) wxWidgets Team
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 #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/defs.h"
 
 #if wxUSE_DRAG_AND_DROP


@@ -27,6 +23,17 @@
 // constants
 // ----------------------------------------------------------------------------
 
 // constants
 // ----------------------------------------------------------------------------
 

+// flags for wxDropSource::DoDragDrop()
+//
+// NB: wxDrag_CopyOnly must be 0 (== FALSE) and wxDrag_AllowMove must be 1
+//     (== TRUE) for compatibility with the old DoDragDrop(bool) method!
+enum
+{
+    wxDrag_CopyOnly    = 0, // allow only copying
+    wxDrag_AllowMove   = 1, // allow moving (copying is always allowed)
+    wxDrag_DefaultMove = 3  // the default operation is move, not copy
+};
+

 // result of wxDropSource::DoDragDrop() call
 enum wxDragResult
 {
 // result of wxDropSource::DoDragDrop() call
 enum wxDragResult
 {


@@ -34,13 +41,13 @@ enum wxDragResult
     wxDragNone,     // drag target didn't accept the data
     wxDragCopy,     // the data was successfully copied
     wxDragMove,     // the data was successfully moved (MSW only)
     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)
 };
 
     wxDragCancel    // the operation was cancelled by user (not an error)
 };
 

-inline WXDLLEXPORT bool wxIsDragResultOk(wxDragResult res)
-{
-    return res == wxDragCopy || res == wxDragMove;
-}
+// return true if res indicates that something was done during a dnd operation,
+// i.e. is neither error nor none nor cancel
+WXDLLEXPORT bool wxIsDragResultOk(wxDragResult res);

 
 // ----------------------------------------------------------------------------
 // wxDropSource is the object you need to create (and call DoDragDrop on it)
 
 // ----------------------------------------------------------------------------
 // wxDropSource is the object you need to create (and call DoDragDrop on it)


@@ -79,13 +86,15 @@ public:
 
     // start drag action, see enum wxDragResult for return value description
     //
 
     // 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;
+    // if flags contains wxDrag_AllowMove, moving (and only copying) data is
+    // allowed, if it contains wxDrag_DefaultMove (which includes the previous
+    // flag), it is even the default operation
+    virtual wxDragResult DoDragDrop(int flags = wxDrag_CopyOnly) = 0;

 
     // override to give feedback depending on the current operation result
 
     // 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


@@ -98,10 +107,15 @@ protected:
             return m_cursorStop;
     }
 
             return m_cursorStop;
     }
 

+    // the data we're dragging

     wxDataObject *m_data;
 
     // the cursors to use for feedback
     wxDataObject *m_data;
 
     // the cursors to use for feedback

-    wxCursor      m_cursorCopy, m_cursorMove, m_cursorStop;
+    wxCursor m_cursorCopy,
+             m_cursorMove,
+             m_cursorStop;
+
+    DECLARE_NO_COPY_CLASS(wxDropSourceBase)

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


@@ -122,7 +136,7 @@ public:
     // by wxDropTarget and deleted by it automatically. If you don't give it
     // here, you can use SetDataObject() later.
     wxDropTargetBase(wxDataObject *dataObject = (wxDataObject*)NULL)
     // 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; }
+        { 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; }


@@ -158,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;
 


@@ -170,11 +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)

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


@@ -186,16 +215,16 @@ protected:
     #include "wx/msw/ole/droptgt.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/dnd.h"
     #include "wx/msw/ole/droptgt.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/dnd.h"

-#elif defined(__WXGTK__)
+#elif defined(__WXX11__)
+    #include "wx/x11/dnd.h"
+#elif defined(__WXGTK20__)

     #include "wx/gtk/dnd.h"
     #include "wx/gtk/dnd.h"

-#elif defined(__WXQT__)
-    #include "wx/qt/dnd.h"
+#elif defined(__WXGTK__)
+    #include "wx/gtk1/dnd.h"

 #elif defined(__WXMAC__)
     #include "wx/mac/dnd.h"
 #elif defined(__WXPM__)
     #include "wx/os2/dnd.h"
 #elif defined(__WXMAC__)
     #include "wx/mac/dnd.h"
 #elif defined(__WXPM__)
     #include "wx/os2/dnd.h"

-#elif defined(__WXSTUBS__)
-    #include "wx/stubs/dnd.h"

 #endif
 
 // ----------------------------------------------------------------------------
 #endif
 
 // ----------------------------------------------------------------------------


@@ -212,6 +241,9 @@ public:
     virtual bool OnDropText(wxCoord x, wxCoord y, const wxString& text) = 0;
 
     virtual wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def);
     virtual bool OnDropText(wxCoord x, wxCoord y, const wxString& text) = 0;
 
     virtual wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def);

+
+private:
+    DECLARE_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)


@@ -225,6 +257,9 @@ public:
                              const wxArrayString& filenames) = 0;
 
     virtual wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def);
                              const wxArrayString& filenames) = 0;
 
     virtual wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def);

+
+private:
+    DECLARE_NO_COPY_CLASS(wxFileDropTarget)

 };
 
 #endif // wxUSE_DRAG_AND_DROP
 };
 
 #endif // wxUSE_DRAG_AND_DROP