New Signal Slot Syntax: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
(Convert ExpressionEngine links)
(overload - warning about static_cast)
(21 intermediate revisions by 12 users not shown)
Line 1: Line 1:
{{Cleanup | reason=Auto-imported from ExpressionEngine.}}
{{LangSwitch}}
[[Category:Developing Qt::Qt Planning::Qt Public Roadmap]]
[[Category:Developing Qt::Qt Planning]]
[[Category:Developing Qt::Qt5]]


[[Category:Developing_Qt::Qt Planning::Qt Public Roadmap]]
This page was used to describe the new signal and slot syntax during its development. The feature is now released with Qt 5.
 
* {{DocLink|signalsandslots-syntaxes||Differences between String-Based and Functor-Based Connections}} (Official documentation)
 
* [http://woboq.com/blog/new-signals-slots-syntax-in-qt5.html Introduction] (Woboq blog)
= New Signal Slot Syntax in Qt 5 =
* [http://woboq.com/blog/how-qt-signals-slots-work-part2-qt5.html Implementation Details] (Woboq blog)
 
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]
* [http://woboq.com/blog/how-qt-signals-slots-work-part2-qt5.html How it works] (implementation details)


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


== Status ==
== Connecting in Qt 5 ==


* Already merged in qtbase/master
There are several ways to connect a signal in Qt 5.
 
== Connecting in Qt5 ==
 
There will be several ways to connect a signal in Qt5.


=== Old syntax ===
=== 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)
Qt 5 continues to support the {{DocLink|QObject|connect|old string-based syntax}} for connecting signals and slots defined in a QObject or any class that inherits from QObject (including QWidget)


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


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


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


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


==== pros ====
==== Pros ====


* Compile time check of the existence of the signals and slot, of the types, or if the Q_OBJECT is missing.
* Compile time check of the existence of the signals and slot, of the types, or if the Q_OBJECT is missing.
Line 45: Line 44:
* It is possible to connect to any member function of QObject, not only slots.
* It is possible to connect to any member function of QObject, not only slots.


==== cons ====
==== Cons ====


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


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


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


==== pro ====
==== Pros ====


* can be used with tr1::bind
* Can be used with <tt>std::bind</tt>:
* can be used with c+''11 lambda expressions


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


connect(sender, &Sender::valueChanged, [=](const QString &newValue) {
* Can be used with C++11 lambda expressions:
receiver->updateValue("senderValue", newValue);
} );
</code>


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


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


== Disconnecting in Qt5 ==
* There is no automatic disconnection when the 'receiver' is destroyed because it's a functor with no QObject. However, since 5.2 there is an overload which adds a "context object". When that object is destroyed, the connection is broken (the context is also used for the thread affinity: the lambda will be called in the thread of the event loop of the object used as context).


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


=== Old way ===
=== Old way ===
Line 85: Line 93:
You can disconnect in the old way (using SIGNAL, SLOT) but only if  
You can disconnect in the old way (using SIGNAL, SLOT) but only if  


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


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


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


Only works if you connected with the symmetric call, with function pointers (Or you can also use 0 for wild card)
Only works if you connected with the symmetric call, with function pointers (Or you can also use 0 for wild card)
Line 101: Line 110:
=== New way using QMetaObject::Connection ===
=== New way using QMetaObject::Connection ===


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


Works in all cases, including lambda functions or functors.
Works in all cases, including lambda functions or functors.


== Asynchronous made easier ==


== Asynchronous made easier. ==
With C++11 it is possible to keep the code inline
 
With C11 it is possible to keep the code inline
 


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


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


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


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


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


== Error reporting ==
== Error reporting ==
Line 167: Line 183:
Fortunately, IDEs like Qt Creator simplifies the function naming
Fortunately, IDEs like Qt Creator simplifies the function naming


=== forgot Q_OBJECT ===
=== Missing Q_OBJECT in class definition ===
 
<pre>
#include <QtCore>


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


<code>
<pre>
qobject.h: In member function 'void QObject::qt_check_for_QOBJECT_macro(const T&&) const [with T = Goo]':
qobject.h: In member function 'void QObject::qt_check_for_QOBJECT_macro(const T&&) 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]'
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
main.cc:4:68: instantiated from here
qobject.h:353:5: error: void value not ignored as it ought to be
qobject.h:353:5: error: void value not ignored as it ought to be
make: '''* [main.o] Error 1
make: '''* [main.o] Error 1
</code>
</pre>


=== Type mismatch ===
=== Type mismatch ===


<code>
<pre>
#include <QtCore>


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


<code>
<pre>
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]':
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
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:538:163: error: no type named 'IncompatibleSignalSlotArguments' in 'struct  
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)]':
QtPrivate::CheckCompatibleArguments<QtPrivate::List<QString, void>, QtPrivate::List<int, void>, true>'
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]'
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
main.cc:14:2: instantiated from here
qobject.h:109:13: error: cannot convert 'QtPrivate::RemoveRef<QString>::Type' to 'int' in argument passing
qobject.h:109:13: error: cannot convert 'QtPrivate::RemoveRef<QString>::Type' to 'int' in argument passing
make: ''''''* [main.o] Error 1
make: *** [main.o] Error 1
</code>
</pre>


== Open Questions ==
== Open questions ==


=== Default arguments in slot ===
=== Default arguments in slot ===


if you have code like this:
If you have code like this:


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


The old method allows you to connect that slot to a signal that does not have arguments.
The old method allows you to connect that slot to a signal that does not have arguments.
Line 241: Line 281:
=== Overload ===
=== 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.
As you might see in the [[#Asynchronous made easier|example above]], connecting to QAbstractSocket::error is not really beautiful since error has an overload, and taking the address of an overloaded function requires explicit casting, e.g. a connection that previously was made as follows:
 
<code>connect(mySpinBox, SIGNAL(valueChanged(int)), mySlider, SLOT(setValue(int));</code>
 
cannot be simply converted to:
 
connect(
    mySpinBox, &QSpinBox::valueChanged,
    mySlider, &QSlider::setValue
);
 
...because {{DocLink|QSpinBox}} has {{DocLink|QSpinBox|signals|two signals named <tt>valueChanged()</tt>}} with different arguments. Instead, the new code needs to be:
 
connect(
    mySpinBox, static_cast<void (QSpinBox::*)(int)>(&QSpinBox::valueChanged),
    mySlider, &QSlider::setValue
);


Some macro could help (with c11 or ''typeof'' extensions)
Unfortunately, using an explicit cast here allows several types of errors to slip past the compiler. Adding a temporary variable assignment preserves these compile-time checks:
 
void (QSpinBox::* mySignal)(int) = &QSpinBox::valueChanged;
connect(
    mySpinBox, mySignal,
    mySlider, &QSlider::setValue
);
 
Some macro could help (with C++11 or ''typeof'' extensions). A template based solution was introduced in Qt 5.7: {{DocLink|QtGlobal|qOverload}}


The best thing is probably to recommend not to overload signals or slots …
The best thing is probably to recommend not to overload signals or slots …
Line 251: Line 315:
=== Disconnect ===
=== Disconnect ===


Should QMetaObject::Connection have a disconnect() function?
Should <tt>QMetaObject::Connection</tt> 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.
The other problem is that there is no automatic disconnection for some object in the closure if we use the syntax that takes a closure.
One could add a list of object in the disconnection, or a new function like QMetaObject::Connection::require
One could add a list of objects in the disconnection, or a new function like <tt>QMetaObject::Connection::require</tt>
 
// Solution 1
auto c = connect(
    sender, &Sender::valueChanged,
    [=]( const QString &newValue ) { receiver->updateValue( "senderValue", newValue ); },
    QList<QObject> { receiver }
);
// Solution 2 (needs a new definition of QMetaObject::Connection::require)
c.require( receiver );


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


=== Callbacks ===
=== Callbacks ===


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

Revision as of 15:26, 24 December 2018

En Ar Bg De El Es Fa Fi Fr Hi Hu It Ja Kn Ko Ms Nl Pl Pt Ru Sq Th Tr Uk Zh

This page was used to describe the new signal and slot syntax during its development. The feature is now released with Qt 5.

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

Connecting in Qt 5

There are several ways to connect a signal in Qt 5.

Old syntax

Qt 5 continues to support the old string-based syntax for connecting signals and slots defined in a QObject or any class that inherits from QObject (including QWidget)

connect(
    sender, SIGNAL( valueChanged( QString, QString ) ),
    receiver, SLOT( updateValue( QString ) )
);

New: connecting to QObject member

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

connect(
    sender, &Sender::valueChanged,
    receiver, &Receiver::updateValue
);

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? (see below)
  • Default arguments in slot is not supported anymore.

New: connecting to simple function

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

connect(
    sender, &Sender::valueChanged,
    someFunction
);

Pros

  • Can be used with std::bind:
connect(
    sender, &Sender::valueChanged,
    std::bind( &Receiver::updateValue, receiver, "senderValue", std::placeholders::_1 )
);
  • Can be used with C++11 lambda expressions:
connect(
    sender, &Sender::valueChanged,
    [=]( const QString &newValue ) { receiver->updateValue( "senderValue", newValue ); }
);

Cons

  • There is no automatic disconnection when the 'receiver' is destroyed because it's a functor with no QObject. However, since 5.2 there is an overload which adds a "context object". When that object is destroyed, the connection is broken (the context is also used for the thread affinity: the lambda will be called in the thread of the event loop of the object used as context).

Disconnecting in Qt 5

As you might expect, there are some changes in how connections can be terminated in Qt 5, 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

disconnect(
    sender, &Sender::valueChanged,
    receiver, &Receiver::updateValue
);

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

QMetaObject::Connection m_connection;
// …
m_connection = QObject::connect( /* … */ );
// …
QObject::disconnect( m_connection );

Works in all cases, including lambda functions or functors.

Asynchronous made easier

With C++11 it is possible to keep the code inline

void doYourStuff( const QByteArray &page )
{
    QTcpSocket *socket = new QTcpSocket;
    socket->connectToHost( "qt.io", 80 );
    QObject::connect(
        socket, &QTcpSocket::connected,
        [socket, page]() { socket->write( QByteArray( "GET " + page + "" ) ); }
    );
    QObject::connect(
        socket, &QTcpSocket::readyRead,
        [socket]() { qDebug() << "GOT DATA " << socket->readAll(); }
    );
    QObject::connect(
        socket, &QTcpSocket::disconnected,
        [socket]() {
            qDebug() << "DISCONNECTED ";
            socket->deleteLater();
        }
    );
    QObject::connect(
        socket, static_cast<void ( QTcpSocket::* )( QAbstractSocket::SocketError )>( &QAbstractSocket::error ),
        [socket]( QAbstractSocket::SocketError ) {
            qDebug() << "ERROR " << socket->errorString();
            socket->deleteLater();
        }
    );
}

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

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

Another example using QHttpServer : http://pastebin.com/pfbTMqUm

Error reporting

Tested with GCC.

Fortunately, IDEs like Qt Creator simplifies the function naming

Missing Q_OBJECT in class definition

#include <QtCore>

class Goo : public QObject
{
    Goo() {
        connect( this, &Goo::someSignal, this, &QObject::deleteLater );
    }
    
    signals:
        void someSignal();
};
qobject.h: In member function 'void QObject::qt_check_for_QOBJECT_macro(const T&&) 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

Type mismatch

#include <QtCore>

class Goo : public QObject
{
    Q_OBJECT
    
    public:
        Goo() {
            connect( this, &Goo::someSignal, this, &Goo::someSlot1 ); // Error
            connect( this, &Goo::someSignal, this, &Goo::someSlot2 ); // Works
        }
        
    signals:
        void someSignal( QString );
        
    public:
        void someSlot1( int );
        void someSlot2( QVariant );
};
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

Open questions

Default arguments in slot

If you have code like this:

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

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 above, connecting to QAbstractSocket::error is not really beautiful since error has an overload, and taking the address of an overloaded function requires explicit casting, e.g. a connection that previously was made as follows:

connect(mySpinBox, SIGNAL(valueChanged(int)), mySlider, SLOT(setValue(int));

cannot be simply converted to:

connect(
    mySpinBox, &QSpinBox::valueChanged,
    mySlider, &QSlider::setValue
);

...because QSpinBox has two signals named valueChanged() with different arguments. Instead, the new code needs to be:

connect(
    mySpinBox, static_cast<void (QSpinBox::*)(int)>(&QSpinBox::valueChanged),
    mySlider, &QSlider::setValue
);

Unfortunately, using an explicit cast here allows several types of errors to slip past the compiler. Adding a temporary variable assignment preserves these compile-time checks:

void (QSpinBox::* mySignal)(int) = &QSpinBox::valueChanged;
connect(
    mySpinBox, mySignal,
    mySlider, &QSlider::setValue
);

Some macro could help (with C++11 or typeof extensions). A template based solution was introduced in Qt 5.7: qOverload

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 takes a closure. One could add a list of objects in the disconnection, or a new function like QMetaObject::Connection::require

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

// Solution 2 (needs a new definition of QMetaObject::Connection::require)
c.require( receiver );


Callbacks

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