Contents

• Public Functions
• Reimplemented Public Functions
• Detailed Description

Detailed Description

TheQDropEvent class provides an event which is sent when a drag and drop action is completed.

When a widgetaccepts drop events, it will receive this event if it has accepted the most recentQDragEnterEvent orQDragMoveEvent sent to it.

The drop event contains a proposed action, available fromproposedAction(), for the widget to either accept or ignore. If the action can be handled by the widget, you should call theacceptProposedAction() function. Since the proposed action can be a combination ofQt::DropAction values, it may be useful to either select one of these values as a default action or ask the user to select their preferred action.

If the proposed drop action is not suitable, perhaps because your custom widget does not support that action, you can replace it with any of thepossible drop actions by callingsetDropAction() with your preferred action. If you set a value that is not present in the bitwise OR combination of values returned bypossibleActions(), the default copy action will be used. Once a replacement drop action has been set, call accept() instead ofacceptProposedAction() to complete the drop operation.

ThemimeData() function provides the data dropped on the widget in aQMimeData object. This contains information about the MIME type of the data in addition to the data itself.

Member Function Documentation

QDropEvent::QDropEvent(constQPoint & pos,Qt::DropActions actions, constQMimeData * data,Qt::MouseButtons buttons,Qt::KeyboardModifiers modifiers,Type type = Drop)

Constructs a drop event of a certaintype corresponding to a drop at the point specified bypos in the destination widget's coordinate system.

Theactions indicate which types of drag and drop operation can be performed, and the drag data is stored as MIME-encoded data indata.

The states of the mouse buttons and keyboard modifiers at the time of the drop are specified bybuttons andmodifiers.

void QDropEvent::acceptProposedAction()

Sets the drop action to be the proposed action.

See alsosetDropAction(),proposedAction(), andaccept().

Qt::DropAction QDropEvent::dropAction() const

Returns the action to be performed on the data by the target. This may be different from the action supplied inproposedAction() if you have calledsetDropAction() to explicitly choose a drop action.

See alsosetDropAction().

Qt::KeyboardModifiers QDropEvent::keyboardModifiers() const

Returns the modifier keys that are pressed.

constQMimeData * QDropEvent::mimeData() const

Returns the data that was dropped on the widget and its associated MIME type information.

Qt::MouseButtons QDropEvent::mouseButtons() const

Returns the mouse buttons that are pressed..

constQPoint & QDropEvent::pos() const

Returns the position where the drop was made.

Qt::DropActions QDropEvent::possibleActions() const

Returns an OR-combination of possible drop actions.

See alsodropAction().

Qt::DropAction QDropEvent::proposedAction() const

Returns the proposed drop action.

See alsodropAction().

void QDropEvent::setDropAction(Qt::DropAction action)

Sets theaction to be performed on the data by the target. Use this to override theproposed action with one of thepossible actions.

If you set a drop action that is not one of the possible actions, the drag and drop operation will default to a copy operation.

Once you have supplied a replacement drop action, call accept() instead ofacceptProposedAction().

See alsodropAction().

QWidget * QDropEvent::source() const

If the source of the drag operation is a widget in this application, this function returns that source; otherwise it returns 0. The source of the operation is the first parameter to theQDrag object used instantiate the drag.

This is useful if your widget needs special behavior when dragging to itself.

See alsoQDrag::QDrag().