1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the test suite of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\qmlclass SignalSpy SignalSpy
\brief The SignalSpy item enables introspection of signal emission.
\since 4.8
\ingroup qtest::qml
In the following example, a SignalSpy is installed to watch the
"clicked" signal on a user-defined Button element. When the signal
is emitted, the \l count property on the spy will be increased.
\code
Button {
id: button
SignalSpy {
id: spy
target: button
signalName: "clicked"
}
TestCase {
name: "ButtonClick"
function test_click() {
compare(spy.count, 0)
button.clicked();
compare(spy.count, 1)
}
}
}
\endcode
The above style of test is suitable for signals that are emitted
synchronously. For asynchronous signals, the wait() method can be
used to block the test until the signal occurs (or a timeout expires).
\sa TestCase
*/
/*!
\qmlproperty object SignalSpy::target
This property defines the target object that will be used to
listen for emissions of the \l signalName signal.
\sa signalName, count
*/
/*!
\qmlproperty string SignalSpy::signalName
This property defines the name of the signal on \l target to
listen for.
\sa target, count
*/
/*!
\qmlproperty int SignalSpy::count
This property defines the number of times that \l signalName has
been emitted from \l target since the last call to clear().
\sa target, signalName, clear()
*/
/*!
\qmlmethod SignalSpy::clear()
Clears \l count to 0.
\sa count, wait()
*/
/*!
\qmlmethod SignalSpy::wait(timeout = 5000)
Waits for the signal \l signalName on \l target to be emitted,
for up to \a timeout milliseconds. The test case will fail if
the signal is not emitted.
\code
SignalSpy {
id: spy
target: button
signalName: "clicked"
}
function test_async_click() {
...
// do something that will cause clicked() to be emitted
...
spy.wait()
compare(spy.count, 1)
}
\endcode
There are two possible scenarios: the signal has already been
emitted when wait() is called, or the signal has not yet been
emitted. The wait() function handles the first scenario by immediately
returning if the signal has already occurred.
The clear() method can be used to discard information about signals
that have already occurred to synchronize wait() with future signal
emissions.
\sa clear(), TestCase::tryCompare()
*/
|
