Класс QWebChannel
Выставляет QObjects для удалённых HTML-клиентов. Подробнее...
| Заголовок: | #include <QWebChannel> |
| qmake: | QT += webchannel |
| С момента: | Qt 5.4 |
| Наследует: | QObject |
Свойства
- blockUpdates : bool
- 1 свойство унаследовано от QObject
Открытые функции
| QWebChannel(QObject *parent = Q_NULLPTR) | |
| virtual | ~QWebChannel() |
| bool | blockUpdates() const |
| void | deregisterObject(QObject *object) |
| void | registerObject(const QString &id, QObject *object) |
| void | registerObjects(const QHash<QString, QObject *> &objects) |
| QHash<QString, QObject *> | registeredObjects() const |
| void | setBlockUpdates(bool block) |
- 34 открытых функции унаследованы от QObject
Открытые слоты
| void | connectTo(QWebChannelAbstractTransport *transport) |
| void | disconnectFrom(QWebChannelAbstractTransport *transport) |
- 1 открытый слот унаследован от QObject
Сигналы
| void | blockUpdatesChanged(bool block) |
- 2 сигнала унаследованы от QObject
Дополнительные унаследованные члены
- 1 открытая переменная унаследована от QObject
- 10 статические открытые члены унаследованы от QObject
- 9 защищённые функции унаследованы от QObject
- 2 защищённые переменные унаследованы от QObject
Подробное описание
Выставляет QObjects для удалённых HTML-клиентов.
Класс QWebChannel заполняет пробел между приложениями на C++ и приложениями на HTML/JavaScript. Опубликовав производный от QObject объект в QWebChannel и используя qwebchannel.js со стороны HTML, вы можете прозрачно получать доступ к свойствам, открытым слотам и методам QObject. Ручное передачу сообщений и сериализацию данных не требуется, обновления свойств и отправка сигналов на стороне C++ автоматически передаются потенциально удалённым HTML-клиентам. На стороне клиента для каждого опубликованного C++ QObject будет создан JavaScript-объект. Он отражает API объекта C++ и поэтому интуитивно понятен.
API QWebChannel на C++ позволяет взаимодействовать с любым HTML-клиентом, который может выполняться на локальном или удалённом компьютере. Единственное ограничение заключается в том, что HTML-клиент поддерживает используемые JavaScript-функции qwebchannel.js. Таким образом, можно взаимодействовать практически с любым современным HTML-браузером или автономной JavaScript-средой выполнения, такой как node.js.
Также существует декларативный API WebChannel.
См. также Пример Qt WebChannel для автономных приложений и API JavaScript.
Документация по свойствам
blockUpdates : bool
Если установлено в true, обновления блокируются, и удалённые клиенты не будут уведомлены об изменениях свойств.
Изменения записываются и отправляются клиентам, как только обновления вновь станут разблокированными, установив это свойство в false. По умолчанию обновления не блокируются.
Функции доступа:
| bool | blockUpdates() const |
| void | setBlockUpdates(bool block) |
Сигнал уведомления:
| void | blockUpdatesChanged(bool block) |
Документация по членам-функциям
QWebChannel::QWebChannel(QObject *parent = Q_NULLPTR)
Конструирует объект QWebChannel с указанным parent.
Обратите внимание, что QWebChannel полностью готов к работе только после подключения к QWebChannelAbstractTransport. HTML-клиенты также должны быть должным образом настроены с помощью qwebchannel.js.
[virtual] QWebChannel::~QWebChannel()
Удаляет QWebChannel.
[slot] void QWebChannel::connectTo(QWebChannelAbstractTransport *transport)
Подключает QWebChannel к указанному объекту transport.
Объект транспорта затем обрабатывает общение между приложением на C++ и удалённым HTML-клиентом.
См. также QWebChannelAbstractTransport и QWebChannel::disconnectFrom().
void QWebChannel::deregisterObject(QObject *object)
Отменяет регистрацию указанного объекта object из QWebChannel.
Удалённые клиенты получат сигнал destroyed для данного объекта.
Примечание: Эта функция может вызываться через метаобъектную систему и из QML. См. Q_INVOKABLE.
См. также QWebChannel::registerObjects(), QWebChannel::registerObject(), и QWebChannel::registeredObjects().
[slot] void QWebChannel::disconnectFrom(QWebChannelAbstractTransport *transport)
Отключает QWebChannel от объекта transport.
См. также QWebChannel::connectTo().
void QWebChannel::registerObject(const QString &id, QObject *object)
Регистрирует один объект в QWebChannel.
Свойства, сигналы и открытые методы объекта object публикуются для удалённых клиентов. Там затем создаётся объект с идентификатором id.
Примечание: В настоящее время ограничением является то, что объекты должны быть зарегистрированы до инициализации любого клиента.
Примечание: Эта функция может вызываться через метаобъектную систему и из QML. См. Q_INVOKABLE.
См. также QWebChannel::registerObjects(), QWebChannel::deregisterObject(), и QWebChannel::registeredObjects().
void QWebChannel::registerObjects(const QHash<QString, QObject *> &objects)
Регистрирует группу объектов в QWebChannel.
Свойства, сигналы и открытые вызываемые методы объектов публикуются для удалённых клиентов. Там затем создаётся объект с идентификатором, используемым в качестве ключа в карте objects.
Примечание: В настоящее время ограничением является то, что объекты должны быть зарегистрированы до инициализации любого клиента.
См. также QWebChannel::registerObject(), QWebChannel::deregisterObject(), и QWebChannel::registeredObjects().
END_OF_DOCUMENT_MARKERQHash<QString, QObject *> QWebChannel::registeredObjects() const
Возвращает карту зарегистрированных объектов, опубликованных для удаленных клиентов.
См. также QWebChannel::registerObjects(), QWebChannel::registerObject() и QWebChannel::deregisterObject().
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/archives/qt-5.11/qwebchannel.html