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 DataObject and identify its format(s) using the DataFormat class.
To be a drag 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:
my_data = wx.TextDataObject("This text will be dragged.")
Drag start: To start the dragging process (typically in response to a mouse click) you must call DropSource.DoDragDrop like this:
dragSource = wx.DropSource(self)
dragSource.SetData(my_data)
result = dragSource.DoDragDrop(True)
Dragging: The call to DoDragDrop() blocks the program until the user releases the mouse button (unless you override the DropSource.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 DropTarget methods are called - see below.
Processing the result: DoDragDrop() returns an effect code which is one of the values of DragResult:
if result == wx.DragCopy:
# Copy the data
CopyMyData()
elif result == wx.DragMove:
# Move the data
MoveMyData()
else:
# Default, do nothing
pass
To be a drop target, i.e. to receive the data dropped by the user you should follow the instructions below: