Skip to content

OnScreenKeyboard

Windows 11 touch keyboard parity (1.82).

import QWinUI3.Extras.Osk · src/extras/QWinUI3/Extras/OnScreenKeyboard.qml

Category: Input & forms · Library: v3.56

← Component index

Gallery: On-screen keyboard — src/gallery/pages/OnScreenKeyboardPage.qml

Python: same QML type after qwinui3.setup_engine() — Python API.

Extends Control.

Example

OnScreenKeyboard { }
OnScreenKeyboardWindow { systemWide: true }  // floating + optional desktop inject

// --- API ---
// keyboardSize  "default" | "small" | "wide"
// systemWide    Windows SendInput into focused apps (opt-in; default off)
// dragHostWindow  grab bar calls startSystemMove on the host Window
// engine.layoutId / cycleLayout / hardwareInput
// sharedEngine — one KeyboardEngine for dock + floating (2.58)
// candidateBarPlacement  "inline" | "floating"
// captureFocusReturn() / restoreFocusReturn() before hide (2.58)

Notes

Experimental. Win11 touch behavior. Floating host: OnScreenKeyboardWindow. systemWide is Windows-only; Linux stays in-app. Not Qt Virtual Keyboard.

API

Properties

Name Type Description
symbolsMode bool —
emojiMode bool —
shiftLatched bool —
capsLock bool —
showChrome bool —
dragHostWindow bool —
keyboardSize string Win11 keyboard size (Settings → Typing → Touch keyboard). Not Win10 "full" classic.
settingsOpen bool —
clipboardOpen bool —
emojiCategory int —
statusBanner string —
panelMode string none | voice | handwriting
sharedEngine KeyboardEngine Optional shared engine (dock + floating host use the same instance — 2.58).
candidateBarPlacement string —
engine KeyboardEngine —
layoutId string —
hardwareInput bool —
systemWide bool —
supportsSystemWide bool —
shiftOn bool —
keyGap real —
keyH real —
keyRadius real Win11 keys are noticeably rounder than Win10 / Theme.cornerControl (4).
letterShift bool —
langBadge string —
emojiCategoryModel var —
letterWFallback real —
letterRows var Windows 11 default touch keyboard (letters) — not Win10 classic with always-on number row.
symbolRows var —
emojiGridRows var —

Signals

Signature Description
closeRequested() —
settingsRequested() —

Methods

Signature Description
captureFocusReturn() —
restoreFocusReturn() —
unitWidthFor(row) —
keyWidth(row, k) —
keyLabel(vk) —
punctLabel(k) —
punctChar(k) —
tapVk(vk) —
tapShift() —
commitHint(k) —
commitAlt(ch) —
flashBanner(text) —
openVoicePanel() —
closeVoicePanel() —
openHandwritingPanel() —
closeHandwritingPanel() —
openAltFlyout(item, alts) —
altsFor(k) —
iconFor(k) —
labelFor(k) —
accentFor(k) —
handleKey(k) —

Inherited from Control

Also available (base type / Qt Quick Controls):

  • padding
  • font
  • background / contentItem

Generated from module sources by scripts/generate_component_docs.py — do not edit by hand.