QPointerEvent Class | Qt GUI | Qt 6.11.1
Description: A base class for pointer events.

- Qt 6.11
- Qt GUI
- C++ Classes
- QPointerEvent
- Qt 6.11.1 Reference Documentation

# QPointerEvent Class

A base class for pointer events. More...

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

- List of all members, including inherited members

## Public Functions

bool | addPassiveGrabber(const QEventPoint &point, QObject *grabber)
bool | allPointsAccepted() const
bool | allPointsGrabbed() const
void | clearPassiveGrabbers(const QEventPoint &point)
QObject * | exclusiveGrabber(const QEventPoint &point) const
QList<QPointer<QObject>> | passiveGrabbers(const QEventPoint &point) const
QEventPoint & | point(qsizetype i)
QEventPoint * | pointById(int id)
qsizetype | pointCount() const
QPointingDevice::PointerType | pointerType() const
const QPointingDevice * | pointingDevice() const
const QList<QEventPoint> & | points() const
bool | removePassiveGrabber(const QEventPoint &point, QObject *grabber)
void | setExclusiveGrabber(const QEventPoint &point, QObject *exclusiveGrabber)

## Reimplemented Public Functions

virtual void | setAccepted(bool accepted) override

## Detailed Description

## Member Function Documentation

### bool QPointerEvent::addPassiveGrabber(const QEventPoint &point, QObject *grabber)

Informs the delivery logic that the given grabber is to receive all future update events and the release event containing the given point, regardless where else those events may be delivered.

It's only for use by Qt Quick Input Handlers.

Returns `false` if grabber was already added, `true` otherwise.

### bool QPointerEvent::allPointsAccepted() const

Returns `true` if isPointAccepted() is `true` for every point in points(); otherwise `false`.

### bool QPointerEvent::allPointsGrabbed() const

Returns `true` if every point in points() has either an exclusiveGrabber() or one or more passiveGrabbers().

### void QPointerEvent::clearPassiveGrabbers(const QEventPoint &point)

Removes all passive grabbers from the given point.

It's only for use by Qt Quick Input Handlers.

See also QPointerEvent::addPassiveGrabber().

### QObject *QPointerEvent::exclusiveGrabber(const QEventPoint &point) const

Returns the object which has been set to receive all future update events and the release event containing the given point.

It's mainly for use in Qt Quick at this time.

See also setExclusiveGrabber().

### QList<QPointer<QObject>> QPointerEvent::passiveGrabbers(const QEventPoint &point) const

Returns the list of objects that have been requested to receive all future update events and the release event containing the given point.

It's only for use by Qt Quick Input Handlers.

See also QPointerEvent::addPassiveGrabber().

### QEventPoint &QPointerEvent::point(qsizetype i)

Returns a QEventPoint reference for the point at index i.

### QEventPoint *QPointerEvent::pointById(int id)

Returns the point whose id matches the given id, or `nullptr` if no such point is found.

### qsizetype QPointerEvent::pointCount() const

Returns the number of points in this pointer event.

### QPointingDevice::PointerType QPointerEvent::pointerType() const

Returns the type of point that generated the event.

### const QPointingDevice *QPointerEvent::pointingDevice() const

Returns the source device from which this event originates.

This is the same as QInputEvent::device() but typecast for convenience.

### const QList<QEventPoint> &QPointerEvent::points() const

Returns a list of points in this pointer event.

### bool QPointerEvent::removePassiveGrabber(const QEventPoint &point, QObject *grabber)

Removes the passive grabber from the given point if it was previously added. Returns `true` if it had been a passive grabber before, `false` if not.

It's only for use by Qt Quick Input Handlers.

See also QPointerEvent::addPassiveGrabber().

### `[override virtual]` void QPointerEvent::setAccepted(bool accepted)

### void QPointerEvent::setExclusiveGrabber(const QEventPoint &point, QObject *exclusiveGrabber)

Informs the delivery logic that the given exclusiveGrabber is to receive all future update events and the release event containing the given point, and that delivery to other items can be skipped.

It's mainly for use in Qt Quick at this time.

See also exclusiveGrabber().