diff options
Diffstat (limited to 'src/widgets/kernel/qtestsupport_widgets.cpp')
-rw-r--r-- | src/widgets/kernel/qtestsupport_widgets.cpp | 167 |
1 files changed, 93 insertions, 74 deletions
diff --git a/src/widgets/kernel/qtestsupport_widgets.cpp b/src/widgets/kernel/qtestsupport_widgets.cpp index c9116fcef6..f7b25b6643 100644 --- a/src/widgets/kernel/qtestsupport_widgets.cpp +++ b/src/widgets/kernel/qtestsupport_widgets.cpp @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2018 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the QtTest 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$ -** -****************************************************************************/ +// Copyright (C) 2018 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include "qtestsupport_widgets.h" @@ -46,48 +10,101 @@ #include <QtCore/qthread.h> #include <QtGui/qtestsupport_gui.h> #include <QtGui/private/qevent_p.h> +#include <QtGui/private/qeventpoint_p.h> +#include <private/qguiapplication_p.h> +#include <qpa/qplatformintegration.h> QT_BEGIN_NAMESPACE +template <typename FunctorWindowGetter, typename FunctorPredicate, typename Timeout> +static bool qWaitForWidgetWindow(FunctorWindowGetter windowGetter, FunctorPredicate predicate, Timeout timeout) +{ + if (!windowGetter()) + return false; + + return QTest::qWaitFor([&]() { + if (QWindow *window = windowGetter()) + return predicate(window); + return false; + }, timeout); +} + /*! \since 5.0 - Waits for \a timeout milliseconds or until the \a widget's window is active. + Returns \c true if \a widget is active within \a timeout milliseconds. Otherwise returns \c false. + + The method is useful in tests that call QWidget::show() and rely on the widget actually being + active (i.e. being visible and having focus) before proceeding. + + \note The method will time out and return \c false if another window prevents \a widget from + becoming active. - Returns \c true if \c widget's window is active within \a timeout milliseconds, otherwise returns \c false. + \note Since focus is an exclusive property, \a widget may loose its focus to another window at + any time - even after the method has returned \c true. \sa qWaitForWindowExposed(), QWidget::isActiveWindow() */ Q_WIDGETS_EXPORT bool QTest::qWaitForWindowActive(QWidget *widget, int timeout) { - if (QWindow *window = widget->window()->windowHandle()) - return QTest::qWaitForWindowActive(window, timeout); - return false; + if (Q_UNLIKELY(!QGuiApplicationPrivate::platformIntegration()->hasCapability(QPlatformIntegration::WindowActivation))) { + qWarning() << "qWaitForWindowActive was called on a platform that doesn't support window" + << "activation. This means there is an error in the test and it should either" + << "check for the WindowActivation platform capability before calling" + << "qWaitForWindowActivate, use qWaitForWindowExposed instead, or skip the test." + << "Falling back to qWaitForWindowExposed."; + return qWaitForWindowExposed(widget, timeout); + } + return qWaitForWidgetWindow([&]() { return widget->window()->windowHandle(); }, + [&](QWindow *window) { return window->isActive(); }, + timeout); } + /*! - \since 5.0 + \since 6.7 + + Returns \c true, if \a widget is the focus window within \a timeout. Otherwise returns \c false. - Waits for \a timeout milliseconds or until the \a widget's window is exposed. - Returns \c true if \c widget's window is exposed within \a timeout milliseconds, otherwise returns \c false. + The method is useful in tests that call QWidget::show() and rely on the widget + having focus (for receiving keyboard events e.g.) before proceeding. + + \note The method will time out and return \c false if another window prevents \a widget from + becoming focused. + + \note Since focus is an exclusive property, \a widget may loose its focus to another window at + any time - even after the method has returned \c true. + + \sa qWaitForWindowExposed(), qWaitForWindowActive(), QGuiApplication::focusWindow() +*/ +Q_WIDGETS_EXPORT bool QTest::qWaitForWindowFocused(QWidget *widget, QDeadlineTimer timeout) +{ + return qWaitForWidgetWindow([&]() { + return widget->window()->windowHandle(); + }, [&](QWindow *window) { + return qGuiApp->focusWindow() == window; + }, timeout); +} + +/*! + \since 5.0 - This is mainly useful for asynchronous systems like X11, where a window will be mapped to screen some - time after being asked to show itself on the screen. + Returns \c true if \a widget is exposed within \a timeout milliseconds. Otherwise returns \c false. - Note that a window that is mapped to screen may still not be considered exposed if the window client - area is completely covered by other windows, or if the window is otherwise not visible. This function - will then time out when waiting for such a window. + The method is useful in tests that call QWidget::show() and rely on the widget actually being + being visible before proceeding. - A specific configuration where this happens is when using QGLWidget as a viewport widget on macOS: - The viewport widget gets the expose event, not the parent widget. + \note A window mapped to screen may still not be considered exposed, if the window client area is + not visible, e.g. because it is completely covered by other windows. + In such cases, the method will time out and return \c false. - \sa qWaitForWindowActive() + \sa qWaitForWindowActive(), QWidget::isVisible(), QWindow::isExposed() */ Q_WIDGETS_EXPORT bool QTest::qWaitForWindowExposed(QWidget *widget, int timeout) { - if (QWindow *window = widget->window()->windowHandle()) - return QTest::qWaitForWindowExposed(window, timeout); - return false; + return qWaitForWidgetWindow([&]() { return widget->window()->windowHandle(); }, + [&](QWindow *window) { return window->isExposed(); }, + timeout); } namespace QTest { @@ -95,52 +112,54 @@ namespace QTest { QTouchEventWidgetSequence::~QTouchEventWidgetSequence() { if (commitWhenDestroyed) - commit(); + QTouchEventWidgetSequence::commit(); } QTouchEventWidgetSequence& QTouchEventWidgetSequence::press(int touchId, const QPoint &pt, QWidget *widget) { - auto &p = QMutableEventPoint::from(point(touchId)); - p.setGlobalPosition(mapToScreen(widget, pt)); - p.setState(QEventPoint::State::Pressed); + auto &p = point(touchId); + QMutableEventPoint::setGlobalPosition(p, mapToScreen(widget, pt)); + QMutableEventPoint::setState(p, QEventPoint::State::Pressed); return *this; } QTouchEventWidgetSequence& QTouchEventWidgetSequence::move(int touchId, const QPoint &pt, QWidget *widget) { - auto &p = QMutableEventPoint::from(point(touchId)); - p.setGlobalPosition(mapToScreen(widget, pt)); - p.setState(QEventPoint::State::Updated); + auto &p = point(touchId); + QMutableEventPoint::setGlobalPosition(p, mapToScreen(widget, pt)); + QMutableEventPoint::setState(p, QEventPoint::State::Updated); return *this; } QTouchEventWidgetSequence& QTouchEventWidgetSequence::release(int touchId, const QPoint &pt, QWidget *widget) { - auto &p = QMutableEventPoint::from(point(touchId)); - p.setGlobalPosition(mapToScreen(widget, pt)); - p.setState(QEventPoint::State::Released); + auto &p = point(touchId); + QMutableEventPoint::setGlobalPosition(p, mapToScreen(widget, pt)); + QMutableEventPoint::setState(p, QEventPoint::State::Released); return *this; } QTouchEventWidgetSequence& QTouchEventWidgetSequence::stationary(int touchId) { - auto &p = QMutableEventPoint::from(pointOrPreviousPoint(touchId)); - p.setState(QEventPoint::State::Stationary); + auto &p = pointOrPreviousPoint(touchId); + QMutableEventPoint::setState(p, QEventPoint::State::Stationary); return *this; } -void QTouchEventWidgetSequence::commit(bool processEvents) +bool QTouchEventWidgetSequence::commit(bool processEvents) { + bool ret = false; if (points.isEmpty()) - return; - QThread::msleep(1); + return ret; + QThread::sleep(std::chrono::milliseconds{1}); if (targetWindow) { - qt_handleTouchEvent(targetWindow, device, points.values()); + ret = qt_handleTouchEventv2(targetWindow, device, points.values()); } else if (targetWidget) { - qt_handleTouchEvent(targetWidget->windowHandle(), device, points.values()); + ret = qt_handleTouchEventv2(targetWidget->windowHandle(), device, points.values()); } if (processEvents) QCoreApplication::processEvents(); previousPoints = points; points.clear(); + return ret; } QTest::QTouchEventWidgetSequence::QTouchEventWidgetSequence(QWidget *widget, QPointingDevice *aDevice, bool autoCommit) |