|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the documentation of the Qt Toolkit. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 /*! |
|
43 \class QSignalSpy |
|
44 \inmodule QtTest |
|
45 |
|
46 \brief The QSignalSpy class enables introspection of signal emission. |
|
47 |
|
48 QSignalSpy can connect to any signal of any object and records its emission. |
|
49 QSignalSpy itself is a list of QVariant lists. Each emission of the signal |
|
50 will append one item to the list, containing the arguments of the signal. |
|
51 |
|
52 The following example records all signal emissions for the \c clicked() signal |
|
53 of a QCheckBox: |
|
54 |
|
55 \snippet doc/src/snippets/code/doc_src_qsignalspy.qdoc 0 |
|
56 |
|
57 \c{spy.takeFirst()} returns the arguments for the first emitted signal, as a |
|
58 list of QVariant objects. The \c clicked() signal has a single bool argument, |
|
59 which is stored as the first entry in the list of arguments. |
|
60 |
|
61 The example below catches a signal from a custom object: |
|
62 |
|
63 \snippet doc/src/snippets/code/doc_src_qsignalspy.qdoc 1 |
|
64 |
|
65 \bold {Note:} Non-standard data types need to be registered, using |
|
66 the qRegisterMetaType() function, before you can create a |
|
67 QSignalSpy. For example: |
|
68 |
|
69 \snippet doc/src/snippets/code/doc_src_qsignalspy.qdoc 2 |
|
70 |
|
71 To retrieve the \c QModelIndex, you can use qvariant_cast: |
|
72 |
|
73 \snippet doc/src/snippets/code/doc_src_qsignalspy.qdoc 3 |
|
74 */ |
|
75 |
|
76 /*! \fn QSignalSpy::QSignalSpy(QObject *object, const char *signal) |
|
77 |
|
78 Constructs a new QSignalSpy that listens for emissions of the \a signal |
|
79 from the QObject \a object. Neither \a signal nor \a object can be null. |
|
80 |
|
81 Example: |
|
82 \snippet doc/src/snippets/code/doc_src_qsignalspy.qdoc 4 |
|
83 */ |
|
84 |
|
85 /*! \fn QSignalSpy::isValid() const |
|
86 |
|
87 Returns true if the signal spy listens to a valid signal, otherwise false. |
|
88 */ |
|
89 |
|
90 /*! \fn QSignalSpy::signal() const |
|
91 |
|
92 Returns the normalized signal the spy is currently listening to. |
|
93 */ |
|
94 |
|
95 /*! \fn int QSignalSpy::qt_metacall(QMetaObject::Call call, int id, void **a) |
|
96 \internal |
|
97 */ |
|
98 |