Contents Up Previous Next

wxDropSource

This class represents a source for a drag and drop operation.

See Drag'n'Drop overview and wxDataObject overview for more information.

Derived from

None

Include files

<wx/dnd.h>

Types

wxDragResult is defined as follows:


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)
;

See also

wxDropTarget, wxTextDropTarget, wxFileDropTarget

Members

wxDropSource::wxDropSource
wxDropSource::~wxDropSource
wxDropSource::SetData
wxDropSource::DoDragDrop
wxDropSource::GiveFeedback


wxDropSource::wxDropSource

wxDropSource(wxWindow* win = NULL)

Default/wxGTK-specific constructor. If you use the default constructor you must call SetData later.

Note that win is required by the GTK port and therefore should always be set.


wxDropSource::~wxDropSource

virtual ~wxDropSource()


wxDropSource::SetData

void SetData(wxDataObject& data)

Sets the data wxDataObject associated with the drop source. This will not delete any previously associated data.


wxDropSource::DoDragDrop

virtual wxDragResult DoDragDrop(bool allowMove = FALSE)

Do it (call this in response to a mouse button press, for example).

If allowMove is FALSE, data can only be copied.


wxDropSource::GiveFeedback

virtual bool GiveFeedback(wxDragResult effect, bool scrolling)

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 slow.

Parameters

effect

scrolling

Return value

Return FALSE if you want default feedback, or TRUE if you implement your own feedback. The return values is ignored under GTK.