1/****************************************************************************
2**
3** Copyright (C) 2018 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtTest module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#include "qtestsupport_widgets.h"
41
42#include "qwidget.h"
43
44#include <QtGui/qwindow.h>
45#include <QtGui/qtestsupport_gui.h>
46
47QT_BEGIN_NAMESPACE
48
49/*!
50 \since 5.0
51
52 Waits for \a timeout milliseconds or until the \a widget's window is active.
53
54 Returns \c true if \c widget's window is active within \a timeout milliseconds, otherwise returns \c false.
55
56 \sa qWaitForWindowExposed(), QWidget::isActiveWindow()
57*/
58Q_WIDGETS_EXPORT Q_REQUIRED_RESULT bool QTest::qWaitForWindowActive(QWidget *widget, int timeout)
59{
60 if (QWindow *window = widget->window()->windowHandle())
61 return QTest::qWaitForWindowActive(window, timeout);
62 return false;
63}
64
65/*!
66 \since 5.0
67
68 Waits for \a timeout milliseconds or until the \a widget's window is exposed.
69 Returns \c true if \c widget's window is exposed within \a timeout milliseconds, otherwise returns \c false.
70
71 This is mainly useful for asynchronous systems like X11, where a window will be mapped to screen some
72 time after being asked to show itself on the screen.
73
74 Note that a window that is mapped to screen may still not be considered exposed if the window client
75 area is completely covered by other windows, or if the window is otherwise not visible. This function
76 will then time out when waiting for such a window.
77
78 A specific configuration where this happens is when using QGLWidget as a viewport widget on macOS:
79 The viewport widget gets the expose event, not the parent widget.
80
81 \sa qWaitForWindowActive()
82*/
83Q_WIDGETS_EXPORT Q_REQUIRED_RESULT bool QTest::qWaitForWindowExposed(QWidget *widget, int timeout)
84{
85 if (QWindow *window = widget->window()->windowHandle())
86 return QTest::qWaitForWindowExposed(window, timeout);
87 return false;
88}
89
90/*! \fn bool QTest::qWaitForWindowShown(QWidget *widget, int timeout)
91 \since 5.0
92 \deprecated
93
94 Use qWaitForWindowExposed() instead.
95
96 Waits for \a timeout milliseconds or until the \a widget's window is exposed.
97 Returns \c true if \c widget's window is exposed within \a timeout milliseconds, otherwise returns \c false.
98
99 This function does the same as qWaitForWindowExposed().
100
101 Example:
102
103 \code
104 QWidget widget;
105 widget.show();
106 QTest::qWaitForWindowShown(&widget);
107 \endcode
108
109 \sa qWaitForWindowActive(), qWaitForWindowExposed()
110*/
111
112QT_END_NAMESPACE
113

source code of qtbase/src/widgets/kernel/qtestsupport_widgets.cpp