wxWidgets: Drag and Drop Overview

| Version: 3.0.5

Drag and Drop Overview

It may be noted that data transfer to and from the clipboard is quite similar to data transfer with drag and drop and the code to implement these two types is almost the same.

In particular, both data transfer mechanisms store data in some kind of wxDataObject and identify its format(s) using the wxDataFormat class.

Note that `wxUSE_DRAG_AND_DROP` must be defined in `setup.h` in order to use drag and drop in wxWidgets.

See also
  wxDataObject Overview, Clipboard and Drag & Drop, Drag & Drop Sample

# Drop Source Requirements

To be a "drop source", i.e. to provide the data which may be dragged by the user elsewhere, you should implement the following steps:

- Preparation: First of all, a data object must be created and initialized with the data you wish to drag. For example:
  wxTextDataObject my_data("This text will be dragged.");
  wxTextDataObject
  wxTextDataObject is a specialization of wxDataObjectSimple for text data.
  Definition: dataobj.h:687
- Drag start: To start the dragging process (typically in response to a mouse click) you must call wxDropSource::DoDragDrop like this:
  wxDropSource dragSource( this );
  dragSource.SetData( my_data );
  wxDragResult result = dragSource.DoDragDrop( true );
  wxDropSource
  This class represents a source for a drag and drop operation.
  Definition: dnd.h:176
  wxDragResult
  wxDragResult
  Result returned from a wxDropSource::DoDragDrop() call.
  Definition: dnd.h:22
- Dragging: The call to DoDragDrop() blocks the program until the user releases the mouse button (unless you override the wxDropSource::GiveFeedback function to do something special). When the mouse moves in a window of a program which understands the same drag-and-drop protocol (any program under Windows or any program supporting the XDnD protocol under X Windows), the corresponding wxDropTarget methods are called - see below.
- Processing the result: DoDragDrop() returns an effect code which is one of the values of `wxDragResult` enum (explained in wxDropTarget page):
  switch (result)
  {
  case wxDragCopy:
  // copy the data
  break;
  case wxDragMove:
  // move the data
  break;
  default:
  // do nothing
  break;
  }
  wxDragCopy
  @ wxDragCopy
  The data was successfully copied.
  Definition: dnd.h:25
  wxDragMove
  @ wxDragMove
  The data was successfully moved (MSW only).
  Definition: dnd.h:26

# Drop Target Requirements

To be a "drop target", i.e. to receive the data dropped by the user you should follow the instructions below:

- Initialization: For a window to be a drop target, it needs to have an associated wxDropTarget object. Normally, you will call wxWindow::SetDropTarget during window creation associating your drop target with it. You must derive a class from wxDropTarget and override its pure virtual methods. Alternatively, you may derive from wxTextDropTarget or wxFileDropTarget and override their OnDropText() or OnDropFiles() method.
- Drop: When the user releases the mouse over a window, wxWidgets asks the associated wxDropTarget object if it accepts the data. For this, a wxDataObject must be associated with the drop target and this data object will be responsible for the format negotiation between the drag source and the drop target. If all goes well, then wxDropTarget::OnData will get called and the wxDataObject belonging to the drop target can get filled with data.
- The end: After processing the data, DoDragDrop() returns either wxDragCopy or wxDragMove depending on the state of the keys Ctrl, Shift and Alt at the moment of the drop. There is currently no way for the drop target to change this return code.