\section{\class{wxDropSource}}\label{wxdropsource}
-\overview{Overview}{wxdndoverview}
-
This class represents a source for a drag and drop operation.
+See \helpref{Drag and drop overview}{wxdndoverview} and \helpref{wxDataObject overview}{wxdataobjectoverview}
+for more information.
+
\wxheading{Derived from}
-\helpref{wxObject}{wxobject}
+None
+
+\wxheading{Include files}
+
+<wx/dnd.h>
\wxheading{Types}
\index{wxDragResult}wxDragResult is defined as follows:
-{\small\begin{verbatim}
+\begin{verbatim}
enum wxDragResult
- {
+{
wxDragError, // error prevented the d&d operation from completing
wxDragNone, // drag target didn't accept the data
wxDragCopy, // the data was successfully copied
wxDragMove, // the data was successfully moved
wxDragCancel // the operation was cancelled by user (not an error)
- };
-\end{verbatim}%
-}
+};
+\end{verbatim}
\wxheading{See also}
-\helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDropTarget}{wxdroptarget},
+\helpref{wxDropTarget}{wxdroptarget},
\helpref{wxTextDropTarget}{wxtextdroptarget}, \helpref{wxFileDropTarget}{wxfiledroptarget}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxDropSource::wxDropSource}\label{wxdropsourcewxdropsource}
-\func{}{wxDropSource}{\param{wxWindow }{*win = NULL}}
+\func{}{wxDropSource}{\param{wxWindow*}{ win = NULL},\param{const wxIconOrCursor\& }{iconCopy = wxNullIconOrCursor}, \param{const wxIconOrCursor\& }{iconMove = wxNullIconOrCursor}, \param{const wxIconOrCursor\& }{iconNone = wxNullIconOrCursor}}
-Default/wxGTK-specific constructor. If you use the default constructor you must
-call \helpref{wxDropSource::SetData}{wxdropsourcesetdata} later.
+\func{}{wxDropSource}{\param{wxDataObject\&}{ data}, \param{wxWindow*}{ win = NULL},\param{const wxIconOrCursor\& }{iconCopy = wxNullIconOrCursor}, \param{const wxIconOrCursor\& }{iconMove = wxNullIconOrCursor}, \param{const wxIconOrCursor\& }{iconNone = wxNullIconOrCursor}}
-{\it win} is only used by wxGTK. TODO: in what circumstances?
+The constructors for wxDataObject.
-\func{}{wxDropSource}{\param{wxDataObject }{\&data}, \param{wxWindow }{*win = NULL}}
+If you use the constructor without {\it data} parameter you must call
+\helpref{SetData}{wxdropsourcesetdata} later.
+
+Note that the exact type of {\it iconCopy} and subsequent parameters differs
+between wxMSW and wxGTK: these are cursors under Windows but icons for GTK.
+You should use the macro \helpref{wxDROP\_ICON}{wxdropicon} in portable
+programs instead of directly using either of these types.
\wxheading{Parameters}
-\docparam{data}{A reference to the \helpref{data object}{wxdataobject} associated with the drop source.}
+\docparam{win}{The window which initiates the drag and drop operation.}
+
+\docparam{iconCopy}{The icon or cursor used for feedback for copy operation.}
+
+\docparam{iconMove}{The icon or cursor used for feedback for move operation.}
-\docparam{win}{Only used by wxGTK. TODO}
+\docparam{iconNone}{The icon or cursor used for feedback when operation can't be done.}
+
+{\it win} is the window which initiates the drag and drop operation.
\membersection{wxDropSource::\destruct{wxDropSource}}\label{wxdropsourcedtor}
\membersection{wxDropSource::SetData}\label{wxdropsourcesetdata}
-\func{void}{SetData}{\param{wxDataObject }{\&data}}
+\func{void}{SetData}{\param{wxDataObject\&}{ data}}
-Sets the data \helpref{data object}{wxdataobject} associated with the drop source.
+Sets the data \helpref{wxDataObject}{wxdataobject} associated with the
+drop source. This will not delete any previously associated data.
\membersection{wxDropSource::DoDragDrop}\label{wxdropsourcedodragdrop}
-\func{virtual wxDragResult}{DoDragDrop}{\param{bool }{bAllowMove = FALSE}}
+\func{virtual wxDragResult}{DoDragDrop}{\param{int }{flags = {\tt wxDrag\_CopyOnly}}}
+
+Do it (call this in response to a mouse button press, for example). This starts
+the drag-and-drop operation which will terminate when the user releases the
+mouse.
+
+\wxheading{Parameters}
+
+\docparam{flags}{If {\tt wxDrag\_AllowMove} is included in the flags, data may
+be moved and not only copied (default). If {\tt wxDrag\_DefaultMove} is
+specified (which includes the previous flag), this is even the default
+operation}.
-Do it (call this in response to a mouse button press, for example).
+\wxheading{Return value}
-If {\bf bAllowMove} is FALSE, data can only be copied.
+Returns the operation requested by the user, may be {\tt wxDragCopy}, {\tt
+wxDragMove}, {\tt wxDragCancel} or {\tt wxDragNone} if an error occured.
\membersection{wxDropSource::GiveFeedback}\label{wxdropsourcegivefeedback}
-\func{virtual bool}{GiveFeedback}{\param{wxDragResult }{effect}, \param{bool }{bScrolling}}
+\func{virtual bool}{GiveFeedback}{\param{wxDragResult }{effect}}
Overridable: you may give some custom UI feedback during the drag and drop operation
in this function. It is called on each mouse move, so your implementation must not be too
\wxheading{Parameters}
-\docparam{effect}{The effect to implement. One of wxDragCopy, wxDragMove.}
+\docparam{effect}{The effect to implement. One of wxDragCopy, wxDragMove and wxDragNone. }
-\docparam{bScrolling}{TRUE if the window is scrolling.}
+\docparam{scrolling}{true if the window is scrolling. MSW only. }
\wxheading{Return value}
-Return FALSE if you want default feedback, or TRUE if you implement your own
-feedback.
+Return false if you want default feedback, or true if you implement your own
+feedback. The return values is ignored under GTK.
projects / wxWidgets.git / blobdiff