Google Git
Sign in
third-party-mirror / orbit / refs/heads/master / . / qt-everywhere-src-5.15.1 / qtbase / src / gui / kernel / qevent.cpp
blob: 68f2d0392fd4bd6d76cb68ea452d26ad1b86f6b6 [file] [log] [blame]
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtGui module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qevent.h"
#include "qcursor.h"
#include "private/qguiapplication_p.h"
#include "private/qtouchdevice_p.h"
#include "qpa/qplatformintegration.h"
#include "private/qevent_p.h"
#include "qfile.h"
#include "qhashfunctions.h"
#include "qmetaobject.h"
#include "qmimedata.h"
#include "qevent_p.h"
#include "qmath.h"
#if QT_CONFIG(draganddrop)
#include <qpa/qplatformdrag.h>
#include <private/qdnd_p.h>
#endif
#include <private/qdebug_p.h>
QT_BEGIN_NAMESPACE
/*!
\class QEnterEvent
\ingroup events
\inmodule QtGui
\brief The QEnterEvent class contains parameters that describe an enter event.
Enter events occur when the mouse cursor enters a window or a widget.
\since 5.0
*/
/*!
Constructs an enter event object.
The points \a localPos, \a windowPos and \a screenPos specify the
mouse cursor's position relative to the receiving widget or item,
window, and screen, respectively.
*/
QEnterEvent::QEnterEvent(const QPointF &localPos, const QPointF &windowPos, const QPointF &screenPos)
: QEvent(QEvent::Enter)
, l(localPos)
, w(windowPos)
, s(screenPos)
{
}
/*!
\internal
*/
QEnterEvent::~QEnterEvent()
{
}
/*!
\fn QPoint QEnterEvent::globalPos() const
Returns the global position of the mouse cursor \e{at the time of the event}.
*/
/*!
\fn int QEnterEvent::globalX() const
Returns the global position on the X-axis of the mouse cursor \e{at the time of the event}.
*/
/*!
\fn int QEnterEvent::globalY() const
Returns the global position on the Y-axis of the mouse cursor \e{at the time of the event}.
*/
/*!
\fn QPointF QEnterEvent::localPos() const
Returns the mouse cursor's position relative to the receiving widget.
*/
/*!
\fn QPoint QEnterEvent::pos() const
Returns the position of the mouse cursor relative to the receiving widget.
*/
/*!
\fn QPointF QEnterEvent::screenPos() const
Returns the position of the mouse cursor relative to the receiving screen.
*/
/*!
\fn QPointF QEnterEvent::windowPos() const
Returns the position of the mouse cursor relative to the receiving window.
*/
/*!
\fn int QEnterEvent::x() const
Returns the x position of the mouse cursor relative to the receiving widget.
*/
/*!
\fn int QEnterEvent::y() const
Returns the y position of the mouse cursor relative to the receiving widget.
*/
/*!
\class QInputEvent
\ingroup events
\inmodule QtGui
\brief The QInputEvent class is the base class for events that
describe user input.
*/
/*!
\internal
*/
QInputEvent::QInputEvent(Type type, Qt::KeyboardModifiers modifiers)
: QEvent(type), modState(modifiers), ts(0)
{}
/*!
\internal
*/
QInputEvent::~QInputEvent()
{
}
/*!
\fn Qt::KeyboardModifiers QInputEvent::modifiers() const
Returns the keyboard modifier flags that existed immediately
before the event occurred.
\sa QGuiApplication::keyboardModifiers()
*/
/*! \fn void QInputEvent::setModifiers(Qt::KeyboardModifiers modifiers)
\internal
Sets the keyboard modifiers flags for this event.
*/
/*!
\fn ulong QInputEvent::timestamp() const
Returns the window system's timestamp for this event.
It will normally be in milliseconds since some arbitrary point
in time, such as the time when the system was started.
*/
/*! \fn void QInputEvent::setTimestamp(ulong atimestamp)
\internal
Sets the timestamp for this event.
*/
/*!
\class QMouseEvent
\ingroup events
\inmodule QtGui
\brief The QMouseEvent class contains parameters that describe a mouse event.
Mouse events occur when a mouse button is pressed or released
inside a widget, or when the mouse cursor is moved.
Mouse move events will occur only when a mouse button is pressed
down, unless mouse tracking has been enabled with
QWidget::setMouseTracking().
Qt automatically grabs the mouse when a mouse button is pressed
inside a widget; the widget will continue to receive mouse events
until the last mouse button is released.
A mouse event contains a special accept flag that indicates
whether the receiver wants the event. You should call ignore() if
the mouse event is not handled by your widget. A mouse event is
propagated up the parent widget chain until a widget accepts it
with accept(), or an event filter consumes it.
\note If a mouse event is propagated to a \l{QWidget}{widget} for
which Qt::WA_NoMousePropagation has been set, that mouse event
will not be propagated further up the parent widget chain.
The state of the keyboard modifier keys can be found by calling the
\l{QInputEvent::modifiers()}{modifiers()} function, inherited from
QInputEvent.
The functions pos(), x(), and y() give the cursor position
relative to the widget that receives the mouse event. If you
move the widget as a result of the mouse event, use the global
position returned by globalPos() to avoid a shaking motion.
The QWidget::setEnabled() function can be used to enable or
disable mouse and keyboard events for a widget.
Reimplement the QWidget event handlers, QWidget::mousePressEvent(),
QWidget::mouseReleaseEvent(), QWidget::mouseDoubleClickEvent(),
and QWidget::mouseMoveEvent() to receive mouse events in your own
widgets.
\sa QWidget::setMouseTracking(), QWidget::grabMouse(),
QCursor::pos()
*/
/*!
Constructs a mouse event object.
The \a type parameter must be one of QEvent::MouseButtonPress,
QEvent::MouseButtonRelease, QEvent::MouseButtonDblClick,
or QEvent::MouseMove.
The \a localPos is the mouse cursor's position relative to the
receiving widget or item. The window position is set to the same value
as \a localPos.
The \a button that caused the event is given as a value from
the Qt::MouseButton enum. If the event \a type is
\l MouseMove, the appropriate button for this event is Qt::NoButton.
The mouse and keyboard states at the time of the event are specified by
\a buttons and \a modifiers.
The screenPos() is initialized to QCursor::pos(), which may not
be appropriate. Use the other constructor to specify the global
position explicitly.
*/
QMouseEvent::QMouseEvent(Type type, const QPointF &localPos, Qt::MouseButton button,
Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers)
: QInputEvent(type, modifiers), l(localPos), w(localPos), b(button), mouseState(buttons), caps(0)
{
#ifndef QT_NO_CURSOR
s = QCursor::pos();
#endif
}
/*!
Constructs a mouse event object.
The \a type parameter must be QEvent::MouseButtonPress,
QEvent::MouseButtonRelease, QEvent::MouseButtonDblClick,
or QEvent::MouseMove.
The \a localPos is the mouse cursor's position relative to the
receiving widget or item. The cursor's position in screen coordinates is
specified by \a screenPos. The window position is set to the same value
as \a localPos. The \a button that caused the event is
given as a value from the \l Qt::MouseButton enum. If the event \a
type is \l MouseMove, the appropriate button for this event is
Qt::NoButton. \a buttons is the state of all buttons at the
time of the event, \a modifiers the state of all keyboard
modifiers.
*/
QMouseEvent::QMouseEvent(Type type, const QPointF &localPos, const QPointF &screenPos,
Qt::MouseButton button, Qt::MouseButtons buttons,
Qt::KeyboardModifiers modifiers)
: QMouseEvent(type, localPos, localPos, screenPos, button, buttons, modifiers)
{}
/*!
Constructs a mouse event object.
The \a type parameter must be QEvent::MouseButtonPress,
QEvent::MouseButtonRelease, QEvent::MouseButtonDblClick,
or QEvent::MouseMove.
The points \a localPos, \a windowPos and \a screenPos specify the
mouse cursor's position relative to the receiving widget or item,
window, and screen, respectively.
The \a button that caused the event is
given as a value from the \l Qt::MouseButton enum. If the event \a
type is \l MouseMove, the appropriate button for this event is
Qt::NoButton. \a buttons is the state of all buttons at the
time of the event, \a modifiers the state of all keyboard
modifiers.
*/
QMouseEvent::QMouseEvent(Type type, const QPointF &localPos, const QPointF &windowPos, const QPointF &screenPos,
Qt::MouseButton button, Qt::MouseButtons buttons,
Qt::KeyboardModifiers modifiers)
: QInputEvent(type, modifiers), l(localPos), w(windowPos), s(screenPos), b(button), mouseState(buttons), caps(0)
{}
/*!
\since 5.6
Constructs a mouse event object.
The \a type parameter must be QEvent::MouseButtonPress,
QEvent::MouseButtonRelease, QEvent::MouseButtonDblClick,
or QEvent::MouseMove.
The points \a localPos, \a windowPos and \a screenPos specify the
mouse cursor's position relative to the receiving widget or item,
window, and screen, respectively.
The \a button that caused the event is given as a value from the
\l Qt::MouseButton enum. If the event \a type is \l MouseMove,
the appropriate button for this event is Qt::NoButton. \a buttons
is the state of all buttons at the time of the event, \a modifiers
is the state of all keyboard modifiers.
The source of the event is specified by \a source.
*/
QMouseEvent::QMouseEvent(QEvent::Type type, const QPointF &localPos, const QPointF &windowPos, const QPointF &screenPos,
Qt::MouseButton button, Qt::MouseButtons buttons,
Qt::KeyboardModifiers modifiers, Qt::MouseEventSource source)
: QMouseEvent(type, localPos, windowPos, screenPos, button, buttons, modifiers)
{
QGuiApplicationPrivate::setMouseEventSource(this, source);
}
/*!
\internal
*/
QMouseEvent::~QMouseEvent()
{
}
/*!
\since 5.3
Returns information about the mouse event source.
The mouse event source can be used to distinguish between genuine
and artificial mouse events. The latter are events that are
synthesized from touch events by the operating system or Qt itself.
\note Many platforms provide no such information. On such platforms
\l Qt::MouseEventNotSynthesized is returned always.
\sa Qt::MouseEventSource
\sa QGraphicsSceneMouseEvent::source()
*/
Qt::MouseEventSource QMouseEvent::source() const
{
return QGuiApplicationPrivate::mouseEventSource(this);
}
/*!
\since 5.3
Returns the mouse event flags.
The mouse event flags provide additional information about a mouse event.
\sa Qt::MouseEventFlag
\sa QGraphicsSceneMouseEvent::flags()
*/
Qt::MouseEventFlags QMouseEvent::flags() const
{
return QGuiApplicationPrivate::mouseEventFlags(this);
}
/*!
\fn QPointF QMouseEvent::localPos() const
\since 5.0
Returns the position of the mouse cursor as a QPointF, relative to the
widget or item that received the event.
If you move the widget as a result of the mouse event, use the
screen position returned by screenPos() to avoid a shaking
motion.
\sa x(), y(), windowPos(), screenPos()
*/
/*!
\fn void QMouseEvent::setLocalPos(const QPointF &localPosition)
\since 5.8
\internal
Sets the local position in the mouse event to \a localPosition. This allows to re-use one event
when sending it to a series of receivers that expect the local pos in their
respective local coordinates.
*/
/*!
\fn QPointF QMouseEvent::windowPos() const
\since 5.0
Returns the position of the mouse cursor as a QPointF, relative to the
window that received the event.
If you move the widget as a result of the mouse event, use the
global position returned by globalPos() to avoid a shaking
motion.
\sa x(), y(), pos(), localPos(), screenPos()
*/
/*!
\fn QPointF QMouseEvent::screenPos() const
\since 5.0
Returns the position of the mouse cursor as a QPointF, relative to the
screen that received the event.
\sa x(), y(), pos(), localPos(), windowPos()
*/
/*!
\fn QPoint QMouseEvent::pos() const
Returns the position of the mouse cursor, relative to the widget
that received the event.
If you move the widget as a result of the mouse event, use the
global position returned by globalPos() to avoid a shaking
motion.
\sa x(), y(), globalPos()
*/
/*!
\fn QPoint QMouseEvent::globalPos() const
Returns the global position of the mouse cursor \e{at the time
of the event}. This is important on asynchronous window systems
like X11. Whenever you move your widgets around in response to
mouse events, globalPos() may differ a lot from the current
pointer position QCursor::pos(), and from
QWidget::mapToGlobal(pos()).
\sa globalX(), globalY()
*/
/*!
\fn int QMouseEvent::x() const
Returns the x position of the mouse cursor, relative to the
widget that received the event.
\sa y(), pos()
*/
/*!
\fn int QMouseEvent::y() const
Returns the y position of the mouse cursor, relative to the
widget that received the event.
\sa x(), pos()
*/
/*!
\fn int QMouseEvent::globalX() const
Returns the global x position of the mouse cursor at the time of
the event.
\sa globalY(), globalPos()
*/
/*!
\fn int QMouseEvent::globalY() const
Returns the global y position of the mouse cursor at the time of
the event.
\sa globalX(), globalPos()
*/
/*!
\fn Qt::MouseButton QMouseEvent::button() const
Returns the button that caused the event.
Note that the returned value is always Qt::NoButton for mouse
move events.
\sa buttons(), Qt::MouseButton
*/
/*!
\fn Qt::MouseButton QMouseEvent::buttons() const
Returns the button state when the event was generated. The button
state is a combination of Qt::LeftButton, Qt::RightButton,
Qt::MidButton using the OR operator. For mouse move events,
this is all buttons that are pressed down. For mouse press and
double click events this includes the button that caused the
event. For mouse release events this excludes the button that
caused the event.
\sa button(), Qt::MouseButton
*/
/*!
\class QHoverEvent
\ingroup events
\inmodule QtGui
\brief The QHoverEvent class contains parameters that describe a mouse event.
Mouse events occur when a mouse cursor is moved into, out of, or within a
widget, and if the widget has the Qt::WA_Hover attribute.
The function pos() gives the current cursor position, while oldPos() gives
the old mouse position.
There are a few similarities between the events QEvent::HoverEnter
and QEvent::HoverLeave, and the events QEvent::Enter and QEvent::Leave.
However, they are slightly different because we do an update() in the event
handler of HoverEnter and HoverLeave.
QEvent::HoverMove is also slightly different from QEvent::MouseMove. Let us
consider a top-level window A containing a child B which in turn contains a
child C (all with mouse tracking enabled):
\image hoverevents.png
Now, if you move the cursor from the top to the bottom in the middle of A,
you will get the following QEvent::MouseMove events:
\list 1
\li A::MouseMove
\li B::MouseMove
\li C::MouseMove
\endlist
You will get the same events for QEvent::HoverMove, except that the event
always propagates to the top-level regardless whether the event is accepted
or not. It will only stop propagating with the Qt::WA_NoMousePropagation
attribute.
In this case the events will occur in the following way:
\list 1
\li A::HoverMove
\li A::HoverMove, B::HoverMove
\li A::HoverMove, B::HoverMove, C::HoverMove
\endlist
*/
/*!
\fn QPoint QHoverEvent::pos() const
Returns the position of the mouse cursor, relative to the widget
that received the event.
On QEvent::HoverLeave events, this position will always be
QPoint(-1, -1).
\sa oldPos()
*/
/*!
\fn QPoint QHoverEvent::oldPos() const
Returns the previous position of the mouse cursor, relative to the widget
that received the event. If there is no previous position, oldPos() will
return the same position as pos().
On QEvent::HoverEnter events, this position will always be
QPoint(-1, -1).
\sa pos()
*/
/*!
\fn const QPointF &QHoverEvent::posF() const
Returns the position of the mouse cursor, relative to the widget
that received the event.
On QEvent::HoverLeave events, this position will always be
QPointF(-1, -1).
\sa oldPosF()
*/
/*!
\fn const QPointF &QHoverEvent::oldPosF() const
Returns the previous position of the mouse cursor, relative to the widget
that received the event. If there is no previous position, oldPosF() will
return the same position as posF().
On QEvent::HoverEnter events, this position will always be
QPointF(-1, -1).
\sa posF()
*/
/*!
Constructs a hover event object.
The \a type parameter must be QEvent::HoverEnter,
QEvent::HoverLeave, or QEvent::HoverMove.
The \a pos is the current mouse cursor's position relative to the
receiving widget, while \a oldPos is its previous such position.
\a modifiers hold the state of all keyboard modifiers at the time
of the event.
*/
QHoverEvent::QHoverEvent(Type type, const QPointF &pos, const QPointF &oldPos, Qt::KeyboardModifiers modifiers)
: QInputEvent(type, modifiers), p(pos), op(oldPos)
{
}
/*!
\internal
*/
QHoverEvent::~QHoverEvent()
{
}
/*!
\class QWheelEvent
\brief The QWheelEvent class contains parameters that describe a wheel event.
\inmodule QtGui
\ingroup events
Wheel events are sent to the widget under the mouse cursor, but
if that widget does not handle the event they are sent to the
focus widget. Wheel events are generated for both mouse wheels
and trackpad scroll gestures. There are two ways to read the
wheel event delta: angleDelta() returns the deltas in wheel
degrees. These values are always provided. pixelDelta() returns
the deltas in screen pixels, and is available on platforms that
have high-resolution trackpads, such as \macos. If that is the
case, source() will return Qt::MouseEventSynthesizedBySystem.
The functions pos() and globalPos() return the mouse cursor's
location at the time of the event.
A wheel event contains a special accept flag that indicates
whether the receiver wants the event. You should call ignore() if
you do not handle the wheel event; this ensures that it will be
sent to the parent widget.
The QWidget::setEnabled() function can be used to enable or
disable mouse and keyboard events for a widget.
The event handler QWidget::wheelEvent() receives wheel events.
\sa QMouseEvent, QWidget::grabMouse()
*/
/*!
\enum QWheelEvent::anonymous
\internal
\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
\since 5.5
Returns information about the wheel event source.
The source can be used to distinguish between events that come from a mouse
with a physical wheel and events that are generated by some other means,
such as a flick gesture on a touchpad.
\note Many platforms provide no such information. On such platforms
\l Qt::MouseEventNotSynthesized is returned always.
\sa Qt::MouseEventSource
*/
/*!
\fn bool QWheelEvent::inverted() const
\since 5.7
Returns whether the delta values delivered with the event are inverted.
Normally, a vertical wheel will produce a QWheelEvent with positive delta
values if the top of the wheel is rotating away from the hand operating it.
Similarly, a horizontal wheel movement will produce a QWheelEvent with
positive delta values if the top of the wheel is moved to the left.
However, on some platforms this is configurable, so that the same
operations described above will produce negative delta values (but with the
same magnitude). With the inverted property a wheel event consumer can
choose to always follow the direction of the wheel, regardless of the
system settings, but only for specific widgets. (One such use case could be
that the user is rotating the wheel in the same direction as a visual
Tumbler rotates. Another usecase is to make a slider handle follow the
direction of movement of fingers on a touchpad regardless of system
configuration.)
\note Many platforms provide no such information. On such platforms
\l inverted always returns false.
*/
#if QT_DEPRECATED_SINCE(5, 15)
/*!
\fn Qt::Orientation QWheelEvent::orientation() const
\obsolete
Use angleDelta() instead.
*/
#endif
#if QT_CONFIG(wheelevent)
#if QT_DEPRECATED_SINCE(5, 15)
/*!
\obsolete
This constructor has been deprecated.
*/
QWheelEvent::QWheelEvent(const QPointF &pos, int delta,
Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers,
Qt::Orientation orient)
: QInputEvent(Wheel, modifiers), p(pos), qt4D(delta), qt4O(orient), mouseState(buttons),
src(Qt::MouseEventNotSynthesized), invertedScrolling(false), ph(Qt::NoScrollPhase)
{
g = QCursor::pos();
if (orient == Qt::Vertical)
angleD = QPoint(0, delta);
else
angleD = QPoint(delta, 0);
}
/*!
\obsolete
This constructor has been deprecated.
*/
QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos, int delta,
Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers,
Qt::Orientation orient)
: QInputEvent(Wheel, modifiers), p(pos), g(globalPos), qt4D(delta), qt4O(orient), mouseState(buttons),
src(Qt::MouseEventNotSynthesized), invertedScrolling(false), ph(Qt::NoScrollPhase)
{
if (orient == Qt::Vertical)
angleD = QPoint(0, delta);
else
angleD = QPoint(delta, 0);
}
/*!
\obsolete
This constructor has been deprecated.
*/
QT_WARNING_PUSH
QT_WARNING_DISABLE_DEPRECATED
QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos,
QPoint pixelDelta, QPoint angleDelta, int qt4Delta, Qt::Orientation qt4Orientation,
Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers)
: QWheelEvent(pos, globalPos, pixelDelta, angleDelta, qt4Delta, qt4Orientation,
buttons, modifiers, Qt::NoScrollPhase)
{}
QT_WARNING_POP
/*!
\obsolete
This constructor has been deprecated.
*/
QT_WARNING_PUSH
QT_WARNING_DISABLE_DEPRECATED
QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos,
QPoint pixelDelta, QPoint angleDelta, int qt4Delta, Qt::Orientation qt4Orientation,
Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, Qt::ScrollPhase phase)
: QWheelEvent(pos, globalPos, pixelDelta, angleDelta, qt4Delta, qt4Orientation,
buttons, modifiers, phase, Qt::MouseEventNotSynthesized)
{}
QT_WARNING_POP
/*!
\obsolete
This constructor has been deprecated.
*/
QT_WARNING_PUSH
QT_WARNING_DISABLE_DEPRECATED
QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos,
QPoint pixelDelta, QPoint angleDelta, int qt4Delta, Qt::Orientation qt4Orientation,
Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, Qt::ScrollPhase phase, Qt::MouseEventSource source)
: QWheelEvent(pos, globalPos, pixelDelta, angleDelta, qt4Delta, qt4Orientation,
buttons, modifiers, phase, source, false)
{}
QT_WARNING_POP
/*!
\obsolete
This constructor has been deprecated.
*/
QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos,
QPoint pixelDelta, QPoint angleDelta, int qt4Delta, Qt::Orientation qt4Orientation,
Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, Qt::ScrollPhase phase, Qt::MouseEventSource source, bool inverted)
: QInputEvent(Wheel, modifiers), p(pos), g(globalPos), pixelD(pixelDelta),
angleD(angleDelta), qt4D(qt4Delta), qt4O(qt4Orientation), mouseState(buttons), src(source),
invertedScrolling(inverted), ph(phase)
{}
#endif // QT_DEPRECATED_SINCE(5, 15)
/*!
Constructs a wheel event object.
\since 5.12
The \a pos provides the location of the mouse cursor
within the window. The position in global coordinates is specified
by \a globalPos.
\a pixelDelta contains the scrolling distance in pixels on screen, while
\a angleDelta contains the wheel rotation angle. \a pixelDelta is
optional and can be null.
The mouse and keyboard states at the time of the event are specified by
\a buttons and \a modifiers.
The scrolling phase of the event is specified by \a phase.
If the wheel event comes from a physical mouse wheel, \a source is set to
Qt::MouseEventNotSynthesized. If it comes from a gesture detected by the
operating system, or from a non-mouse hardware device, such that \a
pixelDelta is directly related to finger movement, \a source is set to
Qt::MouseEventSynthesizedBySystem. If it comes from Qt, source would be set
to Qt::MouseEventSynthesizedByQt.
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
should be \c true. Otherwise, \a inverted is \c false
\sa position(), globalPosition(), angleDelta(), pixelDelta(), phase(), inverted(), source()
*/
QWheelEvent::QWheelEvent(QPointF pos, QPointF globalPos, QPoint pixelDelta, QPoint angleDelta,
Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, Qt::ScrollPhase phase,
bool inverted, Qt::MouseEventSource source)
: QInputEvent(Wheel, modifiers), p(pos), g(globalPos), pixelD(pixelDelta), angleD(angleDelta),
qt4O(qAbs(angleDelta.x()) > qAbs(angleDelta.y()) ? Qt::Horizontal : Qt::Vertical),
mouseState(buttons), src(source), invertedScrolling(inverted), ph(phase)
{
qt4D = (qt4O == Qt::Horizontal ? angleDelta.x() : angleDelta.y());
}
/*!
\internal
*/
QWheelEvent::~QWheelEvent()
{
}
#endif // QT_CONFIG(wheelevent)
/*!
\fn QPoint QWheelEvent::pixelDelta() const
Returns the scrolling distance in pixels on screen. This value is
provided on platforms that support high-resolution pixel-based
delta values, such as \macos. The value should be used directly
to scroll content on screen.
Example:
\snippet code/src_gui_kernel_qevent.cpp 0
\note On platforms that support scrolling \l{phase()}{phases}, the delta may be null when:
\list
\li scrolling is about to begin, but the distance did not yet change (Qt::ScrollBegin),
\li or scrolling has ended and the distance did not change anymore (Qt::ScrollEnd).
\endlist
\note On X11 this value is driver specific and unreliable, use angleDelta() instead
*/
/*!
\fn QPoint QWheelEvent::angleDelta() const
Returns the relative amount that the wheel was rotated, in eighths of a
degree. A positive value indicates that the wheel was rotated forwards away
from the user; a negative value indicates that the wheel was rotated
backwards toward the user. \c angleDelta().y() provides the angle through
which the common vertical mouse wheel was rotated since the previous event.
\c angleDelta().x() provides the angle through which the horizontal mouse
wheel was rotated, if the mouse has a horizontal wheel; otherwise it stays
at zero. Some mice allow the user to tilt the wheel to perform horizontal
scrolling, and some touchpads support a horizontal scrolling gesture; that
will also appear in \c angleDelta().x().
Most mouse types work in steps of 15 degrees, in which case the
delta value is a multiple of 120; i.e., 120 units * 1/8 = 15 degrees.
However, some mice have finer-resolution wheels and send delta values
that are less than 120 units (less than 15 degrees). To support this
possibility, you can either cumulatively add the delta values from events
until the value of 120 is reached, then scroll the widget, or you can
partially scroll the widget in response to each wheel event. But to
provide a more native feel, you should prefer \l pixelDelta() on platforms
where it's available.
Example:
\snippet code/src_gui_kernel_qevent.cpp 0
\note On platforms that support scrolling \l{phase()}{phases}, the delta may be null when:
\list
\li scrolling is about to begin, but the distance did not yet change (Qt::ScrollBegin),
\li or scrolling has ended and the distance did not change anymore (Qt::ScrollEnd).
\endlist
\sa pixelDelta()
*/
/*!
\fn QPoint QWheelEvent::position() const
\since 5.14
Returns the position of the mouse cursor relative to the widget
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()
*/
#if QT_DEPRECATED_SINCE(5, 15)
/*!
\fn int QWheelEvent::delta() const
\obsolete
This function has been deprecated, use pixelDelta() or angleDelta() instead.
*/
/*!
\fn QPoint QWheelEvent::pos() const
\obsolete
This function has been deprecated, use position() instead.
*/
/*!
\fn int QWheelEvent::x() const
\obsolete
This function has been deprecated, use position() instead.
*/
/*!
\fn int QWheelEvent::y() const
\obsolete
This function has been deprecated, use position() instead.
*/
/*!
\fn QPoint QWheelEvent::globalPos() const
\obsolete
This function has been deprecated, use globalPosition() instead.
*/
/*!
\fn int QWheelEvent::globalX() const
\obsolete
This function has been deprecated, use globalPosition() instead.
*/
/*!
\fn int QWheelEvent::globalY() const
\obsolete
This function has been deprecated, use globalPosition() instead.
*/
/*!
\fn const QPointF &QWheelEvent::posF() const
\obsolete
This function has been deprecated, use position() instead.
*/
/*!
\fn const QPointF &QWheelEvent::globalPosF() const
\obsolete
This function has been deprecated, use globalPosition() instead.
*/
#endif
/*!
\fn Qt::ScrollPhase QWheelEvent::phase() const
\since 5.2
Returns the scrolling phase of this wheel event.
\note The Qt::ScrollBegin and Qt::ScrollEnd phases are currently
supported only on \macos.
*/
/*!
\class QKeyEvent
\brief The QKeyEvent class describes a key event.
\ingroup events
\inmodule QtGui
Key events are sent to the widget with keyboard input focus
when keys are pressed or released.
A key event contains a special accept flag that indicates whether
the receiver will handle the key event. This flag is set by default
for QEvent::KeyPress and QEvent::KeyRelease, so there is no need to
call accept() when acting on a key event. For QEvent::ShortcutOverride
the receiver needs to explicitly accept the event to trigger the override.
Calling ignore() on a key event will propagate it to the parent widget.
The event is propagated up the parent widget chain until a widget
accepts it or an event filter consumes it.
The QWidget::setEnabled() function can be used to enable or disable
mouse and keyboard events for a widget.
The event handlers QWidget::keyPressEvent(), QWidget::keyReleaseEvent(),
QGraphicsItem::keyPressEvent() and QGraphicsItem::keyReleaseEvent()
receive key events.
\sa QFocusEvent, QWidget::grabKeyboard()
*/
/*!
Constructs a key event object.
The \a type parameter must be QEvent::KeyPress, QEvent::KeyRelease,
or QEvent::ShortcutOverride.
Int \a key is the code for the Qt::Key that the event loop should listen
for. If \a key is 0, the event is not a result of a known key; for
example, it may be the result of a compose sequence or keyboard macro.
The \a modifiers holds the keyboard modifiers, and the given \a text
is the Unicode text that the key generated. If \a autorep is true,
isAutoRepeat() will be true. \a count is the number of keys involved
in the event.
*/
QKeyEvent::QKeyEvent(Type type, int key, Qt::KeyboardModifiers modifiers, const QString& text,
bool autorep, ushort count)
: QInputEvent(type, modifiers), txt(text), k(key),
nScanCode(0), nVirtualKey(0), nModifiers(0),
c(count), autor(autorep)
{
if (type == QEvent::ShortcutOverride)
ignore();
}
/*!
Constructs a key event object.
The \a type parameter must be QEvent::KeyPress, QEvent::KeyRelease,
or QEvent::ShortcutOverride.
Int \a key is the code for the Qt::Key that the event loop should listen
for. If \a key is 0, the event is not a result of a known key; for
example, it may be the result of a compose sequence or keyboard macro.
The \a modifiers holds the keyboard modifiers, and the given \a text
is the Unicode text that the key generated. If \a autorep is true,
isAutoRepeat() will be true. \a count is the number of keys involved
in the event.
In addition to the normal key event data, also contains \a nativeScanCode,
\a nativeVirtualKey and \a nativeModifiers. This extra data is used by the
shortcut system, to determine which shortcuts to trigger.
*/
QKeyEvent::QKeyEvent(Type type, int key, Qt::KeyboardModifiers modifiers,
quint32 nativeScanCode, quint32 nativeVirtualKey, quint32 nativeModifiers,
const QString &text, bool autorep, ushort count)
: QInputEvent(type, modifiers), txt(text), k(key),
nScanCode(nativeScanCode), nVirtualKey(nativeVirtualKey), nModifiers(nativeModifiers),
c(count), autor(autorep)
{
if (type == QEvent::ShortcutOverride)
ignore();
}
/*!
\internal
*/
QKeyEvent::~QKeyEvent()
{
}
/*!
\fn quint32 QKeyEvent::nativeScanCode() const
\since 4.2
Returns the native scan code of the key event. If the key event
does not contain this data 0 is returned.
Note: The native scan code may be 0, even if the key event contains
extended information.
Note: On \macos, this function is not useful, because there is no
way to get the scan code from the system APIs. The function always
returns 1 (or 0 in the case explained above).
*/
/*!
\fn quint32 QKeyEvent::nativeVirtualKey() const
\since 4.2
Returns the native virtual key, or key sym of the key event.
If the key event does not contain this data 0 is returned.
Note: The native virtual key may be 0, even if the key event contains extended information.
*/
/*!
\fn quint32 QKeyEvent::nativeModifiers() const
\since 4.2
Returns the native modifiers of a key event.
If the key event does not contain this data 0 is returned.
Note: The native modifiers may be 0, even if the key event contains extended information.
*/
/*!
\fn int QKeyEvent::key() const
Returns the code of the key that was pressed or released.
See \l Qt::Key for the list of keyboard codes. These codes are
independent of the underlying window system. Note that this
function does not distinguish between capital and non-capital
letters, use the text() function (returning the Unicode text the
key generated) for this purpose.
A value of either 0 or Qt::Key_unknown means that the event is not
the result of a known key; for example, it may be the result of
a compose sequence, a keyboard macro, or due to key event
compression.
\sa Qt::WA_KeyCompression
*/
/*!
\fn QString QKeyEvent::text() const
Returns the Unicode text that this key generated.
Return values when modifier keys such as
Shift, Control, Alt, and Meta are pressed
differ among platforms and could return an empty string.
\note \l key() will always return a valid value,
independent of modifier keys.
\sa Qt::WA_KeyCompression
*/
/*!
Returns the keyboard modifier flags that existed immediately
after the event occurred.
\warning This function cannot always be trusted. The user can
confuse it by pressing both \uicontrol{Shift} keys simultaneously and
releasing one of them, for example.
\sa QGuiApplication::keyboardModifiers()
*/
Qt::KeyboardModifiers QKeyEvent::modifiers() const
{
if (key() == Qt::Key_Shift)
return Qt::KeyboardModifiers(QInputEvent::modifiers()^Qt::ShiftModifier);
if (key() == Qt::Key_Control)
return Qt::KeyboardModifiers(QInputEvent::modifiers()^Qt::ControlModifier);
if (key() == Qt::Key_Alt)
return Qt::KeyboardModifiers(QInputEvent::modifiers()^Qt::AltModifier);
if (key() == Qt::Key_Meta)
return Qt::KeyboardModifiers(QInputEvent::modifiers()^Qt::MetaModifier);
if (key() == Qt::Key_AltGr)
return Qt::KeyboardModifiers(QInputEvent::modifiers()^Qt::GroupSwitchModifier);
return QInputEvent::modifiers();
}
#ifndef QT_NO_SHORTCUT
/*!
\fn bool QKeyEvent::matches(QKeySequence::StandardKey key) const
\since 4.2
Returns \c true if the key event matches the given standard \a key;
otherwise returns \c false.
*/
bool QKeyEvent::matches(QKeySequence::StandardKey matchKey) const
{
//The keypad and group switch modifier should not make a difference
uint searchkey = (modifiers() | key()) & ~(Qt::KeypadModifier | Qt::GroupSwitchModifier);
const QList<QKeySequence> bindings = QKeySequence::keyBindings(matchKey);
return bindings.contains(QKeySequence(searchkey));
}
#endif // QT_NO_SHORTCUT
/*!
\fn bool QKeyEvent::isAutoRepeat() const
Returns \c true if this event comes from an auto-repeating key;
returns \c false if it comes from an initial key press.
Note that if the event is a multiple-key compressed event that is
partly due to auto-repeat, this function could return either true
or false indeterminately.
*/
/*!
\fn int QKeyEvent::count() const
Returns the number of keys involved in this event. If text()
is not empty, this is simply the length of the string.
\sa Qt::WA_KeyCompression
*/
/*!
\class QFocusEvent
\brief The QFocusEvent class contains event parameters for widget focus
events.
\inmodule QtGui
\ingroup events
Focus events are sent to widgets when the keyboard input focus
changes. Focus events occur due to mouse actions, key presses
(such as \uicontrol{Tab} or \uicontrol{Backtab}), the window system, popup
menus, keyboard shortcuts, or other application-specific reasons.
The reason for a particular focus event is returned by reason()
in the appropriate event handler.
The event handlers QWidget::focusInEvent(),
QWidget::focusOutEvent(), QGraphicsItem::focusInEvent and
QGraphicsItem::focusOutEvent() receive focus events.
\sa QWidget::setFocus(), QWidget::setFocusPolicy(), {Keyboard Focus in Widgets}
*/
/*!
Constructs a focus event object.
The \a type parameter must be either QEvent::FocusIn or
QEvent::FocusOut. The \a reason describes the cause of the change
in focus.
*/
QFocusEvent::QFocusEvent(Type type, Qt::FocusReason reason)
: QEvent(type), m_reason(reason)
{}
/*!
\internal
*/
QFocusEvent::~QFocusEvent()
{
}
/*!
Returns the reason for this focus event.
*/
Qt::FocusReason QFocusEvent::reason() const
{
return m_reason;
}
/*!
\fn bool QFocusEvent::gotFocus() const
Returns \c true if type() is QEvent::FocusIn; otherwise returns
false.
*/
/*!
\fn bool QFocusEvent::lostFocus() const
Returns \c true if type() is QEvent::FocusOut; otherwise returns
false.
*/
/*!
\class QPaintEvent
\brief The QPaintEvent class contains event parameters for paint events.
\inmodule QtGui
\ingroup events
Paint events are sent to widgets that need to update themselves,
for instance when part of a widget is exposed because a covering
widget was moved.
The event contains a region() that needs to be updated, and a
rect() that is the bounding rectangle of that region. Both are
provided because many widgets cannot make much use of region(),
and rect() can be much faster than region().boundingRect().
\section1 Automatic Clipping
Painting is clipped to region() during the processing of a paint
event. This clipping is performed by Qt's paint system and is
independent of any clipping that may be applied to a QPainter used to
draw on the paint device.
As a result, the value returned by QPainter::clipRegion() on
a newly-constructed QPainter will not reflect the clip region that is
used by the paint system.
\sa QPainter, QWidget::update(), QWidget::repaint(),
QWidget::paintEvent()
*/
/*!
Constructs a paint event object with the region that needs to
be updated. The region is specified by \a paintRegion.
*/
QPaintEvent::QPaintEvent(const QRegion& paintRegion)
: QEvent(Paint), m_rect(paintRegion.boundingRect()), m_region(paintRegion), m_erased(false)
{}
/*!
Constructs a paint event object with the rectangle that needs
to be updated. The region is specified by \a paintRect.
*/
QPaintEvent::QPaintEvent(const QRect &paintRect)
: QEvent(Paint), m_rect(paintRect),m_region(paintRect), m_erased(false)
{}
/*!
\internal
*/
QPaintEvent::~QPaintEvent()
{
}
/*!
\fn const QRect &QPaintEvent::rect() const
Returns the rectangle that needs to be updated.
\sa region(), QPainter::setClipRect()
*/
/*!
\fn const QRegion &QPaintEvent::region() const
Returns the region that needs to be updated.
\sa rect(), QPainter::setClipRegion()
*/
/*!
\class QMoveEvent
\brief The QMoveEvent class contains event parameters for move events.
\inmodule QtGui
\ingroup events
Move events are sent to widgets that have been moved to a new
position relative to their parent.
The event handler QWidget::moveEvent() receives move events.
\sa QWidget::move(), QWidget::setGeometry()
*/
/*!
Constructs a move event with the new and old widget positions,
\a pos and \a oldPos respectively.
*/
QMoveEvent::QMoveEvent(const QPoint &pos, const QPoint &oldPos)
: QEvent(Move), p(pos), oldp(oldPos)
{}
/*!
\internal
*/
QMoveEvent::~QMoveEvent()
{
}
/*!
\fn const QPoint &QMoveEvent::pos() const
Returns the new position of the widget. This excludes the window
frame for top level widgets.
*/
/*!
\fn const QPoint &QMoveEvent::oldPos() const
Returns the old position of the widget.
*/
/*!
\class QExposeEvent
\since 5.0
\brief The QExposeEvent class contains event parameters for expose events.
\inmodule QtGui
\ingroup events
Expose events are sent to windows when an area of the window is invalidated,
for example when window exposure in the windowing system changes.
A Window with a client area that is completely covered by another window, or
is otherwise not visible may be considered obscured by Qt and may in such
cases not receive expose events.
The event handler QWindow::exposeEvent() receives expose events.
*/
/*!
Constructs an expose event for the given \a exposeRegion which must be
in local coordinates.
*/
QExposeEvent::QExposeEvent(const QRegion &exposeRegion)
: QEvent(Expose)
, rgn(exposeRegion)
{
}
/*!
\internal
*/
QExposeEvent::~QExposeEvent()
{
}
/*!
\class QPlatformSurfaceEvent
\since 5.5
\brief The QPlatformSurfaceEvent class is used to notify about native platform surface events.
\inmodule QtGui
\ingroup events
Platform window events are synchronously sent to windows and offscreen surfaces when their
underlying native surfaces are created or are about to be destroyed.
Applications can respond to these events to know when the underlying platform
surface exists.
*/
/*!
\enum QPlatformSurfaceEvent::SurfaceEventType
This enum describes the type of platform surface event. The possible types are:
\value SurfaceCreated The underlying native surface has been created
\value SurfaceAboutToBeDestroyed The underlying native surface will be destroyed immediately after this event
The \c SurfaceAboutToBeDestroyed event type is useful as a means of stopping rendering to
a platform window before it is destroyed.
*/
/*!
\fn QPlatformSurfaceEvent::SurfaceEventType QPlatformSurfaceEvent::surfaceEventType() const
Returns the specific type of platform surface event.
*/
/*!
Constructs a platform surface event for the given \a surfaceEventType.
*/
QPlatformSurfaceEvent::QPlatformSurfaceEvent(SurfaceEventType surfaceEventType)
: QEvent(PlatformSurface)
, m_surfaceEventType(surfaceEventType)
{
}
/*!
\internal
*/
QPlatformSurfaceEvent::~QPlatformSurfaceEvent()
{
}
/*!
\fn const QRegion &QExposeEvent::region() const
Returns the window area that has been exposed. The region is given in local coordinates.
*/
/*!
\class QResizeEvent
\brief The QResizeEvent class contains event parameters for resize events.
\inmodule QtGui
\ingroup events
Resize events are sent to widgets that have been resized.
The event handler QWidget::resizeEvent() receives resize events.
\sa QWidget::resize(), QWidget::setGeometry()
*/
/*!
Constructs a resize event with the new and old widget sizes, \a
size and \a oldSize respectively.
*/
QResizeEvent::QResizeEvent(const QSize &size, const QSize &oldSize)
: QEvent(Resize), s(size), olds(oldSize)
{}
/*!
\internal
*/
QResizeEvent::~QResizeEvent()
{
}
/*!
\fn const QSize &QResizeEvent::size() const
Returns the new size of the widget. This is the same as
QWidget::size().
*/
/*!
\fn const QSize &QResizeEvent::oldSize() const
Returns the old size of the widget.
*/
/*!
\class QCloseEvent
\brief The QCloseEvent class contains parameters that describe a close event.
\ingroup events
\inmodule QtGui
Close events are sent to widgets that the user wants to close,
usually by choosing "Close" from the window menu, or by clicking
the \uicontrol{X} title bar button. They are also sent when you call
QWidget::close() to close a widget programmatically.
Close events contain a flag that indicates whether the receiver
wants the widget to be closed or not. When a widget accepts the
close event, it is hidden (and destroyed if it was created with
the Qt::WA_DeleteOnClose flag). If it refuses to accept the close
event nothing happens. (Under X11 it is possible that the window
manager will forcibly close the window; but at the time of writing
we are not aware of any window manager that does this.)
The event handler QWidget::closeEvent() receives close events. The
default implementation of this event handler accepts the close
event. If you do not want your widget to be hidden, or want some
special handling, you should reimplement the event handler and
ignore() the event.
The \l{mainwindows/application#close event handler}{closeEvent() in the
Application example} shows a close event handler that
asks whether to save a document before closing.
If you want the widget to be deleted when it is closed, create it
with the Qt::WA_DeleteOnClose flag. This is very useful for
independent top-level windows in a multi-window application.
\l{QObject}s emits the \l{QObject::destroyed()}{destroyed()}
signal when they are deleted.
If the last top-level window is closed, the
QGuiApplication::lastWindowClosed() signal is emitted.
The isAccepted() function returns \c true if the event's receiver has
agreed to close the widget; call accept() to agree to close the
widget and call ignore() if the receiver of this event does not
want the widget to be closed.
\sa QWidget::close(), QWidget::hide(), QObject::destroyed(),
QCoreApplication::exec(), QCoreApplication::quit(),
QGuiApplication::lastWindowClosed()
*/
/*!
Constructs a close event object.
\sa accept()
*/
QCloseEvent::QCloseEvent()
: QEvent(Close)
{}
/*! \internal
*/
QCloseEvent::~QCloseEvent()
{
}
/*!
\class QIconDragEvent
\brief The QIconDragEvent class indicates that a main icon drag has begun.
\inmodule QtGui
\ingroup events
Icon drag events are sent to widgets when the main icon of a window
has been dragged away. On \macos, this happens when the proxy
icon of a window is dragged off the title bar.
It is normal to begin using drag and drop in response to this
event.
\sa {Drag and Drop}, QMimeData, QDrag
*/
/*!
Constructs an icon drag event object with the accept flag set to
false.
\sa accept()
*/
QIconDragEvent::QIconDragEvent()
: QEvent(IconDrag)
{ ignore(); }
/*! \internal */
QIconDragEvent::~QIconDragEvent()
{
}
/*!
\class QContextMenuEvent
\brief The QContextMenuEvent class contains parameters that describe a context menu event.
\inmodule QtGui
\ingroup events
Context menu events are sent to widgets when a user performs
an action associated with opening a context menu.
The actions required to open context menus vary between platforms;
for example, on Windows, pressing the menu button or clicking the
right mouse button will cause this event to be sent.
When this event occurs it is customary to show a QMenu with a
context menu, if this is relevant to the context.
Context menu events contain a special accept flag that indicates
whether the receiver accepted the event. If the event handler does
not accept the event then, if possible, whatever triggered the event will be
handled as a regular input event.
*/
#ifndef QT_NO_CONTEXTMENU
/*!
Constructs a context menu event object with the accept parameter
flag set to false.
The \a reason parameter must be QContextMenuEvent::Mouse or
QContextMenuEvent::Keyboard.
The \a pos parameter specifies the mouse position relative to the
receiving widget. \a globalPos is the mouse position in absolute
coordinates.
*/
QContextMenuEvent::QContextMenuEvent(Reason reason, const QPoint &pos, const QPoint &globalPos)
: QContextMenuEvent(reason, pos, globalPos, Qt::NoModifier)
{}
/*!
Constructs a context menu event object with the accept parameter
flag set to false.
The \a reason parameter must be QContextMenuEvent::Mouse or
QContextMenuEvent::Keyboard.
The \a pos parameter specifies the mouse position relative to the
receiving widget. \a globalPos is the mouse position in absolute
coordinates. The \a modifiers holds the keyboard modifiers.
*/
QContextMenuEvent::QContextMenuEvent(Reason reason, const QPoint &pos, const QPoint &globalPos,
Qt::KeyboardModifiers modifiers)
: QInputEvent(ContextMenu, modifiers), p(pos), gp(globalPos), reas(reason)
{}
/*! \internal */
QContextMenuEvent::~QContextMenuEvent()
{
}
/*!
Constructs a context menu event object with the accept parameter
flag set to false.
The \a reason parameter must be QContextMenuEvent::Mouse or
QContextMenuEvent::Keyboard.
The \a pos parameter specifies the mouse position relative to the
receiving widget.
The globalPos() is initialized to QCursor::pos(), which may not be
appropriate. Use the other constructor to specify the global
position explicitly.
*/
QContextMenuEvent::QContextMenuEvent(Reason reason, const QPoint &pos)
: QInputEvent(ContextMenu), p(pos), reas(reason)
{
#ifndef QT_NO_CURSOR
gp = QCursor::pos();
#endif
}
/*!
\fn const QPoint &QContextMenuEvent::pos() const
Returns the position of the mouse pointer relative to the widget
that received the event.
\sa x(), y(), globalPos()
*/
/*!
\fn int QContextMenuEvent::x() const
Returns the x position of the mouse pointer, relative to the
widget that received the event.
\sa y(), pos()
*/
/*!
\fn int QContextMenuEvent::y() const
Returns the y position of the mouse pointer, relative to the
widget that received the event.
\sa x(), pos()
*/
/*!
\fn const QPoint &QContextMenuEvent::globalPos() const
Returns the global position of the mouse pointer at the time of
the event.
\sa x(), y(), pos()
*/
/*!
\fn int QContextMenuEvent::globalX() const
Returns the global x position of the mouse pointer at the time of
the event.
\sa globalY(), globalPos()
*/
/*!
\fn int QContextMenuEvent::globalY() const
Returns the global y position of the mouse pointer at the time of
the event.
\sa globalX(), globalPos()
*/
#endif // QT_NO_CONTEXTMENU
/*!
\enum QContextMenuEvent::Reason
This enum describes the reason why the event was sent.
\value Mouse The mouse caused the event to be sent. Normally this
means the right mouse button was clicked, but this is platform
dependent.
\value Keyboard The keyboard caused this event to be sent. On
Windows, this means the menu button was pressed.
\value Other The event was sent by some other means (i.e. not by
the mouse or keyboard).
*/
/*!
\fn QContextMenuEvent::Reason QContextMenuEvent::reason() const
Returns the reason for this context event.
*/
/*!
\class QInputMethodEvent
\brief The QInputMethodEvent class provides parameters for input method events.
\inmodule QtGui
\ingroup events
Input method events are sent to widgets when an input method is
used to enter text into a widget. Input methods are widely used
to enter text for languages with non-Latin alphabets.
Note that when creating custom text editing widgets, the
Qt::WA_InputMethodEnabled window attribute must be set explicitly
(using the QWidget::setAttribute() function) in order to receive
input method events.
The events are of interest to authors of keyboard entry widgets
who want to be able to correctly handle languages with complex
character input. Text input in such languages is usually a three
step process:
\list 1
\li \b{Starting to Compose}
When the user presses the first key on a keyboard, an input
context is created. This input context will contain a string
of the typed characters.
\li \b{Composing}
With every new key pressed, the input method will try to create a
matching string for the text typed so far called preedit
string. While the input context is active, the user can only move
the cursor inside the string belonging to this input context.
\li \b{Completing}
At some point, the user will activate a user interface component
(perhaps using a particular key) where they can choose from a
number of strings matching the text they have typed so far. The
user can either confirm their choice cancel the input; in either
case the input context will be closed.
\endlist
QInputMethodEvent models these three stages, and transfers the
information needed to correctly render the intermediate result. A
QInputMethodEvent has two main parameters: preeditString() and
commitString(). The preeditString() parameter gives the currently
active preedit string. The commitString() parameter gives a text
that should get added to (or replace parts of) the text of the
editor widget. It usually is a result of the input operations and
has to be inserted to the widgets text directly before the preedit
string.
If the commitString() should replace parts of the of the text in
the editor, replacementLength() will contain the number of
characters to be replaced. replacementStart() contains the position
at which characters are to be replaced relative from the start of
the preedit string.
A number of attributes control the visual appearance of the
preedit string (the visual appearance of text outside the preedit
string is controlled by the widget only). The AttributeType enum
describes the different attributes that can be set.
A class implementing QWidget::inputMethodEvent() or
QGraphicsItem::inputMethodEvent() should at least understand and
honor the \l TextFormat and \l Cursor attributes.
Since input methods need to be able to query certain properties
from the widget or graphics item, subclasses must also implement
QWidget::inputMethodQuery() and QGraphicsItem::inputMethodQuery(),
respectively.
When receiving an input method event, the text widget has to performs the
following steps:
\list 1
\li If the widget has selected text, the selected text should get
removed.
\li Remove the text starting at replacementStart() with length
replacementLength() and replace it by the commitString(). If
replacementLength() is 0, replacementStart() gives the insertion
position for the commitString().
When doing replacement the area of the preedit
string is ignored, thus a replacement starting at -1 with a length
of 2 will remove the last character before the preedit string and
the first character afterwards, and insert the commit string
directly before the preedit string.
If the widget implements undo/redo, this operation gets added to
the undo stack.
\li If there is no current preedit string, insert the
preeditString() at the current cursor position; otherwise replace
the previous preeditString with the one received from this event.
If the widget implements undo/redo, the preeditString() should not
influence the undo/redo stack in any way.
The widget should examine the list of attributes to apply to the
preedit string. It has to understand at least the TextFormat and
Cursor attributes and render them as specified.
\endlist
\sa QInputMethod
*/
/*!
\enum QInputMethodEvent::AttributeType
\value TextFormat
A QTextCharFormat for the part of the preedit string specified by
start and length. value contains a QVariant of type QTextFormat
specifying rendering of this part of the preedit string. There
should be at most one format for every part of the preedit
string. If several are specified for any character in the string the
behaviour is undefined. A conforming implementation has to at least
honor the backgroundColor, textColor and fontUnderline properties
of the format.
\value Cursor If set, a cursor should be shown inside the preedit
string at position start. The length variable determines whether
the cursor is visible or not. If the length is 0 the cursor is
invisible. If value is a QVariant of type QColor this color will
be used for rendering the cursor, otherwise the color of the
surrounding text will be used. There should be at most one Cursor
attribute per event. If several are specified the behaviour is
undefined.
\value Language
The variant contains a QLocale object specifying the language of a
certain part of the preedit string. There should be at most one
language set for every part of the preedit string. If several are
specified for any character in the string the behavior is undefined.
\value Ruby
The ruby text for a part of the preedit string. There should be at
most one ruby text set for every part of the preedit string. If
several are specified for any character in the string the behaviour
is undefined.
\value Selection
If set, the edit cursor should be moved to the specified position
in the editor text contents. In contrast with \c Cursor, this
attribute does not work on the preedit text, but on the surrounding
text. The cursor will be moved after the commit string has been
committed, and the preedit string will be located at the new edit
position.
The start position specifies the new position and the length
variable can be used to set a selection starting from that point.
The value is unused.
\sa Attribute
*/
/*!
\class QInputMethodEvent::Attribute
\inmodule QtGui
\brief The QInputMethodEvent::Attribute class stores an input method attribute.
*/
/*!
\fn QInputMethodEvent::Attribute::Attribute(AttributeType type, int start, int length, QVariant value)
Constructs an input method attribute. \a type specifies the type
of attribute, \a start and \a length the position of the
attribute, and \a value the value of the attribute.
*/
/*!
\fn QInputMethodEvent::Attribute::Attribute(AttributeType type, int start, int length)
\overload
\since 5.7
Constructs an input method attribute with no value. \a type
specifies the type of attribute, and \a start and \a length
the position of the attribute.
*/
/*!
Constructs an event of type QEvent::InputMethod. The
attributes(), preeditString(), commitString(), replacementStart(),
and replacementLength() are initialized to default values.
\sa setCommitString()
*/
QInputMethodEvent::QInputMethodEvent()
: QEvent(QEvent::InputMethod), replace_from(0), replace_length(0)
{
}
/*!
Constructs an event of type QEvent::InputMethod. The
preedit text is set to \a preeditText, the attributes to
\a attributes.
The commitString(), replacementStart(), and replacementLength()
values can be set using setCommitString().
\sa preeditString(), attributes()
*/
QInputMethodEvent::QInputMethodEvent(const QString &preeditText, const QList<Attribute> &attributes)
: QEvent(QEvent::InputMethod), preedit(preeditText), attrs(attributes),
replace_from(0), replace_length(0)
{
}
/*!
Constructs a copy of \a other.
*/
QInputMethodEvent::QInputMethodEvent(const QInputMethodEvent &other)
: QEvent(QEvent::InputMethod), preedit(other.preedit), attrs(other.attrs),
commit(other.commit), replace_from(other.replace_from), replace_length(other.replace_length)
{
}
QInputMethodEvent::~QInputMethodEvent()
{
// must be empty until ### Qt 6
}
/*!
Sets the commit string to \a commitString.
The commit string is the text that should get added to (or
replace parts of) the text of the editor widget. It usually is a
result of the input operations and has to be inserted to the
widgets text directly before the preedit string.
If the commit string should replace parts of the of the text in
the editor, \a replaceLength specifies the number of
characters to be replaced. \a replaceFrom specifies the position
at which characters are to be replaced relative from the start of
the preedit string.
\sa commitString(), replacementStart(), replacementLength()
*/
void QInputMethodEvent::setCommitString(const QString &commitString, int replaceFrom, int replaceLength)
{
commit = commitString;
replace_from = replaceFrom;
replace_length = replaceLength;
}
/*!
\fn const QList<Attribute> &QInputMethodEvent::attributes() const
Returns the list of attributes passed to the QInputMethodEvent
constructor. The attributes control the visual appearance of the
preedit string (the visual appearance of text outside the preedit
string is controlled by the widget only).
\sa preeditString(), Attribute
*/
/*!
\fn const QString &QInputMethodEvent::preeditString() const
Returns the preedit text, i.e. the text before the user started
editing it.
\sa commitString(), attributes()
*/
/*!
\fn const QString &QInputMethodEvent::commitString() const
Returns the text that should get added to (or replace parts of)
the text of the editor widget. It usually is a result of the
input operations and has to be inserted to the widgets text
directly before the preedit string.
\sa setCommitString(), preeditString(), replacementStart(), replacementLength()
*/
/*!
\fn int QInputMethodEvent::replacementStart() const
Returns the position at which characters are to be replaced relative
from the start of the preedit string.
\sa replacementLength(), setCommitString()
*/
/*!
\fn int QInputMethodEvent::replacementLength() const
Returns the number of characters to be replaced in the preedit
string.
\sa replacementStart(), setCommitString()
*/
/*!
\class QInputMethodQueryEvent
\since 5.0
\inmodule QtGui
\brief The QInputMethodQueryEvent class provides an event sent by the input context to input objects.
It is used by the
input method to query a set of properties of the object to be
able to support complex input method operations as support for
surrounding text and reconversions.
queries() specifies which properties are queried.
The object should call setValue() on the event to fill in the requested
data before calling accept().
*/
/*!
\fn Qt::InputMethodQueries QInputMethodQueryEvent::queries() const
Returns the properties queried by the event.
*/
/*!
Constructs a query event for properties given by \a queries.
*/
QInputMethodQueryEvent::QInputMethodQueryEvent(Qt::InputMethodQueries queries)
: QEvent(InputMethodQuery),
m_queries(queries)
{
}
/*!
\internal
*/
QInputMethodQueryEvent::~QInputMethodQueryEvent()
{
}
/*!
Sets property \a query to \a value.
*/
void QInputMethodQueryEvent::setValue(Qt::InputMethodQuery query, const QVariant &value)
{
for (int i = 0; i < m_values.size(); ++i) {
if (m_values.at(i).query == query) {
m_values[i].value = value;
return;
}
}
QueryPair pair = { query, value };
m_values.append(pair);
}
/*!
Returns value of the property \a query.
*/
QVariant QInputMethodQueryEvent::value(Qt::InputMethodQuery query) const
{
for (int i = 0; i < m_values.size(); ++i)
if (m_values.at(i).query == query)
return m_values.at(i).value;
return QVariant();
}
#if QT_CONFIG(tabletevent)
/*!
\class QTabletEvent
\brief The QTabletEvent class contains parameters that describe a Tablet event.
\inmodule QtGui
\ingroup events
\e{Tablet events} are generated from tablet peripherals such as Wacom
tablets and various other brands, and electromagnetic stylus devices
included with some types of tablet computers. (It is not the same as
\l QTouchEvent which a touchscreen generates, even when a passive stylus is
used on a touchscreen.)
Tablet events are similar to mouse events; for example, the \l x(), \l y(),
\l pos(), \l globalX(), \l globalY(), and \l globalPos() accessors provide
the cursor position, and you can see which \l buttons() are pressed
(pressing the stylus tip against the tablet surface is equivalent to a left
mouse button). But tablet events also pass through some extra information
that the tablet device driver provides; for example, you might want to do
subpixel rendering with higher resolution coordinates (\l globalPosF()),
adjust color brightness based on the \l pressure() of the tool against the
tablet surface, use different brushes depending on the type of tool in use
(\l deviceType()), modulate the brush shape in some way according to the
X-axis and Y-axis tilt of the tool with respect to the tablet surface
(\l xTilt() and \l yTilt()), and use a virtual eraser instead of a brush if
the user switches to the other end of a double-ended stylus
(\l pointerType()).
Every event contains an accept flag that indicates whether the receiver
wants the event. You should call QTabletEvent::accept() if you handle the
tablet event; otherwise it will be sent to the parent widget. The exception
are TabletEnterProximity and TabletLeaveProximity events: these are only
sent to QApplication and do not check whether or not they are accepted.
The QWidget::setEnabled() function can be used to enable or disable
mouse, tablet and keyboard events for a widget.
The event handler QWidget::tabletEvent() receives TabletPress,
TabletRelease and TabletMove events. Qt will first send a
tablet event, then if it is not accepted by any widget, it will send a
mouse event. This allows users of applications that are not designed for
tablets to use a tablet like a mouse. However high-resolution drawing
applications should handle the tablet events, because they can occur at a
higher frequency, which is a benefit for smooth and accurate drawing.
If the tablet events are rejected, the synthetic mouse events may be
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
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
surface in order to register the simultaneous stylus button press.
\section1 Notes for X11 Users
If the tablet is configured in xorg.conf to use the Wacom driver, there
will be separate XInput "devices" for the stylus, eraser, and (optionally)
cursor and touchpad. Qt recognizes these by their names. Otherwise, if the
tablet is configured to use the evdev driver, there will be only one device
and applications may not be able to distinguish the stylus from the eraser.
\section1 Notes for Windows Users
Tablet support currently requires the WACOM windows driver providing the DLL
\c{wintab32.dll} to be installed. It is contained in older packages,
for example \c{pentablet_5.3.5-3.exe}.
*/
/*!
\enum QTabletEvent::TabletDevice
This enum defines what type of device is generating the event.
\value NoDevice No device, or an unknown device.
\value Puck A Puck (a device that is similar to a flat mouse with
a transparent circle with cross-hairs).
\value Stylus A Stylus.
\value Airbrush An airbrush
\value FourDMouse A 4D Mouse.
\value RotationStylus A special stylus that also knows about rotation
(a 6D stylus). \since 4.1
\omitvalue XFreeEraser
*/
/*!
\enum QTabletEvent::PointerType
This enum defines what type of point is generating the event.
\value UnknownPointer An unknown device.
\value Pen Tip end of a stylus-like device (the narrow end of the pen).
\value Cursor Any puck-like device.
\value Eraser Eraser end of a stylus-like device (the broad end of the pen).
\sa pointerType()
*/
/*!
Construct a tablet event of the given \a type.
The \a pos parameter indicates where the event occurred in the
widget; \a globalPos is the corresponding position in absolute
coordinates.
\a pressure contains the pressure exerted on the \a device.
\a pointerType describes the type of pen that is being used.
\a xTilt and \a yTilt contain the device's degree of tilt from the
x and y axes respectively.
\a keyState specifies which keyboard modifiers are pressed (e.g.,
\uicontrol{Ctrl}).
The \a uniqueID parameter contains the unique ID for the current device.
The \a z parameter contains the coordinate of the device on the tablet, this
is usually given by a wheel on 4D mouse. If the device does not support a
Z-axis, pass zero here.
The \a tangentialPressure parameter contins the tangential pressure of an air
brush. If the device does not support tangential pressure, pass 0 here.
\a rotation contains the device's rotation in degrees.
4D mice, the Wacom Art Pen, and the Apple Pencil support rotation.
If the device does not support rotation, pass 0 here.
The \a button that caused the event is given as a value from the
\l Qt::MouseButton enum. If the event \a type is not \l TabletPress or
\l TabletRelease, the appropriate button for this event is \l Qt::NoButton.
\a buttons is the state of all buttons at the time of the event.
\sa pos(), globalPos(), device(), pressure(), xTilt(), yTilt(), uniqueId(), rotation(),
tangentialPressure(), z()
*/
QTabletEvent::QTabletEvent(Type type, const QPointF &pos, const QPointF &globalPos,
int device, int pointerType,
qreal pressure, int xTilt, int yTilt, qreal tangentialPressure,
qreal rotation, int z, Qt::KeyboardModifiers keyState, qint64 uniqueID,
Qt::MouseButton button, Qt::MouseButtons buttons)
: QInputEvent(type, keyState),
mPos(pos),
mGPos(globalPos),
mDev(device),
mPointerType(pointerType),
mXT(xTilt),
mYT(yTilt),
mZ(z),
mPress(pressure),
mTangential(tangentialPressure),
mRot(rotation),
mUnique(uniqueID),
mExtra(new QTabletEventPrivate(button, buttons))
{
}
#if QT_DEPRECATED_SINCE(5, 15)
/*!
Construct a tablet event of the given \a type.
The \a pos parameter indicates where the event occurred in the
widget; \a globalPos is the corresponding position in absolute
coordinates.
\a pressure contains the pressure exerted on the \a device.
\a pointerType describes the type of pen that is being used.
\a xTilt and \a yTilt contain the device's degree of tilt from the
x and y axes respectively.
\a keyState specifies which keyboard modifiers are pressed (e.g.,
\uicontrol{Ctrl}).
The \a uniqueID parameter contains the unique ID for the current device.
The \a z parameter contains the coordinate of the device on the tablet, this
is usually given by a wheel on 4D mouse. If the device does not support a
Z-axis, pass zero here.
The \a tangentialPressure parameter contins the tangential pressure of an air
brush. If the device does not support tangential pressure, pass 0 here.
\a rotation contains the device's rotation in degrees. 4D mice support
rotation. If the device does not support rotation, pass 0 here.
\sa pos(), globalPos(), device(), pressure(), xTilt(), yTilt(), uniqueId(), rotation(),
tangentialPressure(), z()
\deprecated in 5.4: use the constructor with MouseButton status
*/
QTabletEvent::QTabletEvent(Type type, const QPointF &pos, const QPointF &globalPos,
int device, int pointerType,
qreal pressure, int xTilt, int yTilt, qreal tangentialPressure,
qreal rotation, int z, Qt::KeyboardModifiers keyState, qint64 uniqueID)
: QTabletEvent(type, pos, globalPos, device, pointerType, pressure, xTilt, yTilt,
tangentialPressure, rotation, z, keyState, uniqueID, Qt::NoButton, Qt::NoButton)
{
}
#endif
/*!
\internal
*/
QTabletEvent::~QTabletEvent()
{
delete static_cast<QTabletEventPrivate *>(mExtra);
}
/*!
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
*/
Qt::MouseButton QTabletEvent::button() const
{
return static_cast<QTabletEventPrivate *>(mExtra)->b;
}
/*!
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
*/
Qt::MouseButtons QTabletEvent::buttons() const
{
return static_cast<QTabletEventPrivate *>(mExtra)->buttonState;
}
/*!
\fn TabletDevices QTabletEvent::device() const
\deprecated Use deviceType().
*/
/*!
\fn TabletDevices QTabletEvent::deviceType() const
Returns the type of device that generated the event.
\sa TabletDevice
*/
/*!
\fn PointerType QTabletEvent::pointerType() const
Returns the type of point that generated the event.
*/
/*!
\fn qreal QTabletEvent::tangentialPressure() const
Returns the tangential pressure for the device. This is typically given by a finger
wheel on an airbrush tool. The range is from -1.0 to 1.0. 0.0 indicates a
neutral position. Current airbrushes can only move in the positive
direction from the neutrual position. If the device does not support
tangential pressure, this value is always 0.0.
\sa pressure()
*/
/*!
\fn qreal QTabletEvent::rotation() const
Returns the rotation of the current tool in degrees, where zero means the
tip of the stylus is pointing towards the top of the tablet, a positive
value means it's turned to the right, and a negative value means it's
turned to the left. This can be given by a 4D Mouse or a rotation-capable
stylus (such as the Wacom Art Pen or the Apple Pencil). If the device does
not support rotation, this value is always 0.0.
*/
/*!
\fn qreal QTabletEvent::pressure() const
Returns the pressure for the device. 0.0 indicates that the stylus is not
on the tablet, 1.0 indicates the maximum amount of pressure for the stylus.
\sa tangentialPressure()
*/
/*!
\fn int QTabletEvent::xTilt() const
Returns the angle between the device (a pen, for example) and the
perpendicular in the direction of the x axis.
Positive values are towards the tablet's physical right. The angle
is in the range -60 to +60 degrees.
\image qtabletevent-tilt.png
\sa yTilt()
*/
/*!
\fn int QTabletEvent::yTilt() const
Returns the angle between the device (a pen, for example) and the
perpendicular in the direction of the y axis.
Positive values are towards the bottom of the tablet. The angle is
within the range -60 to +60 degrees.
\sa xTilt()
*/
/*!
\fn QPoint QTabletEvent::pos() const
Returns the position of the device, relative to the widget that
received the event.
If you move widgets around in response to mouse events, use
globalPos() instead of this function.
\sa x(), y(), globalPos()
*/
/*!
\fn int QTabletEvent::x() const
Returns the x position of the device, relative to the widget that
received the event.
\sa y(), pos()
*/
/*!
\fn int QTabletEvent::y() const
Returns the y position of the device, relative to the widget that
received the event.
\sa x(), pos()
*/
/*!
\fn int QTabletEvent::z() const
Returns the z position of the device. Typically this is represented by a
wheel on a 4D Mouse. If the device does not support a Z-axis, this value is
always zero. This is \b not the same as pressure.
\sa pressure()
*/
/*!
\fn QPoint QTabletEvent::globalPos() const
Returns the global position of the device \e{at the time of the
event}. This is important on asynchronous windows systems like X11;
whenever you move your widgets around in response to mouse events,
globalPos() can differ significantly from the current position
QCursor::pos().
\sa globalX(), globalY()
*/
/*!
\fn int QTabletEvent::globalX() const
Returns the global x position of the mouse pointer at the time of
the event.
\sa globalY(), globalPos(), hiResGlobalX()
*/
/*!
\fn int QTabletEvent::globalY() const
Returns the global y position of the tablet device at the time of
the event.
\sa globalX(), globalPos(), hiResGlobalY()
*/
/*!
\fn qint64 QTabletEvent::uniqueId() const
Returns a unique ID for the current device, making it possible
to differentiate between multiple devices being used at the same
time on the tablet.
Support of this feature is dependent on the tablet.
Values for the same device may vary from OS to OS.
Later versions of the Wacom driver for Linux will now report
the ID information. If you have a tablet that supports unique ID
and are not getting the information on Linux, consider upgrading
your driver.
As of Qt 4.2, the unique ID is the same regardless of the orientation
of the pen. Earlier versions would report a different value when using
the eraser-end versus the pen-end of the stylus on some OS's.
\sa pointerType()
*/
/*!
\fn qreal &QTabletEvent::hiResGlobalX() const
The high precision x position of the tablet device.
\obsolete use globalPosF()
*/
/*!
\fn qreal &QTabletEvent::hiResGlobalY() const
The high precision y position of the tablet device.
\obsolete use globalPosF()
*/
/*!
\fn const QPointF &QTabletEvent::posF() const
Returns the position of the device, relative to the widget that
received the event.
If you move widgets around in response to mouse events, use
globalPosF() instead of this function.
\sa globalPosF()
*/
/*!
\fn const QPointF &QTabletEvent::globalPosF() const
Returns the global position of the device \e{at the time of the
event}. This is important on asynchronous windows systems like X11;
whenever you move your widgets around in response to mouse events,
globalPosF() can differ significantly from the current position
QCursor::pos().
\sa posF()
*/
#endif // QT_CONFIG(tabletevent)
#ifndef QT_NO_GESTURES
/*!
\class QNativeGestureEvent
\since 5.2
\brief The QNativeGestureEvent class contains parameters that describe a gesture event.
\inmodule QtGui
\ingroup events
Native gesture events are generated by the operating system, typically by
interpreting touch events. Gesture events are high-level events such
as zoom or rotate.
\table
\header
\li Event Type
\li Description
\li Touch sequence
\row
\li Qt::ZoomNativeGesture
\li Magnification delta in percent.
\li \macos: Two-finger pinch.
\row
\li Qt::SmartZoomNativeGesture
\li Boolean magnification state.
\li \macos: Two-finger douple tap (trackpad) / One-finger douple tap (magic mouse).
\row
\li Qt::RotateNativeGesture
\li Rotation delta in degrees.
\li \macos: Two-finger rotate.
\endtable
In addition, BeginNativeGesture and EndNativeGesture are sent before and after
gesture event streams:
BeginNativeGesture
ZoomNativeGesture
ZoomNativeGesture
ZoomNativeGesture
EndNativeGesture
\sa Qt::NativeGestureType, QGestureEvent
*/
#if QT_DEPRECATED_SINCE(5, 10)
/*!
\deprecated The QTouchDevice parameter is now required
*/
QNativeGestureEvent::QNativeGestureEvent(Qt::NativeGestureType type, const QPointF &localPos, const QPointF &windowPos,
const QPointF &screenPos, qreal realValue, ulong sequenceId, quint64 intValue)
: QInputEvent(QEvent::NativeGesture), mGestureType(type),
mLocalPos(localPos), mWindowPos(windowPos), mScreenPos(screenPos), mRealValue(realValue),
mSequenceId(sequenceId), mIntValue(intValue)
{ }
#endif
typedef QHash<const QNativeGestureEvent*, const QTouchDevice*> NativeGestureEventDataHash;
// ### Qt6: move this to a member in QNativeGestureEvent
Q_GLOBAL_STATIC(NativeGestureEventDataHash, g_nativeGestureEventDataHash)
/*!
Constructs a native gesture event of type \a type originating from \a device.
The points \a localPos, \a windowPos and \a screenPos specify the
gesture position relative to the receiving widget or item,
window, and screen, respectively.
\a realValue is the \macos event parameter, \a sequenceId and \a intValue are the Windows event parameters.
\since 5.10
*/
QNativeGestureEvent::QNativeGestureEvent(Qt::NativeGestureType type, const QTouchDevice *device, const QPointF &localPos, const QPointF &windowPos,
const QPointF &screenPos, qreal realValue, ulong sequenceId, quint64 intValue)
: QInputEvent(QEvent::NativeGesture), mGestureType(type),
mLocalPos(localPos), mWindowPos(windowPos), mScreenPos(screenPos), mRealValue(realValue),
mSequenceId(sequenceId), mIntValue(intValue)
{
g_nativeGestureEventDataHash->insert(this, device);
}
QNativeGestureEvent::~QNativeGestureEvent()
{
g_nativeGestureEventDataHash->remove(this);
}
/*!
\since 5.10
Returns the device.
*/
const QTouchDevice *QNativeGestureEvent::device() const
{
return g_nativeGestureEventDataHash->value(this);
}
/*!
\fn QNativeGestureEvent::gestureType() const
\since 5.2
Returns the gesture type.
*/
/*!
\fn QNativeGestureEvent::value() const
\since 5.2
Returns the gesture value. The value should be interpreted based on the
gesture type. For example, a Zoom gesture provides a scale factor while a Rotate
gesture provides a rotation delta.
\sa QNativeGestureEvent, gestureType()
*/
/*!
\fn QPoint QNativeGestureEvent::globalPos() const
\since 5.2
Returns the position of the gesture as a QPointF in screen coordinates
*/
/*!
\fn QPoint QNativeGestureEvent::pos() const
\since 5.2
Returns the position of the mouse cursor, relative to the widget
or item that received the event.
*/
/*!
\fn QPointF QNativeGestureEvent::localPos() const
\since 5.2
Returns the position of the gesture as a QPointF, relative to the
widget or item that received the event.
*/
/*!
\fn QPointF QNativeGestureEvent::screenPos() const
\since 5.2
Returns the position of the gesture as a QPointF in screen coordinates.
*/
/*!
\fn QPointF QNativeGestureEvent::windowPos() const
\since 5.2
Returns the position of the gesture as a QPointF, relative to the
window that received the event.
*/
#endif // QT_NO_GESTURES
#if QT_CONFIG(draganddrop)
/*!
Creates a QDragMoveEvent of the required \a type indicating
that the mouse is at position \a pos given within a widget.
The mouse and keyboard states are specified by \a buttons and
\a modifiers, and the \a actions describe the types of drag
and drop operation that are possible.
The drag data is passed as MIME-encoded information in \a data.
\warning Do not attempt to create a QDragMoveEvent yourself.
These objects rely on Qt's internal state.
*/
QDragMoveEvent::QDragMoveEvent(const QPoint& pos, Qt::DropActions actions, const QMimeData *data,
Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, Type type)
: QDropEvent(pos, actions, data, buttons, modifiers, type)
, rect(pos, QSize(1, 1))
{}
/*!
Destroys the event.
*/
QDragMoveEvent::~QDragMoveEvent()
{
}
/*!
\fn void QDragMoveEvent::accept(const QRect &rectangle)
The same as accept(), but also notifies that future moves will
also be acceptable if they remain within the \a rectangle
given on the widget. This can improve performance, but may
also be ignored by the underlying system.
If the rectangle is empty, drag move events will be sent
continuously. This is useful if the source is scrolling in a
timer event.
*/
/*!
\fn void QDragMoveEvent::accept()
\overload
Calls QDropEvent::accept().
*/
/*!
\fn void QDragMoveEvent::ignore()
\overload
Calls QDropEvent::ignore().
*/
/*!
\fn void QDragMoveEvent::ignore(const QRect &rectangle)
The opposite of the accept(const QRect&) function.
Moves within the \a rectangle are not acceptable, and will be
ignored.
*/
/*!
\fn QRect QDragMoveEvent::answerRect() const
Returns the rectangle in the widget where the drop will occur if accepted.
You can use this information to restrict drops to certain places on the
widget.
*/
/*!
\class QDropEvent
\ingroup events
\ingroup draganddrop
\inmodule QtGui
\brief The QDropEvent class provides an event which is sent when a
drag and drop action is completed.
When a widget \l{QWidget::setAcceptDrops()}{accepts drop events}, it will
receive this event if it has accepted the most recent QDragEnterEvent or
QDragMoveEvent sent to it.
The drop event contains a proposed action, available from proposedAction(), for
the widget to either accept or ignore. If the action can be handled by the
widget, you should call the acceptProposedAction() function. Since the
proposed action can be a combination of \l Qt::DropAction values, it may be
useful to either select one of these values as a default action or ask
the user to select their preferred action.
If the proposed drop action is not suitable, perhaps because your custom
widget does not support that action, you can replace it with any of the
\l{possibleActions()}{possible drop actions} by calling setDropAction()
with your preferred action. If you set a value that is not present in the
bitwise OR combination of values returned by possibleActions(), the default
copy action will be used. Once a replacement drop action has been set, call
accept() instead of acceptProposedAction() to complete the drop operation.
The mimeData() function provides the data dropped on the widget in a QMimeData
object. This contains information about the MIME type of the data in addition to
the data itself.
\sa QMimeData, QDrag, {Drag and Drop}
*/
/*!
\fn const QMimeData *QDropEvent::mimeData() const
Returns the data that was dropped on the widget and its associated MIME
type information.
*/
// ### pos is in which coordinate system?
/*!
Constructs a drop event of a certain \a type corresponding to a
drop at the point specified by \a pos in the destination widget's
coordinate system.
The \a actions indicate which types of drag and drop operation can
be performed, and the drag data is stored as MIME-encoded data in \a data.
The states of the mouse buttons and keyboard modifiers at the time of
the drop are specified by \a buttons and \a modifiers.
*/
QDropEvent::QDropEvent(const QPointF& pos, Qt::DropActions actions, const QMimeData *data,
Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, Type type)
: QEvent(type), p(pos), mouseState(buttons),
modState(modifiers), act(actions),
mdata(data)
{
default_action = QGuiApplicationPrivate::platformIntegration()->drag()->defaultAction(act, modifiers);
drop_action = default_action;
ignore();
}
/*! \internal */
QDropEvent::~QDropEvent()
{
}
/*!
If the source of the drag operation is a widget in this
application, this function returns that source; otherwise it
returns \nullptr. The source of the operation is the first parameter to
the QDrag object used instantiate the drag.
This is useful if your widget needs special behavior when dragging
to itself.
\sa QDrag::QDrag()
*/
QObject* QDropEvent::source() const
{
if (const QDragManager *manager = QDragManager::self())
return manager->source();
return nullptr;
}
void QDropEvent::setDropAction(Qt::DropAction action)
{
if (!(action & act) && action != Qt::IgnoreAction)
action = default_action;
drop_action = action;
}
/*!
\fn QPoint QDropEvent::pos() const
Returns the position where the drop was made.
*/
/*!
\fn const QPointF& QDropEvent::posF() const
Returns the position where the drop was made.
*/
/*!
\fn Qt::MouseButtons QDropEvent::mouseButtons() const
Returns the mouse buttons that are pressed..
*/
/*!
\fn Qt::KeyboardModifiers QDropEvent::keyboardModifiers() const
Returns the modifier keys that are pressed.
*/
/*!
\fn void QDropEvent::setDropAction(Qt::DropAction action)
Sets the \a action to be performed on the data by the target.
Use this to override the \l{proposedAction()}{proposed action}
with one of the \l{possibleActions()}{possible actions}.
If you set a drop action that is not one of the possible actions, the
drag and drop operation will default to a copy operation.
Once you have supplied a replacement drop action, call accept()
instead of acceptProposedAction().
\sa dropAction()
*/
/*!
\fn Qt::DropAction QDropEvent::dropAction() const
Returns the action to be performed on the data by the target. This may be
different from the action supplied in proposedAction() if you have called
setDropAction() to explicitly choose a drop action.
\sa setDropAction()
*/
/*!
\fn Qt::DropActions QDropEvent::possibleActions() const
Returns an OR-combination of possible drop actions.
\sa dropAction()
*/
/*!
\fn Qt::DropAction QDropEvent::proposedAction() const
Returns the proposed drop action.
\sa dropAction()
*/
/*!
\fn void QDropEvent::acceptProposedAction()
Sets the drop action to be the proposed action.
\sa setDropAction(), proposedAction(), {QEvent::accept()}{accept()}
*/
/*!
\class QDragEnterEvent
\brief The QDragEnterEvent class provides an event which is sent
to a widget when a drag and drop action enters it.
\ingroup events
\ingroup draganddrop
\inmodule QtGui
A widget must accept this event in order to receive the \l
{QDragMoveEvent}{drag move events} that are sent while the drag
and drop action is in progress. The drag enter event is always
immediately followed by a drag move event.
QDragEnterEvent inherits most of its functionality from
QDragMoveEvent, which in turn inherits most of its functionality
from QDropEvent.
\sa QDragLeaveEvent, QDragMoveEvent, QDropEvent
*/
/*!
Constructs a QDragEnterEvent that represents a drag entering a
widget at the given \a point with mouse and keyboard states specified by
\a buttons and \a modifiers.
The drag data is passed as MIME-encoded information in \a data, and the
specified \a actions describe the possible types of drag and drop
operation that can be performed.
\warning Do not create a QDragEnterEvent yourself since these
objects rely on Qt's internal state.
*/
QDragEnterEvent::QDragEnterEvent(const QPoint& point, Qt::DropActions actions, const QMimeData *data,
Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers)
: QDragMoveEvent(point, actions, data, buttons, modifiers, DragEnter)
{}
/*! \internal
*/
QDragEnterEvent::~QDragEnterEvent()
{
}
/*!
\class QDragMoveEvent
\brief The QDragMoveEvent class provides an event which is sent while a drag and drop action is in progress.
\ingroup events
\ingroup draganddrop
\inmodule QtGui
A widget will receive drag move events repeatedly while the drag
is within its boundaries, if it accepts
\l{QWidget::setAcceptDrops()}{drop events} and \l
{QWidget::dragEnterEvent()}{enter events}. The widget should
examine the event to see what kind of \l{mimeData()}{data} it
provides, and call the accept() function to accept the drop if appropriate.
The rectangle supplied by the answerRect() function can be used to restrict
drops to certain parts of the widget. For example, we can check whether the
rectangle intersects with the geometry of a certain child widget and only
call \l{QDropEvent::acceptProposedAction()}{acceptProposedAction()} if that
is the case.
Note that this class inherits most of its functionality from
QDropEvent.
\sa QDragEnterEvent, QDragLeaveEvent, QDropEvent
*/
/*!
\class QDragLeaveEvent
\brief The QDragLeaveEvent class provides an event that is sent to a widget when a drag and drop action leaves it.
\ingroup events
\ingroup draganddrop
\inmodule QtGui
This event is always preceded by a QDragEnterEvent and a series
of \l{QDragMoveEvent}s. It is not sent if a QDropEvent is sent
instead.
\sa QDragEnterEvent, QDragMoveEvent, QDropEvent
*/
/*!
Constructs a QDragLeaveEvent.
\warning Do not create a QDragLeaveEvent yourself since these
objects rely on Qt's internal state.
*/
QDragLeaveEvent::QDragLeaveEvent()
: QEvent(DragLeave)
{}
/*! \internal
*/
QDragLeaveEvent::~QDragLeaveEvent()
{
}
#endif // QT_CONFIG(draganddrop)
/*!
\class QHelpEvent
\brief The QHelpEvent class provides an event that is used to request helpful information
about a particular point in a widget.
\ingroup events
\ingroup helpsystem
\inmodule QtGui
This event can be intercepted in applications to provide tooltips
or "What's This?" help for custom widgets. The type() can be
either QEvent::ToolTip or QEvent::WhatsThis.
\sa QToolTip, QWhatsThis, QStatusTipEvent, QWhatsThisClickedEvent
*/
/*!
Constructs a help event with the given \a type corresponding to the
widget-relative position specified by \a pos and the global position
specified by \a globalPos.
\a type must be either QEvent::ToolTip or QEvent::WhatsThis.
\sa pos(), globalPos()
*/
QHelpEvent::QHelpEvent(Type type, const QPoint &pos, const QPoint &globalPos)
: QEvent(type), p(pos), gp(globalPos)
{}
/*!
\fn int QHelpEvent::x() const
Same as pos().x().
\sa y(), pos(), globalPos()
*/
/*!
\fn int QHelpEvent::y() const
Same as pos().y().
\sa x(), pos(), globalPos()
*/
/*!
\fn int QHelpEvent::globalX() const
Same as globalPos().x().
\sa x(), globalY(), globalPos()
*/
/*!
\fn int QHelpEvent::globalY() const
Same as globalPos().y().
\sa y(), globalX(), globalPos()
*/
/*!
\fn const QPoint &QHelpEvent::pos() const
Returns the mouse cursor position when the event was generated,
relative to the widget to which the event is dispatched.
\sa globalPos(), x(), y()
*/
/*!
\fn const QPoint &QHelpEvent::globalPos() const
Returns the mouse cursor position when the event was generated
in global coordinates.
\sa pos(), globalX(), globalY()
*/
/*! \internal
*/
QHelpEvent::~QHelpEvent()
{
}
#ifndef QT_NO_STATUSTIP
/*!
\class QStatusTipEvent
\brief The QStatusTipEvent class provides an event that is used to show messages in a status bar.
\ingroup events
\ingroup helpsystem
\inmodule QtGui
Status tips can be set on a widget using the
QWidget::setStatusTip() function. They are shown in the status
bar when the mouse cursor enters the widget. For example:
\table 100%
\row
\li
\snippet qstatustipevent/main.cpp 1
\dots
\snippet qstatustipevent/main.cpp 3
\li
\image qstatustipevent-widget.png Widget with status tip.
\endtable
Status tips can also be set on actions using the
QAction::setStatusTip() function:
\table 100%
\row
\li
\snippet qstatustipevent/main.cpp 0
\snippet qstatustipevent/main.cpp 2
\dots
\snippet qstatustipevent/main.cpp 3
\li
\image qstatustipevent-action.png Action with status tip.
\endtable
Finally, status tips are supported for the item view classes
through the Qt::StatusTipRole enum value.
\sa QStatusBar, QHelpEvent, QWhatsThisClickedEvent
*/
/*!
Constructs a status tip event with the text specified by \a tip.
\sa tip()
*/
QStatusTipEvent::QStatusTipEvent(const QString &tip)
: QEvent(StatusTip), s(tip)
{}
/*! \internal
*/
QStatusTipEvent::~QStatusTipEvent()
{
}
/*!
\fn QString QStatusTipEvent::tip() const
Returns the message to show in the status bar.
\sa QStatusBar::showMessage()
*/
#endif // QT_NO_STATUSTIP
#if QT_CONFIG(whatsthis)
/*!
\class QWhatsThisClickedEvent
\brief The QWhatsThisClickedEvent class provides an event that
can be used to handle hyperlinks in a "What's This?" text.
\ingroup events
\ingroup helpsystem
\inmodule QtGui
\sa QWhatsThis, QHelpEvent, QStatusTipEvent
*/
/*!
Constructs an event containing a URL specified by \a href when a link
is clicked in a "What's This?" message.
\sa href()
*/
QWhatsThisClickedEvent::QWhatsThisClickedEvent(const QString &href)
: QEvent(WhatsThisClicked), s(href)
{}
/*! \internal
*/
QWhatsThisClickedEvent::~QWhatsThisClickedEvent()
{
}
/*!
\fn QString QWhatsThisClickedEvent::href() const
Returns the URL that was clicked by the user in the "What's
This?" text.
*/
#endif // QT_CONFIG(whatsthis)
#ifndef QT_NO_ACTION
/*!
\class QActionEvent
\brief The QActionEvent class provides an event that is generated
when a QAction is added, removed, or changed.
\ingroup events
\inmodule QtGui
Actions can be added to widgets using QWidget::addAction(). This
generates an \l ActionAdded event, which you can handle to provide
custom behavior. For example, QToolBar reimplements
QWidget::actionEvent() to create \l{QToolButton}s for the
actions.
\sa QAction, QWidget::addAction(), QWidget::removeAction(), QWidget::actions()
*/
/*!
Constructs an action event. The \a type can be \l ActionChanged,
\l ActionAdded, or \l ActionRemoved.
\a action is the action that is changed, added, or removed. If \a
type is ActionAdded, the action is to be inserted before the
action \a before. If \a before is \nullptr, the action is appended.
*/
QActionEvent::QActionEvent(int type, QAction *action, QAction *before)
: QEvent(static_cast<QEvent::Type>(type)), act(action), bef(before)
{}
/*! \internal
*/
QActionEvent::~QActionEvent()
{
}
/*!
\fn QAction *QActionEvent::action() const
Returns the action that is changed, added, or removed.
\sa before()
*/
/*!
\fn QAction *QActionEvent::before() const
If type() is \l ActionAdded, returns the action that should
appear before action(). If this function returns \nullptr, the action
should be appended to already existing actions on the same
widget.
\sa action(), QWidget::actions()
*/
#endif // QT_NO_ACTION
/*!
\class QHideEvent
\brief The QHideEvent class provides an event which is sent after a widget is hidden.
\ingroup events
\inmodule QtGui
This event is sent just before QWidget::hide() returns, and also
when a top-level window has been hidden (iconified) by the user.
If spontaneous() is true, the event originated outside the
application. In this case, the user hid the window using the
window manager controls, either by iconifying the window or by
switching to another virtual desktop where the window is not
visible. The window will become hidden but not withdrawn. If the
window was iconified, QWidget::isMinimized() returns \c true.
\sa QShowEvent
*/
/*!
Constructs a QHideEvent.
*/
QHideEvent::QHideEvent()
: QEvent(Hide)
{}
/*! \internal
*/
QHideEvent::~QHideEvent()
{
}
/*!
\class QShowEvent
\brief The QShowEvent class provides an event that is sent when a widget is shown.
\ingroup events
\inmodule QtGui
There are two kinds of show events: show events caused by the
window system (spontaneous), and internal show events. Spontaneous (QEvent::spontaneous())
show events are sent just after the window system shows the
window; they are also sent when a top-level window is redisplayed
after being iconified. Internal show events are delivered just
before the widget becomes visible.
\sa QHideEvent
*/
/*!
Constructs a QShowEvent.
*/
QShowEvent::QShowEvent()
: QEvent(Show)
{}
/*! \internal
*/
QShowEvent::~QShowEvent()
{
}
/*!
\class QFileOpenEvent
\brief The QFileOpenEvent class provides an event that will be
sent when there is a request to open a file or a URL.
\ingroup events
\inmodule QtGui
File open events will be sent to the QApplication::instance()
when the operating system requests that a file or URL should be opened.
This is a high-level event that can be caused by different user actions
depending on the user's desktop environment; for example, double
clicking on an file icon in the Finder on \macos.
This event is only used to notify the application of a request.
It may be safely ignored.
\note This class is currently supported for \macos only.
\section1 \macos Example
In order to trigger the event on \macos, the application must be configured
to let the OS know what kind of file(s) it should react on.
For example, the following \c Info.plist file declares that the application
can act as a viewer for files with a PNG extension:
\snippet qfileopenevent/Info.plist Custom Info.plist
The following implementation of a QApplication subclass prints the path to
the file that was, for example, dropped on the Dock icon of the application.
\snippet qfileopenevent/main.cpp QApplication subclass
*/
/*!
\internal
Constructs a file open event for the given \a file.
*/
QFileOpenEvent::QFileOpenEvent(const QString &file)
: QEvent(FileOpen), f(file), m_url(QUrl::fromLocalFile(file))
{
}
/*!
\internal
Constructs a file open event for the given \a url.
*/
QFileOpenEvent::QFileOpenEvent(const QUrl &url)
: QEvent(FileOpen), f(url.toLocalFile()), m_url(url)
{
}
/*! \internal
*/
QFileOpenEvent::~QFileOpenEvent()
{
}
/*!
\fn QString QFileOpenEvent::file() const
Returns the file that is being opened.
*/
/*!
\fn QUrl QFileOpenEvent::url() const
Returns the url that is being opened.
\since 4.6
*/
/*!
\fn bool QFileOpenEvent::openFile(QFile &file, QIODevice::OpenMode flags) const
Opens a QFile on the \a file referenced by this event in the mode specified
by \a flags. Returns \c true if successful; otherwise returns \c false.
This is necessary as some files cannot be opened by name, but require specific
information stored in this event.
\since 4.8
*/
bool QFileOpenEvent::openFile(QFile &file, QIODevice::OpenMode flags) const
{
file.setFileName(f);
return file.open(flags);
}
#ifndef QT_NO_TOOLBAR
/*!
\internal
\class QToolBarChangeEvent
\brief The QToolBarChangeEvent class provides an event that is
sent whenever a the toolbar button is clicked on \macos.
\ingroup events
\inmodule QtGui
The QToolBarChangeEvent is sent when the toolbar button is clicked. On
\macos, this is the long oblong button on the right side of the window
title bar. The default implementation is to toggle the appearance (hidden or
shown) of the associated toolbars for the window.
*/
/*!
\internal
Construct a QToolBarChangeEvent given the current button state in \a state.
*/
QToolBarChangeEvent::QToolBarChangeEvent(bool t)
: QEvent(ToolBarChange), tog(t)
{}
/*! \internal
*/
QToolBarChangeEvent::~QToolBarChangeEvent()
{
}
/*!
\fn bool QToolBarChangeEvent::toggle() const
\internal
*/
/*
\fn Qt::ButtonState QToolBarChangeEvent::state() const
Returns the keyboard modifier flags at the time of the event.
The returned value is a selection of the following values,
combined using the OR operator:
Qt::ShiftButton, Qt::ControlButton, Qt::MetaButton, and Qt::AltButton.
*/
#endif // QT_NO_TOOLBAR
#ifndef QT_NO_SHORTCUT
/*!
Constructs a shortcut event for the given \a key press,
associated with the QShortcut ID \a id.
\a ambiguous specifies whether there is more than one QShortcut
for the same key sequence.
*/
QShortcutEvent::QShortcutEvent(const QKeySequence &key, int id, bool ambiguous)
: QEvent(Shortcut), sequence(key), ambig(ambiguous), sid(id)
{
}
/*!
Destroys the event object.
*/
QShortcutEvent::~QShortcutEvent()
{
}
#endif // QT_NO_SHORTCUT
#ifndef QT_NO_DEBUG_STREAM
static inline void formatTouchEvent(QDebug d, const QTouchEvent &t)
{
d << "QTouchEvent(";
QtDebugUtils::formatQEnum(d, t.type());
d << " device: " << t.device()->name();
d << " states: ";
QtDebugUtils::formatQFlags(d, t.touchPointStates());
d << ", " << t.touchPoints().size() << " points: " << t.touchPoints() << ')';
}
static void formatUnicodeString(QDebug d, const QString &s)
{
d << '"' << Qt::hex;
for (int i = 0; i < s.size(); ++i) {
if (i)
d << ',';
d << "U+" << s.at(i).unicode();
}
d << Qt::dec << '"';
}
static inline void formatInputMethodEvent(QDebug d, const QInputMethodEvent *e)
{
d << "QInputMethodEvent(";
if (!e->preeditString().isEmpty()) {
d << "preedit=";
formatUnicodeString(d, e->preeditString());
}
if (!e->commitString().isEmpty()) {
d << ", commit=";
formatUnicodeString(d, e->commitString());
}
if (e->replacementLength()) {
d << ", replacementStart=" << e->replacementStart() << ", replacementLength="
<< e->replacementLength();
}
if (const int attributeCount = e->attributes().size()) {
d << ", attributes= {";
for (int a = 0; a < attributeCount; ++a) {
const QInputMethodEvent::Attribute &at = e->attributes().at(a);
if (a)
d << ',';
d << "[type= " << at.type << ", start=" << at.start << ", length=" << at.length
<< ", value=" << at.value << ']';
}
d << '}';
}
d << ')';
}
static inline void formatInputMethodQueryEvent(QDebug d, const QInputMethodQueryEvent *e)
{
QDebugStateSaver saver(d);
d.noquote();
const Qt::InputMethodQueries queries = e->queries();
d << "QInputMethodQueryEvent(queries=" << Qt::showbase << Qt::hex << int(queries)
<< Qt::noshowbase << Qt::dec << ", {";
for (unsigned mask = 1; mask <= Qt::ImInputItemClipRectangle; mask<<=1) {
if (queries & mask) {
const Qt::InputMethodQuery query = static_cast<Qt::InputMethodQuery>(mask);
const QVariant value = e->value(query);
if (value.isValid()) {
d << '[';
QtDebugUtils::formatQEnum(d, query);
d << '=';
if (query == Qt::ImHints)
QtDebugUtils::formatQFlags(d, Qt::InputMethodHints(value.toInt()));
else
d << value.toString();
d << "],";
}
}
}
d << "})";
}
static const char *eventClassName(QEvent::Type t)
{
switch (t) {
case QEvent::ActionAdded:
case QEvent::ActionRemoved:
case QEvent::ActionChanged:
return "QActionEvent";
case QEvent::MouseButtonPress:
case QEvent::MouseButtonRelease:
case QEvent::MouseButtonDblClick:
case QEvent::MouseMove:
case QEvent::NonClientAreaMouseMove:
case QEvent::NonClientAreaMouseButtonPress:
case QEvent::NonClientAreaMouseButtonRelease:
case QEvent::NonClientAreaMouseButtonDblClick:
return "QMouseEvent";
case QEvent::DragEnter:
return "QDragEnterEvent";
case QEvent::DragMove:
return "QDragMoveEvent";
case QEvent::Drop:
return "QDropEvent";
case QEvent::KeyPress:
case QEvent::KeyRelease:
case QEvent::ShortcutOverride:
return "QKeyEvent";
case QEvent::FocusIn:
case QEvent::FocusOut:
case QEvent::FocusAboutToChange:
return "QFocusEvent";
case QEvent::ChildAdded:
case QEvent::ChildPolished:
case QEvent::ChildRemoved:
return "QChildEvent";
case QEvent::Paint:
return "QPaintEvent";
case QEvent::Move:
return "QMoveEvent";
case QEvent::Resize:
return "QResizeEvent";
case QEvent::Show:
return "QShowEvent";
case QEvent::Hide:
return "QHideEvent";
case QEvent::Enter:
return "QEnterEvent";
case QEvent::Close:
return "QCloseEvent";
case QEvent::FileOpen:
return "QFileOpenEvent";
#ifndef QT_NO_GESTURES
case QEvent::NativeGesture:
return "QNativeGestureEvent";
case QEvent::Gesture:
case QEvent::GestureOverride:
return "QGestureEvent";
#endif
case QEvent::HoverEnter:
case QEvent::HoverLeave:
case QEvent::HoverMove:
return "QHoverEvent";
case QEvent::TabletEnterProximity:
case QEvent::TabletLeaveProximity:
case QEvent::TabletPress:
case QEvent::TabletMove:
case QEvent::TabletRelease:
return "QTabletEvent";
case QEvent::StatusTip:
return "QStatusTipEvent";
case QEvent::ToolTip:
return "QHelpEvent";
case QEvent::WindowStateChange:
return "QWindowStateChangeEvent";
case QEvent::Wheel:
return "QWheelEvent";
case QEvent::TouchBegin:
case QEvent::TouchUpdate:
case QEvent::TouchEnd:
return "QTouchEvent";
case QEvent::Shortcut:
return "QShortcutEvent";
case QEvent::InputMethod:
return "QInputMethodEvent";
case QEvent::InputMethodQuery:
return "QInputMethodQueryEvent";
case QEvent::OrientationChange:
return "QScreenOrientationChangeEvent";
case QEvent::ScrollPrepare:
return "QScrollPrepareEvent";
case QEvent::Scroll:
return "QScrollEvent";
case QEvent::GraphicsSceneMouseMove:
case QEvent::GraphicsSceneMousePress:
case QEvent::GraphicsSceneMouseRelease:
case QEvent::GraphicsSceneMouseDoubleClick:
return "QGraphicsSceneMouseEvent";
case QEvent::GraphicsSceneContextMenu:
case QEvent::GraphicsSceneHoverEnter:
case QEvent::GraphicsSceneHoverMove:
case QEvent::GraphicsSceneHoverLeave:
case QEvent::GraphicsSceneHelp:
case QEvent::GraphicsSceneDragEnter:
case QEvent::GraphicsSceneDragMove:
case QEvent::GraphicsSceneDragLeave:
case QEvent::GraphicsSceneDrop:
case QEvent::GraphicsSceneWheel:
return "QGraphicsSceneEvent";
case QEvent::Timer:
return "QTimerEvent";
case QEvent::PlatformSurface:
return "QPlatformSurfaceEvent";
default:
break;
}
return "QEvent";
}
# if QT_CONFIG(draganddrop)
static void formatDropEvent(QDebug d, const QDropEvent *e)
{
const QEvent::Type type = e->type();
d << eventClassName(type) << "(dropAction=";
QtDebugUtils::formatQEnum(d, e->dropAction());
d << ", proposedAction=";
QtDebugUtils::formatQEnum(d, e->proposedAction());
d << ", possibleActions=";
QtDebugUtils::formatQFlags(d, e->possibleActions());
d << ", posF=";
QtDebugUtils::formatQPoint(d, e->posF());
if (type == QEvent::DragMove || type == QEvent::DragEnter)
d << ", answerRect=" << static_cast<const QDragMoveEvent *>(e)->answerRect();
d << ", formats=" << e->mimeData()->formats();
QtDebugUtils::formatNonNullQFlags(d, ", keyboardModifiers=", e->keyboardModifiers());
d << ", ";
QtDebugUtils::formatQFlags(d, e->mouseButtons());
}
# endif // QT_CONFIG(draganddrop)
# if QT_CONFIG(tabletevent)
static void formatTabletEvent(QDebug d, const QTabletEvent *e)
{
const QEvent::Type type = e->type();
d << eventClassName(type) << '(';
QtDebugUtils::formatQEnum(d, type);
d << ", deviceType=";
QtDebugUtils::formatQEnum(d, e->deviceType());
d << ", pointerType=";
QtDebugUtils::formatQEnum(d, e->pointerType());
d << ", uniqueId=" << e->uniqueId()
<< ", pos=" << e->posF()
<< ", z=" << e->z()
<< ", xTilt=" << e->xTilt()
<< ", yTilt=" << e->yTilt()
<< ", ";
QtDebugUtils::formatQFlags(d, e->buttons());
if (type == QEvent::TabletPress || type == QEvent::TabletMove)
d << ", pressure=" << e->pressure();
if (e->deviceType() == QTabletEvent::RotationStylus || e->deviceType() == QTabletEvent::FourDMouse)
d << ", rotation=" << e->rotation();
if (e->deviceType() == QTabletEvent::Airbrush)
d << ", tangentialPressure=" << e->tangentialPressure();
}
# endif // QT_CONFIG(tabletevent)
QDebug operator<<(QDebug dbg, const QTouchEvent::TouchPoint &tp)
{
QDebugStateSaver saver(dbg);
dbg.nospace();
dbg << "TouchPoint(" << Qt::hex << tp.id() << Qt::dec << " (";
QtDebugUtils::formatQPoint(dbg, tp.pos());
dbg << ") ";
QtDebugUtils::formatQEnum(dbg, tp.state());
dbg << " pressure " << tp.pressure() << " ellipse ("
<< tp.ellipseDiameters().width() << " x " << tp.ellipseDiameters().height()
<< " angle " << tp.rotation() << ") vel (";
QtDebugUtils::formatQPoint(dbg, tp.velocity().toPointF());
dbg << ") start (";
QtDebugUtils::formatQPoint(dbg, tp.startPos());
dbg << ") last (";
QtDebugUtils::formatQPoint(dbg, tp.lastPos());
dbg << ") delta (";
QtDebugUtils::formatQPoint(dbg, tp.pos() - tp.lastPos());
dbg << ')';
return dbg;
}
QDebug operator<<(QDebug dbg, const QEvent *e)
{
QDebugStateSaver saver(dbg);
dbg.nospace();
if (!e) {
dbg << "QEvent(this = 0x0)";
return dbg;
}
// More useful event output could be added here
const QEvent::Type type = e->type();
switch (type) {
case QEvent::Expose:
dbg << "QExposeEvent(" << static_cast<const QExposeEvent *>(e)->region() << ')';
break;
case QEvent::Paint:
dbg << "QPaintEvent(" << static_cast<const QPaintEvent *>(e)->region() << ')';
break;
case QEvent::MouseButtonPress:
case QEvent::MouseMove:
case QEvent::MouseButtonRelease:
case QEvent::MouseButtonDblClick:
case QEvent::NonClientAreaMouseButtonPress:
case QEvent::NonClientAreaMouseMove:
case QEvent::NonClientAreaMouseButtonRelease:
case QEvent::NonClientAreaMouseButtonDblClick:
{
const QMouseEvent *me = static_cast<const QMouseEvent*>(e);
const Qt::MouseButton button = me->button();
const Qt::MouseButtons buttons = me->buttons();
dbg << "QMouseEvent(";
QtDebugUtils::formatQEnum(dbg, type);
if (type != QEvent::MouseMove && type != QEvent::NonClientAreaMouseMove) {
dbg << ", ";
QtDebugUtils::formatQEnum(dbg, button);
}
if (buttons && button != buttons) {
dbg << ", buttons=";
QtDebugUtils::formatQFlags(dbg, buttons);
}
QtDebugUtils::formatNonNullQFlags(dbg, ", ", me->modifiers());
dbg << ", localPos=";
QtDebugUtils::formatQPoint(dbg, me->localPos());
dbg << ", screenPos=";
QtDebugUtils::formatQPoint(dbg, me->screenPos());
QtDebugUtils::formatNonNullQEnum(dbg, ", ", me->source());
QtDebugUtils::formatNonNullQFlags(dbg, ", flags=", me->flags());
dbg << ')';
}
break;
# if QT_CONFIG(wheelevent)
case QEvent::Wheel: {
const QWheelEvent *we = static_cast<const QWheelEvent *>(e);
dbg << "QWheelEvent(" << we->phase();
QT_WARNING_PUSH
QT_WARNING_DISABLE_DEPRECATED // delta() and orientation()
if (!we->pixelDelta().isNull() || !we->angleDelta().isNull())
dbg << ", pixelDelta=" << we->pixelDelta() << ", angleDelta=" << we->angleDelta();
#if QT_DEPRECATED_SINCE(5, 14)
else if (int qt4Delta = we->delta())
dbg << ", delta=" << qt4Delta << ", orientation=" << we->orientation();
#endif
QT_WARNING_POP
dbg << ')';
}
break;
# endif // QT_CONFIG(wheelevent)
case QEvent::KeyPress:
case QEvent::KeyRelease:
case QEvent::ShortcutOverride:
{
const QKeyEvent *ke = static_cast<const QKeyEvent *>(e);
dbg << "QKeyEvent(";
QtDebugUtils::formatQEnum(dbg, type);
dbg << ", ";
QtDebugUtils::formatQEnum(dbg, static_cast<Qt::Key>(ke->key()));
QtDebugUtils::formatNonNullQFlags(dbg, ", ", ke->modifiers());
if (!ke->text().isEmpty())
dbg << ", text=" << ke->text();
if (ke->isAutoRepeat())
dbg << ", autorepeat, count=" << ke->count();
dbg << ')';
}
break;
#ifndef QT_NO_SHORTCUT
case QEvent::Shortcut: {
const QShortcutEvent *se = static_cast<const QShortcutEvent *>(e);
dbg << "QShortcutEvent(" << se->key().toString() << ", id=" << se->shortcutId();
if (se->isAmbiguous())
dbg << ", ambiguous";
dbg << ')';
}
break;
#endif
case QEvent::FocusAboutToChange:
case QEvent::FocusIn:
case QEvent::FocusOut:
dbg << "QFocusEvent(";
QtDebugUtils::formatQEnum(dbg, type);
dbg << ", ";
QtDebugUtils::formatQEnum(dbg, static_cast<const QFocusEvent *>(e)->reason());
dbg << ')';
break;
case QEvent::Move: {
const QMoveEvent *me = static_cast<const QMoveEvent *>(e);
dbg << "QMoveEvent(";
QtDebugUtils::formatQPoint(dbg, me->pos());
if (!me->spontaneous())
dbg << ", non-spontaneous";
dbg << ')';
}
break;
case QEvent::Resize: {
const QResizeEvent *re = static_cast<const QResizeEvent *>(e);
dbg << "QResizeEvent(";
QtDebugUtils::formatQSize(dbg, re->size());
if (!re->spontaneous())
dbg << ", non-spontaneous";
dbg << ')';
}
break;
# if QT_CONFIG(draganddrop)
case QEvent::DragEnter:
case QEvent::DragMove:
case QEvent::Drop:
formatDropEvent(dbg, static_cast<const QDropEvent *>(e));
break;
# endif // QT_CONFIG(draganddrop)
case QEvent::InputMethod:
formatInputMethodEvent(dbg, static_cast<const QInputMethodEvent *>(e));
break;
case QEvent::InputMethodQuery:
formatInputMethodQueryEvent(dbg, static_cast<const QInputMethodQueryEvent *>(e));
break;
case QEvent::TouchBegin:
case QEvent::TouchUpdate:
case QEvent::TouchEnd:
formatTouchEvent(dbg, *static_cast<const QTouchEvent*>(e));
break;
case QEvent::ChildAdded:
case QEvent::ChildPolished:
case QEvent::ChildRemoved:
dbg << "QChildEvent(";
QtDebugUtils::formatQEnum(dbg, type);
dbg << ", " << (static_cast<const QChildEvent*>(e))->child() << ')';
break;
# ifndef QT_NO_GESTURES
case QEvent::NativeGesture: {
const QNativeGestureEvent *ne = static_cast<const QNativeGestureEvent *>(e);
dbg << "QNativeGestureEvent(";
QtDebugUtils::formatQEnum(dbg, ne->gestureType());
dbg << ", localPos=";
QtDebugUtils::formatQPoint(dbg, ne->localPos());
dbg << ", value=" << ne->value() << ')';
}
break;
# endif // !QT_NO_GESTURES
case QEvent::ApplicationStateChange:
dbg << "QApplicationStateChangeEvent(";
QtDebugUtils::formatQEnum(dbg, static_cast<const QApplicationStateChangeEvent *>(e)->applicationState());
dbg << ')';
break;
# ifndef QT_NO_CONTEXTMENU
case QEvent::ContextMenu:
dbg << "QContextMenuEvent(" << static_cast<const QContextMenuEvent *>(e)->pos() << ')';
break;
# endif // !QT_NO_CONTEXTMENU
# if QT_CONFIG(tabletevent)
case QEvent::TabletEnterProximity:
case QEvent::TabletLeaveProximity:
case QEvent::TabletPress:
case QEvent::TabletMove:
case QEvent::TabletRelease:
formatTabletEvent(dbg, static_cast<const QTabletEvent *>(e));
break;
# endif // QT_CONFIG(tabletevent)
case QEvent::Enter:
dbg << "QEnterEvent(" << static_cast<const QEnterEvent *>(e)->pos() << ')';
break;
case QEvent::Timer:
dbg << "QTimerEvent(id=" << static_cast<const QTimerEvent *>(e)->timerId() << ')';
break;
case QEvent::PlatformSurface:
dbg << "QPlatformSurfaceEvent(surfaceEventType=";
switch (static_cast<const QPlatformSurfaceEvent *>(e)->surfaceEventType()) {
case QPlatformSurfaceEvent::SurfaceCreated:
dbg << "SurfaceCreated";
break;
case QPlatformSurfaceEvent::SurfaceAboutToBeDestroyed:
dbg << "SurfaceAboutToBeDestroyed";
break;
}
dbg << ')';
break;
case QEvent::ScrollPrepare: {
const QScrollPrepareEvent *se = static_cast<const QScrollPrepareEvent *>(e);
dbg << "QScrollPrepareEvent(viewportSize=" << se->viewportSize()
<< ", contentPosRange=" << se->contentPosRange()
<< ", contentPos=" << se->contentPos() << ')';
}
break;
case QEvent::Scroll: {
const QScrollEvent *se = static_cast<const QScrollEvent *>(e);
dbg << "QScrollEvent(contentPos=" << se->contentPos()
<< ", overshootDistance=" << se->overshootDistance()
<< ", scrollState=" << se->scrollState() << ')';
}
break;
default:
dbg << eventClassName(type) << '(';
QtDebugUtils::formatQEnum(dbg, type);
dbg << ", " << (const void *)e << ')';
break;
}
return dbg;
}
#endif // !QT_NO_DEBUG_STREAM
/*!
\class QShortcutEvent
\brief The QShortcutEvent class provides an event which is generated when
the user presses a key combination.
\ingroup events
\inmodule QtGui
Normally you do not need to use this class directly; QShortcut
provides a higher-level interface to handle shortcut keys.
\sa QShortcut
*/
/*!
\fn const QKeySequence &QShortcutEvent::key() const
Returns the key sequence that triggered the event.
*/
/*!
\fn int QShortcutEvent::shortcutId() const
Returns the ID of the QShortcut object for which this event was
generated.
\sa QShortcut::id()
*/
/*!
\fn bool QShortcutEvent::isAmbiguous() const
Returns \c true if the key sequence that triggered the event is
ambiguous.
\sa QShortcut::activatedAmbiguously()
*/
/*!
\class QWindowStateChangeEvent
\ingroup events
\inmodule QtGui
\brief The QWindowStateChangeEvent class provides the window state before a
window state change.
*/
/*! \fn Qt::WindowStates QWindowStateChangeEvent::oldState() const
Returns the state of the window before the change.
*/
/*! \internal
*/
QWindowStateChangeEvent::QWindowStateChangeEvent(Qt::WindowStates s, bool isOverride)
: QEvent(WindowStateChange), ostate(s), m_override(isOverride)
{
}
/*! \internal
*/
bool QWindowStateChangeEvent::isOverride() const
{
return m_override;
}
/*! \internal
*/
QWindowStateChangeEvent::~QWindowStateChangeEvent()
{
}
/*!
\class QTouchEvent
\brief The QTouchEvent class contains parameters that describe a touch event.
\since 4.6
\ingroup events
\ingroup touch
\inmodule QtGui
\section1 Enabling Touch Events
Touch events occur when pressing, releasing, or moving one or more touch points on a touch
device (such as a touch-screen or track-pad). To receive touch events, widgets have to have the
Qt::WA_AcceptTouchEvents attribute set and graphics items need to have the
\l{QGraphicsItem::setAcceptTouchEvents()}{acceptTouchEvents} attribute set to true.
When using QAbstractScrollArea based widgets, you should enable the Qt::WA_AcceptTouchEvents
attribute on the scroll area's \l{QAbstractScrollArea::viewport()}{viewport}.
Similarly to QMouseEvent, Qt automatically grabs each touch point on the first press inside a
widget, and the widget will receive all updates for the touch point until it is released.
Note that it is possible for a widget to receive events for numerous touch points, and that
multiple widgets may be receiving touch events at the same time.
\section1 Event Handling
All touch events are of type QEvent::TouchBegin, QEvent::TouchUpdate, QEvent::TouchEnd or
QEvent::TouchCancel. Reimplement QWidget::event() or QAbstractScrollArea::viewportEvent() for
widgets and QGraphicsItem::sceneEvent() for items in a graphics view to receive touch events.
Unlike widgets, QWindows receive touch events always, there is no need to opt in. When working
directly with a QWindow, it is enough to reimplement QWindow::touchEvent().
The QEvent::TouchUpdate and QEvent::TouchEnd events are sent to the widget or item that
accepted the QEvent::TouchBegin event. If the QEvent::TouchBegin event is not accepted and not
filtered by an event filter, then no further touch events are sent until the next
QEvent::TouchBegin.
Some systems may send an event of type QEvent::TouchCancel. Upon receiving this event
applications are requested to ignore the entire active touch sequence. For example in a
composited system the compositor may decide to treat certain gestures as system-wide
gestures. Whenever such a decision is made (the gesture is recognized), the clients will be
notified with a QEvent::TouchCancel event so they can update their state accordingly.
The touchPoints() function returns a list of all touch points contained in the event. Note that
this list may be empty, for example in case of a QEvent::TouchCancel event. Information about
each touch point can be retrieved using the QTouchEvent::TouchPoint class. The
Qt::TouchPointState enum describes the different states that a touch point may have.
\note The list of touchPoints() will never be partial: A touch event will always contain a touch
point for each existing physical touch contacts targetting the window or widget to which the
event is sent. For instance, assuming that all touches target the same window or widget, an
event with a condition of touchPoints().count()==2 is guaranteed to imply that the number of
fingers touching the touchscreen or touchpad is exactly two.
\section1 Event Delivery and Propagation
By default, QGuiApplication translates the first touch point in a QTouchEvent into
a QMouseEvent. This makes it possible to enable touch events on existing widgets that do not
normally handle QTouchEvent. See below for information on some special considerations needed
when doing this.
QEvent::TouchBegin is the first touch event sent to a widget. The QEvent::TouchBegin event
contains a special accept flag that indicates whether the receiver wants the event. By default,
the event is accepted. You should call ignore() if the touch event is not handled by your
widget. The QEvent::TouchBegin event is propagated up the parent widget chain until a widget
accepts it with accept(), or an event filter consumes it. For QGraphicsItems, the
QEvent::TouchBegin event is propagated to items under the mouse (similar to mouse event
propagation for QGraphicsItems).
\section1 Touch Point Grouping
As mentioned above, it is possible that several widgets can be receiving QTouchEvents at the
same time. However, Qt makes sure to never send duplicate QEvent::TouchBegin events to the same
widget, which could theoretically happen during propagation if, for example, the user touched 2
separate widgets in a QGroupBox and both widgets ignored the QEvent::TouchBegin event.
To avoid this, Qt will group new touch points together using the following rules:
\list
\li When the first touch point is detected, the destination widget is determined firstly by the
location on screen and secondly by the propagation rules.
\li When additional touch points are detected, Qt first looks to see if there are any active
touch points on any ancestor or descendent of the widget under the new touch point. If there
are, the new touch point is grouped with the first, and the new touch point will be sent in a
single QTouchEvent to the widget that handled the first touch point. (The widget under the new
touch point will not receive an event).
\endlist
This makes it possible for sibling widgets to handle touch events independently while making
sure that the sequence of QTouchEvents is always correct.
\section1 Mouse Events and Touch Event Synthesizing
QTouchEvent delivery is independent from that of QMouseEvent. The application flags
Qt::AA_SynthesizeTouchForUnhandledMouseEvents and Qt::AA_SynthesizeMouseForUnhandledTouchEvents
can be used to enable or disable automatic synthesizing of touch events to mouse events and
mouse events to touch events.
\section1 Caveats
\list
\li As mentioned above, enabling touch events means multiple widgets can be receiving touch
events simultaneously. Combined with the default QWidget::event() handling for QTouchEvents,
this gives you great flexibility in designing touch user interfaces. Be aware of the
implications. For example, it is possible that the user is moving a QSlider with one finger and
pressing a QPushButton with another. The signals emitted by these widgets will be
interleaved.
\li Recursion into the event loop using one of the exec() methods (e.g., QDialog::exec() or
QMenu::exec()) in a QTouchEvent event handler is not supported. Since there are multiple event
recipients, recursion may cause problems, including but not limited to lost events
and unexpected infinite recursion.
\li QTouchEvents are not affected by a \l{QWidget::grabMouse()}{mouse grab} or an
\l{QApplication::activePopupWidget()}{active pop-up widget}. The behavior of QTouchEvents is
undefined when opening a pop-up or grabbing the mouse while there are more than one active touch
points.
\endlist
\sa QTouchEvent::TouchPoint, Qt::TouchPointState, Qt::WA_AcceptTouchEvents,
QGraphicsItem::acceptTouchEvents()
*/
/*!
Constructs a QTouchEvent with the given \a eventType, \a device, and
\a touchPoints. The \a touchPointStates and \a modifiers
are the current touch point states and keyboard modifiers at the time of
the event.
*/
QTouchEvent::QTouchEvent(QEvent::Type eventType,
QTouchDevice *device,
Qt::KeyboardModifiers modifiers,
Qt::TouchPointStates touchPointStates,
const QList<QTouchEvent::TouchPoint> &touchPoints)
: QInputEvent(eventType, modifiers),
_window(nullptr),
_target(nullptr),
_device(device),
_touchPointStates(touchPointStates),
_touchPoints(touchPoints)
{ }
/*!
Destroys the QTouchEvent.
*/
QTouchEvent::~QTouchEvent()
{ }
/*! \fn QWindow *QTouchEvent::window() const
Returns the window on which the event occurred. Useful for doing
global-local mapping on data like rawScreenPositions() which,
for performance reasons, only stores the global positions in the
touch event.
*/
/*! \fn QObject *QTouchEvent::target() const
Returns the target object within the window on which the event occurred.
This is typically a QWidget or a QQuickItem. May be 0 when no specific target is available.
*/
/*! \fn QTouchEvent::TouchPoint::TouchPoint(TouchPoint &&other)
Move-constructs a TouchPoint instance, making it point to the same
object that \a other was pointing to.
*/
/*! \fn Qt::TouchPointStates QTouchEvent::touchPointStates() const
Returns a bitwise OR of all the touch point states for this event.
*/
/*! \fn const QList<QTouchEvent::TouchPoint> &QTouchEvent::touchPoints() const
Returns the list of touch points contained in the touch event.
*/
/*! \fn QTouchDevice* QTouchEvent::device() const
Returns the touch device from which this touch event originates.
*/
/*! \fn void QTouchEvent::setWindow(QWindow *window)
\internal
Sets the window for this event.
*/
/*! \fn void QTouchEvent::setTarget(QObject *target)
\internal
Sets the target within the window (typically a widget) for this event.
*/
/*! \fn void QTouchEvent::setTouchPointStates(Qt::TouchPointStates touchPointStates)
\internal
Sets a bitwise OR of all the touch point states for this event.
*/
/*! \fn void QTouchEvent::setTouchPoints(const QList<QTouchEvent::TouchPoint> &touchPoints)
\internal
Sets the list of touch points for this event.
*/
/*! \fn void QTouchEvent::setDevice(QTouchDevice *adevice)
\internal
Sets the device to \a adevice.
*/
/*! \class QTouchEvent::TouchPoint
\brief The TouchPoint class provides information about a touch point in a QTouchEvent.
\since 4.6
\inmodule QtGui
\image touchpoint-metrics.png
*/
/*! \enum TouchPoint::InfoFlag
The values of this enum describe additional information about a touch point.
\value Pen Indicates that the contact has been made by a designated pointing device (e.g. a pen) instead of a finger.
\value Token Indicates that the contact has been made by a fiducial object (e.g. a knob or other token) instead of a finger.
*/
/*!
\internal
Constructs a QTouchEvent::TouchPoint for use in a QTouchEvent.
*/
QTouchEvent::TouchPoint::TouchPoint(int id)
: d(new QTouchEventTouchPointPrivate(id))
{ }
/*!
\fn QTouchEvent::TouchPoint::TouchPoint(const QTouchEvent::TouchPoint &other)
\internal
Constructs a copy of \a other.
*/
QTouchEvent::TouchPoint::TouchPoint(const QTouchEvent::TouchPoint &other)
: d(other.d)
{
d->ref.ref();
}
/*!
\internal
Destroys the QTouchEvent::TouchPoint.
*/
QTouchEvent::TouchPoint::~TouchPoint()
{
if (d && !d->ref.deref())
delete d;
}
/*!
Returns the id number of this touch point.
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.
*/
int QTouchEvent::TouchPoint::id() const
{
return d->id;
}
/*!
\since 5.8
Returns the unique ID of this touch point or token, if any.
It is normally invalid (see \l {QPointingDeviceUniqueId::isValid()} {isValid()}),
because touchscreens cannot uniquely identify fingers. But when the
\l {TouchPoint::InfoFlag} {Token} flag is set, it is expected to uniquely
identify a specific token (fiducial object).
\sa flags
*/
QPointingDeviceUniqueId QTouchEvent::TouchPoint::uniqueId() const
{
return d->uniqueId;
}
/*!
Returns the current state of this touch point.
*/
Qt::TouchPointState QTouchEvent::TouchPoint::state() const
{
return Qt::TouchPointState(int(d->state));
}
/*!
Returns the position of this touch point, relative to the widget
or QGraphicsItem that received the event.
\sa startPos(), lastPos(), screenPos(), scenePos(), normalizedPos()
*/
QPointF QTouchEvent::TouchPoint::pos() const
{
return d->pos;
}
/*!
Returns the scene position of this touch point.
The scene position is the position in QGraphicsScene coordinates
if the QTouchEvent is handled by a QGraphicsItem::touchEvent()
reimplementation, and identical to the screen position for
widgets.
\sa startScenePos(), lastScenePos(), pos()
*/
QPointF QTouchEvent::TouchPoint::scenePos() const
{
return d->scenePos;
}
/*!
Returns the screen position of this touch point.
\sa startScreenPos(), lastScreenPos(), pos()
*/
QPointF QTouchEvent::TouchPoint::screenPos() const
{
return d->screenPos;
}
/*!
Returns the normalized position of this touch point.
The coordinates are normalized to the size of the touch device,
i.e. (0,0) is the top-left corner and (1,1) is the bottom-right corner.
\sa startNormalizedPos(), lastNormalizedPos(), pos()
*/
QPointF QTouchEvent::TouchPoint::normalizedPos() const
{
return d->normalizedPos;
}
/*!
Returns the starting position of this touch point, relative to the
widget or QGraphicsItem that received the event.
\sa pos(), lastPos()
*/
QPointF QTouchEvent::TouchPoint::startPos() const
{
return d->startPos;
}
/*!
Returns the starting scene position of this touch point.
The scene position is the position in QGraphicsScene coordinates
if the QTouchEvent is handled by a QGraphicsItem::touchEvent()
reimplementation, and identical to the screen position for
widgets.
\sa scenePos(), lastScenePos()
*/
QPointF QTouchEvent::TouchPoint::startScenePos() const
{
return d->startScenePos;
}
/*!
Returns the starting screen position of this touch point.
\sa screenPos(), lastScreenPos()
*/
QPointF QTouchEvent::TouchPoint::startScreenPos() const
{
return d->startScreenPos;
}
/*!
Returns the normalized starting position of this touch point.
The coordinates are normalized to the size of the touch device,
i.e. (0,0) is the top-left corner and (1,1) is the bottom-right corner.
\sa normalizedPos(), lastNormalizedPos()
*/
QPointF QTouchEvent::TouchPoint::startNormalizedPos() const
{
return d->startNormalizedPos;
}
/*!
Returns the position of this touch point from the previous touch
event, relative to the widget or QGraphicsItem that received the event.
\sa pos(), startPos()
*/
QPointF QTouchEvent::TouchPoint::lastPos() const
{
return d->lastPos;
}
/*!
Returns the scene position of this touch point from the previous
touch event.
The scene position is the position in QGraphicsScene coordinates
if the QTouchEvent is handled by a QGraphicsItem::touchEvent()
reimplementation, and identical to the screen position for
widgets.
\sa scenePos(), startScenePos()
*/
QPointF QTouchEvent::TouchPoint::lastScenePos() const
{
return d->lastScenePos;
}
/*!
Returns the screen position of this touch point from the previous
touch event.
\sa screenPos(), startScreenPos()
*/
QPointF QTouchEvent::TouchPoint::lastScreenPos() const
{
return d->lastScreenPos;
}
/*!
Returns the normalized position of this touch point from the
previous touch event.
The coordinates are normalized to the size of the touch device,
i.e. (0,0) is the top-left corner and (1,1) is the bottom-right corner.
\sa normalizedPos(), startNormalizedPos()
*/
QPointF QTouchEvent::TouchPoint::lastNormalizedPos() const
{
return d->lastNormalizedPos;
}
#if QT_DEPRECATED_SINCE(5, 15)
/*!
\deprecated This function is deprecated since 5.9 because it returns the outer bounds
of the touchpoint regardless of rotation, whereas a touchpoint is more correctly
modeled as an ellipse at position pos() with ellipseDiameters()
which are independent of rotation().
*/
QRectF QTouchEvent::TouchPoint::rect() const
{
QRectF ret(QPointF(), d->ellipseDiameters);
ret.moveCenter(d->pos);
return ret;
}
/*!
\deprecated This function is deprecated since 5.9 because it returns the outer bounds
of the touchpoint regardless of rotation, whereas a touchpoint is more correctly
modeled as an ellipse at position scenePos() with ellipseDiameters()
which are independent of rotation().
*/
QRectF QTouchEvent::TouchPoint::sceneRect() const
{
QRectF ret(QPointF(), d->ellipseDiameters);
ret.moveCenter(d->scenePos);
return ret;
}
/*!
\deprecated This function is deprecated since 5.9 because it returns the outer bounds of the
touchpoint regardless of rotation, whereas a touchpoint is more correctly
modeled as an ellipse at position screenPos() with ellipseDiameters()
which are independent of rotation().
*/
QRectF QTouchEvent::TouchPoint::screenRect() const
{
QRectF ret(QPointF(), d->ellipseDiameters);
ret.moveCenter(d->screenPos);
return ret;
}
#endif
/*!
Returns the pressure of this touch point. The return value is in
the range 0.0 to 1.0.
*/
qreal QTouchEvent::TouchPoint::pressure() const
{
return d->pressure;
}
/*!
\since 5.8
Returns the angular orientation of this touch point. The return value is in degrees,
where zero (the default) indicates the finger or token is pointing upwards,
a negative angle means it's rotated to the left, and a positive angle means
it's rotated to the right. Most touchscreens do not detect rotation, so
zero is the most common value.
*/
qreal QTouchEvent::TouchPoint::rotation() const
{
return d->rotation;
}
/*!
\since 5.9
Returns the width and height of the bounding ellipse of this touch point.
The return value is in logical pixels. Most touchscreens do not detect the
shape of the contact point, so a null size is the most common value.
In other cases the diameters may be nonzero and equal (the ellipse is
approximated as a circle).
*/
QSizeF QTouchEvent::TouchPoint::ellipseDiameters() const
{
return d->ellipseDiameters;
}
/*!
Returns a velocity vector for this touch point.
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 touch device's capabilities include QTouchDevice::Velocity.
\sa QTouchDevice::capabilities(), device()
*/
QVector2D QTouchEvent::TouchPoint::velocity() const
{
return d->velocity;
}
/*!
Returns additional information about the touch point.
\sa QTouchEvent::TouchPoint::InfoFlags
*/
QTouchEvent::TouchPoint::InfoFlags QTouchEvent::TouchPoint::flags() const
{
return d->flags;
}
/*!
\since 5.0
Returns the raw, unfiltered positions for the touch point. The positions are in native screen coordinates.
To get local coordinates you can use mapFromGlobal() of the QWindow returned by QTouchEvent::window().
\note Returns an empty vector if the touch device's capabilities do not include QTouchDevice::RawPositions.
\note Native screen coordinates refer to the native orientation of the screen which, in case of
mobile devices, is typically portrait. This means that on systems capable of screen orientation
changes the positions in this list will not reflect the current orientation (unlike pos(),
screenPos(), etc.) and will always be reported in the native orientation.
\sa QTouchDevice::capabilities(), device(), window()
*/
QVector<QPointF> QTouchEvent::TouchPoint::rawScreenPositions() const
{
return d->rawScreenPositions;
}
/*! \internal */
void QTouchEvent::TouchPoint::setId(int id)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->id = id;
}
/*! \internal */
void QTouchEvent::TouchPoint::setUniqueId(qint64 uid)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->uniqueId = QPointingDeviceUniqueId::fromNumericId(uid);
}
/*! \internal */
void QTouchEvent::TouchPoint::setState(Qt::TouchPointStates state)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->state = state;
}
/*! \internal */
void QTouchEvent::TouchPoint::setPos(const QPointF &pos)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->pos = pos;
}
/*! \internal */
void QTouchEvent::TouchPoint::setScenePos(const QPointF &scenePos)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->scenePos = scenePos;
}
/*! \internal */
void QTouchEvent::TouchPoint::setScreenPos(const QPointF &screenPos)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->screenPos = screenPos;
}
/*! \internal */
void QTouchEvent::TouchPoint::setNormalizedPos(const QPointF &normalizedPos)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->normalizedPos = normalizedPos;
}
/*! \internal */
void QTouchEvent::TouchPoint::setStartPos(const QPointF &startPos)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->startPos = startPos;
}
/*! \internal */
void QTouchEvent::TouchPoint::setStartScenePos(const QPointF &startScenePos)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->startScenePos = startScenePos;
}
/*! \internal */
void QTouchEvent::TouchPoint::setStartScreenPos(const QPointF &startScreenPos)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->startScreenPos = startScreenPos;
}
/*! \internal */
void QTouchEvent::TouchPoint::setStartNormalizedPos(const QPointF &startNormalizedPos)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->startNormalizedPos = startNormalizedPos;
}
/*! \internal */
void QTouchEvent::TouchPoint::setLastPos(const QPointF &lastPos)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->lastPos = lastPos;
}
/*! \internal */
void QTouchEvent::TouchPoint::setLastScenePos(const QPointF &lastScenePos)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->lastScenePos = lastScenePos;
}
/*! \internal */
void QTouchEvent::TouchPoint::setLastScreenPos(const QPointF &lastScreenPos)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->lastScreenPos = lastScreenPos;
}
/*! \internal */
void QTouchEvent::TouchPoint::setLastNormalizedPos(const QPointF &lastNormalizedPos)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->lastNormalizedPos = lastNormalizedPos;
}
#if QT_DEPRECATED_SINCE(5, 15)
// ### remove the following 3 setRect functions and their usages soon
/*! \internal
\obsolete
*/
void QTouchEvent::TouchPoint::setRect(const QRectF &rect)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->pos = rect.center();
d->ellipseDiameters = rect.size();
}
/*! \internal
\obsolete
*/
void QTouchEvent::TouchPoint::setSceneRect(const QRectF &sceneRect)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->scenePos = sceneRect.center();
d->ellipseDiameters = sceneRect.size();
}
/*! \internal
\obsolete
*/
void QTouchEvent::TouchPoint::setScreenRect(const QRectF &screenRect)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->screenPos = screenRect.center();
d->ellipseDiameters = screenRect.size();
}
#endif
/*! \internal */
void QTouchEvent::TouchPoint::setPressure(qreal pressure)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->pressure = pressure;
}
/*! \internal */
void QTouchEvent::TouchPoint::setRotation(qreal angle)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->rotation = angle;
}
/*! \internal */
void QTouchEvent::TouchPoint::setEllipseDiameters(const QSizeF &dia)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->ellipseDiameters = dia;
}
/*! \internal */
void QTouchEvent::TouchPoint::setVelocity(const QVector2D &v)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->velocity = v;
}
/*! \internal */
void QTouchEvent::TouchPoint::setRawScreenPositions(const QVector<QPointF> &positions)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->rawScreenPositions = positions;
}
/*!
\internal
*/
void QTouchEvent::TouchPoint::setFlags(InfoFlags flags)
{
if (d->ref.loadRelaxed() != 1)
d = d->detach();
d->flags = flags;
}
/*!
\fn QTouchEvent::TouchPoint &QTouchEvent::TouchPoint::operator=(const QTouchEvent::TouchPoint &other)
\internal
*/
/*!
\fn QTouchEvent::TouchPoint &QTouchEvent::TouchPoint::operator=(QTouchEvent::TouchPoint &&other)
\internal
*/
/*!
\fn void QTouchEvent::TouchPoint::swap(TouchPoint &other);
\internal
*/
/*!
\class QScrollPrepareEvent
\since 4.8
\ingroup events
\inmodule QtGui
\brief The QScrollPrepareEvent class is sent in preparation of scrolling.
The scroll prepare event is sent before scrolling (usually by QScroller) is started.
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 is not guaranteed that a QScrollEvent will be sent after an acceepted
QScrollPrepareEvent, e.g. in a case where the maximum content position is (0,0).
\sa QScrollEvent, QScroller
*/
/*!
Creates new QScrollPrepareEvent
The \a startPos is the position of a touch or mouse event that started the scrolling.
*/
QScrollPrepareEvent::QScrollPrepareEvent(const QPointF &startPos)
: QEvent(QEvent::ScrollPrepare), m_target(nullptr), m_startPos(startPos)
{
Q_UNUSED(m_target);
}
/*!
Destroys QScrollEvent.
*/
QScrollPrepareEvent::~QScrollPrepareEvent()
{
}
/*!
Returns the position of the touch or mouse event that started the scrolling.
*/
QPointF QScrollPrepareEvent::startPos() const
{
return m_startPos;
}
/*!
Returns size of the area that is to be scrolled as set by setViewportSize
\sa setViewportSize()
*/
QSizeF QScrollPrepareEvent::viewportSize() const
{
return m_viewportSize;
}
/*!
Returns the range of coordinates for the content as set by setContentPosRange().
*/
QRectF QScrollPrepareEvent::contentPosRange() const
{
return m_contentPosRange;
}
/*!
Returns the current position of the content as set by setContentPos.
*/
QPointF QScrollPrepareEvent::contentPos() const
{
return m_contentPos;
}
/*!
Sets the size of the area that is to be scrolled to \a size.
\sa viewportSize()
*/
void QScrollPrepareEvent::setViewportSize(const QSizeF &size)
{
m_viewportSize = size;
}
/*!
Sets the range of content coordinates to \a rect.
\sa contentPosRange()
*/
void QScrollPrepareEvent::setContentPosRange(const QRectF &rect)
{
m_contentPosRange = rect;
}
/*!
Sets the current content position to \a pos.
\sa contentPos()
*/
void QScrollPrepareEvent::setContentPos(const QPointF &pos)
{
m_contentPos = pos;
}
/*!
\class QScrollEvent
\since 4.8
\ingroup events
\inmodule QtGui
\brief The QScrollEvent class is sent when scrolling.
The scroll event is sent to indicate that the receiver should be scrolled.
Usually the receiver should be something visual like QWidget or QGraphicsObject.
Some care should be taken that no conflicting QScrollEvents are sent from two
sources. Using QScroller::scrollTo is save however.
\sa QScrollPrepareEvent, QScroller
*/
/*!
\enum QScrollEvent::ScrollState
This enum describes the states a scroll event can have.
\value ScrollStarted Set for the first scroll event of a scroll activity.
\value ScrollUpdated Set for all but the first and the last scroll event of a scroll activity.
\value ScrollFinished Set for the last scroll event of a scroll activity.
\sa QScrollEvent::scrollState()
*/
/*!
Creates a new QScrollEvent
\a contentPos is the new content position, \a overshootDistance is the
new overshoot distance while \a scrollState indicates if this scroll
event is the first one, the last one or some event in between.
*/
QScrollEvent::QScrollEvent(const QPointF &contentPos, const QPointF &overshootDistance, ScrollState scrollState)
: QEvent(QEvent::Scroll), m_contentPos(contentPos), m_overshoot(overshootDistance), m_state(scrollState)
{
}
/*!
Destroys QScrollEvent.
*/
QScrollEvent::~QScrollEvent()
{
}
/*!
Returns the new scroll position.
*/
QPointF QScrollEvent::contentPos() const
{
return m_contentPos;
}
/*!
Returns the new overshoot distance.
See QScroller for an explanation of the term overshoot.
\sa QScroller
*/
QPointF QScrollEvent::overshootDistance() const
{
return m_overshoot;
}
/*!
Returns the current scroll state as a combination of ScrollStateFlag values.
ScrollStarted (or ScrollFinished) will be set, if this scroll event is the first (or last) event in a scrolling activity.
Please note that both values can be set at the same time, if the activity consists of a single QScrollEvent.
All other scroll events in between will have their state set to ScrollUpdated.
A widget could for example revert selections when scrolling is started and stopped.
*/
QScrollEvent::ScrollState QScrollEvent::scrollState() const
{
return m_state;
}
/*!
Creates a new QScreenOrientationChangeEvent
\a screenOrientation is the new orientation of the \a screen.
*/
QScreenOrientationChangeEvent::QScreenOrientationChangeEvent(QScreen *screen, Qt::ScreenOrientation screenOrientation)
: QEvent(QEvent::OrientationChange), m_screen(screen), m_orientation(screenOrientation)
{
}
/*!
Destroys QScreenOrientationChangeEvent.
*/
QScreenOrientationChangeEvent::~QScreenOrientationChangeEvent()
{
}
/*!
Returns the screen whose orientation changed.
*/
QScreen *QScreenOrientationChangeEvent::screen() const
{
return m_screen;
}
/*!
Returns the orientation of the screen.
*/
Qt::ScreenOrientation QScreenOrientationChangeEvent::orientation() const
{
return m_orientation;
}
/*!
Creates a new QApplicationStateChangeEvent.
\a applicationState is the new state.
*/
QApplicationStateChangeEvent::QApplicationStateChangeEvent(Qt::ApplicationState applicationState)
: QEvent(QEvent::ApplicationStateChange), m_applicationState(applicationState)
{
}
/*!
Returns the state of the application.
*/
Qt::ApplicationState QApplicationStateChangeEvent::applicationState() const
{
return m_applicationState;
}
/*!
\class QPointingDeviceUniqueId
\since 5.8
\ingroup events
\inmodule QtGui
\brief QPointingDeviceUniqueId identifies a unique object, such as a tagged token
or stylus, which is used with a pointing device.
QPointingDeviceUniqueIds can be compared for equality, and can be used as keys in a QHash.
You get access to the numerical ID via numericId(), if the device supports such IDs.
For future extensions, though, you should not use that function, but compare objects
of this type using the equality operator.
This class is a thin wrapper around an integer ID. You pass it into and out of
functions by value.
This type actively prevents you from holding it in a QList, because doing so would
be very inefficient. Use a QVector instead, which has the same API as QList, but more
efficient storage.
\sa QTouchEvent::TouchPoint
*/
/*!
\fn QPointingDeviceUniqueId::QPointingDeviceUniqueId()
Constructs an invalid unique pointer ID.
*/
/*!
Constructs a unique pointer ID from numeric ID \a id.
*/
QPointingDeviceUniqueId QPointingDeviceUniqueId::fromNumericId(qint64 id)
{
QPointingDeviceUniqueId result;
result.m_numericId = id;
return result;
}
/*!
\fn bool QPointingDeviceUniqueId::isValid() const
Returns whether this unique pointer ID is valid, that is, it represents an actual
pointer.
*/
/*!
\property QPointingDeviceUniqueId::numericId
\brief the numeric unique ID of the token represented by a touchpoint
If the device provides a numeric ID, isValid() returns true, and this
property provides the numeric ID;
otherwise it is -1.
You should not use the value of this property in portable code, but
instead rely on equality to identify pointers.
\sa isValid()
*/
qint64 QPointingDeviceUniqueId::numericId() const noexcept
{
return m_numericId;
}
/*!
\relates QPointingDeviceUniqueId
\since 5.8
Returns whether the two unique pointer IDs \a lhs and \a rhs identify the same pointer
(\c true) or not (\c false).
*/
bool operator==(QPointingDeviceUniqueId lhs, QPointingDeviceUniqueId rhs) noexcept
{
return lhs.numericId() == rhs.numericId();
}
/*!
\fn bool operator!=(QPointingDeviceUniqueId lhs, QPointingDeviceUniqueId rhs)
\relates QPointingDeviceUniqueId
\since 5.8
Returns whether the two unique pointer IDs \a lhs and \a rhs identify different pointers
(\c true) or not (\c false).
*/
/*!
\relates QPointingDeviceUniqueId
\since 5.8
Returns the hash value for \a key, using \a seed to seed the calculation.
*/
uint qHash(QPointingDeviceUniqueId key, uint seed) noexcept
{
return qHash(key.numericId(), seed);
}
QT_END_NAMESPACE