Leitfaden für den Einsatz

Übersicht

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

Bereitstellung

Die verschiedenen Qt Virtual Keyboard Plugins und Dateien werden an den folgenden Orten bereitgestellt:

Abhängigkeiten

Lesen Sie mehr unter Einsatz von Qt-Bibliotheken.

Integrations-Methode

Qt Virtual Keyboard Qtvkbstyles unterstützt derzeit zwei alternative Integrationsmethoden für die Verwendung des Plugins:

• Desktop: Erfordert keine Änderungen an bestehenden Anwendungen. Die virtuelle Tastatur ist für alle Qt-Anwendungen im System verfügbar.

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

• ApplicationDie virtuelle Tastatur wird in die Qt-Anwendung selbst eingebettet, indem ein InputPanel -Element in QML instanziiert wird.

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

  Diese Methode kann auch von Qt Wayland Compositors verwendet werden, um eine serverseitige virtuelle Tastatur bereitzustellen. Siehe den Abschnitt unten für Details.

Die Integrationsmethode wird automatisch in den Projektdateien ausgewählt. In Desktop-Umgebungen ist es jedoch möglich, die Desktop-Integrationsmethode außer Kraft zu setzen und stattdessen die Anwendungsintegrationsmethode zu verwenden, indem Sie die Umgebungsvariable QT_VIRTUALKEYBOARD_DESKTOP_DISABLE verwenden oder -no-vkb-desktop zur Befehlszeile configure hinzufügen.

Verwendung von Qt Virtual Keyboard mit Qt Wayland

In diesem Abschnitt wird erklärt, wie Qt Virtual Keyboard verwendet wird, um mit dem BeispielQt Widgets Line Edits zu interagieren, wobei das Beispiel Fancy Compositor als Compositor verwendet wird.

Wir werden Ubuntu 18.04 verwenden, um das Beispiel auszuführen, wobei X11 als Fenstersystem verwendet wird. 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. Bevor Sie die Client-Anwendung starten, stellen Sie sicher, dass QT_IM_MODULE nicht gesetzt ist:

   unset QT_IM_MODULE

3. Starten Sie das Line Edits-Beispiel als Client:

   ./lineedits -platform wayland

4. Klicken Sie auf eine Zeilenbearbeitung und das Eingabefenster von Qt Virtual Keyboard wird geöffnet.

Wenn Probleme auftreten, können die folgenden Umgebungsvariablen beim Ausführen des Compositors gesetzt werden, um Debug-Ausgaben zu erhalten, die bei der Diagnose des Problems helfen können:

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 main()-Funktion:

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

Bei der Desktop-Integrationsmethode ist dieser Schritt alles, was für die Verwendung von Qt Virtual Keyboard erforderlich ist. Bei der Anwendungsintegrationsmethode muss die Anwendung eine Instanz von InputPanel erstellen, wie im folgenden Kapitel erläutert.

Erstellen eines InputPanels

Das folgende Beispiel zeigt, wie ein InputPanel erstellt wird und wie der Bildschirmbereich mit dem Anwendungscontainer geteilt werden kann.

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 InputPanel muss ein Geschwisterelement neben dem Anwendungscontainer sein. Es ist wichtig, das Eingabefeld nicht innerhalb des Anwendungscontainers zu platzieren, da es sich dann mit dem Inhalt der Anwendung überlappen würde. Außerdem wird die Höhe des Eingabefeldes automatisch entsprechend der verfügbaren Breite aktualisiert; das Seitenverhältnis des Eingabefeldes ist konstant.

Umgebungsvariablen

Es gibt mehrere vom Modul definierte Umgebungsvariablen, die im Folgenden aufgeführt sind: