Spec-Zone.ru › Qt 5.15

Класс QWebChannel

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

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

См. также Пример Qt WebChannel Standalone и 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.15/qwebchannel.html

Spec-Zone.ru

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