View source for New signal slot syntax

{{Cleanup | reason=Auto-imported from ExpressionEngine.}}

[[Category:Developing_Qt::Qt Planning::Qt Public Roadmap]]


= New Signal Slot Syntax in Qt 5 =

This page was used to describe the new signal and slot syntax during its development. The feature is now released with Qt5.
* [http://woboq.com/blog/new-signals-slots-syntax-in-qt5.html Blog entry introducing it] [woboq.com]
* [http://woboq.com/blog/how-qt-signals-slots-work-part2-qt5.html How it works][woboq.com](implementation details)

'''Note''': This is in addition to the old string-based syntax which remains valid.

== Status ==

* Already merged in qtbase/master

== Connecting in Qt5 ==

There will be several ways to connect a signal in Qt5.

=== Old syntax ===

Qt5 will continue to support the [http://doc.qt.nokia.com/latest/qobject.html#connect old string-based syntax] for connecting signals and slots defined in a QObject or any class that inherits from QObject (including QWidget)

<code>
connect(sender, SIGNAL (valueChanged(QString,QString)),
 receiver, SLOT (updateValue(QString)) );
</code>

=== New: connecting to QObject member ===

Here's a new way to connect two QObjects and pass non-string objects:

<code>
connect(sender, &amp;Sender::valueChanged,
 receiver, &amp;Receiver::updateValue );
</code>

==== pros ====

* Compile time check of the existence of the signals and slot, of the types, or if the Q_OBJECT is missing.
* Argument can be by typedefs or with different namespace specifier, and it works.
* Possibility to automatically cast the types if there is implicit conversion (e.g. from QString to QVariant)
* It is possible to connect to any member function of QObject, not only slots.

==== cons ====

* More complicated syntax? (you need to specify the type of your object)
* Very complicated syntax in cases of overloads?
* Default arguments in slot is not supported anymore.

=== New: connecting to simple function ===

The new syntax can even connect to functions, not just QObjects:

<code>
connect(sender, &amp;Sender::valueChanged, someFunction);
</code>

==== pro ====

* can be used with tr1::bind
* can be used with c+''11 lambda expressions

<code>
connect(sender, &amp;Sender::valueChanged,
 tr1::bind(receiver, &amp;Receiver::updateValue, "senderValue", tr1::placeholder::_1) );

connect(sender, &amp;Sender::valueChanged, [=](const QString &amp;newValue) {
 receiver->updateValue("senderValue", newValue);
 } );
</code>

==== cons ====

* There is no automatic disconnection when the 'receiver' is destroyed

== Disconnecting in Qt5 ==

As you might expect, there are some changes in how connections can be terminated in Qt5, too.

=== Old way ===

You can disconnect in the old way (using SIGNAL, SLOT) but only if 

* you connected using the old way, or
* if you want to disconnect all the slots from a given signal using wild card character

=== Symetric to the function pointer one ===

<code>
disconnect(sender, &amp;Sender::valueChanged,
 receiver, &amp;Receiver::updateValue );

</code>

Only works if you connected with the symmetric call, with function pointers (Or you can also use 0 for wild card)
In particular, does not work with static function, functors or lambda functions.

=== New way using QMetaObject::Connection ===

<code>
QMetaObject::Connection m_connection;
//…
m_connection = QObject::connect(…);
//…
QObject::disconnect(m_connection);
</code>

Works in all cases, including lambda functions or functors.


== Asynchronous made easier. ==

With C11 it is possible to keep the code inline


<code>
void doYourStuff(const QByteArray &amp;page)
{
 QTcpSocket '''socket = new QTcpSocket;
 socket->connectToHost("qt.nokia.com", 80);
 QObject::connect(socket, &amp;QTcpSocket::connected, [socket, page] () {
 socket->write(QByteArray("GET " + page + ""));
 });
 QObject::connect(socket, &amp;QTcpSocket::readyRead, [socket] () {
 qDebug()<< "GOT DATA "<< socket->readAll();
 });
 QObject::connect(socket, &amp;QTcpSocket::disconnected, [socket] () {
 qDebug()<< "DISCONNECTED ";
 socket->deleteLater();
 });

 QObject::connect(socket, static_cast<void (QTcpSocket::''')(QAbstractSocket::SocketError)>(&amp;QAbstractSocket::error), [socket] (QAbstractSocket::SocketError) {
 qDebug()<< "ERROR " << socket->errorString();
 socket->deleteLater();
 });
}
</code>

Here's a QDialog without re-entering the eventloop, and keeping the code where it belongs:

<code>
void Doc::saveDocument() {
 QFileDialog '''dlg = new QFileDialog();
 dlg->open();
 QObject::connect(dlg, &amp;QDialog::finished, [dlg, this](int result) {
 if (result) {
 QFile file(dlg->selectedFiles().first());
 // …
 }
 dlg->deleteLater();
 });

}
</code>

Another example using "QHttpServer":http://blog.nikhilmarathe.me/2011/02/qhttpserver-web-apps-in-qt.html : http://pastebin.com/pfbTMqUm



== Error reporting ==

Tested with GCC.

Fortunately, IDEs like Qt Creator simplifies the function naming

=== forgot Q_OBJECT ===

<code>
#include <QtCore/QtCore>
class Goo : public QObject {
 Goo() {
 connect(this, &amp;Goo::someSignal, this, &amp;QObject::deleteLater);
 }
signals:
 void someSignal();
};
</code>

<code>
qobject.h: In member function 'void QObject::qt_check_for_QOBJECT_macro(const T&amp;amp;) const [with T = Goo]':
qobject.h:535:9: instantiated from 'static typename QtPrivate::QEnableIf<((int)(QtPrivate::FunctionPointer<Func>::ArgumentCount) >= (int)(QtPrivate::FunctionPointer<Func2>::ArgumentCount)), void'''>::Type QObject::connect(const typename QtPrivate::FunctionPointer<Func>::Object*, Func1, const typename QtPrivate::FunctionPointer<Func2>::Object*, Func2, Qt::ConnectionType) [with Func1 = void (Goo::''')(), Func2 = void (QObject::''')(), typename QtPrivate::QEnableIf<((int)(QtPrivate::FunctionPointer<Func>::ArgumentCount) >= (int)(QtPrivate::FunctionPointer<Func2>::ArgumentCount)), void*>::Type = void*, typename QtPrivate::FunctionPointer<Func>::Object = Goo, typename QtPrivate::FunctionPointer<Func2>::Object = QObject]'
main.cc:4:68: instantiated from here
qobject.h:353:5: error: void value not ignored as it ought to be
make: '''* [main.o] Error 1
</code>

=== Type mismatch ===

<code>

#include <QtCore/QtCore>
class Goo : public QObject {
Q_OBJECT
public:
 Goo() {
 connect(this, &amp;Goo::someSignal, this, &amp;Goo::someSlot1); //error
 connect(this, &amp;Goo::someSignal, this, &amp;Goo::someSlot2); //works
 }
signals:
 void someSignal(QString);
public:
 void someSlot1(int);
 void someSlot2(QVariant);
};
</code>

<code>
qobject.h: In static member function 'static typename QtPrivate::QEnableIf<((int)(QtPrivate::FunctionPointer<Func>::ArgumentCount) >= (int)(QtPrivate::FunctionPointer<Func2>::ArgumentCount)), void*>::Type QObject::connect(const typename QtPrivate::FunctionPointer<Func>::Object*, Func1, const typename QtPrivate::FunctionPointer<Func2>::Object*, Func2, Qt::ConnectionType) [with Func1 = void (Goo::''')(QString), Func2 = void (Goo::''')(int), typename QtPrivate::QEnableIf<((int)(QtPrivate::FunctionPointer<Func>::ArgumentCount) >= (int)(QtPrivate::FunctionPointer<Func2>::ArgumentCount)), void*>::Type = void*, typename QtPrivate::FunctionPointer<Func>::Object = Goo, typename QtPrivate::FunctionPointer<Func2>::Object = Goo]':
main.cc:6:62: instantiated from here
qobject.h:538:163: error: no type named 'IncompatibleSignalSlotArguments' in 'struct QtPrivate::CheckCompatibleArguments<QtPrivate::List<QString, void>, QtPrivate::List<int, void>, true>'
qobject.h: In static member function 'static void QtPrivate::FunctionPointer<Ret (Obj::''')(Arg1)>::call(QtPrivate::FunctionPointer<Ret (Obj::''')(Arg1)>::Function, Obj*, void''') [with Args = QtPrivate::List<QString, void>, Obj = Goo, Ret = void, Arg1 = int, QtPrivate::FunctionPointer<Ret (Obj::''')(Arg1)>::Function = void (Goo::''')(int)]':
qobject.h:501:13: instantiated from 'void QObject::QSlotObject<Func, Args>::call(QObject*, void*''') [with Func = void (Goo::''')(int), Args = QtPrivate::List<QString, void>, QObject = QObject]'
main.cc:14:2: instantiated from here
qobject.h:109:13: error: cannot convert 'QtPrivate::RemoveRef<QString>::Type' to 'int' in argument passing
make: ''''''* [main.o] Error 1
</code>

== Open Questions ==

=== Default arguments in slot ===

if you have code like this:

<code>
class A : public QObject { Q_OBJECT
 public slots:
 void someSlot(int foo = 0);
};
</code>

The old method allows you to connect that slot to a signal that does not have arguments.
But I cannot know with template code if a function has default arguments or not.
So this feature is disabled.

There was an implementation that falls back to the old method if there are more arguments in the slot than in the signal.
This however is quite inconsistent, since the old method does not perform type-checking or type conversion. It was removed from the patch that has been merged.

=== Overload ===

As you might see in the example, connecting to QAbstractSocket::error is not really beautiful since error has an overload, and taking the address of an overloaded function requires explicit casting.

Some macro could help (with c11 or ''typeof'' extensions)

The best thing is probably to recommend not to overload signals or slots …

… but we have been adding overloads in past minor releases of Qt because taking the address of a function was not a use case we support. But now this would be impossible without breaking the source compatibility.

=== Disconnect ===

Should QMetaObject::Connection have a disconnect() function?

The other problem is that there is no automatic disconnection for some object in the closure if we use the syntax that take a closure.
One could add a list of object in the disconnection, or a new function like QMetaObject::Connection::require

<code>
auto c = connect(sender, &amp;Sender::valueChanged, [=](const QString &amp;newValue) {
 receiver->updateValue("senderValue", newValue);
 } , QList<QObject> { receiver } ); // solution 1
c.require(receiver); // solution 2
</code>

=== Callbacks ===

Function such as QHostInfo::lookupHost or QTimer::singleShot or QFileDialog::open take a QObject receiver and char* slot.
This do not work for the new method.
If one wants to do callback c''+ way, one should use std::function (or tr1)
But we cannot use STL types in our ABI, so a QFunction should be done to copy std::function.
This is anyway irrelevant for QObject connections.

== History ==