The QGraphicsSceneDragDropEvent class provides events for drag and drop in the graphics view framework. More...

#include <qgraphicssceneevent.h>

Inheritance diagram for QGraphicsSceneDragDropEvent:

Collaboration diagram for QGraphicsSceneDragDropEvent:

Public Member Functions
	QGraphicsSceneDragDropEvent (Type type=None)

	~QGraphicsSceneDragDropEvent ()
	Destroys the object.

QPointF	pos () const
	Returns the mouse position of the event relative to the view that sent the event.

void	setPos (const QPointF &pos)

QPointF	scenePos () const
	Returns the position of the mouse in scene coordinates.

void	setScenePos (const QPointF &pos)

QPoint	screenPos () const
	Returns the position of the mouse relative to the screen.

void	setScreenPos (const QPoint &pos)

Qt::MouseButtons	buttons () const
	Returns a Qt::MouseButtons value indicating which buttons were pressed on the mouse when this mouse event was generated.

void	setButtons (Qt::MouseButtons buttons)

Qt::KeyboardModifiers	modifiers () const
	Returns the keyboard modifiers that were pressed when the drag and drop event was created.

void	setModifiers (Qt::KeyboardModifiers modifiers)

Qt::DropActions	possibleActions () const
	Returns the possible drop actions that the drag and drop can result in.

void	setPossibleActions (Qt::DropActions actions)

Qt::DropAction	proposedAction () const
	Returns the drop action that is proposed, i.e., preferred.

void	setProposedAction (Qt::DropAction action)

void	acceptProposedAction ()
	Sets the proposed action as accepted, i.e, the drop action is set to the proposed action.

Qt::DropAction	dropAction () const
	Returns the action that was performed in this drag and drop.

void	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 \l{QGraphicsSceneDragDropEvent::possibleActions()}{possible actions}.

QWidget *	source () const
	This function returns the QGraphicsView that created the QGraphicsSceneDragDropEvent.

void	setSource (QWidget *source)

const QMimeData *	mimeData () const
	This function returns the MIME data of the event.

void	setMimeData (const QMimeData *data)

Public Member Functions inherited from QGraphicsSceneEvent
	QGraphicsSceneEvent (Type type)

	~QGraphicsSceneEvent ()
	Destroys the event.

QWidget *	widget () const
	Returns the widget where the event originated, or \nullptr if the event originates from another application.

void	setWidget (QWidget *widget)

quint64	timestamp () const

void	setTimestamp (quint64 ts)

Public Member Functions inherited from QEvent
	QEvent (Type type)
	Constructs an event object of type type.

virtual	~QEvent ()
	Destroys the event.

Type	type () const
	Returns the event type.

bool	spontaneous () const
	Returns `true` if the event originated outside the application (a system event); otherwise returns `false`.

virtual void	setAccepted (bool accepted)

bool	isAccepted () const

void	accept ()
	Sets the accept flag of the event object, the equivalent of calling setAccepted(true).

void	ignore ()
	Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false).

bool	isInputEvent () const noexcept

bool	isPointerEvent () const noexcept

bool	isSinglePointEvent () const noexcept

virtual QEvent *	clone () const
	Creates and returns an identical copy of this event.

Additional Inherited Members
Public Types inherited from QEvent
enum	Type { None = 0 , Timer = 1 , MouseButtonPress = 2 , MouseButtonRelease = 3 , MouseButtonDblClick = 4 , MouseMove = 5 , KeyPress = 6 , KeyRelease = 7 , FocusIn = 8 , FocusOut = 9 , FocusAboutToChange = 23 , Enter = 10 , Leave = 11 , Paint = 12 , Move = 13 , Resize = 14 , Create = 15 , Destroy = 16 , Show = 17 , Hide = 18 , Close = 19 , Quit = 20 , ParentChange = 21 , ParentAboutToChange = 131 , ThreadChange = 22 , WindowActivate = 24 , WindowDeactivate = 25 , ShowToParent = 26 , HideToParent = 27 , Wheel = 31 , WindowTitleChange = 33 , WindowIconChange = 34 , ApplicationWindowIconChange = 35 , ApplicationFontChange = 36 , ApplicationLayoutDirectionChange = 37 , ApplicationPaletteChange = 38 , PaletteChange = 39 , Clipboard = 40 , Speech = 42 , MetaCall = 43 , SockAct = 50 , WinEventAct = 132 , DeferredDelete = 52 , DragEnter = 60 , DragMove = 61 , DragLeave = 62 , Drop = 63 , DragResponse = 64 , ChildAdded = 68 , ChildPolished = 69 , ChildRemoved = 71 , ShowWindowRequest = 73 , PolishRequest = 74 , Polish = 75 , LayoutRequest = 76 , UpdateRequest = 77 , UpdateLater = 78 , EmbeddingControl = 79 , ActivateControl = 80 , DeactivateControl = 81 , ContextMenu = 82 , InputMethod = 83 , TabletMove = 87 , LocaleChange = 88 , LanguageChange = 89 , LayoutDirectionChange = 90 , Style = 91 , TabletPress = 92 , TabletRelease = 93 , OkRequest = 94 , HelpRequest = 95 , IconDrag = 96 , FontChange = 97 , EnabledChange = 98 , ActivationChange = 99 , StyleChange = 100 , IconTextChange = 101 , ModifiedChange = 102 , MouseTrackingChange = 109 , WindowBlocked = 103 , WindowUnblocked = 104 , WindowStateChange = 105 , ReadOnlyChange = 106 , ToolTip = 110 , WhatsThis = 111 , StatusTip = 112 , ActionChanged = 113 , ActionAdded = 114 , ActionRemoved = 115 , FileOpen = 116 , Shortcut = 117 , ShortcutOverride = 51 , WhatsThisClicked = 118 , ToolBarChange = 120 , ApplicationActivate = 121 , ApplicationActivated = ApplicationActivate , ApplicationDeactivate = 122 , ApplicationDeactivated = ApplicationDeactivate , QueryWhatsThis = 123 , EnterWhatsThisMode = 124 , LeaveWhatsThisMode = 125 , ZOrderChange = 126 , HoverEnter = 127 , HoverLeave = 128 , HoverMove = 129 , AcceptDropsChange = 152 , ZeroTimerEvent = 154 , GraphicsSceneMouseMove = 155 , GraphicsSceneMousePress = 156 , GraphicsSceneMouseRelease = 157 , GraphicsSceneMouseDoubleClick = 158 , GraphicsSceneContextMenu = 159 , GraphicsSceneHoverEnter = 160 , GraphicsSceneHoverMove = 161 , GraphicsSceneHoverLeave = 162 , GraphicsSceneHelp = 163 , GraphicsSceneDragEnter = 164 , GraphicsSceneDragMove = 165 , GraphicsSceneDragLeave = 166 , GraphicsSceneDrop = 167 , GraphicsSceneWheel = 168 , GraphicsSceneLeave = 220 , KeyboardLayoutChange = 169 , DynamicPropertyChange = 170 , TabletEnterProximity = 171 , TabletLeaveProximity = 172 , NonClientAreaMouseMove = 173 , NonClientAreaMouseButtonPress = 174 , NonClientAreaMouseButtonRelease = 175 , NonClientAreaMouseButtonDblClick = 176 , MacSizeChange = 177 , ContentsRectChange = 178 , MacGLWindowChange = 179 , FutureCallOut = 180 , GraphicsSceneResize = 181 , GraphicsSceneMove = 182 , CursorChange = 183 , ToolTipChange = 184 , NetworkReplyUpdated = 185 , GrabMouse = 186 , UngrabMouse = 187 , GrabKeyboard = 188 , UngrabKeyboard = 189 , StateMachineSignal = 192 , StateMachineWrapped = 193 , TouchBegin = 194 , TouchUpdate = 195 , TouchEnd = 196 , NativeGesture = 197 , RequestSoftwareInputPanel = 199 , CloseSoftwareInputPanel = 200 , WinIdChange = 203 , Gesture = 198 , GestureOverride = 202 , ScrollPrepare = 204 , Scroll = 205 , Expose = 206 , InputMethodQuery = 207 , OrientationChange = 208 , TouchCancel = 209 , ThemeChange = 210 , SockClose = 211 , PlatformPanel = 212 , StyleAnimationUpdate = 213 , ApplicationStateChange = 214 , WindowChangeInternal = 215 , ScreenChangeInternal = 216 , PlatformSurface = 217 , Pointer = 218 , TabletTrackingChange = 219 , WindowAboutToChangeInternal = 221 , DevicePixelRatioChange = 222 , ChildWindowAdded = 223 , ChildWindowRemoved = 224 , ParentWindowAboutToChange = 225 , ParentWindowChange = 226 , User = 1000 , MaxUser = 65535 }
	This enum type defines the valid event types in Qt. More...

Static Public Member Functions inherited from QEvent
static int	registerEventType (int hint=-1) noexcept

Protected Member Functions inherited from QGraphicsSceneEvent
	QGraphicsSceneEvent (QGraphicsSceneEventPrivate &dd, Type type=None)

Protected Member Functions inherited from QEvent
	QT_DEFINE_TAG_STRUCT (InputEventTag)

	QEvent (Type type, InputEventTag)

	QT_DEFINE_TAG_STRUCT (PointerEventTag)

	QEvent (Type type, PointerEventTag)

	QT_DEFINE_TAG_STRUCT (SinglePointEventTag)

	QEvent (Type type, SinglePointEventTag)

Protected Attributes inherited from QGraphicsSceneEvent
QScopedPointer< QGraphicsSceneEventPrivate >	d_ptr

Protected Attributes inherited from QEvent
quint16	t

Detailed Description

The QGraphicsSceneDragDropEvent class provides events for drag and drop in the graphics view framework.

Since: 4.2

\inmodule QtWidgets

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 \l{QGraphicsItem::}{setAcceptDrops()}.

Definition at line 222 of file qgraphicssceneevent.h.

Constructor & Destructor Documentation

◆ QGraphicsSceneDragDropEvent()

QGraphicsSceneDragDropEvent::QGraphicsSceneDragDropEvent ( Type type = None )

explicit

Constructs a new QGraphicsSceneDragDropEvent of the specified type. The type can be either QEvent::GraphicsSceneDragEnter, QEvent::GraphicsSceneDragLeave, QEvent::GraphicsSceneDragMove, or QEvent::GraphicsSceneDrop.

Definition at line 1371 of file qgraphicssceneevent.cpp.

◆ ~QGraphicsSceneDragDropEvent()

QGraphicsSceneDragDropEvent::~QGraphicsSceneDragDropEvent ( )

Destroys the object.

Definition at line 1379 of file qgraphicssceneevent.cpp.

Member Function Documentation

◆ acceptProposedAction()

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

Definition at line 1574 of file qgraphicssceneevent.cpp.

◆ buttons()

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: Qt::MouseButtons

Definition at line 1463 of file qgraphicssceneevent.cpp.

◆ dropAction()

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

Definition at line 1588 of file qgraphicssceneevent.cpp.

◆ mimeData()

const QMimeData * QGraphicsSceneDragDropEvent::mimeData ( ) const

This function returns the MIME data of the event.

Definition at line 1634 of file qgraphicssceneevent.cpp.

◆ modifiers()

Qt::KeyboardModifiers QGraphicsSceneDragDropEvent::modifiers ( ) const

Returns the keyboard modifiers that were pressed when the drag and drop event was created.

See also: Qt::KeyboardModifiers

Definition at line 1488 of file qgraphicssceneevent.cpp.

◆ pos()

QPointF QGraphicsSceneDragDropEvent::pos ( ) const

Returns the mouse position of the event relative to the view that sent the event.

See also: QGraphicsView, screenPos(), scenePos()

Definition at line 1389 of file qgraphicssceneevent.cpp.

◆ possibleActions()

Qt::DropActions QGraphicsSceneDragDropEvent::possibleActions ( ) const

Returns the possible drop actions that the drag and drop can result in.

See also: Qt::DropActions

Definition at line 1515 of file qgraphicssceneevent.cpp.

◆ proposedAction()

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: Qt::DropAction, possibleActions()

Definition at line 1542 of file qgraphicssceneevent.cpp.

◆ scenePos()

QPointF QGraphicsSceneDragDropEvent::scenePos ( ) const

Returns the position of the mouse in scene coordinates.

See also: pos(), screenPos()

Definition at line 1415 of file qgraphicssceneevent.cpp.

◆ screenPos()

QPoint QGraphicsSceneDragDropEvent::screenPos ( ) const

Returns the position of the mouse relative to the screen.

See also: pos(), scenePos()

Definition at line 1438 of file qgraphicssceneevent.cpp.

◆ setButtons()

void QGraphicsSceneDragDropEvent::setButtons ( Qt::MouseButtons buttons )

Sets the mouse buttons that were pressed when the event was created to buttons.

See also: Qt::MouseButtons, buttons()

Definition at line 1476 of file qgraphicssceneevent.cpp.

◆ setDropAction()

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 \l{QGraphicsSceneDragDropEvent::possibleActions()}{possible actions}.

Call accept() in stead of acceptProposedAction() if you use this function.

See also: dropAction(), accept(), possibleActions()

Definition at line 1604 of file qgraphicssceneevent.cpp.

◆ setMimeData()

void QGraphicsSceneDragDropEvent::setMimeData ( const QMimeData * data )

This function sets the MIME data for the event.

Definition at line 1644 of file qgraphicssceneevent.cpp.

◆ setModifiers()

void QGraphicsSceneDragDropEvent::setModifiers ( Qt::KeyboardModifiers modifiers )

Sets the keyboard modifiers that were pressed when the event was created to modifiers.

See also: Qt::KeyboardModifiers, modifiers()

Definition at line 1502 of file qgraphicssceneevent.cpp.

◆ setPos()

void QGraphicsSceneDragDropEvent::setPos ( const QPointF & pos )

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

Definition at line 1404 of file qgraphicssceneevent.cpp.

◆ setPossibleActions()

void QGraphicsSceneDragDropEvent::setPossibleActions ( Qt::DropActions actions )

Sets the possible drop actions that the drag can result in to actions.

See also: Qt::DropActions, possibleActions()

Definition at line 1528 of file qgraphicssceneevent.cpp.

◆ setProposedAction()

void QGraphicsSceneDragDropEvent::setProposedAction ( Qt::DropAction action )

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

Definition at line 1557 of file qgraphicssceneevent.cpp.

◆ setScenePos()

void QGraphicsSceneDragDropEvent::setScenePos ( const QPointF & pos )

Sets the scene position of the mouse to pos.

See also: scenePos(), setScreenPos(), setPos()

Definition at line 1427 of file qgraphicssceneevent.cpp.

◆ setScreenPos()

void QGraphicsSceneDragDropEvent::setScreenPos ( const QPoint & pos )

Sets the mouse position relative to the screen to pos.

See also: screenPos(), setScenePos(), setPos()

Definition at line 1450 of file qgraphicssceneevent.cpp.

◆ setSource()

void QGraphicsSceneDragDropEvent::setSource ( QWidget * source )

This function set the source widget, i.e., the widget that created the drop event, to source.

Definition at line 1625 of file qgraphicssceneevent.cpp.

◆ source()

QWidget * QGraphicsSceneDragDropEvent::source ( ) const

This function returns the QGraphicsView that created the QGraphicsSceneDragDropEvent.

Definition at line 1614 of file qgraphicssceneevent.cpp.

The documentation for this class was generated from the following files:

qtbase/src/widgets/graphicsview/qgraphicssceneevent.h (05fc3aef53348fb58be6308076e000825b704e58)
qtbase/src/widgets/graphicsview/qgraphicssceneevent.cpp (05fc3aef53348fb58be6308076e000825b704e58)

Public Member Functions

Additional Inherited Members