このページでは

InputEngine QML Type (Uncreatable)

ユーザー入力を入力方式にマッピングします。詳細...

Import Statement: import QtQuick.VirtualKeyboard
In C++: QVirtualKeyboardInputEngine

注:これは生成不可能な型です。QML ではインスタンス化できません。

プロパティ

信号

方法

詳細な説明

入力エンジンは、入力イベントを入力方式へルーティングする役割を担います。実際の入力ロジックは、各入力方式によって実装されます。

また、入力エンジンにはデフォルトの入力メソッドも含まれており、アクティブな入力メソッドがイベントを処理できない場合に、デフォルトの処理を行います。

プロパティのドキュメント

activeKey : int [read-only]

現在押されているキー。

inputMethod : InputMethod

このプロパティを使用して、アクティブな入力方式を設定したり、アクティブな入力方式が変更されたことを監視したりします。

inputMode : int

このプロパティを使用して、現在の入力モードを取得または設定します。InputEngine::inputModes プロパティは、現在の入力方式およびロケールで有効な入力モードの一覧を提供します。

定義済みの入力モードは次のとおりです:

  • InputEngine.InputMode.Latin ラテン文字のデフォルトの入力モード。
  • InputEngine.InputMode.Numeric 数値入力のみが許可されます。
  • InputEngine.InputMode.Dialable ダイヤル入力のみが許可されます。
  • InputEngine.InputMode.Pinyin 中国語用のピンイン入力モード。
  • InputEngine.InputMode.Cangjie 中国語用の倉頡入力モード。
  • InputEngine.InputMode.Zhuyin 中国語用の注音入力モード。
  • InputEngine.InputMode.Hangul 韓国語用のハングル入力モード。
  • InputEngine.InputMode.Hiragana 日本語のひらがな入力モード。
  • InputEngine.InputMode.Katakana 日本語用のカタカナ入力モード。
  • InputEngine.InputMode.FullwidthLatin 東アジア言語用の全角ラテン文字入力モード。
  • InputEngine.InputMode.Greek ギリシャ語入力モード。
  • InputEngine.InputMode.Cyrillic キリル文字入力モード。
  • InputEngine.InputMode.Arabic アラビア語入力モード。
  • InputEngine.InputMode.Hebrew ヘブライ語入力モード。
  • InputEngine.InputMode.ChineseHandwriting 中国語の手書き入力。
  • InputEngine.InputMode.JapaneseHandwriting 日本語手書き入力。
  • InputEngine.InputMode.KoreanHandwriting 韓国語の手書き入力。
  • InputEngine.InputMode.Thai タイ語入力モード。
  • InputEngine.InputMode.Stroke 中国語の画数入力モード。
  • InputEngine.InputMode.Romaji 日本語のローマ字入力モード。
  • InputEngine.InputMode.HiraganaFlick 日本語用のフリック入力モード。

inputModes : list<int> [read-only]

利用可能な入力モードの一覧は、入力方式およびロケールによって異なります。これらの依存関係のいずれかが変更されると、このプロパティは更新されます。

patternRecognitionModes : list<int> [read-only, since QtQuick.VirtualKeyboard 2.0]

利用可能なパターン認識モードの一覧。

取り得る値:

定数説明
InputEngine.PatternRecognitionMode.Noneパターン認識は利用できません。
InputEngine.PatternRecognitionMode.PatternRecognitionDisabledobsolete - 代わりに「None 」を使用してください。
InputEngine.PatternRecognitionMode.Handwriting手書き文字認識用のパターン認識モード。
InputEngine.PatternRecognitionMode.HandwritingRecoginitionobsolete - 代わりに `Handwriting ` を使用してください。

このプロパティは、QtQuick.VirtualKeyboard 2.0 で導入されました。

previousKey : int [read-only]

以前に押されたキー。

wordCandidateListModel : SelectionListModel [read-only]

このプロパティを使用して、単語候補リストのリストモデルにアクセスします。

wordCandidateListVisibleHint : bool [read-only]

このプロパティを使用して、単語候補リストをUIに表示するかどうかを指定します。

Signal ドキュメント

void activeKeyChanged(int key)

アクティブなkey が変更されたことを示します。

注: 対応するハンドラは onActiveKeyChanged です。

void inputMethodChanged()

入力方法が変更されたことを示します。

注: 対応するハンドラは onInputMethodChanged です。

void inputMethodReset()

入力方式をリセットする必要があるときに発信されます。

注:この シグナルは 、入力メソッドがアクティブ化された際に、QVirtualKeyboardAbstractInputMethod::reset() およびInputMethod::reset() に自動的に接続されます。

注: 対応するハンドラは onInputMethodReset です。

void inputMethodUpdate()

注:この シグナルは 、入力方式が有効になると、自動的にQVirtualKeyboardAbstractInputMethod::update() およびInputMethod::update() に接続されます。

注: 対応するハンドラは onInputMethodUpdate です。

void inputModeChanged()

入力モードが変更されたことを示します。

注: 対応するハンドラは onInputModeChanged です。

void inputModesChanged()

利用可能な入力モードが変更されたことを示します。

注: 対応するハンドラは onInputModesChanged です。

[since QtQuick.VirtualKeyboard 2.0] void patternRecognitionModesChanged()

利用可能なパターン認識モードが変更されたことを示します。

あらかじめ定義されているパターン認識モードは以下の通りです:

  • InputEngine.PatternRecognitionMode.None パターン認識は利用できません。
  • InputEngine.PatternRecognitionMode.PatternRecognitionDisabled obsolete InputEngine .PatternRecognitionMode.None を使用してください。
  • InputEngine.PatternRecognitionMode.Handwriting 手書き認識用のパターン認識モード。
  • InputEngine.PatternRecognitionMode.HandwritingRecoginition obsolete InputEngine .PatternRecognitionMode.Handwriting を使用してください。

注: 対応するハンドラは `onPatternRecognitionModesChanged` です。

このシグナルは、QtQuick.VirtualKeyboard 2.0 で導入されました。

void previousKeyChanged(int key)

以前のkey に変更があったことを示します。

注: 対応するハンドラは onPreviousKeyChanged です。

void virtualKeyClicked(int key, string text, int modifiers)

指定されたtext およびmodifiers を使用して、仮想key がクリックされたことを示します。このシグナルは、入力メソッドがキーイベントを処理した後に発行されます。

注: 対応するハンドラは onVirtualKeyClicked です。

メソッドのドキュメント

[since QtQuick.VirtualKeyboard 2.0] Trace traceBegin(int traceId, int patternRecognitionMode, var traceCaptureDeviceInfo, var traceScreenInfo)

入力エンジンとのトレースのやり取りを開始します。

トレースは、traceId によって一意に識別されます。入力メソッドがイベントを受け入れた場合、入力エンジンはそのIDをTraceオブジェクトに割り当てます。

patternRecognitionMode は、そのパターンに使用される認識モードを指定します。

現在の入力メソッドがイベントを受け入れた場合、このインタラクションに関連付けられた Trace オブジェクトを返します。入力メソッドがイベントを破棄した場合は、null 値を返します。

traceCaptureDeviceInfo はソースデバイスに関する情報を提供し、traceScreenInfo は画面コンテキストに関する情報を提供します。

定義上、Trace オブジェクトは、traceEnd() メソッドが呼び出されるまで有効です。

InputEngine.traceEnd() メソッドを呼び出すことで、トレースインタラクションは終了します。

このメソッドは、QtQuick.VirtualKeyboard 2.0 で導入されました。

bool traceEnd(Trace trace)

入力エンジンとのトレースのやり取りを終了します。

この関数を呼び出した後は、trace オブジェクトをいつでも破棄してもかまいません。

トレースの連携が受け入れられた場合(つまり、タッチイベントが他の目的で使用されない場合)、この関数は true を返します。

void virtualKeyCancel()

キーイベントを送信せずに、アクティブなキーの状態を元に戻します。このメソッドは、ユーザーが現在のキーを解除し、キーの状態を復元する必要がある場合に役立ちます。

bool virtualKeyClick(int key, string text, int modifiers)

指定されたkey 、text 、およびmodifiers に対して、キークリックイベントを発火します。キーイベントが入力エンジンによって受け入れられた場合、true を返します。

bool virtualKeyPress(int key, string text, int modifiers, bool repeat)

キーボードレイヤーによって呼び出され、key が押されたことを示します。この際、指定されたtext およびmodifiers が渡されます。

key はアクティブなキー(押下中のキー)として設定されます。実際のキーイベントは、virtualKeyRelease() メソッドによってキーが解放されたときにトリガーされます。virtualKeyCancel() を呼び出すことで、キー押下イベントを破棄することができます。

また、repeat がtrue の場合、キーの押下によってキーリピートタイマーが開始されます。

キーがこの入力エンジンによって受け入れられた場合、true を返します。

virtualKeyCancel() およびvirtualKeyRelease()も参照してください 。

bool virtualKeyRelease(int key, string text, int modifiers)

key でキーを解放します。このメソッドは、イベントが繰り返しタイマーによって生成されたものでない場合、入力メソッドに対してキーイベントを発生させます。text およびmodifiers が入力メソッドに渡されます。

キーが入力エンジンによって受け入れられた場合、true を返します。

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