En esta página

QWebChannel Class

Expone los QObjects a clientes HTML remotos. Más...

Header: #include <QWebChannel>
qmake: QT += webchannel
Inherits: QObject

Propiedades

Funciones públicas

QWebChannel(QObject *parent = nullptr)
virtual ~QWebChannel()
QBindable<bool> bindableBlockUpdates()
QBindable<int> bindablePropertyUpdateInterval()
bool blockUpdates() const
void deregisterObject(QObject *object)
int propertyUpdateInterval() const
void registerObject(const QString &id, QObject *object)
void registerObjects(const QHash<QString, QObject *> &objects)
QHash<QString, QObject *> registeredObjects() const
void setBlockUpdates(bool block)
void setPropertyUpdateInterval(int ms)

Ranuras públicas

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

Señales

void blockUpdatesChanged(bool block)

Descripción detallada

QWebChannel cubre la brecha entre las aplicaciones en C++ y las aplicaciones en HTML/JavaScript. Al publicar un objeto derivado de ` QObject ` en un QWebChannel y utilizar el archivo `qwebchannel.js` en el lado HTML, se puede acceder de forma transparente a las propiedades, los slots públicos y los métodos de ` QObject`. No se requiere ningún paso manual de mensajes ni serialización de datos; las actualizaciones de propiedades y la emisión de señales en el lado de C++ se transmiten automáticamente a los clientes HTML que pueden estar ejecutándose de forma remota. En el lado del cliente, se creará un objeto JavaScript para cada ` QObject` de C++ publicado. Este refleja la API del objeto de C++ y, por lo tanto, se puede utilizar de forma intuitiva.

QWebChannel admite de forma transparente QFuture. Cuando un cliente llama a un método que devuelve un QFuture, QWebChannel enviará una respuesta con el resultado QFuture solo una vez que haya finalizado el QFuture.

Se admite la conversión personalizada de tipos hacia y desde JSON mediante la definición de convertidores con QMetaType::registerConverter() hacia y desde QJsonValue. Tenga en cuenta que los convertidores personalizados de QJsonValue a un tipo concreto deben fallar si el QJsonValue no coincide con el formato esperado. De lo contrario, QWebChannel no podrá recurrir a sus mecanismos de conversión predeterminados. También hay convertidores personalizados disponibles en el lado de JavaScript.

La API de QWebChannel en C++ permite comunicarse con cualquier cliente HTML, que puede ejecutarse en un equipo local o incluso remoto. La única limitación es que el cliente HTML admita las características de JavaScript utilizadas por qwebchannel.js. De este modo, se puede interactuar básicamente con cualquier navegador HTML moderno o entorno de ejecución de JavaScript independiente, como node.js.

También existe un WebChannel API declarativo.

Véase también el ejemplo independiente deQt WebChannel , la API de JavaScript y QMetaType::registerConverter().

Documentación de propiedades

[bindable] blockUpdates : bool

Nota: Esta propiedad admite enlaces de tipo « QProperty ».

Cuando se establece en « true », las actualizaciones se bloquean y no se notificarán a los clientes remotos los cambios en las propiedades.

Los cambios se registran y se envían a los clientes una vez que las actualizaciones se desbloquean de nuevo al establecer esta propiedad en « false ». De forma predeterminada, las actualizaciones no se bloquean.

Funciones de acceso:

bool blockUpdates() const
void setBlockUpdates(bool block)

Señal del notificador:

void blockUpdatesChanged(bool block)

[bindable] propertyUpdateInterval : int

Nota: Esta propiedad admite enlaces de tipo « QProperty ».

Esta propiedad contiene el intervalo de actualización de la propiedad.

Este intervalo se puede cambiar a otro valor en milisegundos asignándole un valor positivo. Las actualizaciones de la propiedad se agrupan y se envían una vez transcurrido el intervalo. Si se establece en cero, las actualizaciones que se produzcan durante una misma ejecución del bucle de eventos se agrupan y se envían en la siguiente ejecución. Si es negativo, las actualizaciones se enviarán inmediatamente. El valor por defecto es de 50 milisegundos.

Funciones de acceso:

int propertyUpdateInterval() const
void setPropertyUpdateInterval(int ms)

Documentación de funciones de miembro

[explicit] QWebChannel::QWebChannel(QObject *parent = nullptr)

Crea el objeto QWebChannel con el parent especificado.

Ten en cuenta que un QWebChannel solo estará plenamente operativo una vez que lo conectes a un QWebChannelAbstractTransport. Los clientes HTML también deben configurarse adecuadamente utilizando qwebchannel.js.

[virtual noexcept] QWebChannel::~QWebChannel()

Destruye el « QWebChannel ».

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

Conecta el objeto ` QWebChannel ` con el objeto ` transport ` indicado.

A continuación, el objeto de transporte se encarga de la comunicación entre la aplicación C++ y un cliente HTML remoto.

Véase también QWebChannelAbstractTransport y QWebChannel::disconnectFrom().

[invokable] void QWebChannel::deregisterObject(QObject *object)

Da de baja el objeto « object » especificado de la lista « QWebChannel ».

Los clientes remotos recibirán una señal ` destroyed ` para el objeto indicado.

Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.

Véase también QWebChannel::registerObjects(), QWebChannel::registerObject() y QWebChannel::registeredObjects().

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

Desvincula el objeto ` QWebChannel ` del objeto ` transport `.

Véase también QWebChannel::connectTo().

[invokable] void QWebChannel::registerObject(const QString &id, QObject *object)

Registra un único objeto en el servicio « QWebChannel ».

Las propiedades, señales y métodos públicos de object se publican en los clientes remotos. Allí se crea entonces un objeto con el identificador id.

Una propiedad que sea de tipo « BINDABLE » pero que no tenga una señal « NOTIFY » permitirá actualizarla correctamente en el lado del cliente, pero no dispondrá de ningún mecanismo para registrar una llamada de retorno para las notificaciones de cambio.

Nota: Una limitación actual es que los objetos deben registrarse antes de que se inicialice cualquier cliente.

Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.

Véase también QWebChannel::registerObjects(), QWebChannel::deregisterObject() y QWebChannel::registeredObjects().

void QWebChannel::registerObjects(const QHash<QString, QObject *> &objects)

Registra un grupo de objetos en el mapa « QWebChannel ».

Las propiedades, señales y métodos invocables públicos de los objetos se publican para los clientes remotos. A continuación, se crea un objeto con el identificador utilizado como clave en el mapa objects.

Nota: Una limitación actual es que los objetos deben registrarse antes de que se inicialice cualquier cliente.

Véase también QWebChannel::registerObject(), QWebChannel::deregisterObject() y QWebChannel::registeredObjects().

QHash<QString, QObject *> QWebChannel::registeredObjects() const

Devuelve el mapa de objetos registrados que se publican a clientes remotos.

Véase también QWebChannel::registerObjects(), QWebChannel::registerObject() y QWebChannel::deregisterObject().

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.