include/QtGui/qtestsupport_gui.h

0001 // Copyright (C) 2018 The Qt Company Ltd.
0002 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
0003
0004 #ifndef QTESTSUPPORT_GUI_H
0005 #define QTESTSUPPORT_GUI_H
0006
0007 #include <QtGui/qtguiglobal.h>
0008 #include <QtGui/qevent.h>
0009 #include <QtCore/qmap.h>
0010 #include <QtCore/qtestsupport_core.h>
0011
0012 QT_BEGIN_NAMESPACE
0013
0014 class QWindow;
0015
0016 Q_GUI_EXPORT void qt_handleTouchEvent(QWindow *w, const QPointingDevice *device,
0017                                 const QList<QEventPoint> &points,
0018                                 Qt::KeyboardModifiers mods = Qt::NoModifier);
0019
0020 Q_GUI_EXPORT bool qt_handleTouchEventv2(QWindow *w, const QPointingDevice *device,
0021                                 const QList<QEventPoint> &points,
0022                                 Qt::KeyboardModifiers mods = Qt::NoModifier);
0023
0024 namespace QTest {
0025
0026 [[nodiscard]] Q_GUI_EXPORT bool qWaitForWindowActive(QWindow *window, int timeout);
0027 [[nodiscard]] Q_GUI_EXPORT bool qWaitForWindowActive(QWindow *window, QDeadlineTimer timeout);
0028 [[nodiscard]] Q_GUI_EXPORT bool qWaitForWindowActive(QWindow *window);
0029
0030 [[nodiscard]] Q_GUI_EXPORT bool qWaitForWindowFocused(QWindow *window, QDeadlineTimer timeout);
0031 [[nodiscard]] Q_GUI_EXPORT bool qWaitForWindowFocused(QWindow *window);
0032
0033 [[nodiscard]] Q_GUI_EXPORT bool qWaitForWindowExposed(QWindow *window, int timeout);
0034 [[nodiscard]] Q_GUI_EXPORT bool qWaitForWindowExposed(QWindow *window, QDeadlineTimer timeout);
0035 [[nodiscard]] Q_GUI_EXPORT bool qWaitForWindowExposed(QWindow *window);
0036
0037 Q_GUI_EXPORT QPointingDevice * createTouchDevice(QInputDevice::DeviceType devType = QInputDevice::DeviceType::TouchScreen,
0038                                                  QInputDevice::Capabilities caps = QInputDevice::Capability::Position);
0039
0040 class Q_GUI_EXPORT QTouchEventSequence
0041 {
0042 public:
0043     virtual ~QTouchEventSequence();
0044     QTouchEventSequence& press(int touchId, const QPoint &pt, QWindow *window = nullptr);
0045     QTouchEventSequence& move(int touchId, const QPoint &pt, QWindow *window = nullptr);
0046     QTouchEventSequence& release(int touchId, const QPoint &pt, QWindow *window = nullptr);
0047     virtual QTouchEventSequence& stationary(int touchId);
0048
0049     virtual bool commit(bool processEvents = true);
0050
0051 protected:
0052     QTouchEventSequence(QWindow *window, QPointingDevice *aDevice, bool autoCommit);
0053
0054     QPoint mapToScreen(QWindow *window, const QPoint &pt);
0055
0056     QEventPoint &point(int touchId);
0057
0058     QEventPoint &pointOrPreviousPoint(int touchId);
0059
0060     QMap<int, QEventPoint> previousPoints;
0061     QMap<int, QEventPoint> points;
0062     QWindow *targetWindow;
0063     QPointingDevice *device;
0064     bool commitWhenDestroyed;
0065     friend QTouchEventSequence touchEvent(QWindow *window, QPointingDevice *device, bool autoCommit);
0066 };
0067
0068 } // namespace QTest
0069
0070 //
0071 //  W A R N I N G
0072 //  -------------
0073 //
0074 // The QtGuiTest namespace is not part of the Qt API.  It exists purely as an
0075 // implementation detail.  It may change from version to version without notice,
0076 // or even be removed.
0077 //
0078 // We mean it.
0079 //
0080
0081 #if QT_CONFIG(test_gui)
0082 namespace QtGuiTest
0083 {
0084     Q_GUI_EXPORT void setKeyboardModifiers(Qt::KeyboardModifiers modifiers);
0085     Q_GUI_EXPORT void setCursorPosition(const QPoint &position);
0086     Q_GUI_EXPORT void synthesizeExtendedKeyEvent(QEvent::Type type, int key, Qt::KeyboardModifiers modifiers,
0087                                     quint32 nativeScanCode, quint32 nativeVirtualKey,
0088                                     const QString &text);
0089     Q_GUI_EXPORT bool synthesizeKeyEvent(QWindow *window, QEvent::Type t, int k, Qt::KeyboardModifiers mods,
0090                             const QString & text = QString(), bool autorep = false,
0091                             ushort count = 1);
0092
0093     Q_GUI_EXPORT void synthesizeMouseEvent(const QPointF &position, Qt::MouseButtons state,
0094                               Qt::MouseButton button, QEvent::Type type,
0095                               Qt::KeyboardModifiers modifiers);
0096
0097     Q_GUI_EXPORT void synthesizeWheelEvent(int rollCount, Qt::KeyboardModifiers modifiers);
0098
0099     Q_GUI_EXPORT qint64 eventTimeElapsed();
0100
0101     Q_GUI_EXPORT void postFakeWindowActivation(QWindow *window);
0102
0103     Q_GUI_EXPORT QPoint toNativePixels(const QPoint &value, const QWindow *window);
0104     Q_GUI_EXPORT QRect toNativePixels(const QRect &value, const QWindow *window);
0105     Q_GUI_EXPORT qreal scaleFactor(const QWindow *window);
0106
0107     Q_GUI_EXPORT void setEventPointId(QEventPoint &p, int arg);
0108     Q_GUI_EXPORT void setEventPointPressure(QEventPoint &p, qreal arg);
0109     Q_GUI_EXPORT void setEventPointState(QEventPoint &p, QEventPoint::State arg);
0110     Q_GUI_EXPORT void setEventPointPosition(QEventPoint &p, QPointF arg);
0111     Q_GUI_EXPORT void setEventPointGlobalPosition(QEventPoint &p, QPointF arg);
0112     Q_GUI_EXPORT void setEventPointScenePosition(QEventPoint &p, QPointF arg);
0113     Q_GUI_EXPORT void setEventPointEllipseDiameters(QEventPoint &p, QSizeF arg);
0114 } // namespace QtGuiTest
0115
0116 #endif // #if QT_CONFIG(test_gui)
0117
0118 QT_END_NAMESPACE
0119
0120 #endif // #ifndef QTESTSUPPORT_GUI_H