WebChannel QML Type

QML-Schnittstelle zu QWebChannel. Mehr...

Import Statement: import QtWebChannel 1.8

Eigenschaften

Beigefügte Eigenschaften

  • id : string

Methoden

Detaillierte Beschreibung

Der WebChannel bietet einen Mechanismus zum transparenten Zugriff auf QObject oder QML-Objekte von HTML-Clients aus. Alle Eigenschaften, Signale und öffentlichen Slots können von den HTML-Clients verwendet werden.

Siehe auch QWebChannel und JavaScript API.

Dokumentation der Eigenschaften

blockUpdates : bool

Bei der Einstellung true werden Aktualisierungen blockiert und Remote-Clients werden nicht über Eigenschaftsänderungen benachrichtigt.

Die Änderungen werden aufgezeichnet und an die Clients gesendet, sobald die Aktualisierungen wieder freigegeben werden, indem diese Eigenschaft auf false gesetzt wird. Standardmäßig werden die Aktualisierungen nicht blockiert.


propertyUpdateInterval : int

Das Aktualisierungsintervall der Eigenschaft.

Dieses Intervall kann auf ein anderes Intervall in Millisekunden geändert werden, indem es auf einen positiven Wert gesetzt wird. Eigenschaftsaktualisierungen werden gebündelt und nach Ablauf des Intervalls versendet. Bei einem Wert von Null werden die Aktualisierungen innerhalb eines einzelnen Ereignisschleifenlaufs zusammengefasst und beim nächsten Lauf gesendet. Ist der Wert negativ, werden die Aktualisierungen sofort gesendet. Der Standardwert ist 50 Millisekunden.


registeredObjects : list<QtObject> [read-only]

Eine Liste von Objekten, die für entfernte Clients zugänglich sein sollen.

Bei den Objekten muss die angehängte Eigenschaft id auf einen Bezeichner gesetzt werden, unter dem das Objekt dann auf der HTML-Seite bekannt ist.

Einmal registriert, werden alle Signale und Eigenschaftsänderungen automatisch an die Clients weitergegeben. Öffentliche aufrufbare Methoden, einschließlich Slots, sind auch für die Clients zugänglich.

Wenn Objekte registriert werden müssen, die bei der Erstellung der Komponente nicht verfügbar sind, verwenden Sie die imperative Methode registerObjects.

Siehe auch registerObjects() und id.


transports : list<QtObject> [read-only]

Eine Liste von Transportobjekten, die QWebChannelAbstractTransport implementieren. Die Transporte werden verwendet, um mit den entfernten Clients zu kommunizieren.

Siehe auch connectTo() und disconnectFrom().


Angehängte Eigenschaft Dokumentation

WebChannel.id : string

Der Bezeichner, unter dem ein Objekt, das in einem WebChannel registriert ist, den Remote-Clients bekannt ist.

Diese Eigenschaft muss für jedes Objekt festgelegt werden, das über den WebChannel veröffentlicht werden soll. Es gibt zwar keine Beschränkungen für das Format der ID, aber es ist in der Regel ratsam, eine Zeichenkette zu wählen, die auch ein gültiger JavaScript-Bezeichner ist.


Dokumentation der Methode

void connectTo(QtObject transport)

Stellt eine Verbindung zu transport her, die einen Kommunikationskanal zu einem einzelnen Client darstellt.

Das Transportobjekt muss eine Implementierung von QWebChannelAbstractTransport sein.

Siehe auch transports und disconnectFrom().


void deregisterObject(QtObject object)

Deregistriert den angegebenen object vom WebChannel.

Entfernte Clients erhalten ein destroyed Signal für das angegebene Objekt.

Siehe auch registerObjects(), registerObject(), und registeredObjects.


void disconnectFrom(QtObject transport)

Trennt die Verbindung von transport zu diesem WebChannel.

Der Client kann nicht mehr mit dem WebChannel kommunizieren und erhält auch keine Signale oder Eigenschaftsaktualisierungen.

Siehe auch connectTo().


void registerObject(const string id, QtObject object)

Meldet ein einzelnes Objekt beim WebChannel an.

Die Eigenschaften, Signale und öffentlichen Methoden des object werden an die Remote-Clients veröffentlicht. Dort wird dann ein Objekt mit dem Bezeichner id konstruiert.

Eine Eigenschaft, die BINDABLE ist, aber kein NOTIFY Signal hat, hat funktionierende Eigenschaftsaktualisierungen auf der Client-Seite, aber keinen Mechanismus, um einen Callback für die Änderungsbenachrichtigungen zu registrieren.

Hinweis: Eine aktuelle Einschränkung ist, dass Objekte registriert werden müssen, bevor ein Client initialisiert wird.

Siehe auch registerObjects(), deregisterObject(), und registeredObjects.


void registerObjects(object objects)

Registriert die angegebenen objects, um sie für HTML-Clients zugänglich zu machen. objects sollte ein JavaScript Map-Objekt sein. Der Schlüssel der Map wird als Bezeichner für das Objekt auf der Client-Seite verwendet.

Sobald es registriert ist, werden alle Signale und Eigenschaftsänderungen automatisch an die Clients weitergegeben. Öffentliche aufrufbare Methoden, einschließlich Slots, sind auch für die Clients zugänglich.

Diese zwingende API kann verwendet werden, um Objekte im laufenden Betrieb zu registrieren. Für statische Objekte sollte die deklarative registeredObjects Eigenschaft bevorzugt werden.

Siehe auch registeredObjects.


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