Spec-Zone.ru › Qt 5.13

Класс QWebChannel

Предоставляет доступ к объектам QObject удалённым HTML-клиентам. Подробнее...

Заголовок: #include <QWebChannel>
qmake: QT += webchannel
С момента: Qt 5.4
Наследует: QObject

Этот класс был представлен в Qt 5.4.

  • Список всех членов, включая наследуемые

Свойства

  • blockUpdates : bool

Публичные функции

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)

Публичные слоты

void connectTo(QWebChannelAbstractTransport *transport)
void disconnectFrom(QWebChannelAbstractTransport *transport)

Сигналы

void blockUpdatesChanged(bool block)

Подробное описание

Класс QWebChannel заполняет пробел между приложениями на C++ и HTML/JavaScript-приложениями. Публикуя объект, производный от QObject, в QWebChannel, и используя qwebchannel.js со стороны HTML, можно прозрачно получать доступ к свойствам и публичным слотам и методам объекта QObject. Не требуется ручная передача сообщений и сериализация данных, обновления свойств и отправка сигналов на стороне C++ автоматически передаются потенциально удалённым HTML-клиентам. На стороне клиента для каждого опубликованного C++ объекта QObject будет создан JavaScript-объект. Он отражает API объекта C++, и поэтому его интуитивно удобно использовать.

API C++ класса QWebChannel позволяет общаться с любым HTML-клиентом, который может работать на локальном или даже удалённом компьютере. Единственное ограничение заключается в том, что HTML-клиент поддерживает JavaScript-функции, используемые в qwebchannel.js. Таким образом, можно взаимодействовать практически с любым современным HTML-браузером или автономной JavaScript-средой выполнения, такой как node.js.

Также существует декларативный WebChannel API.

См. также Пример 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.

[slot] void QWebChannel::connectTo(QWebChannelAbstractTransport *transport)

Подключает QWebChannel к заданному объекту transport.

Объект транспорта обрабатывает общение между приложением на C++ и удалённым HTML-клиентом.

См. также QWebChannelAbstractTransport и QWebChannel::disconnectFrom().

[slot] void QWebChannel::disconnectFrom(QWebChannelAbstractTransport *transport)

Отключает QWebChannel от объекта transport.

См. также QWebChannel::connectTo().

[virtual] QWebChannel::~QWebChannel()

Уничтожает QWebChannel.

void QWebChannel::deregisterObject(QObject *object)

Дерегистрирует указанный объект object из QWebChannel.

Удалённые клиенты получат сигнал destroyed для данного объекта.

Примечание: Эта функция может вызываться через систему метаобъектов и из QML. См. Q_INVOKABLE.

См. также QWebChannel::registerObjects(), QWebChannel::registerObject() и QWebChannel::registeredObjects().

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().

QHash<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/qt-5.13/qwebchannel.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API