1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: Drag and drop classes declarations
4 // Author: Vadim Zeitlin, Robert Roebling
8 // Copyright: (c) wxWindows Team
9 // Licence: wxWindows license
10 ///////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_DND_H_BASE_
13 #define _WX_DND_H_BASE_
15 #if defined(__GNUG__) && !defined(__APPLE__)
16 #pragma interface "dndbase.h"
21 #if wxUSE_DRAG_AND_DROP
23 #include "wx/dataobj.h"
24 #include "wx/cursor.h"
26 // ----------------------------------------------------------------------------
28 // ----------------------------------------------------------------------------
30 // flags for wxDropSource::DoDragDrop()
32 // NB: wxDrag_CopyOnly must be 0 (== FALSE) and wxDrag_AllowMove must be 1
33 // (== TRUE) for compatibility with the old DoDragDrop(bool) method!
36 wxDrag_CopyOnly
= 0, // allow only copying
37 wxDrag_AllowMove
= 1, // allow moving (copying is always allowed)
38 wxDrag_DefaultMove
= 3 // the default operation is move, not copy
41 // result of wxDropSource::DoDragDrop() call
44 wxDragError
, // error prevented the d&d operation from completing
45 wxDragNone
, // drag target didn't accept the data
46 wxDragCopy
, // the data was successfully copied
47 wxDragMove
, // the data was successfully moved (MSW only)
48 wxDragLink
, // operation is a drag-link
49 wxDragCancel
// the operation was cancelled by user (not an error)
52 inline WXDLLEXPORT
bool wxIsDragResultOk(wxDragResult res
)
54 return res
== wxDragCopy
|| res
== wxDragMove
|| res
== wxDragLink
;
57 // ----------------------------------------------------------------------------
58 // wxDropSource is the object you need to create (and call DoDragDrop on it)
59 // to initiate a drag-and-drop operation
60 // ----------------------------------------------------------------------------
62 class WXDLLEXPORT wxDropSourceBase
65 wxDropSourceBase(const wxCursor
&cursorCopy
= wxNullCursor
,
66 const wxCursor
&cursorMove
= wxNullCursor
,
67 const wxCursor
&cursorStop
= wxNullCursor
)
68 : m_cursorCopy(cursorCopy
),
69 m_cursorMove(cursorMove
),
70 m_cursorStop(cursorStop
)
71 { m_data
= (wxDataObject
*)NULL
; }
72 virtual ~wxDropSourceBase() { }
74 // set the data which is transfered by drag and drop
75 void SetData(wxDataObject
& data
)
78 wxDataObject
*GetDataObject()
81 // set the icon corresponding to given drag result
82 void SetCursor(wxDragResult res
, const wxCursor
& cursor
)
84 if ( res
== wxDragCopy
)
85 m_cursorCopy
= cursor
;
86 else if ( res
== wxDragMove
)
87 m_cursorMove
= cursor
;
89 m_cursorStop
= cursor
;
92 // start drag action, see enum wxDragResult for return value description
94 // if flags contains wxDrag_AllowMove, moving (and only copying) data is
95 // allowed, if it contains wxDrag_DefaultMove (which includes the previous
96 // flag), it is even the default operation
97 virtual wxDragResult
DoDragDrop(int flags
= wxDrag_CopyOnly
) = 0;
99 // override to give feedback depending on the current operation result
100 // "effect" and return TRUE if you did something, FALSE to let the library
101 // give the default feedback
102 virtual bool GiveFeedback(wxDragResult
WXUNUSED(effect
)) { return FALSE
; }
105 const wxCursor
& GetCursor(wxDragResult res
) const
107 if ( res
== wxDragCopy
)
109 else if ( res
== wxDragMove
)
115 // the data we're dragging
116 wxDataObject
*m_data
;
118 // the cursors to use for feedback
119 wxCursor m_cursorCopy
,
123 DECLARE_NO_COPY_CLASS(wxDropSourceBase
)
126 // ----------------------------------------------------------------------------
127 // wxDropTarget should be associated with a window if it wants to be able to
128 // receive data via drag and drop.
130 // To use this class, you should derive from wxDropTarget and implement
131 // OnData() pure virtual method. You may also wish to override OnDrop() if you
132 // want to accept the data only inside some region of the window (this may
133 // avoid having to copy the data to this application which happens only when
134 // OnData() is called)
135 // ----------------------------------------------------------------------------
137 class WXDLLEXPORT wxDropTargetBase
140 // ctor takes a pointer to heap-allocated wxDataObject which will be owned
141 // by wxDropTarget and deleted by it automatically. If you don't give it
142 // here, you can use SetDataObject() later.
143 wxDropTargetBase(wxDataObject
*dataObject
= (wxDataObject
*)NULL
)
144 { m_dataObject
= dataObject
; }
145 // dtor deletes our data object
146 virtual ~wxDropTargetBase()
147 { delete m_dataObject
; }
149 // get/set the associated wxDataObject
150 wxDataObject
*GetDataObject() const
151 { return m_dataObject
; }
152 void SetDataObject(wxDataObject
*dataObject
)
153 { if (m_dataObject
) delete m_dataObject
;
154 m_dataObject
= dataObject
; }
156 // these functions are called when data is moved over position (x, y) and
157 // may return either wxDragCopy, wxDragMove or wxDragNone depending on
158 // what would happen if the data were dropped here.
160 // the last parameter is what would happen by default and is determined by
161 // the platform-specific logic (for example, under Windows it's wxDragCopy
162 // if Ctrl key is pressed and wxDragMove otherwise) except that it will
163 // always be wxDragNone if the carried data is in an unsupported format.
165 // called when the mouse enters the window (only once until OnLeave())
166 virtual wxDragResult
OnEnter(wxCoord x
, wxCoord y
, wxDragResult def
)
167 { return OnDragOver(x
, y
, def
); }
169 // called when the mouse moves in the window - shouldn't take long to
170 // execute or otherwise mouse movement would be too slow
171 virtual wxDragResult
OnDragOver(wxCoord
WXUNUSED(x
), wxCoord
WXUNUSED(y
),
175 // called when mouse leaves the window: might be used to remove the
176 // feedback which was given in OnEnter()
177 virtual void OnLeave() { }
179 // this function is called when data is dropped at position (x, y) - if it
180 // returns TRUE, OnData() will be called immediately afterwards which will
181 // allow to retrieve the data dropped.
182 virtual bool OnDrop(wxCoord x
, wxCoord y
) = 0;
184 // called after OnDrop() returns TRUE: you will usually just call
185 // GetData() from here and, probably, also refresh something to update the
186 // new data and, finally, return the code indicating how did the operation
187 // complete (returning default value in case of success and wxDragError on
188 // failure is usually ok)
189 virtual wxDragResult
OnData(wxCoord x
, wxCoord y
, wxDragResult def
) = 0;
191 // may be called *only* from inside OnData() and will fill m_dataObject
192 // with the data from the drop source if it returns TRUE
193 virtual bool GetData() = 0;
196 wxDataObject
*m_dataObject
;
198 DECLARE_NO_COPY_CLASS(wxDropTargetBase
)
201 // ----------------------------------------------------------------------------
202 // include platform dependent class declarations
203 // ----------------------------------------------------------------------------
205 #if defined(__WXMSW__)
206 #include "wx/msw/ole/dropsrc.h"
207 #include "wx/msw/ole/droptgt.h"
208 #elif defined(__WXMOTIF__)
209 #include "wx/motif/dnd.h"
210 #elif defined(__WXX11__)
211 #include "wx/x11/dnd.h"
212 #elif defined(__WXGTK__)
213 #include "wx/gtk/dnd.h"
214 #elif defined(__WXMAC__)
215 #include "wx/mac/dnd.h"
216 #elif defined(__WXPM__)
217 #include "wx/os2/dnd.h"
218 #elif defined(__WXSTUBS__)
219 #include "wx/stubs/dnd.h"
222 // ----------------------------------------------------------------------------
223 // standard wxDropTarget implementations (implemented in common/dobjcmn.cpp)
224 // ----------------------------------------------------------------------------
226 // A simple wxDropTarget derived class for text data: you only need to
227 // override OnDropText() to get something working
228 class WXDLLEXPORT wxTextDropTarget
: public wxDropTarget
233 virtual bool OnDropText(wxCoord x
, wxCoord y
, const wxString
& text
) = 0;
235 virtual wxDragResult
OnData(wxCoord x
, wxCoord y
, wxDragResult def
);
238 // A drop target which accepts files (dragged from File Manager or Explorer)
239 class WXDLLEXPORT wxFileDropTarget
: public wxDropTarget
244 // parameters are the number of files and the array of file names
245 virtual bool OnDropFiles(wxCoord x
, wxCoord y
,
246 const wxArrayString
& filenames
) = 0;
248 virtual wxDragResult
OnData(wxCoord x
, wxCoord y
, wxDragResult def
);
251 #endif // wxUSE_DRAG_AND_DROP
253 #endif // _WX_DND_H_BASE_