QGraphicsSceneDragDropEvent Class
The QGraphicsSceneDragDropEvent class provides events for drag and drop in the graphics view framework. \since
4.2 \ingroup
graphicsview-api \inmodule
QtWidgets. More...
Header: | #include <QGraphicsSceneDragDropEvent> |
Inherits: | QGraphicsSceneEvent |
Public Functions
QGraphicsSceneDragDropEvent(Type type = None) | |
virtual | ~QGraphicsSceneDragDropEvent() |
void | acceptProposedAction() |
Qt::MouseButtons | buttons() const |
Qt::DropAction | dropAction() const |
const QMimeData * | mimeData() const |
Qt::KeyboardModifiers | modifiers() const |
QPointF | pos() const |
Qt::DropActions | possibleActions() const |
Qt::DropAction | proposedAction() const |
QPointF | scenePos() const |
QPoint | screenPos() const |
void | setButtons(Qt::MouseButtons buttons) |
void | setDropAction(Qt::DropAction action) |
void | setMimeData(const QMimeData *data) |
void | setModifiers(Qt::KeyboardModifiers modifiers) |
void | setPos(const QPointF &pos) |
void | setPossibleActions(Qt::DropActions actions) |
void | setProposedAction(Qt::DropAction action) |
void | setScenePos(const QPointF &pos) |
void | setScreenPos(const QPoint &pos) |
void | setSource(QWidget *source) |
QWidget * | source() const |
Detailed Description
QGraphicsView inherits the drag and drop functionality provided by QWidget. When it receives a drag and drop event, it translates it to a QGraphicsSceneDragDropEvent.
QGraphicsSceneDragDropEvent stores events of type GraphicsSceneDragEnter, GraphicsSceneDragLeave, GraphicsSceneDragMove, or GraphicsSceneDrop.
QGraphicsSceneDragDropEvent contains the position of the mouse cursor in both item, scene, and screen coordinates; this can be retrieved with pos(), scenePos(), and screenPos().
The scene sends the event to the first QGraphicsItem under the mouse cursor that accepts drops; a graphics item is set to accept drops with setAcceptDrops().
Member Function Documentation
[explicit]
QGraphicsSceneDragDropEvent::QGraphicsSceneDragDropEvent(Type type = None)
\internal
Constructs a new QGraphicsSceneDragDropEvent of the specified type. The type can be either QEvent::GraphicsSceneDragEnter, QEvent::GraphicsSceneDragLeave, QEvent::GraphicsSceneDragMove, or QEvent::GraphicsSceneDrop.
[virtual noexcept]
QGraphicsSceneDragDropEvent::~QGraphicsSceneDragDropEvent()
Destroys the object.
void QGraphicsSceneDragDropEvent::acceptProposedAction()
Sets the proposed action as accepted, i.e, the drop action is set to the proposed action. This is equal to:
setDropAction(proposedAction());
When using this function, one should not call accept()
.
See also dropAction(), setDropAction(), and proposedAction().
Qt::MouseButtons QGraphicsSceneDragDropEvent::buttons() const
Returns a Qt::MouseButtons value indicating which buttons were pressed on the mouse when this mouse event was generated.
See also setButtons() and Qt::MouseButtons.
Qt::DropAction QGraphicsSceneDragDropEvent::dropAction() const
Returns the action that was performed in this drag and drop. This should be set by the receiver of the drop and is returned by QDrag::exec().
See also setDropAction() and acceptProposedAction().
const QMimeData *QGraphicsSceneDragDropEvent::mimeData() const
This function returns the MIME data of the event.
See also setMimeData().
Qt::KeyboardModifiers QGraphicsSceneDragDropEvent::modifiers() const
Returns the keyboard modifiers that were pressed when the drag and drop event was created.
See also setModifiers() and Qt::KeyboardModifiers.
QPointF QGraphicsSceneDragDropEvent::pos() const
Returns the mouse position of the event relative to the view that sent the event.
See also setPos(), QGraphicsView, screenPos(), and scenePos().
Qt::DropActions QGraphicsSceneDragDropEvent::possibleActions() const
Returns the possible drop actions that the drag and drop can result in.
See also setPossibleActions() and Qt::DropActions.
Qt::DropAction QGraphicsSceneDragDropEvent::proposedAction() const
Returns the drop action that is proposed, i.e., preferred. The action must be one of the possible actions as defined by possibleActions()
.
See also setProposedAction(), Qt::DropAction, and possibleActions().
QPointF QGraphicsSceneDragDropEvent::scenePos() const
Returns the position of the mouse in scene coordinates.
See also setScenePos(), pos(), and screenPos().
QPoint QGraphicsSceneDragDropEvent::screenPos() const
Returns the position of the mouse relative to the screen.
See also setScreenPos(), pos(), and scenePos().
void QGraphicsSceneDragDropEvent::setButtons(Qt::MouseButtons buttons)
\internal
Sets the mouse buttons that were pressed when the event was created to buttons.
See also Qt::MouseButtons and buttons().
void QGraphicsSceneDragDropEvent::setDropAction(Qt::DropAction action)
This function lets the receiver of the drop set the drop action that was performed to action, which should be one of the possible actions. Call accept()
in stead of acceptProposedAction()
if you use this function.
See also dropAction(), accept(), and possibleActions().
void QGraphicsSceneDragDropEvent::setMimeData(const QMimeData *data)
\internal
This function sets the MIME data for the event.
See also mimeData().
void QGraphicsSceneDragDropEvent::setModifiers(Qt::KeyboardModifiers modifiers)
\internal
Sets the keyboard modifiers that were pressed when the event was created to modifiers.
See also Qt::KeyboardModifiers and modifiers().
void QGraphicsSceneDragDropEvent::setPos(const QPointF &pos)
\internal
Sets the position of the mouse to pos; this should be relative to the widget that generated the event, which normally is a QGraphicsView.
See also pos(), setScenePos(), and setScreenPos().
void QGraphicsSceneDragDropEvent::setPossibleActions(Qt::DropActions actions)
\internal
Sets the possible drop actions that the drag can result in to actions.
See also Qt::DropActions and possibleActions().
void QGraphicsSceneDragDropEvent::setProposedAction(Qt::DropAction action)
\internal
Sets the proposed action to action. The proposed action is a Qt::DropAction that is one of the possible actions as given by possibleActions()
.
See also proposedAction(), Qt::DropAction, and possibleActions().
void QGraphicsSceneDragDropEvent::setScenePos(const QPointF &pos)
\internal
Sets the scene position of the mouse to pos.
See also scenePos(), setScreenPos(), and setPos().
void QGraphicsSceneDragDropEvent::setScreenPos(const QPoint &pos)
\internal
Sets the mouse position relative to the screen to pos.
See also screenPos(), setScenePos(), and setPos().
void QGraphicsSceneDragDropEvent::setSource(QWidget *source)
\internal
This function set the source widget, i.e., the widget that created the drop event, to source.
See also source().
QWidget *QGraphicsSceneDragDropEvent::source() const
This function returns the QGraphicsView that created the QGraphicsSceneDragDropEvent.
See also setSource().