Home · All Classes · Main Classes · Grouped Classes · Modules · Functions

QDropEvent Class Reference
^{[QtGui module]}

The QDropEvent class provides an event which is sent when a drag and drop action is completed. More...

#include <QDropEvent>

Inherits QEvent and QMimeSource.

Inherited by QDragMoveEvent.

• List of all members, including inherited members
• Qt 3 support members

Public Functions

• QDropEvent ( const QPoint & pos, Qt::DropActions actions, const QMimeData * data, Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, Type type = Drop )
• void acceptProposedAction ()
• Qt::DropAction dropAction () const
• Qt::KeyboardModifiers keyboardModifiers () const
• const QMimeData * mimeData () const
• Qt::MouseButtons mouseButtons () const
• const QPoint & pos () const
• Qt::DropActions possibleActions () const
• Qt::DropAction proposedAction () const
• void setDropAction ( Qt::DropAction action )
• QWidget * source () const

• 6 public functions inherited from QEvent
• 3 public functions inherited from QMimeSource

Additional Inherited Members

• 1 property inherited from QEvent

Detailed Description

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

When a widget accepts drop events, it will receive this event if it has accepted the most recent QDragEnterEvent or QDragMoveEvent sent to it.

The drop event contains a proposed action, available from proposedAction(), for the widget to either accept or ignore. If the action can be handled by the widget, you should call the acceptProposedAction() function. Since the proposed action can be a combination of Qt::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 required drop action is different to the proposed action, you can call setDropAction() instead of acceptProposedAction() to complete the drop operation.

The mimeData() function provides the data dropped on the widget in a QMimeData object. This contains information about the MIME type of the data in addition to the data itself.

See also QMimeData, QDrag, and Drag and Drop.

Member Function Documentation

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

Constructs a drop event of a certain type corresponding to a drop at the point specified by pos in the destination widget's coordinate system.

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

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

void QDropEvent::acceptProposedAction ()

Sets the drop action to be the proposed action.

See also setDropAction(), proposedAction(), and accept().

Qt::DropAction QDropEvent::dropAction () const

Returns the action that the target is expected to perform on the data. If your application understands the action and can process the supplied data, call acceptAction(); if your application can process the supplied data but can only perform the Copy action, call accept().

See also setDropAction().

Qt::KeyboardModifiers QDropEvent::keyboardModifiers () const

Returns the modifier keys that are pressed.

const QMimeData * 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..

const QPoint & 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 also dropAction().

Qt::DropAction QDropEvent::proposedAction () const

Returns the proposed drop action.

See also dropAction().

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

Sets the action to be performed on the data by the target. Use this to override the proposed action with one of the possible 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.

See also dropAction().

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 the QDrag object used instantiate the drag.

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

See also QDrag::QDrag().