Qt Virtual Keyboard
The Qt Virtual Keyboard project provides an input framework and reference keyboard frontend for Qt 6 on Linux Desktop/X11, Windows Desktop, and Boot2Qt targets.
The input framework makes it easy to write custom input methods or to integrate 3rd party input engines. The input methods can be implemented in C++ or QML.
Using the Module
Using a Qt module's C++ API requires linking against the module library, either directly or through other dependencies. Several build tools have dedicated support for this, including CMake and qmake.
Building with CMake
find_package() command to locate the needed module component in the
find_package(Qt6 REQUIRED COMPONENTS VirtualKeyboard) target_link_libraries(mytarget PRIVATE Qt6::VirtualKeyboard)
For more details, see the Build with CMake overview.
Building with qmake
To configure the module for building with qmake, add the module as a value of the
QT variable in the project's .pro file:
QT += virtualkeyboard
Articles and Guides
- Qt Virtual Keyboard API for Applications
- Qt Virtual Keyboard API for Advanced Use Cases
- Qt Virtual Keyboard QML Types
- Qt Virtual Keyboard C++ Classes
Licenses and Attributions
Qt Virtual Keyboard is available under commercial licenses from The Qt Company. In addition, it is available under the GNU General Public License, version 3. See Qt Licensing for further details.
Furthermore, Qt Virtual Keyboard potentially contains third party modules under the following permissive licenses:
Apache License 2.0
Apache License 2.0
Apache License 2.0 and BSD 3-clause "New" or "Revised" License
© 2023 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.