WebChannel QML Type

Interfaz QML para QWebChannel. Más...

• Lista de todos los miembros, incluidos los heredados

Propiedades

• blockUpdates : bool
• propertyUpdateInterval : int
• registeredObjects : list<QtObject>
• transports : list<QtObject>

Propiedades anexas

• id : string

Métodos

• void connectTo(QtObject transport)
• void deregisterObject(QtObject object)
• void disconnectFrom(QtObject transport)
• void registerObject(const string id, QtObject object)
• void registerObjects(object objects)

Descripción detallada

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

Véase también QWebChannel y JavaScript API.

Documentación de propiedades

blockUpdates : bool

Cuando se establece a true, las actualizaciones se bloquean y los clientes remotos no serán notificados de 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 estableciendo esta propiedad en false. Por defecto, las actualizaciones no se bloquean.

propertyUpdateInterval : int

El intervalo de actualización de la propiedad.

Este intervalo puede cambiarse a un intervalo diferente en milisegundos estableciéndolo en un valor positivo. Las actualizaciones de propiedades se agrupan por lotes y se envían cuando expira el intervalo. Si se establece a cero, las actualizaciones que se producen dentro de una sola ejecución del bucle de eventos se agrupan por lotes y se envían en la siguiente ejecución. Si es negativo, las actualizaciones se enviarán inmediatamente. El valor por defecto es 50 milisegundos.

registeredObjects : list<QtObject> [read-only]

Una lista de objetos que deben ser accesibles a clientes remotos.

Los objetos deben tener la propiedad adjunta id establecida a un identificador, bajo el cual el objeto es entonces conocido en el lado HTML.

Una vez registrados, todas las señales y cambios de 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 es necesario registrar objetos que no están disponibles cuando se crea el componente, utilice 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 hablar con los clientes remotos.

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

Documentación de propiedades adjuntas

WebChannel.id : string

El identificador con el que un objeto, registrado en un WebChannel, es conocido por los clientes remotos.

Esta propiedad debe establecerse para cada objeto que deba publicarse a través del WebChannel. Aunque no se impone ninguna restricción en cuanto al formato del identificador, suele ser una buena idea elegir una cadena que también sea un identificador JavaScript válido.

Documentación del método

void connectTo(QtObject transport)

Conecta con 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 del WebChannel la dirección object indicada.

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

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

void disconnectFrom(QtObject transport)

Desconecta el 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 de object se publican en los clientes remotos. A continuación, se construye un objeto con el identificador id.

Una propiedad que sea BINDABLE pero que no tenga una señal NOTIFY tendrá actualizaciones de propiedades en funcionamiento en el lado del cliente, pero no tendrá ningún mecanismo para registrar una devolución de llamada para las notificaciones de cambio.

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

void registerObjects(object objects)

Registra los objects especificados para hacerlos accesibles a los clientes HTML. objects debe ser un objeto JavaScript Map. La clave del mapa se utiliza como identificador del objeto en el lado del cliente.

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

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

Véase también registeredObjects.