QGraphicsSceneMouseEvent Class Reference

The QGraphicsSceneMouseEvent class provides mouse events in the graphics view framework. More...

#include <qgraphicssceneevent.h>

Inheritance diagram for QGraphicsSceneMouseEvent:

Collaboration diagram for QGraphicsSceneMouseEvent:

Public Member Functions
	QGraphicsSceneMouseEvent (Type type=None)
	~QGraphicsSceneMouseEvent ()
	Destroys the event.
QPointF	pos () const
	Returns the mouse cursor position in item coordinates.
void	setPos (const QPointF &pos)
QPointF	scenePos () const
	Returns the mouse cursor position in scene coordinates.
void	setScenePos (const QPointF &pos)
QPoint	screenPos () const
	Returns the mouse cursor position in screen coordinates.
void	setScreenPos (const QPoint &pos)
QPointF	buttonDownPos (Qt::MouseButton button) const
	Returns the mouse cursor position in item coordinates where the specified button was clicked.
void	setButtonDownPos (Qt::MouseButton button, const QPointF &pos)
QPointF	buttonDownScenePos (Qt::MouseButton button) const
	Returns the mouse cursor position in scene coordinates where the specified button was clicked.
void	setButtonDownScenePos (Qt::MouseButton button, const QPointF &pos)
QPoint	buttonDownScreenPos (Qt::MouseButton button) const
	Returns the mouse cursor position in screen coordinates where the specified button was clicked.
void	setButtonDownScreenPos (Qt::MouseButton button, const QPoint &pos)
QPointF	lastPos () const
	Returns the last recorded mouse cursor position in item coordinates.
void	setLastPos (const QPointF &pos)
QPointF	lastScenePos () const
	Returns the last recorded mouse cursor position in scene coordinates.
void	setLastScenePos (const QPointF &pos)
QPoint	lastScreenPos () const
	Returns the last recorded mouse cursor position in screen coordinates.
void	setLastScreenPos (const QPoint &pos)
Qt::MouseButtons	buttons () const
	Returns the combination of mouse buttons that were pressed at the time the event was sent.
void	setButtons (Qt::MouseButtons buttons)
Qt::MouseButton	button () const
	Returns the mouse button (if any) that caused the event.
void	setButton (Qt::MouseButton button)
Qt::KeyboardModifiers	modifiers () const
	Returns the keyboard modifiers in use at the time the event was sent.
void	setModifiers (Qt::KeyboardModifiers modifiers)
Qt::MouseEventSource	source () const
void	setSource (Qt::MouseEventSource source)
Qt::MouseEventFlags	flags () const
void	setFlags (Qt::MouseEventFlags)
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 ,   SafeAreaMarginsChange = 227 , 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 QGraphicsSceneMouseEvent class provides mouse events in the graphics view framework.

Since

4.2

\inmodule QtWidgets

When a QGraphicsView receives a QMouseEvent, it translates it to a QGraphicsSceneMouseEvent. The event is then forwarded to the QGraphicsScene associated with the view. If the event is not handled by the scene, the view may use it, e.g., for the \l{QGraphicsView::}{DragMode}.

In addition to containing the item, scene, and screen coordinates of the event (as pos(), scenePos(), and screenPos()), mouse events also contain the coordinates of the previous mouse event received by the view. These can be retrieved with lastPos(), lastScreenPos(), and lastScenePos().

See also

QGraphicsSceneContextMenuEvent, QGraphicsSceneHoverEvent, QGraphicsSceneWheelEvent, QMouseEvent

Definition at line 47 of file qgraphicssceneevent.h.

Constructor & Destructor Documentation

QGraphicsSceneMouseEvent()

QGraphicsSceneMouseEvent::QGraphicsSceneMouseEvent ( Type type = None )

explicit

Constructs a generic graphics scene mouse event of the specified type.

Definition at line 357 of file qgraphicssceneevent.cpp.

~QGraphicsSceneMouseEvent()

QGraphicsSceneMouseEvent::~QGraphicsSceneMouseEvent

(

)

Destroys the event.

Definition at line 365 of file qgraphicssceneevent.cpp.

Member Function Documentation

button()

Qt::MouseButton QGraphicsSceneMouseEvent::button

(

)

const

Returns the mouse button (if any) that caused the event.

See also

buttons(), modifiers()

Definition at line 585 of file qgraphicssceneevent.cpp.

buttonDownPos()

QPointF QGraphicsSceneMouseEvent::buttonDownPos

(

Qt::MouseButton

button

)

const

Returns the mouse cursor position in item coordinates where the specified button was clicked.

See also

buttonDownScenePos(), buttonDownScreenPos(), pos()

Definition at line 435 of file qgraphicssceneevent.cpp.

buttonDownScenePos()

QPointF QGraphicsSceneMouseEvent::buttonDownScenePos

(

Qt::MouseButton

button

)

const

Returns the mouse cursor position in scene coordinates where the specified button was clicked.

See also

buttonDownPos(), buttonDownScreenPos(), scenePos()

Definition at line 456 of file qgraphicssceneevent.cpp.

buttonDownScreenPos()

QPoint QGraphicsSceneMouseEvent::buttonDownScreenPos

(

Qt::MouseButton

button

)

const

Returns the mouse cursor position in screen coordinates where the specified button was clicked.

See also

screenPos(), buttonDownPos(), buttonDownScenePos()

Definition at line 477 of file qgraphicssceneevent.cpp.

buttons()

Qt::MouseButtons QGraphicsSceneMouseEvent::buttons

(

)

const

Returns the combination of mouse buttons that were pressed at the time the event was sent.

See also

button(), modifiers()

Definition at line 565 of file qgraphicssceneevent.cpp.

flags()

Qt::MouseEventFlags QGraphicsSceneMouseEvent::flags

(

)

const

Since

5.4

Returns the mouse event flags.

The mouse event flags provide additional information about a mouse event.

See also

Qt::MouseEventFlag

QMouseEvent::flags()

Definition at line 650 of file qgraphicssceneevent.cpp.

lastPos()

QPointF QGraphicsSceneMouseEvent::lastPos

(

)

const

Returns the last recorded mouse cursor position in item coordinates.

See also

lastScenePos(), lastScreenPos(), pos()

Definition at line 498 of file qgraphicssceneevent.cpp.

lastScenePos()

QPointF QGraphicsSceneMouseEvent::lastScenePos

(

)

const

Returns the last recorded mouse cursor position in scene coordinates.

The last recorded position is the position of the previous mouse event received by the view that created the event.

See also

lastPos(), lastScreenPos(), scenePos()

Definition at line 521 of file qgraphicssceneevent.cpp.

lastScreenPos()

QPoint QGraphicsSceneMouseEvent::lastScreenPos

(

)

const

Returns the last recorded mouse cursor position in screen coordinates.

The last recorded position is the position of the previous mouse event received by the view that created the event.

See also

lastPos(), lastScenePos(), screenPos()

Definition at line 544 of file qgraphicssceneevent.cpp.

modifiers()

Qt::KeyboardModifiers QGraphicsSceneMouseEvent::modifiers

(

)

const

Returns the keyboard modifiers in use at the time the event was sent.

See also

buttons(), button()

Definition at line 606 of file qgraphicssceneevent.cpp.

pos()

QPointF QGraphicsSceneMouseEvent::pos

(

)

const

Returns the mouse cursor position in item coordinates.

See also

scenePos(), screenPos(), lastPos()

Definition at line 374 of file qgraphicssceneevent.cpp.

scenePos()

QPointF QGraphicsSceneMouseEvent::scenePos

(

)

const

Returns the mouse cursor position in scene coordinates.

See also

pos(), screenPos(), lastScenePos()

Definition at line 394 of file qgraphicssceneevent.cpp.

screenPos()

QPoint QGraphicsSceneMouseEvent::screenPos

(

)

const

Returns the mouse cursor position in screen coordinates.

See also

pos(), scenePos(), lastScreenPos()

Definition at line 414 of file qgraphicssceneevent.cpp.

setButton()

void QGraphicsSceneMouseEvent::setButton

(

Qt::MouseButton

button

)

Definition at line 594 of file qgraphicssceneevent.cpp.

setButtonDownPos()

void QGraphicsSceneMouseEvent::setButtonDownPos	(	Qt::MouseButton	button,
		const QPointF &	pos )

Definition at line 444 of file qgraphicssceneevent.cpp.

setButtonDownScenePos()

void QGraphicsSceneMouseEvent::setButtonDownScenePos	(	Qt::MouseButton	button,
		const QPointF &	pos )

Definition at line 465 of file qgraphicssceneevent.cpp.

setButtonDownScreenPos()

void QGraphicsSceneMouseEvent::setButtonDownScreenPos	(	Qt::MouseButton	button,
		const QPoint &	pos )

Definition at line 486 of file qgraphicssceneevent.cpp.

setButtons()

void QGraphicsSceneMouseEvent::setButtons

(

Qt::MouseButtons

buttons

)

Definition at line 574 of file qgraphicssceneevent.cpp.

setFlags()

void QGraphicsSceneMouseEvent::setFlags

(

Qt::MouseEventFlags

flags

)

Since

5.4

Definition at line 660 of file qgraphicssceneevent.cpp.

setLastPos()

void QGraphicsSceneMouseEvent::setLastPos

(

const QPointF &

pos

)

Definition at line 507 of file qgraphicssceneevent.cpp.

setLastScenePos()

void QGraphicsSceneMouseEvent::setLastScenePos

(

const QPointF &

pos

)

Definition at line 530 of file qgraphicssceneevent.cpp.

setLastScreenPos()

void QGraphicsSceneMouseEvent::setLastScreenPos

(

const QPoint &

pos

)

Definition at line 553 of file qgraphicssceneevent.cpp.

setModifiers()

void QGraphicsSceneMouseEvent::setModifiers

(

Qt::KeyboardModifiers

modifiers

)

Definition at line 669 of file qgraphicssceneevent.cpp.

setPos()

void QGraphicsSceneMouseEvent::setPos

(

const QPointF &

pos

)

Definition at line 383 of file qgraphicssceneevent.cpp.

setScenePos()

void QGraphicsSceneMouseEvent::setScenePos

(

const QPointF &

pos

)

Definition at line 403 of file qgraphicssceneevent.cpp.

setScreenPos()

void QGraphicsSceneMouseEvent::setScreenPos

(

const QPoint &

pos

)

Definition at line 423 of file qgraphicssceneevent.cpp.

setSource()

void QGraphicsSceneMouseEvent::setSource

(

Qt::MouseEventSource

source

)

Since

5.4

Definition at line 634 of file qgraphicssceneevent.cpp.

source()

Qt::MouseEventSource QGraphicsSceneMouseEvent::source

(

)

const

Since

5.4

Returns information about the mouse event source.

The mouse event source can be used to distinguish between genuine and artificial mouse events. The latter are events that are synthesized from touch events by the operating system or Qt itself.

See also

Qt::MouseEventSource

QMouseEvent::source()

Definition at line 624 of file qgraphicssceneevent.cpp.

---

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

• qtbase/src/widgets/graphicsview/qgraphicssceneevent.h (c0e526f70f58c9b70fea1b9426d14b18f1f0066c)
• qtbase/src/widgets/graphicsview/qgraphicssceneevent.cpp (c0e526f70f58c9b70fea1b9426d14b18f1f0066c)