Back to Qt.io
Contact Us Blog Download Qt

QTouchEventSequence Class

class QTest::QTouchEventSequence

The QTouchEventSequence class is used to simulate a sequence of touch events. More...

Header: #include <QTouchEventSequence>
CMake: find_package(Qt6 REQUIRED COMPONENTS Test)
target_link_libraries(mytarget PRIVATE Qt6::Test)
qmake: QT += testlib

Public Functions

virtual ~QTouchEventSequence()
virtual bool commit(bool processEvents = true)
QTest::QTouchEventSequence &move(int touchId, const QPoint &pt, QWindow *window = nullptr)
QTest::QTouchEventSequence &press(int touchId, const QPoint &pt, QWindow *window = nullptr)
QTest::QTouchEventSequence &release(int touchId, const QPoint &pt, QWindow *window = nullptr)
virtual QTest::QTouchEventSequence &stationary(int touchId)

Detailed Description

To simulate a sequence of touch events on a specific device for a window or widget, call QTest::touchEvent to create a QTouchEventSequence instance. Add touch events to the sequence by calling press(), move(), release() and stationary(), and let the instance run out of scope to commit the sequence to the event system.

Example:

QTouchDevice *dev = QTest::createTouchDevice();
QWidget widget;

QTest::touchEvent(&widget, dev)
    .press(0, QPoint(10, 10));
QTest::touchEvent(&widget, dev)
    .stationary(0)
    .press(1, QPoint(40, 10));
QTest::touchEvent(&widget, dev)
    .move(0, QPoint(12, 12))
    .move(1, QPoint(45, 5));
QTest::touchEvent(&widget, dev)
    .release(0, QPoint(12, 12))
    .release(1, QPoint(45, 5));

Member Function Documentation

[virtual noexcept] QTouchEventSequence::~QTouchEventSequence()

Commits this sequence of touch events, unless autoCommit was disabled, and frees allocated resources.

[virtual] bool QTouchEventSequence::commit(bool processEvents = true)

Commits this touch event to the event system, and returns whether it was accepted after delivery.

Normally there is no need to call this function because it is called from the destructor. However, if autoCommit is disabled, the events only get committed upon explicitly calling this function. Another reason to call it explicitly is to check the return value.

In special cases, tests may want to disable the processing of the event. This can be achieved by setting processEvents to false. This results in merely queuing the event: the event loop will not be forced to process it.

Returns whether the event was accepted after delivery.

QTest::QTouchEventSequence &QTouchEventSequence::move(int touchId, const QPoint &pt, QWindow *window = nullptr)

Adds a move event for touchpoint touchId at position pt to this sequence and returns a reference to this QTouchEventSequence.

The position pt is interpreted as relative to window. If window is the null pointer, then pt is interpreted as relative to the window provided when instantiating this QTouchEventSequence.

Simulates that the user moved the finger identified by touchId.

QTest::QTouchEventSequence &QTouchEventSequence::press(int touchId, const QPoint &pt, QWindow *window = nullptr)

Adds a press event for touchpoint touchId at position pt to this sequence and returns a reference to this QTouchEventSequence.

The position pt is interpreted as relative to window. If window is the null pointer, then pt is interpreted as relative to the window provided when instantiating this QTouchEventSequence.

Simulates that the user pressed the touch screen or pad with the finger identified by touchId.

QTest::QTouchEventSequence &QTouchEventSequence::release(int touchId, const QPoint &pt, QWindow *window = nullptr)

Adds a release event for touchpoint touchId at position pt to this sequence and returns a reference to this QTouchEventSequence.

The position pt is interpreted as relative to window. If window is the null pointer, then pt is interpreted as relative to the window provided when instantiating this QTouchEventSequence.

Simulates that the user lifted the finger identified by touchId.

[virtual] QTest::QTouchEventSequence &QTouchEventSequence::stationary(int touchId)

Adds a stationary event for touchpoint touchId to this sequence and returns a reference to this QTouchEventSequence.

Simulates that the user did not move the finger identified by touchId.

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.