summaryrefslogtreecommitdiffstats
path: root/src/testlib/qsignalspy.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/testlib/qsignalspy.qdoc')
-rw-r--r--src/testlib/qsignalspy.qdoc124
1 files changed, 0 insertions, 124 deletions
diff --git a/src/testlib/qsignalspy.qdoc b/src/testlib/qsignalspy.qdoc
deleted file mode 100644
index 85b91589f7..0000000000
--- a/src/testlib/qsignalspy.qdoc
+++ /dev/null
@@ -1,124 +0,0 @@
-// Copyright (C) 2019 The Qt Company Ltd.
-// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
-
-/*!
- \class QSignalSpy
- \inmodule QtTest
-
- \brief The QSignalSpy class enables introspection of signal emission.
-
- QSignalSpy can connect to any signal of any object and records its emission.
- QSignalSpy itself is a list of QVariant lists. Each emission of the signal
- will append one item to the list, containing the arguments of the signal.
-
- The following example records all signal emissions for the \c clicked() signal
- of a QCheckBox:
-
- \snippet code/doc_src_qsignalspy.cpp 0
-
- \c{spy.takeFirst()} returns the arguments for the first emitted signal, as a
- list of QVariant objects. The \c clicked() signal has a single bool argument,
- which is stored as the first entry in the list of arguments.
-
- The example below catches a signal from a custom object:
-
- \snippet code/doc_src_qsignalspy.cpp 1
-
- \note Non-standard data types need to be registered, using
- the qRegisterMetaType() function, before you can create a
- QSignalSpy. For example:
-
- \snippet code/doc_src_qsignalspy.cpp 2
-
- To retrieve the instance, you can use qvariant_cast:
-
- \snippet code/doc_src_qsignalspy.cpp 3
-
- \section1 Verifying Signal Emissions
-
- The QSignalSpy class provides an elegant mechanism for capturing the list
- of signals emitted by an object. However, you should verify its validity
- after construction. The constructor does a number of sanity checks, such as
- verifying that the signal to be spied upon actually exists. To make the
- diagnosis of test failures easier, the results of these checks should be
- checked by calling \c QVERIFY(spy.isValid()) before proceeding further with
- a test.
-
- \sa QVERIFY()
- */
-
-/*! \fn QSignalSpy::QSignalSpy(const QObject *object, const char *signal)
-
- Constructs a new QSignalSpy that listens for emissions of the \a signal
- from the QObject \a object. If QSignalSpy is not able to listen for a
- valid signal (for example, because \a object is \nullptr or \a signal does
- not denote a valid signal of \a object), an explanatory warning message
- will be output using qWarning() and subsequent calls to \c isValid() will
- return false.
-
- Example:
- \snippet code/doc_src_qsignalspy.cpp 4
-*/
-
-/*! \fn template <typename PointerToMemberFunction> QSignalSpy::QSignalSpy(const QObject *object, PointerToMemberFunction signal)
- \since 5.4
-
- Constructs a new QSignalSpy that listens for emissions of the \a signal
- from the QObject \a object. If QSignalSpy is not able to listen for a
- valid signal (for example, because \a object is \nullptr or \a signal does
- not denote a valid signal of \a object), an explanatory warning message
- will be output using qWarning() and subsequent calls to \c isValid() will
- return false.
-
- Example:
- \snippet code/doc_src_qsignalspy.cpp 6
-*/
-
-/*! \fn QSignalSpy::QSignalSpy(const QObject *obj, const QMetaMethod &signal)
- \since 5.14
-
- Constructs a new QSignalSpy that listens for emissions of the \a signal
- from the QObject \a obj. If QSignalSpy is not able to listen for a
- valid signal (for example, because \a obj is \nullptr or \a signal does
- not denote a valid signal of \a obj), an explanatory warning message
- will be output using qWarning() and subsequent calls to \c isValid() will
- return false.
-
- This constructor is convenient to use when Qt's meta-object system is
- heavily used in a test.
-
- Basic usage example:
- \snippet code/doc_src_qsignalspy.cpp 7
-
- Imagine we need to check whether all properties of the QWindow class
- that represent minimum and maximum dimensions are properly writable.
- The following example demonstrates one of the approaches:
- \snippet code/doc_src_qsignalspy.cpp 8
-*/
-
-/*! \fn QSignalSpy::isValid() const
-
- Returns \c true if the signal spy listens to a valid signal, otherwise false.
-*/
-
-/*! \fn QSignalSpy::signal() const
-
- Returns the normalized signal the spy is currently listening to.
-*/
-
-/*! \fn int QSignalSpy::qt_metacall(QMetaObject::Call call, int id, void **a)
- \internal
-*/
-
-/*! \fn QSignalSpy::wait(int timeout)
-
- \since 5.0
-
- Starts an event loop that runs until the given signal is received.
- Optionally the event loop can return earlier on a \a timeout (in milliseconds).
-
- Returns \c true if the signal was emitted at least once in \a timeout milliseconds, otherwise returns \c false.
-
- Example:
- \snippet code/doc_src_qsignalspy.cpp 5
-*/