QSinglePointEvent Class

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

Header: #include <QSinglePointEvent>
CMake: find_package(Qt6 COMPONENTS Gui REQUIRED)
target_link_libraries(mytarget PRIVATE Qt6::Gui)
qmake: QT += gui
Since: Qt 6.0
Inherits: QPointerEvent
Inherited By:

QEnterEvent, QHoverEvent, QMouseEvent, QNativeGestureEvent, QTabletEvent, and QWheelEvent

Properties

Public Functions

Qt::MouseButton button() const
Qt::MouseButtons buttons() const
QObject *exclusivePointGrabber() const
QPointF globalPosition() const
QPointF position() const
QPointF scenePosition() const
void setExclusivePointGrabber(QObject *exclusiveGrabber)

Reimplemented Public Functions

virtual bool isBeginEvent() const override
virtual bool isEndEvent() const override
virtual bool isUpdateEvent() const override

Detailed Description

Property Documentation

exclusivePointGrabber : QObject*

This property holds 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);

Access functions:

QObject *exclusivePointGrabber() const
void setExclusivePointGrabber(QObject *exclusiveGrabber)

Member Function Documentation

Qt::MouseButton QSinglePointEvent::button() const

Returns the button that caused the event.

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

See also buttons().

Qt::MouseButtons QSinglePointEvent::buttons() const

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 TabletMove events, this is all buttons that are pressed down.

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

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

See also button().

QPointF QSinglePointEvent::globalPosition() const

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

[override virtual] bool QSinglePointEvent::isBeginEvent() const

Returns true if this event represents a button being pressed.

[override virtual] bool QSinglePointEvent::isEndEvent() const

Returns true if this event represents a button being released.

[override virtual] bool QSinglePointEvent::isUpdateEvent() const

Returns true if this event does not include a change in button state.

QPointF QSinglePointEvent::position() const

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

QPointF QSinglePointEvent::scenePosition() const

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

See also QEventPoint::scenePosition.

© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.