Тип QML WebChannel

QML-интерфейс к QWebChannel. Подробнее...

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

Свойства

• registeredObjects : QQmlListProperty<QObject>
• transports : QQmlListProperty<QObject>

Присоединённые свойства

• id : QString

Методы

• void connectTo(QWebChannelAbstractTransport transport)
• void disconnectFrom(QWebChannelAbstractTransport transport)
• void registerObjects(QVariantMap objects)

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

WebChannel предоставляет механизм для прозрачного доступа к объектам QObject или QML из HTML-клиентов. Все свойства, сигналы и публичные слоты могут быть использованы из HTML-клиентов.

См. также QWebChannel и API JavaScript.

Документация свойств

registeredObjects : QQmlListProperty<QObject>

Список объектов, которые должны быть доступны удалённым клиентам.

Объекты должны иметь установленное присоединённое свойство id со значением идентификатора, под которым объект затем известен на стороне HTML.

После регистрации все сигналы и изменения свойств автоматически распространяются на клиентов. Публичные вызываемые методы, включая слоты, также доступны клиентам.

Если необходимо зарегистрировать объекты, которые недоступны при создании компонента, используйте императивный метод registerObjects.

См. также registerObjects() и id.

transports : QQmlListProperty<QObject>

Список объектов-транспортов, реализующих QWebChannelAbstractTransport. Транспорты используются для общения с удалёнными клиентами.

См. также connectTo() и disconnectFrom().

Документация присоединённых свойств

WebChannel.id : QString

Идентификатор, под которым объект, зарегистрированный в WebChannel, известен удалённым клиентам.

Это свойство должно быть установлено для каждого объекта, который должен быть опубликован через WebChannel. Хотя никаких ограничений на формат идентификатора нет, обычно рекомендуется выбирать строку, которая также является допустимым идентификатором JavaScript.

Документация методов

void connectTo(QWebChannelAbstractTransport transport)

Подключается к transport, представляющему канал связи с отдельным клиентом.

Объект-транспорт должен быть реализацией QWebChannelAbstractTransport.

См. также transports и disconnectFrom().

void disconnectFrom(QWebChannelAbstractTransport transport)

Отключает transport от этого WebChannel.

Клиент больше не сможет общаться с WebChannel, а также не получит никаких сигналов или обновлений свойств.

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

void registerObjects(QVariantMap objects)

Регистрирует объекты, чтобы сделать их доступными для HTML-клиентов. Ключ карты используется в качестве идентификатора объекта на стороне клиента.

После регистрации все сигналы и изменения свойств автоматически распространяются на клиентов. Публичные вызываемые методы, включая слоты, также доступны клиентам.

Этот императивный API может быть использован для регистрации объектов на лету. Для статических объектов предпочтительнее декларативное свойство registeredObjects.

См. также registeredObjects.