En esta página

WebChannel QML Type

Interfaz QML para QWebChannel. Más...

Import Statement: import QtWebChannel 1.12

Propiedades

Propiedades adjuntas

  • id : string

Métodos

Descripción detallada

WebChannel proporciona un mecanismo para acceder de forma transparente a objetos de QObject o QML desde clientes HTML. Todas las propiedades, señales y ranuras públicas se pueden utilizar desde los clientes HTML.

Véase también « QWebChannel » y «API de JavaScript».

Documentación de propiedades

blockUpdates : bool

Cuando se establece en « true », se bloquean las actualizaciones y no se notificará 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 están bloqueadas.

propertyUpdateInterval : int

El intervalo de actualización de la propiedad.

Este intervalo se puede cambiar a un valor diferente en milisegundos asignándole un valor positivo. Las actualizaciones de las propiedades 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 agruparán y se enviarán en la siguiente ejecución. Si es negativo, las actualizaciones se enviarán inmediatamente. El valor por defecto es de 50 milisegundos.

registeredObjects : list<QtObject> [read-only]

Una lista de objetos a los que deben poder acceder los clientes remotos.

Los objetos deben tener la propiedad « id » asociada establecida en un identificador, bajo el cual se reconocerá el objeto en el lado HTML.

Una vez registrados, todas las señales y los cambios en las propiedades se propagan automáticamente a los clientes. Los métodos públicos invocables, incluidas las ranuras, también son accesibles para los clientes.

Si necesitas registrar objetos que no están disponibles cuando se crea el componente, utiliza el método imperativo ` registerObjects `.

Véase también registerObjects() y id.

transports : list<QtObject> [read-only]

Una lista de objetos de transporte que implementan ` QWebChannelAbstractTransport`. Los transportes se utilizan para comunicarse con los clientes remotos.

Véase también connectTo() y disconnectFrom().

Documentación de la propiedad adjunta

WebChannel.id : string [attached]

El identificador mediante el cual los clientes remotos reconocen un objeto registrado en un WebChannel.

Esta propiedad debe establecerse para cada objeto que se vaya a publicar a través del WebChannel. Aunque no se aplican restricciones al formato del identificador, suele ser recomendable elegir una cadena que también sea un identificador válido de JavaScript.

Documentación de métodos

void connectTo(QtObject transport)

Se conecta a ` transport`, que representa un canal de comunicación con un único cliente.

El objeto de transporte debe ser una implementación de ` QWebChannelAbstractTransport`.

Véase también ` transports ` y ` disconnectFrom()`.

void deregisterObject(QtObject object)

Da de baja el objeto « object » indicado del WebChannel.

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

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

void disconnectFrom(QtObject transport)

Desconecta el canal de datos de aplicación ( transport ) de este WebChannel.

El cliente ya no podrá comunicarse con el WebChannel, ni recibirá señales ni actualizaciones de propiedades.

Véase también connectTo().

void registerObject(const string id, QtObject object)

Registra un único objeto en el WebChannel.

Las propiedades, señales y métodos públicos del objeto « 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á actualizar la propiedad 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.

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

void registerObjects(object objects)

Registra el objeto « objects » especificado para que sea accesible a los clientes HTML. « objects » debe ser un objeto «Map» de JavaScript. La clave del mapa se utiliza como identificador del objeto en el lado del cliente.

Una vez registrado, todas las señales y los cambios de propiedad se propagan automáticamente a los clientes. Los métodos públicos invocables, incluidas las ranuras, también son accesibles para los clientes.

Esta API imperativa se puede utilizar para registrar objetos sobre la marcha. Para los objetos estáticos, es preferible utilizar la propiedad declarativa ` registeredObjects `.

Véase también registeredObjects.

© 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.