Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QTouchEvent Class Reference

The QTouchEvent class contains parameters that describe a touch event. More...

#include <qevent.h>

+ Inheritance diagram for QTouchEvent:
+ Collaboration diagram for QTouchEvent:

Public Types

using TouchPoint = QEventPoint
 
- Public Types inherited from QEvent
enum  Type {
  None = 0 , Timer = 1 , MouseButtonPress = 2 , MouseButtonRelease = 3 ,
  MouseButtonDblClick = 4 , MouseMove = 5 , KeyPress = 6 , KeyRelease = 7 ,
  FocusIn = 8 , FocusOut = 9 , FocusAboutToChange = 23 , Enter = 10 ,
  Leave = 11 , Paint = 12 , Move = 13 , Resize = 14 ,
  Create = 15 , Destroy = 16 , Show = 17 , Hide = 18 ,
  Close = 19 , Quit = 20 , ParentChange = 21 , ParentAboutToChange = 131 ,
  ThreadChange = 22 , WindowActivate = 24 , WindowDeactivate = 25 , ShowToParent = 26 ,
  HideToParent = 27 , Wheel = 31 , WindowTitleChange = 33 , WindowIconChange = 34 ,
  ApplicationWindowIconChange = 35 , ApplicationFontChange = 36 , ApplicationLayoutDirectionChange = 37 , ApplicationPaletteChange = 38 ,
  PaletteChange = 39 , Clipboard = 40 , Speech = 42 , MetaCall = 43 ,
  SockAct = 50 , WinEventAct = 132 , DeferredDelete = 52 , DragEnter = 60 ,
  DragMove = 61 , DragLeave = 62 , Drop = 63 , DragResponse = 64 ,
  ChildAdded = 68 , ChildPolished = 69 , ChildRemoved = 71 , ShowWindowRequest = 73 ,
  PolishRequest = 74 , Polish = 75 , LayoutRequest = 76 , UpdateRequest = 77 ,
  UpdateLater = 78 , EmbeddingControl = 79 , ActivateControl = 80 , DeactivateControl = 81 ,
  ContextMenu = 82 , InputMethod = 83 , TabletMove = 87 , LocaleChange = 88 ,
  LanguageChange = 89 , LayoutDirectionChange = 90 , Style = 91 , TabletPress = 92 ,
  TabletRelease = 93 , OkRequest = 94 , HelpRequest = 95 , IconDrag = 96 ,
  FontChange = 97 , EnabledChange = 98 , ActivationChange = 99 , StyleChange = 100 ,
  IconTextChange = 101 , ModifiedChange = 102 , MouseTrackingChange = 109 , WindowBlocked = 103 ,
  WindowUnblocked = 104 , WindowStateChange = 105 , ReadOnlyChange = 106 , ToolTip = 110 ,
  WhatsThis = 111 , StatusTip = 112 , ActionChanged = 113 , ActionAdded = 114 ,
  ActionRemoved = 115 , FileOpen = 116 , Shortcut = 117 , ShortcutOverride = 51 ,
  WhatsThisClicked = 118 , ToolBarChange = 120 , ApplicationActivate = 121 , ApplicationActivated = ApplicationActivate ,
  ApplicationDeactivate = 122 , ApplicationDeactivated = ApplicationDeactivate , QueryWhatsThis = 123 , EnterWhatsThisMode = 124 ,
  LeaveWhatsThisMode = 125 , ZOrderChange = 126 , HoverEnter = 127 , HoverLeave = 128 ,
  HoverMove = 129 , AcceptDropsChange = 152 , ZeroTimerEvent = 154 , GraphicsSceneMouseMove = 155 ,
  GraphicsSceneMousePress = 156 , GraphicsSceneMouseRelease = 157 , GraphicsSceneMouseDoubleClick = 158 , GraphicsSceneContextMenu = 159 ,
  GraphicsSceneHoverEnter = 160 , GraphicsSceneHoverMove = 161 , GraphicsSceneHoverLeave = 162 , GraphicsSceneHelp = 163 ,
  GraphicsSceneDragEnter = 164 , GraphicsSceneDragMove = 165 , GraphicsSceneDragLeave = 166 , GraphicsSceneDrop = 167 ,
  GraphicsSceneWheel = 168 , GraphicsSceneLeave = 220 , KeyboardLayoutChange = 169 , DynamicPropertyChange = 170 ,
  TabletEnterProximity = 171 , TabletLeaveProximity = 172 , NonClientAreaMouseMove = 173 , NonClientAreaMouseButtonPress = 174 ,
  NonClientAreaMouseButtonRelease = 175 , NonClientAreaMouseButtonDblClick = 176 , MacSizeChange = 177 , ContentsRectChange = 178 ,
  MacGLWindowChange = 179 , FutureCallOut = 180 , GraphicsSceneResize = 181 , GraphicsSceneMove = 182 ,
  CursorChange = 183 , ToolTipChange = 184 , NetworkReplyUpdated = 185 , GrabMouse = 186 ,
  UngrabMouse = 187 , GrabKeyboard = 188 , UngrabKeyboard = 189 , StateMachineSignal = 192 ,
  StateMachineWrapped = 193 , TouchBegin = 194 , TouchUpdate = 195 , TouchEnd = 196 ,
  NativeGesture = 197 , RequestSoftwareInputPanel = 199 , CloseSoftwareInputPanel = 200 , WinIdChange = 203 ,
  Gesture = 198 , GestureOverride = 202 , ScrollPrepare = 204 , Scroll = 205 ,
  Expose = 206 , InputMethodQuery = 207 , OrientationChange = 208 , TouchCancel = 209 ,
  ThemeChange = 210 , SockClose = 211 , PlatformPanel = 212 , StyleAnimationUpdate = 213 ,
  ApplicationStateChange = 214 , WindowChangeInternal = 215 , ScreenChangeInternal = 216 , PlatformSurface = 217 ,
  Pointer = 218 , TabletTrackingChange = 219 , WindowAboutToChangeInternal = 221 , DevicePixelRatioChange = 222 ,
  ChildWindowAdded = 223 , ChildWindowRemoved = 224 , ParentWindowAboutToChange = 225 , ParentWindowChange = 226 ,
  User = 1000 , MaxUser = 65535
}
 This enum type defines the valid event types in Qt. More...
 

Public Member Functions

 QTouchEvent (QEvent::Type eventType, const QPointingDevice *device=nullptr, Qt::KeyboardModifiers modifiers=Qt::NoModifier, const QList< QEventPoint > &touchPoints={})
 Constructs a QTouchEvent with the given eventType, device, touchPoints, and current keyboard modifiers at the time of the event.
 
QObjecttarget () const
 Returns the target object within the window on which the event occurred.
 
QEventPoint::States touchPointStates () const
 Returns a bitwise OR of all the touch point states for this event.
 
bool isBeginEvent () const override
 Returns true if this event includes at least one newly-pressed touchpoint.
 
bool isUpdateEvent () const override
 Returns true if this event does not include newly-pressed or newly-released touchpoints.
 
bool isEndEvent () const override
 Returns true if this event includes at least one newly-released touchpoint.
 
- Public Member Functions inherited from QPointerEvent
 QPointerEvent (Type type, const QPointingDevice *dev, Qt::KeyboardModifiers modifiers=Qt::NoModifier, const QList< QEventPoint > &points={})
 
const QPointingDevicepointingDevice () const
 Returns the source device from which this event originates.
 
QPointingDevice::PointerType pointerType () const
 Returns the type of point that generated the event.
 
void setTimestamp (quint64 timestamp) override
 
qsizetype pointCount () const
 Returns the number of points in this pointer event.
 
QEventPointpoint (qsizetype i)
 Returns a QEventPoint reference for the point at index i.
 
const QList< QEventPoint > & points () const
 Returns a list of points in this pointer event.
 
QEventPointpointById (int id)
 Returns the point whose \l {QEventPoint::id()}{id} matches the given id, or nullptr if no such point is found.
 
bool allPointsGrabbed () const
 Returns true if every point in points() has either an exclusiveGrabber() or one or more passiveGrabbers().
 
bool allPointsAccepted () const
 Returns true if isPointAccepted() is true for every point in points(); otherwise false.
 
virtual void setAccepted (bool accepted) override
 \reimp
 
QObjectexclusiveGrabber (const QEventPoint &point) const
 Returns the object which has been set to receive all future update events and the release event containing the given point.
 
void setExclusiveGrabber (const QEventPoint &point, QObject *exclusiveGrabber)
 Informs the delivery logic that the given exclusiveGrabber is to receive all future update events and the release event containing the given point, and that delivery to other items can be skipped.
 
QList< QPointer< QObject > > passiveGrabbers (const QEventPoint &point) const
 Returns the list of objects that have been requested to receive all future update events and the release event containing the given point.
 
void clearPassiveGrabbers (const QEventPoint &point)
 Removes all passive grabbers from the given point.
 
bool addPassiveGrabber (const QEventPoint &point, QObject *grabber)
 Informs the delivery logic that the given grabber is to receive all future update events and the release event containing the given point, regardless where else those events may be delivered.
 
bool removePassiveGrabber (const QEventPoint &point, QObject *grabber)
 Removes the passive grabber from the given point if it was previously added.
 
- Public Member Functions inherited from QInputEvent
 QInputEvent (Type type, const QInputDevice *m_dev, Qt::KeyboardModifiers modifiers=Qt::NoModifier)
 
const QInputDevicedevice () const
 
QInputDevice::DeviceType deviceType () const
 Returns the type of device that generated the event.
 
Qt::KeyboardModifiers modifiers () const
 Returns the keyboard modifier flags that existed immediately before the event occurred.
 
void setModifiers (Qt::KeyboardModifiers modifiers)
 
quint64 timestamp () const
 Returns the window system's timestamp for this event.
 
- Public Member Functions inherited from QEvent
 QEvent (Type type)
 Constructs an event object of type type.
 
virtual ~QEvent ()
 Destroys the event.
 
Type type () const
 Returns the event type.
 
bool spontaneous () const
 Returns true if the event originated outside the application (a system event); otherwise returns false.
 
bool isAccepted () const
 
void accept ()
 Sets the accept flag of the event object, the equivalent of calling setAccepted(true).
 
void ignore ()
 Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false).
 
bool isInputEvent () const noexcept
 
bool isPointerEvent () const noexcept
 
bool isSinglePointEvent () const noexcept
 
virtual QEventclone () const
 Creates and returns an identical copy of this event.
 

Protected Attributes

QObjectm_target = nullptr
 
QEventPoint::States m_touchPointStates = QEventPoint::State::Unknown
 
quint32 m_reserved: 24
 
- Protected Attributes inherited from QPointerEvent
QList< QEventPointm_points
 
- Protected Attributes inherited from QInputEvent
const QInputDevicem_dev = nullptr
 
quint64 m_timeStamp = 0
 
Qt::KeyboardModifiers m_modState = Qt::NoModifier
 
quint32 m_reserved = 0
 
- Protected Attributes inherited from QEvent
quint16 t
 

Additional Inherited Members

- Static Public Member Functions inherited from QEvent
static int registerEventType (int hint=-1) noexcept
 
- Protected Member Functions inherited from QPointerEvent
 QPointerEvent (Type type, SinglePointEventTag, const QInputDevice *dev, Qt::KeyboardModifiers modifiers=Qt::NoModifier)
 
- Protected Member Functions inherited from QInputEvent
 QInputEvent (Type type, PointerEventTag, const QInputDevice *dev, Qt::KeyboardModifiers modifiers=Qt::NoModifier)
 
 QInputEvent (Type type, SinglePointEventTag, const QInputDevice *dev, Qt::KeyboardModifiers modifiers=Qt::NoModifier)
 
- Protected Member Functions inherited from QEvent
 QEvent (Type type, InputEventTag)
 
 QEvent (Type type, PointerEventTag)
 
 QEvent (Type type, SinglePointEventTag)
 

Detailed Description

The QTouchEvent class contains parameters that describe a touch event.

Since
4.6

\inmodule QtGui

Definition at line 916 of file qevent.h.

Member Typedef Documentation

◆ TouchPoint

Definition at line 920 of file qevent.h.

Constructor & Destructor Documentation

◆ QTouchEvent()

QTouchEvent::QTouchEvent ( QEvent::Type eventType,
const QPointingDevice * device = nullptr,
Qt::KeyboardModifiers modifiers = Qt::NoModifier,
const QList< QEventPoint > & touchPoints = {} )
explicit

Constructs a QTouchEvent with the given eventType, device, touchPoints, and current keyboard modifiers at the time of the event.

Definition at line 4485 of file qevent.cpp.

References device.

Member Function Documentation

◆ isBeginEvent()

bool QTouchEvent::isBeginEvent ( ) const
overridevirtual

Returns true if this event includes at least one newly-pressed touchpoint.

Reimplemented from QPointerEvent.

Definition at line 4525 of file qevent.cpp.

References QEventPoint::Pressed.

◆ isEndEvent()

bool QTouchEvent::isEndEvent ( ) const
overridevirtual

Returns true if this event includes at least one newly-released touchpoint.

Reimplemented from QPointerEvent.

Definition at line 4543 of file qevent.cpp.

References m_touchPointStates, and QEventPoint::Released.

Referenced by QQuickDragHandler::handlePointerEventImpl().

+ Here is the caller graph for this function:

◆ isUpdateEvent()

bool QTouchEvent::isUpdateEvent ( ) const
overridevirtual

Returns true if this event does not include newly-pressed or newly-released touchpoints.

Reimplemented from QPointerEvent.

Definition at line 4534 of file qevent.cpp.

References m_touchPointStates, QEventPoint::Pressed, and QEventPoint::Released.

◆ target()

QObject * QTouchEvent::target ( ) const
inline

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.

Definition at line 935 of file qevent.h.

◆ touchPointStates()

QEventPoint::States QTouchEvent::touchPointStates ( ) const
inline

Returns a bitwise OR of all the touch point states for this event.

Definition at line 936 of file qevent.h.

Member Data Documentation

◆ m_reserved

quint32 QTouchEvent::m_reserved
protected

Definition at line 948 of file qevent.h.

◆ m_target

QObject* QTouchEvent::m_target = nullptr
protected

Definition at line 946 of file qevent.h.

◆ m_touchPointStates

QEventPoint::States QTouchEvent::m_touchPointStates = QEventPoint::State::Unknown
protected

Definition at line 947 of file qevent.h.

Referenced by QMutableTouchEvent::addPoint(), isEndEvent(), and isUpdateEvent().


The documentation for this class was generated from the following files: