QSinglePointEvent Class Reference

A base class for pointer events containing a single point, such as mouse events. More...

#include <qevent.h>

Inheritance diagram for QSinglePointEvent:

Collaboration diagram for QSinglePointEvent:

Public Member Functions
Qt::MouseButton	button () const
Qt::MouseButtons	buttons () const
QPointF	position () const
QPointF	scenePosition () const
QPointF	globalPosition () const
bool	isBeginEvent () const override
bool	isUpdateEvent () const override
bool	isEndEvent () const override
QObject *	exclusivePointGrabber () const
void	setExclusivePointGrabber (QObject *exclusiveGrabber)
QSinglePointEvent *	clone () const override
Public Member Functions inherited from QPointerEvent
	QPointerEvent (Type type, const QPointingDevice *dev, Qt::KeyboardModifiers modifiers=Qt::NoModifier, const QList< QEventPoint > &points={})
	~QPointerEvent ()
const QPointingDevice *	pointingDevice () const
QPointingDevice::PointerType	pointerType () const
void	setTimestamp (quint64 timestamp) override
qsizetype	pointCount () const
QEventPoint &	point (qsizetype i)
const QList< QEventPoint > &	points () const
QEventPoint *	pointById (int id)
bool	allPointsGrabbed () const
bool	allPointsAccepted () const
virtual void	setAccepted (bool accepted) override
QObject *	exclusiveGrabber (const QEventPoint &point) const
void	setExclusiveGrabber (const QEventPoint &point, QObject *exclusiveGrabber)
QList< QPointer< QObject > >	passiveGrabbers (const QEventPoint &point) const
void	clearPassiveGrabbers (const QEventPoint &point)
bool	addPassiveGrabber (const QEventPoint &point, QObject *grabber)
bool	removePassiveGrabber (const QEventPoint &point, QObject *grabber)
Public Member Functions inherited from QInputEvent
	QInputEvent (Type type, const QInputDevice *m_dev, Qt::KeyboardModifiers modifiers=Qt::NoModifier)
	~QInputEvent ()
const QInputDevice *	device () const
QInputDevice::DeviceType	deviceType () const
Qt::KeyboardModifiers	modifiers () const
void	setModifiers (Qt::KeyboardModifiers modifiers)
quint64	timestamp () const
Public Member Functions inherited from QEvent
	QEvent (Type type)
virtual	~QEvent ()
Type	type () const
bool	spontaneous () const
bool	isAccepted () const
void	accept ()
void	ignore ()
bool	isInputEvent () const noexcept
bool	isPointerEvent () const noexcept
bool	isSinglePointEvent () const noexcept

Protected Member Functions
	QSinglePointEvent (Type type, const QPointingDevice *dev, const QEventPoint &point, Qt::MouseButton button, Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, Qt::MouseEventSource source)
	QSinglePointEvent (Type type, const QPointingDevice *dev, const QPointF &localPos, const QPointF &scenePos, const QPointF &globalPos, Qt::MouseButton button, Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, Qt::MouseEventSource source=Qt::MouseEventNotSynthesized)
Protected Member Functions inherited from QPointerEvent
	QPointerEvent (Type type, SinglePointEventTag, const QInputDevice *dev, Qt::KeyboardModifiers modifiers=Qt::NoModifier)
Protected Member Functions inherited from QInputEvent
	QInputEvent (Type type, PointerEventTag, const QInputDevice *dev, Qt::KeyboardModifiers modifiers=Qt::NoModifier)
	QInputEvent (Type type, SinglePointEventTag, const QInputDevice *dev, Qt::KeyboardModifiers modifiers=Qt::NoModifier)
Protected Member Functions inherited from QEvent
	QEvent (Type type, InputEventTag)
	QEvent (Type type, PointerEventTag)
	QEvent (Type type, SinglePointEventTag)

Protected Attributes
Qt::MouseButton	m_button = Qt::NoButton
Qt::MouseButtons	m_mouseState = Qt::NoButton
Qt::MouseEventSource	m_source
quint16	m_reserved
quint16	m_reserved2: 11
quint16	m_doubleClick: 1
quint16	m_phase: 3
quint16	m_invertedScrolling: 1
Protected Attributes inherited from QPointerEvent
QList< QEventPoint >	m_points
Protected Attributes inherited from QInputEvent
const QInputDevice *	m_dev = nullptr
quint64	m_timeStamp = 0
Qt::KeyboardModifiers	m_modState = Qt::NoModifier
quint32	m_reserved = 0
Protected Attributes inherited from QEvent
quint16	t

Properties
Q_GADGETQObject *	exclusivePointGrabber
	the object that will receive future updates More...

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 , User = 1000 , MaxUser = 65535 }
Static Public Member Functions inherited from QEvent
static int	registerEventType (int hint=-1) noexcept

Detailed Description

A base class for pointer events containing a single point, such as mouse events.

Since

6.0 \inmodule QtGui

Definition at line 139 of file qevent.h.

Constructor & Destructor Documentation

QSinglePointEvent() [1/2]

QSinglePointEvent::QSinglePointEvent ( Type  type, const QPointingDevice *  dev, const QEventPoint &  point, Qt::MouseButton  button, Qt::MouseButtons  buttons, Qt::KeyboardModifiers  modifiers, Qt::MouseEventSource  source  )

protected

QSinglePointEvent() [2/2]

QSinglePointEvent::QSinglePointEvent ( Type  type, const QPointingDevice *  dev, const QPointF &  localPos, const QPointF &  scenePos, const QPointF &  globalPos, Qt::MouseButton  button, Qt::MouseButtons  buttons, Qt::KeyboardModifiers  modifiers, Qt::MouseEventSource  source = Qt::MouseEventNotSynthesized  )

protected

Member Function Documentation

button()

Qt::MouseButton QSinglePointEvent::button ( ) const

inline

Returns the button that caused the event.

The returned value is always Qt::NoButton for mouse move events, as well as \l TabletMove, \l TabletEnterProximity, and \l TabletLeaveProximity events.

See also

buttons()

Definition at line 147 of file qevent.h.

Here is the caller graph for this function:

buttons()

Qt::MouseButtons QSinglePointEvent::buttons ( ) const

inline

Returns the button state when the event was generated.

The button state is a combination of Qt::LeftButton, Qt::RightButton, and Qt::MiddleButton using the OR operator.

For mouse move or \l TabletMove events, this is all buttons that are pressed down.

For mouse press, double click, or \l TabletPress events, this includes the button that caused the event.

For mouse release or \l TabletRelease events, this excludes the button that caused the event.

See also

button()

Definition at line 148 of file qevent.h.

Here is the caller graph for this function:

clone()

QSinglePointEvent* QSinglePointEvent::clone ( ) const

inlineoverridevirtual

Creates and returns an identical copy of this event.

Since

6.0

Reimplemented from QPointerEvent.

Reimplemented in QHoverEvent, QMouseEvent, and QEnterEvent.

Definition at line 166 of file qevent.h.

exclusivePointGrabber()

QObject* QSinglePointEvent::exclusivePointGrabber ( ) const

inline

Definition at line 161 of file qevent.h.

Here is the call graph for this function:

globalPosition()

QPointF QSinglePointEvent::globalPosition ( ) const

inline

Returns the position of the point in this event on the screen or virtual desktop.

Note

The global position of a mouse pointer is recorded {at the time of the event}. This is important on asynchronous window systems such as X11; whenever you move your widgets around in response to mouse events, globalPosition() can differ a lot from the current cursor position returned by QCursor::pos().

See also

position()

Definition at line 154 of file qevent.h.

Here is the caller graph for this function:

isBeginEvent()

bool QSinglePointEvent::isBeginEvent ( ) const

overridevirtual

Returns true if this event represents a \l {button()}{button} being pressed.

Reimplemented from QPointerEvent.

Definition at line 604 of file qevent.cpp.

Here is the call graph for this function:

isEndEvent()

bool QSinglePointEvent::isEndEvent ( ) const

overridevirtual

Returns true if this event represents a \l {button()}{button} being released.

Reimplemented from QPointerEvent.

Definition at line 626 of file qevent.cpp.

isUpdateEvent()

bool QSinglePointEvent::isUpdateEvent ( ) const

overridevirtual

Returns true if this event does not include a change in \l {buttons()}{button state}.

Reimplemented from QPointerEvent.

Reimplemented in QHoverEvent.

Definition at line 616 of file qevent.cpp.

Here is the call graph for this function:

position()

QPointF QSinglePointEvent::position ( ) const

inline

Returns the position of the point in this event, relative to the widget or item that received the event.

If you move your widgets around in response to mouse events, use globalPosition() instead.

See also

globalPosition()

Definition at line 150 of file qevent.h.

Here is the caller graph for this function:

scenePosition()

QPointF QSinglePointEvent::scenePosition ( ) const

inline

Returns the position of the point in this event, relative to the window or scene.

See also

QEventPoint::scenePosition

Definition at line 152 of file qevent.h.

setExclusivePointGrabber()

void QSinglePointEvent::setExclusivePointGrabber ( QObject *  exclusiveGrabber )

inline

Definition at line 163 of file qevent.h.

Here is the call graph for this function:

Member Data Documentation

m_button

Qt::MouseButton QSinglePointEvent::m_button = Qt::NoButton

protected

Definition at line 178 of file qevent.h.

m_doubleClick

quint16 QSinglePointEvent::m_doubleClick

protected

Definition at line 190 of file qevent.h.

m_invertedScrolling

quint16 QSinglePointEvent::m_invertedScrolling

protected

Definition at line 193 of file qevent.h.

m_mouseState

Qt::MouseButtons QSinglePointEvent::m_mouseState = Qt::NoButton

protected

Definition at line 179 of file qevent.h.

m_phase

quint16 QSinglePointEvent::m_phase

protected

Definition at line 192 of file qevent.h.

m_reserved

quint16 QSinglePointEvent::m_reserved

protected

Definition at line 187 of file qevent.h.

m_reserved2

quint16 QSinglePointEvent::m_reserved2

protected

Definition at line 188 of file qevent.h.

m_source

Qt::MouseEventSource QSinglePointEvent::m_source

protected

Definition at line 180 of file qevent.h.

Property Documentation

exclusivePointGrabber

QSinglePointEvent::exclusivePointGrabber

readwrite

the object that will receive future updates

The exclusive grabber is an object that has chosen to receive all future update events and the release event containing the same point that this event carries.

Setting the exclusivePointGrabber property is a convenience equivalent to:

setExclusiveGrabber(points().first(), exclusiveGrabber);

Definition at line 141 of file qevent.h.

---

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

• src/gui/kernel/qevent.h
• src/gui/kernel/qevent.cpp