Doc: Fix documentation issues for event and input device classes
* Document the new base classes QPointerEvent and QSinglePointEvent, and move relevant documentation to be located under them. * Replace linking to deprecated functions with their new counterparts. * Remove non-existent function and parameter documentation. * Document QEventPoint::State enum. * Prefer \obsolete over \deprecated and fix the usage. * Document the Capabilities enum in the correct location and add docs for the missing enum values. Change-Id: Ic8f2732f2e90ecbf522cd744c601cedcc574825c Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
This commit is contained in:
parent
2c63164012
commit
e1ce78d484
@ -84,7 +84,7 @@ static const QString pointDeviceName(const QEventPoint &point)
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
Constructs an enter event object.
|
Constructs an enter event object originating from \a device.
|
||||||
|
|
||||||
The points \a localPos, \a scenePos and \a globalPos specify the
|
The points \a localPos, \a scenePos and \a globalPos specify the
|
||||||
mouse cursor's position relative to the receiving widget or item,
|
mouse cursor's position relative to the receiving widget or item,
|
||||||
@ -339,7 +339,7 @@ QSizeF QEventPoint::ellipseDiameters() const
|
|||||||
bool QEventPoint::isAccepted() const
|
bool QEventPoint::isAccepted() const
|
||||||
{ return d->accept; }
|
{ return d->accept; }
|
||||||
|
|
||||||
/*
|
/*!
|
||||||
Sets the accepted state of the point.
|
Sets the accepted state of the point.
|
||||||
|
|
||||||
In widget-based applications, this function is not used so far, because
|
In widget-based applications, this function is not used so far, because
|
||||||
@ -359,17 +359,17 @@ void QEventPoint::setAccepted(bool accepted)
|
|||||||
d->accept = accepted;
|
d->accept = accepted;
|
||||||
}
|
}
|
||||||
|
|
||||||
/*! \internal
|
/*!
|
||||||
void QMutableEventPoint::setPosition(const QPointF &pos)
|
\obsolete
|
||||||
|
Deprecated since Qt 6.0. Use globalPosition() instead.
|
||||||
|
|
||||||
Sets the localized position.
|
Returns the normalized position of this point.
|
||||||
|
|
||||||
Often events need to be localized before delivery to specific widgets or
|
The coordinates are normalized to QInputDevice::availableVirtualGeometry(),
|
||||||
items. This can be done directly, or in a copy (for which we have a copy
|
i.e. (0, 0) is the top-left corner and (1, 1) is the bottom-right corner.
|
||||||
constructor), depending on whether the original point needs to be retained.
|
|
||||||
Usually it's calculated by mapping scenePosition() to the target anyway.
|
\sa startNormalizedPos(), lastNormalizedPos(), pos()
|
||||||
*/
|
*/
|
||||||
|
|
||||||
QPointF QEventPoint::normalizedPos() const
|
QPointF QEventPoint::normalizedPos() const
|
||||||
{
|
{
|
||||||
auto geom = d->device->availableVirtualGeometry();
|
auto geom = d->device->availableVirtualGeometry();
|
||||||
@ -378,6 +378,12 @@ QPointF QEventPoint::normalizedPos() const
|
|||||||
return (globalPosition() - geom.topLeft()) / geom.width();
|
return (globalPosition() - geom.topLeft()) / geom.width();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\obsolete
|
||||||
|
Deprecated since Qt 6.0. Use globalPressPosition() instead.
|
||||||
|
|
||||||
|
Returns the normalized press position of this point.
|
||||||
|
*/
|
||||||
QPointF QEventPoint::startNormalizedPos() const
|
QPointF QEventPoint::startNormalizedPos() const
|
||||||
{
|
{
|
||||||
auto geom = d->device->availableVirtualGeometry();
|
auto geom = d->device->availableVirtualGeometry();
|
||||||
@ -386,6 +392,18 @@ QPointF QEventPoint::startNormalizedPos() const
|
|||||||
return (globalPressPosition() - geom.topLeft()) / geom.width();
|
return (globalPressPosition() - geom.topLeft()) / geom.width();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\obsolete
|
||||||
|
Deprecated since Qt 6.0. Use globalLastPosition() instead.
|
||||||
|
|
||||||
|
Returns the normalized position of this touch point from the
|
||||||
|
previous touch event.
|
||||||
|
|
||||||
|
The coordinates are normalized to QInputDevice::availableVirtualGeometry(),
|
||||||
|
i.e. (0, 0) is the top-left corner and (1, 1) is the bottom-right corner.
|
||||||
|
|
||||||
|
\sa normalizedPos(), startNormalizedPos()
|
||||||
|
*/
|
||||||
QPointF QEventPoint::lastNormalizedPos() const
|
QPointF QEventPoint::lastNormalizedPos() const
|
||||||
{
|
{
|
||||||
auto geom = d->device->availableVirtualGeometry();
|
auto geom = d->device->availableVirtualGeometry();
|
||||||
@ -414,6 +432,44 @@ void QMutableEventPoint::detach()
|
|||||||
d = new QEventPointPrivate(*d);
|
d = new QEventPointPrivate(*d);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/*! \internal
|
||||||
|
void QMutableEventPoint::setPosition(const QPointF &pos)
|
||||||
|
Sets the localized position.
|
||||||
|
Often events need to be localized before delivery to specific widgets or
|
||||||
|
items. This can be done directly, or in a copy (for which we have a copy
|
||||||
|
constructor), depending on whether the original point needs to be retained.
|
||||||
|
Usually it's calculated by mapping scenePosition() to the target anyway.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\class QPointerEvent
|
||||||
|
\since 6.0
|
||||||
|
\inmodule QtGui
|
||||||
|
|
||||||
|
\brief A base class for pointer events.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\fn int QPointerEvent::pointCount() const
|
||||||
|
|
||||||
|
Returns the number of points in this pointer event.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\fn const QEventPoint &QPointerEvent::point(int i) const
|
||||||
|
|
||||||
|
Returns a QEventPoint reference for a point at index \a i.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\fn QPointingDevice::PointerType QPointerEvent::pointerType() const
|
||||||
|
|
||||||
|
Returns the type of point that generated the event.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\internal
|
||||||
|
*/
|
||||||
QPointerEvent::QPointerEvent(QEvent::Type type, const QPointingDevice *dev, Qt::KeyboardModifiers modifiers)
|
QPointerEvent::QPointerEvent(QEvent::Type type, const QPointingDevice *dev, Qt::KeyboardModifiers modifiers)
|
||||||
: QInputEvent(type, QEvent::PointerEventTag{}, dev, modifiers)
|
: QInputEvent(type, QEvent::PointerEventTag{}, dev, modifiers)
|
||||||
{
|
{
|
||||||
@ -423,8 +479,7 @@ QPointerEvent::~QPointerEvent()
|
|||||||
{
|
{
|
||||||
}
|
}
|
||||||
|
|
||||||
/*! \fn QPointingDevice* QPointerEvent::pointingDevice() const
|
/*!
|
||||||
|
|
||||||
Returns the source device from which this event originates.
|
Returns the source device from which this event originates.
|
||||||
|
|
||||||
This is the same as QInputEvent::device() but typecast for convenience.
|
This is the same as QInputEvent::device() but typecast for convenience.
|
||||||
@ -533,6 +588,93 @@ void QPointerEvent::clearPassiveGrabbers(const QEventPoint &point)
|
|||||||
point.d->passiveGrabbers.clear();
|
point.d->passiveGrabbers.clear();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\class QSinglePointEvent
|
||||||
|
\since 6.0
|
||||||
|
\inmodule QtGui
|
||||||
|
|
||||||
|
\brief A base class for pointer events containing a single point, such as
|
||||||
|
mouse events.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*! \fn int QSinglePointEvent::pointCount() const
|
||||||
|
|
||||||
|
Returns the number of points in the event. For a QSinglePointEvent, this
|
||||||
|
is always 1.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*! \fn const QEventPoint &QSinglePointEvent::point(int i) const
|
||||||
|
|
||||||
|
Returns a reference to a point at index \a i. For a QSinglePointEvent,
|
||||||
|
\a i must be 0.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*! \fn 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 \l TabletMove, \l TabletEnterProximity, and
|
||||||
|
\l TabletLeaveProximity events.
|
||||||
|
|
||||||
|
\sa buttons()
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*! \fn 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::MidButton 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.
|
||||||
|
|
||||||
|
\sa button()
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*! \fn 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.
|
||||||
|
|
||||||
|
\sa globalPosition()
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*! \fn QPointF QSinglePointEvent::scenePosition() const
|
||||||
|
|
||||||
|
Returns the position of the point in this event, relative to the window or
|
||||||
|
scene.
|
||||||
|
|
||||||
|
\sa QEventPoint::scenePosition()
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*! \fn 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 \e{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().
|
||||||
|
|
||||||
|
\sa position()
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\internal
|
||||||
|
*/
|
||||||
QSinglePointEvent::QSinglePointEvent(QEvent::Type type, const QPointingDevice *dev, const QPointF &localPos, const QPointF &scenePos,
|
QSinglePointEvent::QSinglePointEvent(QEvent::Type type, const QPointingDevice *dev, const QPointF &localPos, const QPointF &scenePos,
|
||||||
const QPointF &globalPos, Qt::MouseButton button, Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers)
|
const QPointF &globalPos, Qt::MouseButton button, Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers)
|
||||||
: QPointerEvent(type, dev, modifiers),
|
: QPointerEvent(type, dev, modifiers),
|
||||||
@ -556,7 +698,7 @@ QSinglePointEvent::QSinglePointEvent(QEvent::Type type, const QPointingDevice *d
|
|||||||
}
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
Returns true if this event represents a \l {button()}{button} being pressed.
|
Returns \c true if this event represents a \l {button()}{button} being pressed.
|
||||||
*/
|
*/
|
||||||
bool QSinglePointEvent::isPressEvent() const
|
bool QSinglePointEvent::isPressEvent() const
|
||||||
{
|
{
|
||||||
@ -564,7 +706,7 @@ bool QSinglePointEvent::isPressEvent() const
|
|||||||
}
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
Returns true if this event does not include a change in \l {buttons()}{button state}.
|
Returns \c true if this event does not include a change in \l {buttons()}{button state}.
|
||||||
*/
|
*/
|
||||||
bool QSinglePointEvent::isUpdateEvent() const
|
bool QSinglePointEvent::isUpdateEvent() const
|
||||||
{
|
{
|
||||||
@ -572,19 +714,13 @@ bool QSinglePointEvent::isUpdateEvent() const
|
|||||||
}
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
Returns true if this event represents a \l {button()}{button} being released.
|
Returns \c true if this event represents a \l {button()}{button} being released.
|
||||||
*/
|
*/
|
||||||
bool QSinglePointEvent::isReleaseEvent() const
|
bool QSinglePointEvent::isReleaseEvent() const
|
||||||
{
|
{
|
||||||
return m_button != Qt::NoButton && !m_mouseState.testFlag(m_button);
|
return m_button != Qt::NoButton && !m_mouseState.testFlag(m_button);
|
||||||
}
|
}
|
||||||
|
|
||||||
/*!
|
|
||||||
\fn QPointingDevice::PointerType QPointerEvent::pointerType() const
|
|
||||||
|
|
||||||
Returns the type of point that generated the event.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\class QMouseEvent
|
\class QMouseEvent
|
||||||
\ingroup events
|
\ingroup events
|
||||||
@ -635,7 +771,7 @@ bool QSinglePointEvent::isReleaseEvent() const
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
Constructs a mouse event object.
|
Constructs a mouse event object originating from \a device.
|
||||||
|
|
||||||
The \a type parameter must be one of QEvent::MouseButtonPress,
|
The \a type parameter must be one of QEvent::MouseButtonPress,
|
||||||
QEvent::MouseButtonRelease, QEvent::MouseButtonDblClick,
|
QEvent::MouseButtonRelease, QEvent::MouseButtonDblClick,
|
||||||
@ -667,7 +803,7 @@ QMouseEvent::QMouseEvent(Type type, const QPointF &localPos, Qt::MouseButton but
|
|||||||
}
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
Constructs a mouse event object.
|
Constructs a mouse event object originating from \a device.
|
||||||
|
|
||||||
The \a type parameter must be QEvent::MouseButtonPress,
|
The \a type parameter must be QEvent::MouseButtonPress,
|
||||||
QEvent::MouseButtonRelease, QEvent::MouseButtonDblClick,
|
QEvent::MouseButtonRelease, QEvent::MouseButtonDblClick,
|
||||||
@ -1010,7 +1146,7 @@ Qt::MouseEventFlags QMouseEvent::flags() const
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
Constructs a hover event object.
|
Constructs a hover event object originating from \a device.
|
||||||
|
|
||||||
The \a type parameter must be QEvent::HoverEnter,
|
The \a type parameter must be QEvent::HoverEnter,
|
||||||
QEvent::HoverLeave, or QEvent::HoverMove.
|
QEvent::HoverLeave, or QEvent::HoverMove.
|
||||||
@ -1051,7 +1187,7 @@ QHoverEvent::~QHoverEvent()
|
|||||||
have high-resolution trackpads, such as \macos. If that is the
|
have high-resolution trackpads, such as \macos. If that is the
|
||||||
case, device()->type() will return QInputDevice::DeviceType::Touchpad.
|
case, device()->type() will return QInputDevice::DeviceType::Touchpad.
|
||||||
|
|
||||||
The functions pos() and globalPos() return the mouse cursor's
|
The functions position() and globalPosition() return the mouse cursor's
|
||||||
location at the time of the event.
|
location at the time of the event.
|
||||||
|
|
||||||
A wheel event contains a special accept flag that indicates
|
A wheel event contains a special accept flag that indicates
|
||||||
@ -1074,12 +1210,6 @@ QHoverEvent::~QHoverEvent()
|
|||||||
\value DefaultDeltasPerStep Defaqult deltas per step
|
\value DefaultDeltasPerStep Defaqult deltas per step
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
|
||||||
\fn Qt::MouseButtons QWheelEvent::buttons() const
|
|
||||||
|
|
||||||
Returns the mouse state when the event occurred.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\fn Qt::MouseEventSource QWheelEvent::source() const
|
\fn Qt::MouseEventSource QWheelEvent::source() const
|
||||||
\since 5.5
|
\since 5.5
|
||||||
@ -1140,7 +1270,9 @@ QHoverEvent::~QHoverEvent()
|
|||||||
The mouse and keyboard states at the time of the event are specified by
|
The mouse and keyboard states at the time of the event are specified by
|
||||||
\a buttons and \a modifiers.
|
\a buttons and \a modifiers.
|
||||||
|
|
||||||
The scrolling phase of the event is specified by \a phase.
|
The scrolling phase of the event is specified by \a phase, and the
|
||||||
|
\a source indicates whether this is a genuine or artificial (synthesized)
|
||||||
|
event.
|
||||||
|
|
||||||
If the system is configured to invert the delta values delivered with the
|
If the system is configured to invert the delta values delivered with the
|
||||||
event (such as natural scrolling of the touchpad on macOS), \a inverted
|
event (such as natural scrolling of the touchpad on macOS), \a inverted
|
||||||
@ -1225,31 +1357,6 @@ QWheelEvent::~QWheelEvent()
|
|||||||
\sa pixelDelta()
|
\sa pixelDelta()
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
|
||||||
\fn QPoint QWheelEvent::position() const
|
|
||||||
\since 5.14
|
|
||||||
|
|
||||||
Returns the position of the mouse cursor relative to the widget
|
|
||||||
or item that received the event.
|
|
||||||
|
|
||||||
If you move your widgets around in response to mouse events,
|
|
||||||
use globalPosition() instead of this function.
|
|
||||||
|
|
||||||
\sa globalPosition()
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*!
|
|
||||||
\fn QPoint QWheelEvent::globalPosition() const
|
|
||||||
|
|
||||||
Returns the global position of the mouse pointer \e{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().
|
|
||||||
|
|
||||||
\sa position()
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\fn Qt::ScrollPhase QWheelEvent::phase() const
|
\fn Qt::ScrollPhase QWheelEvent::phase() const
|
||||||
\since 5.2
|
\since 5.2
|
||||||
@ -2476,11 +2583,6 @@ QVariant QInputMethodQueryEvent::value(Qt::InputMethodQuery query) const
|
|||||||
If the tablet events are rejected, the synthetic mouse events may be
|
If the tablet events are rejected, the synthetic mouse events may be
|
||||||
compressed for efficiency.
|
compressed for efficiency.
|
||||||
|
|
||||||
New in Qt 5.4: QTabletEvent includes all information available from the
|
|
||||||
device, including \l QTabletEvent::buttons(). Previously it was not
|
|
||||||
possible to accept all tablet events and also know which stylus buttons
|
|
||||||
were pressed.
|
|
||||||
|
|
||||||
Note that pressing the stylus button while the stylus hovers over the
|
Note that pressing the stylus button while the stylus hovers over the
|
||||||
tablet will generate a button press on some types of tablets, while on
|
tablet will generate a button press on some types of tablets, while on
|
||||||
other types it will be necessary to press the stylus against the tablet
|
other types it will be necessary to press the stylus against the tablet
|
||||||
@ -2508,15 +2610,7 @@ QVariant QInputMethodQueryEvent::value(Qt::InputMethodQuery query) const
|
|||||||
The \a pos parameter indicates where the event occurred in the widget;
|
The \a pos parameter indicates where the event occurred in the widget;
|
||||||
\a globalPos is the corresponding position in absolute coordinates.
|
\a globalPos is the corresponding position in absolute coordinates.
|
||||||
|
|
||||||
\a pressure gives the pressure exerted on the \a device.
|
\a pressure gives the pressure exerted on the device \a dev.
|
||||||
|
|
||||||
\a deviceType, of type \l QInputDevice::DeviceType,
|
|
||||||
indicates the type of stylus or other tool the event comes from.
|
|
||||||
|
|
||||||
\a pointerType should be one of QPointingDevice::PointerType::Pen or
|
|
||||||
QPointingDevice::PointerType::Eraser, depending on which end of the
|
|
||||||
stylus the event comes from; or QPointingDevice::PointerType::Cursor
|
|
||||||
if \a deviceType is QInputDevice::DeviceType::Puck.
|
|
||||||
|
|
||||||
\a xTilt and \a yTilt give the device's degree of tilt from the
|
\a xTilt and \a yTilt give the device's degree of tilt from the
|
||||||
x and y axes respectively.
|
x and y axes respectively.
|
||||||
@ -2524,8 +2618,6 @@ QVariant QInputMethodQueryEvent::value(Qt::InputMethodQuery query) const
|
|||||||
\a keyState specifies which keyboard modifiers are pressed (e.g.,
|
\a keyState specifies which keyboard modifiers are pressed (e.g.,
|
||||||
\uicontrol{Ctrl}).
|
\uicontrol{Ctrl}).
|
||||||
|
|
||||||
The \a uniqueID parameter gives the serial number of the current tool.
|
|
||||||
|
|
||||||
The \a z parameter gives the Z coordinate of the device on the tablet;
|
The \a z parameter gives the Z coordinate of the device on the tablet;
|
||||||
this is usually given by a wheel on a 4D mouse. If the device does not
|
this is usually given by a wheel on a 4D mouse. If the device does not
|
||||||
support a Z-axis (i.e. \l QPointingDevice::capabilities() does not include
|
support a Z-axis (i.e. \l QPointingDevice::capabilities() does not include
|
||||||
@ -2573,30 +2665,6 @@ QTabletEvent::~QTabletEvent()
|
|||||||
{
|
{
|
||||||
}
|
}
|
||||||
|
|
||||||
/*!
|
|
||||||
\fn Qt::MouseButton QTabletEvent::button() const
|
|
||||||
|
|
||||||
Returns the button that caused the event.
|
|
||||||
|
|
||||||
Note that the returned value is always Qt::NoButton for \l TabletMove,
|
|
||||||
\l TabletEnterProximity and \l TabletLeaveProximity events.
|
|
||||||
|
|
||||||
\sa buttons(), Qt::MouseButton
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*!
|
|
||||||
\fn Qt::MouseButtons QTabletEvent::buttons() const
|
|
||||||
|
|
||||||
Returns the button state when the event was generated. The button state is
|
|
||||||
a combination of buttons from the \l Qt::MouseButton enum using the OR
|
|
||||||
operator. For \l TabletMove events, this is all buttons that are pressed
|
|
||||||
down. For \l TabletPress events this includes the button that caused the
|
|
||||||
event. For \l TabletRelease events this excludes the button that caused the
|
|
||||||
event.
|
|
||||||
|
|
||||||
\sa button(), Qt::MouseButton
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\fn qreal QTabletEvent::tangentialPressure() const
|
\fn qreal QTabletEvent::tangentialPressure() const
|
||||||
|
|
||||||
@ -2837,13 +2905,6 @@ QNativeGestureEvent::QNativeGestureEvent(Qt::NativeGestureType type, const QPoin
|
|||||||
QNativeGestureEvent::~QNativeGestureEvent()
|
QNativeGestureEvent::~QNativeGestureEvent()
|
||||||
= default;
|
= default;
|
||||||
|
|
||||||
/*!
|
|
||||||
\fn const QPointingDevice *QNativeGestureEvent::device() const
|
|
||||||
\since 5.10
|
|
||||||
|
|
||||||
Returns the device.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\fn QNativeGestureEvent::gestureType() const
|
\fn QNativeGestureEvent::gestureType() const
|
||||||
\since 5.2
|
\since 5.2
|
||||||
@ -4431,7 +4492,8 @@ QTouchEvent::QTouchEvent(QEvent::Type eventType,
|
|||||||
}
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\obsolete Try to use another constructor, because \a touchPointStates
|
\obsolete
|
||||||
|
Try to use another constructor, because \a touchPointStates
|
||||||
can be calculated from the given \a touchPoints.
|
can be calculated from the given \a touchPoints.
|
||||||
|
|
||||||
Constructs a QTouchEvent with the given \a eventType, \a device, and
|
Constructs a QTouchEvent with the given \a eventType, \a device, and
|
||||||
@ -4508,16 +4570,39 @@ bool QTouchEvent::isReleaseEvent() const
|
|||||||
\inmodule QtGui
|
\inmodule QtGui
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*! \fn int QEventPoint::id() const
|
/*!
|
||||||
Returns the id number of this touch point.
|
\enum QEventPoint::State
|
||||||
|
|
||||||
Do not assume that id numbers start at zero or that they are sequential.
|
Specifies the state of this event point.
|
||||||
Such an assumption is often false due to the way the underlying drivers work.
|
|
||||||
|
\value Unknown
|
||||||
|
Unknown state.
|
||||||
|
|
||||||
|
\value Stationary
|
||||||
|
The event point did not move.
|
||||||
|
|
||||||
|
\value Pressed
|
||||||
|
The touch point or button is pressed.
|
||||||
|
|
||||||
|
\value Updated
|
||||||
|
The event point was updated.
|
||||||
|
|
||||||
|
\value Released
|
||||||
|
The touch point or button was released.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*! \fn int QEventPoint::id() const
|
||||||
|
|
||||||
|
Returns the ID number of this event point.
|
||||||
|
|
||||||
|
\note Do not assume that ID numbers start at zero or that they are
|
||||||
|
sequential. Such an assumption is often false due to the way
|
||||||
|
the underlying drivers work.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*! \fn QPointingDeviceUniqueId QEventPoint::uniqueId() const
|
/*! \fn QPointingDeviceUniqueId QEventPoint::uniqueId() const
|
||||||
\since 5.8
|
|
||||||
Returns the unique ID of this touch point or token, if any.
|
Returns the unique ID of this point or token, if any.
|
||||||
|
|
||||||
It is often invalid (see \l {QPointingDeviceUniqueId::isValid()} {isValid()}),
|
It is often invalid (see \l {QPointingDeviceUniqueId::isValid()} {isValid()}),
|
||||||
because touchscreens cannot uniquely identify fingers.
|
because touchscreens cannot uniquely identify fingers.
|
||||||
@ -4527,8 +4612,6 @@ bool QTouchEvent::isReleaseEvent() const
|
|||||||
|
|
||||||
It may identify a specific token (fiducial object) when the TUIO driver is
|
It may identify a specific token (fiducial object) when the TUIO driver is
|
||||||
in use with a touchscreen that supports them.
|
in use with a touchscreen that supports them.
|
||||||
|
|
||||||
\sa flags
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*! \fn QEventPoint::State QEventPoint::state() const
|
/*! \fn QEventPoint::State QEventPoint::state() const
|
||||||
@ -4541,6 +4624,14 @@ bool QTouchEvent::isReleaseEvent() const
|
|||||||
or item that received the event.
|
or item that received the event.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/*! \fn QPointF QEventPoint::pos() const
|
||||||
|
\obsolete
|
||||||
|
Deprecated since Qt 6.0. Use position() instead.
|
||||||
|
|
||||||
|
Returns the position of this point, relative to the widget
|
||||||
|
or item that received the event.
|
||||||
|
*/
|
||||||
|
|
||||||
/*! \fn QPointF QEventPoint::scenePosition() const
|
/*! \fn QPointF QEventPoint::scenePosition() const
|
||||||
Returns the position of this point relative to the window or scene.
|
Returns the position of this point relative to the window or scene.
|
||||||
|
|
||||||
@ -4557,17 +4648,6 @@ bool QTouchEvent::isReleaseEvent() const
|
|||||||
\sa globalPressPosition(), position(), scenePosition()
|
\sa globalPressPosition(), position(), scenePosition()
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*! \fn QPointF QEventPoint::normalizedPos() const
|
|
||||||
\deprecated in Qt 6.0. Use globalPosition() instead.
|
|
||||||
|
|
||||||
Returns the normalized position of this point.
|
|
||||||
|
|
||||||
The coordinates are normalized to QInputDevice::availableVirtualGeometry(),
|
|
||||||
i.e. (0,0) is the top-left corner and (1,1) is the bottom-right corner.
|
|
||||||
|
|
||||||
\sa startNormalizedPos(), lastNormalizedPos(), pos()
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*! \fn QPointF QEventPoint::pressPosition() const
|
/*! \fn QPointF QEventPoint::pressPosition() const
|
||||||
Returns the position at which this point was pressed, relative to the
|
Returns the position at which this point was pressed, relative to the
|
||||||
widget or item that received the event.
|
widget or item that received the event.
|
||||||
@ -4595,10 +4675,10 @@ bool QTouchEvent::isReleaseEvent() const
|
|||||||
Returns the position of this point from the previous event,
|
Returns the position of this point from the previous event,
|
||||||
relative to the widget or QGraphicsItem that received the event.
|
relative to the widget or QGraphicsItem that received the event.
|
||||||
|
|
||||||
\sa pos(), startPos()
|
\sa position(), pressPosition()
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*! \fn QPointF QEventPoint::lastScenePosition() const
|
/*! \fn QPointF QEventPoint::sceneLastPosition() const
|
||||||
Returns the scene position of this point from the previous event.
|
Returns the scene position of this point from the previous event.
|
||||||
|
|
||||||
The scene position is the position in QGraphicsScene coordinates
|
The scene position is the position in QGraphicsScene coordinates
|
||||||
@ -4606,18 +4686,7 @@ bool QTouchEvent::isReleaseEvent() const
|
|||||||
reimplementation, and identical to the screen position for
|
reimplementation, and identical to the screen position for
|
||||||
widgets.
|
widgets.
|
||||||
|
|
||||||
\sa scenePos(), startScenePos()
|
\sa scenePosition(), scenePressPosition()
|
||||||
*/
|
|
||||||
|
|
||||||
/*! \fn QPointF QEventPoint::lastNormalizedPos() const
|
|
||||||
\deprecated in 6.0: use globalLastPosition()
|
|
||||||
Returns the normalized position of this touch point from the
|
|
||||||
previous touch event.
|
|
||||||
|
|
||||||
The coordinates are normalized to QInputDevice::availableVirtualGeometry(),
|
|
||||||
i.e. (0,0) is the top-left corner and (1,1) is the bottom-right corner.
|
|
||||||
|
|
||||||
\sa normalizedPos(), startNormalizedPos()
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*! \fn qreal QEventPoint::pressure() const
|
/*! \fn qreal QEventPoint::pressure() const
|
||||||
@ -4626,7 +4695,7 @@ bool QTouchEvent::isReleaseEvent() const
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/*! \fn qreal QEventPoint::rotation() const
|
/*! \fn qreal QEventPoint::rotation() const
|
||||||
\since 5.8
|
|
||||||
Returns the angular orientation of this point. The return value is in degrees,
|
Returns the angular orientation of this point. The return value is in degrees,
|
||||||
where zero (the default) indicates the finger, token or stylus is pointing upwards,
|
where zero (the default) indicates the finger, token or stylus is pointing upwards,
|
||||||
a negative angle means it's rotated to the left, and a positive angle means
|
a negative angle means it's rotated to the left, and a positive angle means
|
||||||
@ -4635,21 +4704,22 @@ bool QTouchEvent::isReleaseEvent() const
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/*! \fn QSizeF QEventPoint::ellipseDiameters() const
|
/*! \fn QSizeF QEventPoint::ellipseDiameters() const
|
||||||
\since 5.9
|
|
||||||
Returns the width and height of the bounding ellipse of the touch point.
|
Returns the width and height of the bounding ellipse of the touch point.
|
||||||
The return value is in logical pixels. Most touchscreens do not detect the
|
The return value is in logical pixels. Most touchscreens do not detect the
|
||||||
shape of the contact point, and no mice or tablet devices can do detect it,
|
shape of the contact point, and no mice or tablet devices can detect it,
|
||||||
so a null size is the most common value. On some touchscreens the diameters
|
so a null size is the most common value. On some touchscreens the diameters
|
||||||
may be nonzero and equal (the ellipse is approximated as a circle).
|
may be nonzero and always equal (the ellipse is approximated as a circle).
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
|
\fn QVector2D QEventPoint::velocity() const
|
||||||
Returns a velocity vector for this point.
|
Returns a velocity vector for this point.
|
||||||
The vector is in the screen's coordinate system, using pixels per seconds for the magnitude.
|
The vector is in the screen's coordinate system, using pixels per seconds for the magnitude.
|
||||||
|
|
||||||
\note The returned vector is only valid if the device's capabilities include QInputDevice::Velocity.
|
\note The returned vector is only valid if the device's capabilities include QInputDevice::Velocity.
|
||||||
|
|
||||||
\sa QInputDevice::capabilities(), device()
|
\sa QInputDevice::capabilities(), QInputEvent::device()
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@ -4664,8 +4734,8 @@ bool QTouchEvent::isReleaseEvent() const
|
|||||||
The object receiving this event should set viewportSize, maxContentPos and contentPos.
|
The object receiving this event should set viewportSize, maxContentPos and contentPos.
|
||||||
It also should accept this event to indicate that scrolling should be started.
|
It also should accept this event to indicate that scrolling should be started.
|
||||||
|
|
||||||
It is not guaranteed that a QScrollEvent will be sent after an acceepted
|
It is not guaranteed that a QScrollEvent will be sent after an accepted
|
||||||
QScrollPrepareEvent, e.g. in a case where the maximum content position is (0,0).
|
QScrollPrepareEvent, e.g. in a case where the maximum content position is (0, 0).
|
||||||
|
|
||||||
\sa QScrollEvent, QScroller
|
\sa QScrollEvent, QScroller
|
||||||
*/
|
*/
|
||||||
|
@ -67,6 +67,67 @@ Q_DECLARE_LOGGING_CATEGORY(lcQpaInputDevices)
|
|||||||
instances pointed to by QInputEvent::device() and QInputDevice::devices().
|
instances pointed to by QInputEvent::device() and QInputDevice::devices().
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\enum QInputDevice::Capability
|
||||||
|
|
||||||
|
Indicates what kind of information the input device or its driver can
|
||||||
|
provide.
|
||||||
|
|
||||||
|
\value None
|
||||||
|
No information about input device capabilities available.
|
||||||
|
|
||||||
|
\value Position
|
||||||
|
Indicates that position information is available, meaning that the
|
||||||
|
position() family of functions in the touch points return valid points.
|
||||||
|
|
||||||
|
\value Area
|
||||||
|
Indicates that touch area information is available, meaning that
|
||||||
|
QEventPoint::ellipseDiameters() in the touch points return valid
|
||||||
|
values.
|
||||||
|
|
||||||
|
\value Pressure
|
||||||
|
Indicates that pressure information is available, meaning that
|
||||||
|
QEventPoint::pressure() returns a valid value.
|
||||||
|
|
||||||
|
\value Velocity
|
||||||
|
Indicates that velocity information is available, meaning that
|
||||||
|
QEventPoint::velocity() returns a valid vector.
|
||||||
|
|
||||||
|
\value NormalizedPosition
|
||||||
|
Indicates that the normalized position is available, meaning that
|
||||||
|
QEventPoint::globalPosition() returns a valid value.
|
||||||
|
|
||||||
|
\value MouseEmulation
|
||||||
|
Indicates that the device synthesizes mouse events.
|
||||||
|
|
||||||
|
\value Scroll
|
||||||
|
Indicates that the device has a scroll capability.
|
||||||
|
|
||||||
|
\value Hover
|
||||||
|
Indicates that the device has a hover capability.
|
||||||
|
|
||||||
|
\value Rotation
|
||||||
|
Indicates that \l {QEventPoint::}{rotation} information is available.
|
||||||
|
|
||||||
|
\value XTilt
|
||||||
|
Indicates that \l {QTabletEvent::xTilt()}{tilt} information is
|
||||||
|
available for the X-axis.
|
||||||
|
|
||||||
|
\value YTilt
|
||||||
|
Indicates that \l {QTabletEvent::yTilt()}{tilt} information is
|
||||||
|
available for the Y-axis.
|
||||||
|
|
||||||
|
\value TangentialPressure
|
||||||
|
Indicates that \l {QTabletEvent::tangentialPressure()}
|
||||||
|
{tangential pressure} information is available.
|
||||||
|
|
||||||
|
\value ZPosition
|
||||||
|
Indicates that position information for the \l {QTabletEvent::z()}
|
||||||
|
{Z-axis} is available.
|
||||||
|
|
||||||
|
\value All
|
||||||
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
Creates a new invalid input device instance.
|
Creates a new invalid input device instance.
|
||||||
*/
|
*/
|
||||||
@ -116,17 +177,17 @@ QInputDevice::QInputDevice(QInputDevicePrivate &d, QObject *parent)
|
|||||||
Returns the region within the \l{QScreen::availableVirtualGeometry}{virtual desktop}
|
Returns the region within the \l{QScreen::availableVirtualGeometry}{virtual desktop}
|
||||||
that this device can access.
|
that this device can access.
|
||||||
|
|
||||||
For example a \l {QInputDevice::DeviceType::TouchScreen}{TouchScreen} input
|
For example a \l {QInputDevice::DeviceType}{TouchScreen} input
|
||||||
device is fixed in place upon a single physical screen, and usually
|
device is fixed in place upon a single physical screen, and usually
|
||||||
calibrated so that this area is the same as QScreen::geometry(); whereas a
|
calibrated so that this area is the same as QScreen::geometry(); whereas a
|
||||||
\l {QInputDevice::DeviceType::Mouse}{Mouse} can probably access all screens
|
\l {QInputDevice::DeviceType}{Mouse} can probably access all screens
|
||||||
on the virtual desktop. A Wacom graphics tablet may be configured in a way
|
on the virtual desktop. A Wacom graphics tablet may be configured in a way
|
||||||
that it's mapped to all screens, or only to the screen where the user
|
that it's mapped to all screens, or only to the screen where the user
|
||||||
prefers to create drawings, or to the window in which drawing occurs.
|
prefers to create drawings, or to the window in which drawing occurs.
|
||||||
A \l {QInputDevice::DeviceType::Stylus}{Stylus} device that is integrated
|
A \l {QInputDevice::DeviceType}{Stylus} device that is integrated
|
||||||
with a touchscreen may be physically limited to that screen.
|
with a touchscreen may be physically limited to that screen.
|
||||||
|
|
||||||
If the returned rectangle is \l {null}{QRect::isNull()}, it means this device
|
If the returned rectangle is \l {QRect::isNull()}{null}, it means this device
|
||||||
can access the entire virtual desktop.
|
can access the entire virtual desktop.
|
||||||
*/
|
*/
|
||||||
QRect QInputDevice::availableVirtualGeometry() const
|
QRect QInputDevice::availableVirtualGeometry() const
|
||||||
@ -207,7 +268,7 @@ static QBasicMutex devicesMutex;
|
|||||||
|
|
||||||
\note The returned list cannot be used to add new devices. To add a simulated
|
\note The returned list cannot be used to add new devices. To add a simulated
|
||||||
touch screen for an autotest, QTest::createTouchDevice() can be used.
|
touch screen for an autotest, QTest::createTouchDevice() can be used.
|
||||||
Platform plugins should call \l QWindowSystemInterface::registerInputDevice()
|
Platform plugins should call QWindowSystemInterface::registerInputDevice()
|
||||||
to add devices as they are discovered.
|
to add devices as they are discovered.
|
||||||
*/
|
*/
|
||||||
QList<const QInputDevice *> QInputDevice::devices()
|
QList<const QInputDevice *> QInputDevice::devices()
|
||||||
|
@ -103,6 +103,9 @@ Q_DECLARE_LOGGING_CATEGORY(lcQpaInputDevices)
|
|||||||
A device that is similar to a flat mouse with a transparent circle with
|
A device that is similar to a flat mouse with a transparent circle with
|
||||||
cross-hairs.
|
cross-hairs.
|
||||||
|
|
||||||
|
\value Keyboard
|
||||||
|
A keyboard.
|
||||||
|
|
||||||
\value AllDevices
|
\value AllDevices
|
||||||
Any of the above (used as a default filter value).
|
Any of the above (used as a default filter value).
|
||||||
*/
|
*/
|
||||||
@ -133,40 +136,12 @@ Q_DECLARE_LOGGING_CATEGORY(lcQpaInputDevices)
|
|||||||
\value Eraser
|
\value Eraser
|
||||||
The other end of the stylus (if it has a virtual eraser on the other end).
|
The other end of the stylus (if it has a virtual eraser on the other end).
|
||||||
\value Cursor
|
\value Cursor
|
||||||
A transparent circle with cross-hairs as found on a \l {DeviceType.Puck}{Puck} device.
|
A transparent circle with cross-hairs as found on a
|
||||||
|
\l {QInputDevice::DeviceType}{Puck} device.
|
||||||
\value AllPointerTypes
|
\value AllPointerTypes
|
||||||
Any of the above (used as a default filter value).
|
Any of the above (used as a default filter value).
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*! \enum QPointingDevice::Capability
|
|
||||||
|
|
||||||
This enum is used with QPointingDevice::capabilities() to indicate what kind of information the
|
|
||||||
touch device or its driver can provide.
|
|
||||||
|
|
||||||
\value Position
|
|
||||||
Indicates that position information is available, meaning that the
|
|
||||||
pos() family of functions in the touch points return valid points.
|
|
||||||
|
|
||||||
\value Area
|
|
||||||
Indicates that touch area information is available, meaning that the
|
|
||||||
rect() family of functions in the touch points return valid rectangles.
|
|
||||||
|
|
||||||
\value Pressure
|
|
||||||
Indicates that pressure information is available, meaning that
|
|
||||||
QPointerEvent::EventPoint::pressure() returns a valid value.
|
|
||||||
|
|
||||||
\value Velocity
|
|
||||||
Indicates that velocity information is available, meaning that
|
|
||||||
QPointerEvent::EventPoint::velocity() returns a valid vector.
|
|
||||||
|
|
||||||
\value NormalizedPosition
|
|
||||||
Indicates that the normalized position is available, meaning that
|
|
||||||
QPointerEvent::EventPoint::normalizedPos() returns a valid value.
|
|
||||||
|
|
||||||
\value MouseEmulation
|
|
||||||
Indicates that the device synthesizes mouse events.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
Creates a new invalid pointing device instance.
|
Creates a new invalid pointing device instance.
|
||||||
*/
|
*/
|
||||||
@ -183,8 +158,8 @@ QPointingDevice::~QPointingDevice()
|
|||||||
|
|
||||||
/*!
|
/*!
|
||||||
Creates a new pointing device instance with the given
|
Creates a new pointing device instance with the given
|
||||||
\a deviceType, \a pointerType, \a capabilities, \a maxPoints,
|
\a name, \a deviceType, \a pointerType, \a capabilities, \a maxPoints,
|
||||||
\a buttonCount, \a name, \a id and \a seatId.
|
\a buttonCount, \a seatName, \a uniqueId and \a parent.
|
||||||
*/
|
*/
|
||||||
QPointingDevice::QPointingDevice(const QString &name, qint64 id, QInputDevice::DeviceType deviceType,
|
QPointingDevice::QPointingDevice(const QString &name, qint64 id, QInputDevice::DeviceType deviceType,
|
||||||
QPointingDevice::PointerType pointerType, Capabilities capabilities, int maxPoints, int buttonCount,
|
QPointingDevice::PointerType pointerType, Capabilities capabilities, int maxPoints, int buttonCount,
|
||||||
|
Loading…
x
Reference in New Issue
Block a user