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