New Signal Slot Syntax/ru: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
(replacing <code> with <pre> + minor edits)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{LangSwitch}}
{{LangSwitch}}
[[Category:Developing_Qt::Qt Planning::Qt Public Roadmap]]
[[Category:Developing Qt::Qt Planning::Qt Public Roadmap]]
[[Category:Developing_Qt::Qt Planning]]
[[Category:Developing Qt::Qt Planning]]
[[Category:Developing_Qt]]
[[Category:Developing Qt::Qt5]]


= Новый синтаксис сигналов и слотов в Qt 5 =
= Новый синтаксис сигналов и слотов в Qt 5 =
Line 11: Line 11:


'''Подсказка''': Старый синтаксис использования сигналов и слотов остается по прежнему и будет работать.
'''Подсказка''': Старый синтаксис использования сигналов и слотов остается по прежнему и будет работать.
== Состояние ==
* Уже слито в qtbase/master


== Связи в Qt5 ==
== Связи в Qt5 ==
Line 22: Line 18:
=== Старый синтаксис ===
=== Старый синтаксис ===


В Qt 5 по прежнему осталась возможность использования старого синтаксиса для связи сигнала и слотов [http://doc.qt.io/qt-5/qobject.html#connect old string-based syntax] определенные в QObject или любом наследнике класса QObject (включая QWidget).
В Qt 5 по прежнему осталась возможность использования старого синтаксиса для связи сигнала и слотов [http://doc.qt.io/qt-5/qobject.html#connect old string-based syntax] определенные в QObject или любом наследнике класса QObject (включая 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>


=== Новый синтаксис ===
=== Новый синтаксис ===
Line 33: Line 31:
Способ связи сигнала и слота между двумя объектами класса QObjects и не строковыми параметрами:
Способ связи сигнала и слота между двумя объектами класса QObjects и не строковыми параметрами:


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


==== pros ====
==== Плюсы ====


* Проверка существования сигнала и слота во время компиляции.
* Проверка существования сигнала и слота во время компиляции.
Line 45: Line 45:
* Возможность связать любую член-функцию QObject, необязательно слот.
* Возможность связать любую член-функцию QObject, необязательно слот.


==== cons ====
==== Минусы ====


* Более сложный и непонятный синтаксис? (Необходимо указывать явно тип объекта)
* Более сложный и непонятный синтаксис? (Необходимо указывать явно тип объекта)
Line 55: Line 55:
Связь с простой свободной функцией:
Связь с простой свободной функцией:


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


==== pro ====
==== Плюсы ====


* можно использовать tr1::bind
* можно использовать <tt>std::bind</tt>
* можно использовать лямбда-выражения c+''11


<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>
 
* можно использовать лямбда-выражения C++11
 
<pre>
connect(
    sender, &Sender::valueChanged,
    [=]( const QString &newValue ) { receiver->updateValue( "senderValue", newValue ); }
);
</pre>


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


==== cons ====
==== Минусы ====


* Нет способа автоматического разрыва связи когда удалится объект 'receiver', потому что функтор не является QObject. Однако, начиная с версии Qt 5.2 существует перегрузка, которая добавляет "контекст объекта". Когда объект уничтожен, связь разрывается.
* Нет способа автоматического разрыва связи когда удалится объект 'receiver', потому что функтор не является QObject. Однако, начиная с версии Qt 5.2 существует перегрузка, которая добавляет "контекст объекта". Когда объект уничтожен, связь разрывается.
Line 90: Line 100:
=== Так же как и при установке связи ===
=== Так же как и при установке связи ===


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


Этот способ работает только если связь была установлена таким же способом.
Этот способ работает только если связь была установлена таким же способом.
Line 101: Line 110:
=== Новый способ с использованием QMetaObject::Connection ===
=== Новый способ с использованием QMetaObject::Connection ===


<code>
<pre>
QMetaObject::Connection m_connection;
QMetaObject::Connection m_connection;
//…
//…
Line 107: Line 116:
//…
//…
QObject::disconnect(m_connection);
QObject::disconnect(m_connection);
</code>
</pre>


Этот способ работает и с лямбда-выражениями и с функторами..
Этот способ работает и с лямбда-выражениями и с функторами..
Line 116: Line 125:




<code>
<pre>
void doYourStuff(const QByteArray &page)
void doYourStuff(const QByteArray &page)
{
{
Line 138: Line 147:
  });
  });
}
}
</code>
</pre>


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();
  QFileDialog *dlg = new QFileDialog();
Line 155: Line 164:


}
}
</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
Line 167: Line 176:
=== forgot Q_OBJECT ===
=== forgot Q_OBJECT ===


<code>
<pre>
#include <QtCore>
#include <QtCore>
class Goo : public QObject {
class Goo : public QObject {
Line 176: Line 185:
  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)
qobject.h:535:9: instantiated from 'static typename QtPrivate::QEnableIf<((int)
Line 191: Line 200:
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>
Line 211: Line 220:
  void someSlot2(QVariant);
  void someSlot2(QVariant);
};
};
</code>
</pre>


<code>
<pre>
qobject.h: In static member function 'static typename QtPrivate::QEnableIf<((int)
qobject.h: In static member function 'static typename QtPrivate::QEnableIf<((int)
(QtPrivate::FunctionPointer<Func>::ArgumentCount) >= (int)
(QtPrivate::FunctionPointer<Func>::ArgumentCount) >= (int)
Line 233: Line 242:
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 ==
Line 241: Line 250:
if you have code like this:
if you have code like this:


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


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 282: Line 291:
One could add a list of object in the disconnection, or a new function like QMetaObject::Connection::require
One could add a list of object in the disconnection, or a new function like QMetaObject::Connection::require


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


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

Latest revision as of 01:41, 16 May 2021

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

Новый синтаксис сигналов и слотов в Qt 5

На этой странице можно узнать о новом синтаксисе сигналов и слотов, который используется в последних версиях Qt 5.

Подсказка: Старый синтаксис использования сигналов и слотов остается по прежнему и будет работать.

Связи в Qt5

В Qt5 имеется несколько способов связать сигналы и слоты.

Старый синтаксис

В Qt 5 по прежнему осталась возможность использования старого синтаксиса для связи сигнала и слотов old string-based syntax определенные в QObject или любом наследнике класса QObject (включая QWidget)

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

Новый синтаксис

Способ связи сигнала и слота между двумя объектами класса QObjects и не строковыми параметрами:

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

Плюсы

  • Проверка существования сигнала и слота во время компиляции.
  • Аргумент может иметь псевдоним typedefs или находится в другом пространстве имен.
  • Автоматическое преобразование типов при неявном объявлении (например, из QString в QVariant)
  • Возможность связать любую член-функцию QObject, необязательно слот.

Минусы

  • Более сложный и непонятный синтаксис? (Необходимо указывать явно тип объекта)
  • Сложный синтаксис в случае перегрузки? (см. ниже)
  • Не поддерживаются значения параметров по умолчанию в слотах.

Связь с простой свободной функцией

Связь с простой свободной функцией:

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

Плюсы

  • можно использовать std::bind
connect(
    sender, &Sender::valueChanged,
    std::bind( &Receiver::updateValue, receiver, "senderValue", std::placeholders::_1 )
);
  • можно использовать лямбда-выражения C++11
connect(
    sender, &Sender::valueChanged,
    [=]( const QString &newValue ) { receiver->updateValue( "senderValue", newValue ); }
);


Минусы

  • Нет способа автоматического разрыва связи когда удалится объект 'receiver', потому что функтор не является QObject. Однако, начиная с версии Qt 5.2 существует перегрузка, которая добавляет "контекст объекта". Когда объект уничтожен, связь разрывается.

Разрыв связи в Qt 5

В Qt 5 так же произошли изменения при разрыве соединения между сигналом и слотом.

Старый способ

Для разрыва соединения по прежнему можно использовать старый способ, только если

  • связь была установлена тоже старым способом
  • если необходимо разъединить все слоты с сигналом, используя шаблон-маску

Так же как и при установке связи

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

Этот способ работает только если связь была установлена таким же способом. Не работает со статическими функциями, функторами и лямбда-выражениями.

Новый способ с использованием QMetaObject::Connection

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

Этот способ работает и с лямбда-выражениями и с функторами..

Asynchronous made easier

With C11 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

forgot Q_OBJECT

#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);

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

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

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