Merge branch 'master' of git@scm.dev.nokia.troll.no:qt/qt

1 files changed, 98 insertions, 0 deletions

diff --git a/doc/src/classes/qsignalspy.qdoc b/doc/src/classes/qsignalspy.qdoc
new file mode 100644
index 000000000..4ee7590f0
--- /dev/null
+++ b/doc/src/classes/qsignalspy.qdoc
@@ -0,0 +1,98 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the either Technology Preview License Agreement or the
+** Beta Release License Agreement.
+**
+** 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, Nokia gives you certain
+** additional rights. These rights are described in the Nokia Qt LGPL
+** Exception version 1.0, 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.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at http://www.qtsoftware.com/contact.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*! 
+    \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 doc/src/snippets/code/doc_src_qsignalspy.qdoc 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 doc/src/snippets/code/doc_src_qsignalspy.qdoc 1
+
+    \bold {Note:} Non-standard data types need to be registered, using
+    the qRegisterMetaType() function, before you can create a
+    QSignalSpy. For example:
+
+    \snippet doc/src/snippets/code/doc_src_qsignalspy.qdoc 2
+
+    To retrieve the \c QModelIndex, you can use qvariant_cast:
+
+    \snippet doc/src/snippets/code/doc_src_qsignalspy.qdoc 3
+ */
+
+/*! \fn QSignalSpy::QSignalSpy(QObject *object, const char *signal)
+
+    Constructs a new QSignalSpy that listens for emissions of the \a signal
+    from the QObject \a object. Neither \a signal nor \a object can be null.
+
+    Example:
+    \snippet doc/src/snippets/code/doc_src_qsignalspy.qdoc 4
+*/
+
+/*! \fn QSignalSpy::isValid() const
+
+    Returns 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
+*/
+