WebChannel QML Type

Interface QML vers QWebChannel. En savoir plus...

• 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 associé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

WebChannel fournit un mécanisme permettant d'accéder de manière transparente à des objets QObject ou QML à partir de clients HTML. Toutes les propriétés, tous les signaux et tous les slots publics peuvent être utilisés depuis les clients HTML.

Voir également QWebChannel et API JavaScript.

Documentation des propriétés

blockUpdates : bool

Lorsque cette propriété est définie sur « true », les mises à jour sont bloquées et les clients distants ne sont pas informés des modifications apportées aux propriétés.

Les modifications sont enregistrées et envoyées aux clients dès que les mises à jour sont à nouveau autorisé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 une fois cet intervalle écoulé. Si la valeur est définie sur zéro, les mises à jour survenant au cours d'un même cycle de boucle d'événements sont regroupées et envoyées lors du cycle suivant. 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]

Liste des objets qui doivent être accessibles aux clients distants.

Les objets doivent avoir la propriété « id » associée définie sur un identifiant, sous lequel l'objet est alors reconnu côté HTML.

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

Si vous devez enregistrer des objets qui ne sont pas disponibles lors de la création du composant, utilisez la méthode impérative ` registerObjects `.

Voir également registerObjects() et id.

transports : list<QtObject> [read-only]

Liste des objets de transport qui implémentent l'interface QWebChannelAbstractTransport. Ces transports sont utilisés pour communiquer avec les clients distants.

Voir également ` connectTo()` et ` disconnectFrom()`.

Documentation sur les propriétés associées

WebChannel.id : string [attached]

Identifiant sous lequel un objet, enregistré sur un WebChannel, est reconnu par les clients distants.

Cette propriété doit être définie pour chaque objet devant être publié via le WebChannel. Bien qu'aucune restriction ne s'applique au format de l'identifiant, il est généralement recommandé de choisir une chaîne de caractères qui soit également un identifiant JavaScript valide.

Documentation des méthodes

void connectTo(QtObject transport)

Se connecte à l'interface ` transport`, qui représente un canal de communication vers un seul client.

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

Voir également ` transports ` et ` disconnectFrom()`.

void deregisterObject(QtObject object)

Désenregistre l'object indiquée du WebChannel.

Les clients distants recevront un signal « destroyed » pour l'objet spécifié.

Voir également registerObjects(), registerObject() et registeredObjects.

void disconnectFrom(QtObject transport)

Déconnecte l'transport e de ce WebChannel.

Le client ne pourra plus communiquer avec le WebChannel et ne recevra plus aucun signal ni aucune mise à jour de propriété.

Voir également connectTo().

void registerObject(const string id, QtObject object)

Enregistre un objet unique auprès du WebChannel.

Les propriétés, les signaux et les méthodes publiques de l’ object sont publiés vers les clients distants. Un objet portant l’identifiant id y est alors créé.

Une propriété de type « BINDABLE » qui ne dispose pas d’un signal « NOTIFY » permettra la mise à jour de la propriété côté client, mais ne disposera d’aucun mécanisme permettant d’enregistrer un rappel pour les notifications de modification.

Voir également registerObjects(), deregisterObject() et registeredObjects.

void registerObjects(object objects)

Enregistre les objets « objects » spécifiés afin de les rendre accessibles aux clients HTML. ` objects ` doit être un objet `Map` JavaScript. La clé de la `Map` sert d’identifiant à l’objet côté client.

Une fois enregistrées, toutes les modifications de signaux et de propriétés sont automatiquement propagées 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.