QDropEvent Class
The QDropEvent class provides an event which is sent when a drag and drop action is completed. More...
| Header: | #include <QDropEvent> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Gui) target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
| Inherits: | QEvent |
| Inherited By: |
- List of all members, including inherited members
- Deprecated members
- QDropEvent is part of Event Classes.
Public Functions
| QDropEvent(const QPointF &pos, Qt::DropActions actions, const QMimeData *data, Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, QEvent::Type type = Drop) | |
| void | acceptProposedAction() |
(since 6.0) Qt::MouseButtons | buttons() const |
| Qt::DropAction | dropAction() const |
| const QMimeData * | mimeData() const |
(since 6.0) Qt::KeyboardModifiers | modifiers() const |
(since 6.0) QPointF | position() const |
| Qt::DropActions | possibleActions() const |
| Qt::DropAction | proposedAction() const |
| void | setDropAction(Qt::DropAction action) |
| QObject * | source() const |
Detailed Description
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()
Sets the drop action to be the proposed action.
See also setDropAction(), proposedAction(), and accept().
[since 6.0] Qt::MouseButtons QDropEvent::buttons() const
Returns the mouse buttons that are pressed.
This function was introduced in Qt 6.0.
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 in proposedAction() if you have called setDropAction() to explicitly choose a drop action.
See also setDropAction().
const QMimeData *QDropEvent::mimeData() const
Returns the data that was dropped on the widget and its associated MIME type information.
[since 6.0] Qt::KeyboardModifiers QDropEvent::modifiers() const
Returns the modifier keys that are pressed.
This function was introduced in Qt 6.0.
[since 6.0] QPointF QDropEvent::position() const
Returns the position where the drop was made.
This function was introduced in Qt 6.0.
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.
Once you have supplied a replacement drop action, call accept() instead of acceptProposedAction().
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 nullptr. 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().