QDropEvent Class
The QDropEvent class provides an event which is sent when a drag and drop action is completed. More...
Header: | #include <QDropEvent> |
qmake: | QT += gui |
Inherits: | QEvent |
Inherited By: |
Public Functions
QDropEvent(const QPointF &pos, Qt::DropActions actions, const QMimeData *data, Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, QEvent::Type type = Drop) | |
void | acceptProposedAction() |
Qt::DropAction | dropAction() const |
Qt::KeyboardModifiers | keyboardModifiers() const |
const QMimeData * | mimeData() const |
Qt::MouseButtons | mouseButtons() const |
QPoint | pos() const |
const QPointF & | posF() const |
Qt::DropActions | possibleActions() const |
Qt::DropAction | proposedAction() const |
void | setDropAction(Qt::DropAction action) |
QObject * | source() const |
- 6 public functions inherited from QEvent
Protected Variables
Qt::DropActions | act |
Qt::DropAction | default_action |
Qt::DropAction | drop_action |
const QMimeData * | mdata |
Qt::KeyboardModifiers | modState |
Qt::MouseButtons | mouseState |
QPointF | p |
Additional Inherited Members
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 proposed drop action is not suitable, perhaps because your custom widget does not support that action, you can replace it with any of the possible drop actions by calling setDropAction() with your preferred action. If you set a value that is not present in the bitwise OR combination of values returned by possibleActions(), the default copy action will be used. Once a replacement drop action has been set, call accept() 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 QPointF &pos, Qt::DropActions actions, const QMimeData *data, Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, QEvent::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()
Qt::DropAction QDropEvent::dropAction() const
See also setDropAction().
Qt::KeyboardModifiers QDropEvent::keyboardModifiers() const
const QMimeData *QDropEvent::mimeData() const
Qt::MouseButtons QDropEvent::mouseButtons() const
QPoint QDropEvent::pos() const
const QPointF &QDropEvent::posF() const
Qt::DropActions QDropEvent::possibleActions() const
Qt::DropAction QDropEvent::proposedAction() const
void QDropEvent::setDropAction(Qt::DropAction action)
See also dropAction().
QObject *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().