Bereitstellungshandbuch

Übersicht

Dieses Dokument beschreibt, wie das Qt Virtual Keyboard -Plugin in Qt-Anwendungen bereitgestellt und verwendet wird.

Bereitstellung

Die verschiedenen „ Qt Virtual Keyboard “-Plugins und -Dateien werden an folgenden Speicherorten bereitgestellt:

Abhängigkeiten

Weitere Informationen finden Sie unter „Bereitstellung der Qt-Bibliotheken“.

Integrationsmethode

Qt Virtual Keyboard Derzeit werden zwei alternative Integrationsmethoden für die Nutzung des Plugins unterstützt:

• Desktop: Erfordert keine Änderungen an bestehenden Anwendungen. Die virtuelle Tastatur steht allen Qt-Anwendungen im System zur Verfügung.

  Bei dieser Integrationsmethode wird die Tastatur in einem eigenen Fenster auf oberster Ebene angezeigt.

• Application: Die virtuelle Tastatur wird durch die Instanziierung eines „ InputPanel “-Elements in QML in die Qt-Anwendung selbst eingebettet.

  Diese Methode ist in Umgebungen obligatorisch, in denen keine Unterstützung für mehrere Top-Level-Fenster vorhanden ist (z. B. auf eingebetteten Geräten), kann aber auch in Desktop-Anwendungen verwendet werden.

  Diese Methode kann auch von Qt Wayland Compositoren verwendet werden, um eine serverseitige virtuelle Tastatur bereitzustellen. Weitere Informationen finden Sie im folgenden Abschnitt.

Die Integrationsmethode wird automatisch durch die Projektdateien ausgewählt. In Desktop-Umgebungen ist es jedoch möglich, die Desktop-Integrationsmethode zu überschreiben und stattdessen die Anwendungsintegrationsmethode zu verwenden, indem die Umgebungsvariable ` QT_VIRTUALKEYBOARD_DESKTOP_DISABLE ` gesetzt wird oder ` -no-vkb-desktop ` zur Befehlszeile ` configure ` hinzugefügt wird.

Verwendung von „ Qt Virtual Keyboard “ mit Qt Wayland

In diesem Abschnitt wird erläutert, wie man „ Qt Virtual Keyboard “ verwendet, um mit dem Beispiel „Qt Widgets Line Edits“ zu interagieren, wobei das Beispiel „Fancy Compositor“ als Compositor dient.

Wir verwenden Ubuntu 18.04 zum Ausführen des Beispiels und nutzen X11 als Fenstersystem. Der Beispiel-Compositor (fancy-compositor) wird als Fenster innerhalb einer X11-Sitzung geöffnet.

1. Starten Sie den Compositor:

   QT_XCB_GL_INTEGRATION=xcb_egl QT_WAYLAND_CLIENT_BUFFER_INTEGRATION=xcomposite-egl \
   QT_IM_MODULE=qtvirtualkeyboard ./fancy-compositor -platform xcb

2. Stellen Sie vor dem Ausführen der Client-Anwendung sicher, dass QT_IM_MODULE nicht gesetzt ist:

   unset QT_IM_MODULE

3. Starten Sie das Beispiel „Line Edits“ als Client:

   ./lineedits -platform wayland

4. Klicken Sie auf ein Zeileneingabefeld, und das Eingabefenster von „ Qt Virtual Keyboard “ wird geöffnet.

Sollten Probleme auftreten, können beim Ausführen des Compositors die folgenden Umgebungsvariablen gesetzt werden, um eine Debug-Ausgabe zu erhalten, die bei der Fehlerdiagnose helfen kann:

WAYLAND_DEBUG=1
QT_LOGGING_RULES="qt.virtualkeyboard=true;qt.qpa.wayland*=true"

Laden des Plugins

Bei beiden Integrationsmethoden muss die Anwendung die Umgebungsvariable ` QT_IM_MODULE ` verwenden, um das Plugin zu laden. Zum Beispiel:

$ QT_IM_MODULE=qtvirtualkeyboard myapp

oder in der Funktion `main()`:

qputenv("QT_IM_MODULE", QByteArray("qtvirtualkeyboard"));

Bei der Desktop-Integrationsmethode ist dieser Schritt alles, was erforderlich ist, um „ Qt Virtual Keyboard “ zu verwenden. Bei der Anwendungsintegrationsmethode muss die Anwendung eine Instanz von „ InputPanel “ erstellen, wie im folgenden Kapitel erläutert wird.

Erstellen eines InputPanels

Das folgende Beispiel zeigt, wie ein „ InputPanel “ erstellt und der Bildschirmbereich mit dem Anwendungscontainer aufgeteilt wird.

import QtQuick
import QtQuick.VirtualKeyboard

Item {
    id: root
    Item {
        id: appContainer
        anchors.left: parent.left
        anchors.top: parent.top
        anchors.right: parent.right
        anchors.bottom: inputPanel.top
        ...
    }
    InputPanel {
        id: inputPanel
        y: Qt.inputMethod.visible ? parent.height - inputPanel.height : parent.height
        anchors.left: parent.left
        anchors.right: parent.right
    }
}

Das Eingabefeld muss ein gleichrangiges Element neben dem Anwendungscontainer sein. Es ist wichtig, das Eingabefeld nicht innerhalb des Anwendungscontainers zu platzieren, da es sich sonst mit dem Inhalt der Anwendung überschneiden würde. Außerdem wird die Höhe des Eingabefelds automatisch entsprechend der verfügbaren Breite angepasst; das Seitenverhältnis des Eingabefelds bleibt dabei konstant.

Plugin-Parameter

Einige Parameter können durch Anhängen an den Wert des „ QT_IM_MODULE “ (nach einem Doppelpunkt) angegeben werden, zum Beispiel QT_IM_MODULE=qtvirtualkeyboard:wordCandidateListVisible. Einige Parameter sind Schlüssel-Wert-Paare, die durch "=" getrennt sind.

Umgebungsvariablen

Das Modul definiert mehrere Umgebungsvariablen, die im Folgenden aufgeführt sind: