PySide6.QtGui.QDropEvent

class QDropEvent

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

Inherited by: QDragMoveEvent, QDragEnterEvent

Synopsis

Methods

• def __init__()

• def __repr__()

• def acceptProposedAction()

• def buttons()

• def dropAction()

• def keyboardModifiers()

• def mimeData()

• def modifiers()

• def mouseButtons()

• def pos()

• def posF()

• def position()

• def possibleActions()

• def proposedAction()

• def setDropAction()

• def source()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

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

QDrag Drag and Drop

__init__(arg__1)

Parameters:

arg__1 – QDropEvent

__init__(pos, actions, data, buttons, modifiers[, type=QEvent.Type.Drop])

Parameters:

• pos – QPointF

• actions – Combination of DropAction

• data – QMimeData

• buttons – Combination of MouseButton

• modifiers – Combination of KeyboardModifier

• type – Type

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.

__repr__()

Return type:

str

acceptProposedAction()

Sets the drop action to be the proposed action.

See also

setDropAction() proposedAction() accept()

buttons()

Return type:

Combination of MouseButton

Returns the mouse buttons that are pressed.

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

keyboardModifiers()

Return type:

Combination of KeyboardModifier

Note

This function is deprecated.

Use modifiers() instead.

Returns the modifier keys that are pressed.

mimeData()

Return type:

QMimeData

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

modifiers()

Return type:

Combination of KeyboardModifier

Returns the modifier keys that are pressed.

mouseButtons()

Return type:

Combination of MouseButton

Note

This function is deprecated.

Use buttons() instead.

Returns the mouse buttons that are pressed.

pos()

Return type:

QPoint

Note

This function is deprecated.

Use position() .toPoint() instead.

Returns the position where the drop was made.

posF()

Return type:

QPointF

Note

This function is deprecated.

Use position() instead.

Returns the position where the drop was made.

position()

Return type:

QPointF

Returns the position where the drop was made.

possibleActions()

Return type:

Combination of DropAction

Returns an OR-combination of possible drop actions.

See also

dropAction()

proposedAction()

Return type:

DropAction

Returns the proposed drop action.

See also

dropAction()

setDropAction(action)

Parameters:

action – DropAction

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

source()

Return type:

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