Qt Virtual Keyboard QML Types

The QML types can be imported into your application using the following import statements in your .qml file:

import QtQuick.VirtualKeyboard 2.2
import QtQuick.VirtualKeyboard.Styles 2.2
import QtQuick.VirtualKeyboard.Settings 2.2

In addition to importing the types, the QT_IM_MODULE environment variable must be set to qtvirtualkeyboard. For more information, see Loading the Plugin.

Styling:

KeyIcon

Key icon with adjustable color

KeyPanel

A base type of the styled keys

KeyboardStyle

Provides a styling interface for the Virtual Keyboard

SelectionListItem

A base type for selection list item delegates

TraceCanvas

A specialized Canvas type for rendering Trace objects

TraceInputKeyPanel

A base type of the trace input key

Settings:

VirtualKeyboardSettings

Provides settings for virtual keyboard

Input framework and keys:

BackspaceKey

Backspace key for keyboard layouts

BaseKey

Common parent for all key types

ChangeLanguageKey

Change language key for keyboard layouts

EnterKey

Enter key for keyboard layouts

EnterKeyAction

Provides attached properties for customizing the enter key

FillerKey

Filler key for keyboard layouts

FlickKey

Flick key for keyboard layouts

HandwritingInputPanel

Provides a handwriting panel add-on for the virtual keyboard UI

HandwritingModeKey

Hand writing mode key for keyboard layouts

HideKeyboardKey

Hide keyboard key for keyboard layouts

InputContext

Provides access to an input context

InputEngine

Maps the user input to the input methods

InputMethod

Base type for creating input method in QML

InputModeKey

Input mode key for keyboard layouts

InputPanel

Provides the virtual keyboard UI

Key

Regular character key for keyboard layouts

KeyboardColumn

Keyboard column for keyboard layouts

KeyboardLayout

Keyboard layout

KeyboardLayoutLoader

Allows dynamic loading of keyboard layout

KeyboardObserver

Acts as a hub for keyboard event notifications

KeyboardRow

Keyboard row for keyboard layouts

ModeKey

Generic mode key for keyboard layouts

NumberKey

Specialized number key for keyboard layouts

SelectionListModel

Provides a data model for the selection lists

ShiftHandler

Manages the shift state

ShiftKey

Shift key for keyboard layouts

SpaceKey

Space key for keyboard layouts

SymbolModeKey

Symbol mode key for keyboard layouts

Trace

Data model for touch input data

TraceInputArea

A specialized MultiPointTouchArea for collecting touch input data

TraceInputKey

A specialized key for collecting touch input data

VirtualKeyboard

Provides attached properties for customizing the virtual keyboard

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