1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Add docs for QPointingDevice::GrabTransition and grabChanged signal

Browse Source 
Fixes: QTBUG-97697
Task-number: QTBUG-102160
Change-Id: I6b782206a873bfe1837c419d15b0d6949d5b819d
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
(cherry picked from commit 47ab723d82e9718027ac906aac75116590009053)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Shawn Rutledge 2022-10-10 22:10:00 +02:00 committed by Qt Cherry-pick Bot
parent a8de48b144
commit 5642f64843
1 changed files with 42 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
src/gui/kernel/qpointingdevice.cpp
View File

@ -111,6 +111,48 @@ Q_LOGGING_CATEGORY(lcPointerGrab, "qt.pointer.grab");
Any of the above (used as a default filter value).
*/
/*! \enum QPointingDevice::GrabTransition
This enum represents a transition of exclusive or passive grab
from one object (possibly \c nullptr) to another (possibly \c nullptr).
It is emitted as an argument of the QPointingDevice::grabChanged() signal.
Valid values are:
\value GrabExclusive
Emitted after QPointerEvent::setExclusiveGrabber().
\value UngrabExclusive
Emitted after QPointerEvent::setExclusiveGrabber() when the grabber is
set to \c nullptr, to notify that the grab has terminated normally.
\value CancelGrabExclusive
Emitted after QPointerEvent::setExclusiveGrabber() when the grabber is set
to a different object, to notify that the old grabber's grab is "stolen".
\value GrabPassive
Emitted after QPointerEvent::addPassiveGrabber().
\value UngrabPassive
Emitted when a passive grab is terminated normally,
for example after QPointerEvent::removePassiveGrabber().
\value CancelGrabPassive
Emitted when a passive grab is terminated abnormally (a gesture is canceled).
\value OverrideGrabPassive
This value is not currently used.
*/
/*! \fn void QPointingDevice::grabChanged(QObject *grabber, QPointingDevice::GrabTransition transition, const QPointerEvent *event, const QEventPoint &point) const
This signal is emitted when the \a grabber object gains or loses an
exclusive or passive grab of \a point during delivery of \a event.
The \a transition tells what happened, from the perspective of the
\c grabber object.
\note A grab transition from one object to another results in two signals,
to notify that one object has lost its grab, and to notify that there is
another grabber. In other cases, when transitioning to or from a non-grabbing
state, only one signal is emitted: the \a grabber argument is never \c nullptr.
\sa QPointerEvent::setExclusiveGrabber(), QPointerEvent::addPassiveGrabber(), QPointerEvent::removePassiveGrabber()
*/
/*!
Creates a new invalid pointing device instance as a child of \a parent.
*/