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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the test suite 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/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 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, Digia gives you certain additional
** rights. These rights are described in the Digia 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.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\qmltype SignalSpy
\instantiates SignalSpy
\inqmlmodule QtTest
\brief Enables introspection of signal emission
\ingroup qtquick-utility
\since 4.8
\ingroup qtest::qml
In the following example, a SignalSpy is installed to watch the
"clicked" signal on a user-defined Button type. 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, {Qt Quick Test Reference Documentation}
*/
/*!
\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 list SignalSpy::signalArguments
This property holds a list of emitted signal arguments. Each emission of the signal will append one item to the list, containing the arguments of the signal.
When connecting to a new \l target or new \l signalName or calling the \l clear() method, the \l signalArguments will be reset to empty.
\sa signalName, clear()
\readonly
*/
/*!
\qmlproperty bool SignalSpy::valid
This property defines the current signal connection status. It will be true when the \l signalName of the \l target is connected successfully, otherwise it will be false.
\sa count, target, signalName, clear()
\readonly
*/
/*!
\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()
\readonly
*/
/*!
\qmlmethod SignalSpy::clear()
Clears \l count to 0, resets \l valid to false and clears the \l signalArguments to empty.
\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()
*/
|
