diff options
Diffstat (limited to 'src/widgets/kernel/qtestsupport_widgets.cpp')
| -rw-r--r-- | src/widgets/kernel/qtestsupport_widgets.cpp | 29 |
1 files changed, 16 insertions, 13 deletions
diff --git a/src/widgets/kernel/qtestsupport_widgets.cpp b/src/widgets/kernel/qtestsupport_widgets.cpp index 0056bebdc6..530b9e1bc6 100644 --- a/src/widgets/kernel/qtestsupport_widgets.cpp +++ b/src/widgets/kernel/qtestsupport_widgets.cpp @@ -49,9 +49,16 @@ QT_BEGIN_NAMESPACE /*! \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. - Returns \c true if \c widget's window 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. + + \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() */ @@ -65,20 +72,16 @@ Q_WIDGETS_EXPORT Q_REQUIRED_RESULT bool QTest::qWaitForWindowActive(QWidget *wid /*! \since 5.0 - 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. - - 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 Q_REQUIRED_RESULT bool QTest::qWaitForWindowExposed(QWidget *widget, int timeout) { |