QDropEvent

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

Inheritance diagram of PySide6.QtGui.QDropEvent

Inherited by: QDragMoveEvent, QDragEnterEvent

Synopsis

Functions

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 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 Drag and Drop

class PySide6.QtGui.QDropEvent(arg__1)

PySide6.QtGui.QDropEvent(pos, actions, data, buttons, modifiers[, type=Drop])

Parameters

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.

PySide6.QtGui.QDropEvent.acceptProposedAction()

Sets the drop action to be the proposed action.

See also

setDropAction() proposedAction() accept()

PySide6.QtGui.QDropEvent.buttons()
Return type

MouseButtons

PySide6.QtGui.QDropEvent.dropAction()
Return type

DropAction

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

PySide6.QtGui.QDropEvent.keyboardModifiers()
Return type

KeyboardModifiers

Note

This function is deprecated.

Returns the modifier keys that are pressed.

PySide6.QtGui.QDropEvent.mimeData()
Return type

PySide6.QtCore.QMimeData

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

PySide6.QtGui.QDropEvent.modifiers()
Return type

KeyboardModifiers

PySide6.QtGui.QDropEvent.mouseButtons()
Return type

MouseButtons

Note

This function is deprecated.

Returns the mouse buttons that are pressed..

PySide6.QtGui.QDropEvent.pos()
Return type

PySide6.QtCore.QPoint

Note

This function is deprecated.

Returns the position where the drop was made.

PySide6.QtGui.QDropEvent.posF()
Return type

PySide6.QtCore.QPointF

Note

This function is deprecated.

Returns the position where the drop was made.

PySide6.QtGui.QDropEvent.position()
Return type

PySide6.QtCore.QPointF

PySide6.QtGui.QDropEvent.possibleActions()
Return type

DropActions

Returns an OR-combination of possible drop actions.

See also

dropAction()

PySide6.QtGui.QDropEvent.proposedAction()
Return type

DropAction

Returns the proposed drop action.

See also

dropAction()

PySide6.QtGui.QDropEvent.setDropAction(action)
Parameters

actionDropAction

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

PySide6.QtGui.QDropEvent.source()
Return type

PySide6.QtCore.QObject

If the source of the drag operation is a widget in this application, this function returns that source; otherwise it returns None. 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()