WebChannel QML Type

Interface QML avec QWebChannel. Plus d'informations...

• Liste de tous les membres, y compris les membres hérités

Propriétés

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

Propriétés rattachées

• id : string

Méthodes

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

Description détaillée

Le canal Web fournit un mécanisme permettant d'accéder de manière transparente aux objets QObject ou QML à partir de clients HTML. Toutes les propriétés, tous les signaux et tous les emplacements publics peuvent être utilisés par les clients HTML.

Voir également QWebChannel et l'API JavaScript.

Documentation sur les propriétés

blockUpdates : bool

Lorsque cette propriété vaut true, les mises à jour sont bloquées et les clients distants ne sont pas informés des modifications apportées à la propriété.

Les modifications sont enregistrées et envoyées aux clients dès que les mises à jour sont débloquées en définissant cette propriété sur false. Par défaut, les mises à jour ne sont pas bloquées.

propertyUpdateInterval : int

L'intervalle de mise à jour de la propriété.

Cet intervalle peut être modifié en millisecondes en lui attribuant une valeur positive. Les mises à jour des propriétés sont regroupées et envoyées après expiration de l'intervalle. S'il est fixé à zéro, les mises à jour survenant au cours d'une seule exécution de la boucle d'événements sont regroupées et envoyées lors de l'exécution suivante. Si la valeur est négative, les mises à jour sont envoyées immédiatement. La valeur par défaut est de 50 millisecondes.

registeredObjects : list<QtObject> [read-only]

Une liste d'objets qui doivent être accessibles aux clients distants.

Les objets doivent avoir la propriété attached id définie sur un identifiant, sous lequel l'objet est alors connu du côté HTML.

Une fois enregistrés, tous les signaux et changements de propriété sont automatiquement transmis aux clients. Les méthodes publiques invocables, y compris les slots, sont également accessibles aux clients.

Si l'on doit enregistrer des objets qui ne sont pas disponibles lors de la création du composant, il faut utiliser la méthode impérative registerObjects.

Voir également registerObjects() et id.

transports : list<QtObject> [read-only]

Une liste d'objets de transport, qui implémentent QWebChannelAbstractTransport. Les transports sont utilisés pour communiquer avec les clients distants.

Voir également connectTo() et disconnectFrom().

Documentation sur les propriétés attachées

WebChannel.id : string

Identifiant sous lequel un objet, enregistré dans un canal Web, est connu des clients distants.

Cette propriété doit être définie pour chaque objet qui doit être publié sur le canal Web. Bien qu'aucune restriction ne soit imposée quant au format de l'identifiant, il est généralement conseillé de choisir une chaîne de caractères qui soit également un identifiant JavaScript valide.

Documentation de la méthode

void connectTo(QtObject transport)

Se connecte à transport, qui représente un canal de communication avec un seul client.

L'objet de transport doit être une implémentation de QWebChannelAbstractTransport.

Voir aussi transports et disconnectFrom().

void deregisterObject(QtObject object)

Désenregistre l'objet object du canal Web.

Les clients distants recevront un signal destroyed pour l'objet donné.

Voir aussi registerObjects(), registerObject(), et registeredObjects.

void disconnectFrom(QtObject transport)

Déconnecte le site transport de ce canal Web.

Le client ne pourra plus communiquer avec le canal Web, ni recevoir de signaux ou de mises à jour de propriétés.

Voir aussi connectTo().

void registerObject(const string id, QtObject object)

Enregistre un objet unique auprès du canal Web.

Les propriétés, les signaux et les méthodes publiques de l'objet object sont publiés à l'intention des clients distants. Un objet portant l'identifiant id est alors construit.

Une propriété qui est BINDABLE mais qui n'a pas de signal NOTIFY aura des mises à jour de propriété fonctionnelles du côté client, mais aucun mécanisme pour enregistrer un rappel pour les notifications de changement.

Voir aussi registerObjects(), deregisterObject(), et registeredObjects.

void registerObjects(object objects)

Enregistre les objects spécifiés pour les rendre accessibles aux clients HTML. objects doit être un objet JavaScript Map. La clé de la carte est utilisée comme identifiant de l'objet côté client.

Une fois enregistré, tous les signaux et changements de propriété sont automatiquement propagés aux clients. Les méthodes publiques invocables, y compris les slots, sont également accessibles aux clients.

Cette API impérative peut être utilisée pour enregistrer des objets à la volée. Pour les objets statiques, il est préférable d'utiliser la propriété déclarative registeredObjects.

Voir également registeredObjects.