Skip to content

ImeCandidateBar

Win11-style in-app IME candidate strip (1.74).

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

Category: Input & forms · Library: v3.56

← Component index

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

Extends Control.

Example

ImeCandidateBar { engine: osk.engine }
ImeCandidateBar { engine: osk.engine; placement: "floating"; dockInset: osk.implicitHeight }

Notes

Host above OnScreenKeyboard (inline) or window overlay (floating). Theme acrylic matches OSK dock in light and dark. No focus steal. Shared by pinyin / romaji-kana / hangul. Digits 1–9 / Space via engine. Not Microsoft IME. Live-region: announce paged candidates / preedit on composeChanged (1.85).

API

Properties

Name Type Description
engine KeyboardEngine —
placement string —
dockInset real —
activeGroupIndex int —
groupPage int —

Signals

No custom signals (use inherited signals from the base type).

Methods

No custom methods (use inherited methods from the base type).

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.