このページでは

QVirtualKeyboardInputEngine Class

InputEngine クラスは、C++およびQMLとの統合をサポートする入力エンジンを提供します。詳細...

ヘッダー: #include <QVirtualKeyboardInputEngine>
CMake: find_package(Qt6 REQUIRED COMPONENTS VirtualKeyboard)
target_link_libraries(mytarget PRIVATE Qt6::VirtualKeyboard)
qmake: QT += virtualkeyboard
QML内: InputEngine
継承元: QObject

パブリック型

enum class InputMode { Latin, Numeric, Dialable, Pinyin, Cangjie, …, HiraganaFlick }
enum class PatternRecognitionMode { None, PatternRecognitionDisabled, Handwriting, HandwritingRecoginition }
enum class ReselectFlag { WordBeforeCursor, WordAfterCursor, WordAtCursor }
flags ReselectFlags
enum class TextCase { Lower, Upper }

プロパティ

パブリック関数

Qt::Key activeKey() const
QVirtualKeyboardInputContext *inputContext() const
QVirtualKeyboardAbstractInputMethod *inputMethod() const
QVirtualKeyboardInputEngine::InputMode inputMode() const
QList<int> inputModes() const
QList<int> patternRecognitionModes() const
Qt::Key previousKey() const
(since QtQuick.VirtualKeyboard 2.0) bool reselect(int cursorPosition, const QVirtualKeyboardInputEngine::ReselectFlags &reselectFlags)
void setInputMethod(QVirtualKeyboardAbstractInputMethod *inputMethod)
void setInputMode(QVirtualKeyboardInputEngine::InputMode inputMode)
(since QtQuick.VirtualKeyboard 2.0) QVirtualKeyboardTrace *traceBegin(int traceId, QVirtualKeyboardInputEngine::PatternRecognitionMode patternRecognitionMode, const QVariantMap &traceCaptureDeviceInfo, const QVariantMap &traceScreenInfo)
bool traceEnd(QVirtualKeyboardTrace *trace)
void virtualKeyCancel()
bool virtualKeyClick(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers)
bool virtualKeyPress(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers, bool repeat)
bool virtualKeyRelease(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers)
QVirtualKeyboardSelectionListModel *wordCandidateListModel() const
bool wordCandidateListVisibleHint() const

シグナル

void activeKeyChanged(Qt::Key key)
void inputMethodChanged()
void inputMethodReset()
void inputMethodUpdate()
void inputModeChanged()
void inputModesChanged()
(since QtQuick.VirtualKeyboard 2.0) void patternRecognitionModesChanged()
void previousKeyChanged(Qt::Key key)
void virtualKeyClicked(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers, bool isAutoRepeat)
void wordCandidateListModelChanged()
void wordCandidateListVisibleHintChanged()

詳細な説明

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

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

メンバ型のドキュメント

enum class QVirtualKeyboardInputEngine::InputMode

この列挙型は、入力方式の入力モードを指定します。

定数値説明
QVirtualKeyboardInputEngine::InputMode::Latin0ラテン文字のデフォルトの入力モード。
QVirtualKeyboardInputEngine::InputMode::Numeric1数値入力のみが許可されます。
QVirtualKeyboardInputEngine::InputMode::Dialable2ダイヤル入力のみが許可されます。
QVirtualKeyboardInputEngine::InputMode::Pinyin3中国語用のピンイン入力モード。
QVirtualKeyboardInputEngine::InputMode::Cangjie4中国語用の倉頡入力モード。
QVirtualKeyboardInputEngine::InputMode::Zhuyin5中国語用の注音入力モード。
QVirtualKeyboardInputEngine::InputMode::Hangul6韓国語用のハングル入力モード。
QVirtualKeyboardInputEngine::InputMode::Hiragana7日本語用のひらがな入力モード。
QVirtualKeyboardInputEngine::InputMode::Katakana8日本語用のカタカナ入力モード。
QVirtualKeyboardInputEngine::InputMode::FullwidthLatin9東アジア言語用の全角ラテン文字入力モード。
QVirtualKeyboardInputEngine::InputMode::Greek10ギリシャ語入力モード。
QVirtualKeyboardInputEngine::InputMode::Cyrillic11キリル文字入力モード。
QVirtualKeyboardInputEngine::InputMode::Arabic12アラビア語入力モード。
QVirtualKeyboardInputEngine::InputMode::Hebrew13ヘブライ語入力モード。
QVirtualKeyboardInputEngine::InputMode::ChineseHandwriting14中国語手書き入力モード。
QVirtualKeyboardInputEngine::InputMode::JapaneseHandwriting15日本語手書き入力モード。
QVirtualKeyboardInputEngine::InputMode::KoreanHandwriting16韓国語手書き入力モード。
QVirtualKeyboardInputEngine::InputMode::Thai17タイ語入力モード。
QVirtualKeyboardInputEngine::InputMode::Stroke18中国語の筆画入力モード。
QVirtualKeyboardInputEngine::InputMode::Romaji19日本語のローマ字入力モード。
QVirtualKeyboardInputEngine::InputMode::HiraganaFlick20日本語のフリック入力モード。

enum class QVirtualKeyboardInputEngine::PatternRecognitionMode

この列挙型は、入力方式の入力モードを指定します。

定数値説明
QVirtualKeyboardInputEngine::PatternRecognitionMode::None0パターン認識は利用できません。
QVirtualKeyboardInputEngine::PatternRecognitionMode::PatternRecognitionDisabledNoneobsolete PatternRecognitionMode::None を使用してください。
QVirtualKeyboardInputEngine::PatternRecognitionMode::Handwriting1手書き文字認識のパターン認識モード。
QVirtualKeyboardInputEngine::PatternRecognitionMode::HandwritingRecoginitionHandwritingobsolete PatternRecognitionMode::Handwriting を使用してください

enum class QVirtualKeyboardInputEngine::ReselectFlag
flags QVirtualKeyboardInputEngine::ReselectFlags

この列挙型は、単語の再選択に関するルールを指定します。

定数値説明
QVirtualKeyboardInputEngine::ReselectFlag::WordBeforeCursor0x1カーソルの直前の単語をアクティブにします。このフラグのみが使用される場合、単語はカーソル位置で正確に終わっている必要があります。
QVirtualKeyboardInputEngine::ReselectFlag::WordAfterCursor0x2カーソルの後の単語をアクティブにします。このフラグのみを使用する場合、単語はカーソル位置で正確に終わっている必要があります。
QVirtualKeyboardInputEngine::ReselectFlag::WordAtCursorWordBeforeCursor | WordAfterCursorカーソル位置にある単語をアクティブにします。このフラグは上記のフラグの組み合わせですが、単語がカーソル位置で始まったり終わったりしてはならない点が異なります。

ReselectFlags 型は、QFlags<ReselectFlag> の typedef です。これは、ReselectFlag 値の論理和(OR)の組み合わせを格納します。

enum class QVirtualKeyboardInputEngine::TextCase

この列挙型は、入力メソッドにおけるテキストの大文字・小文字の扱いを指定します。

定数値説明
QVirtualKeyboardInputEngine::TextCase::Lower0小文字のテキスト。
QVirtualKeyboardInputEngine::TextCase::Upper1大文字のテキスト。

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

[read-only] activeKey : Qt::Key

このプロパティには、アクティブなキーが格納されます。

現在押されているキー。

アクセス関数:

Qt::Key activeKey() const

通知シグナル:

void activeKeyChanged(Qt::Key key)

inputMethod : QVirtualKeyboardAbstractInputMethod*

このプロパティは、アクティブな入力方式を保持します。

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

アクセス関数:

QVirtualKeyboardAbstractInputMethod *inputMethod() const
void setInputMethod(QVirtualKeyboardAbstractInputMethod *inputMethod)

通知シグナル:

inputMode : InputMode

このプロパティは、現在の入力モードを保持します。

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

アクセス関数:

QVirtualKeyboardInputEngine::InputMode inputMode() const
void setInputMode(QVirtualKeyboardInputEngine::InputMode inputMode)

通知シグナル:

[read-only] inputModes : QList<int>

このプロパティには、アクティブな入力方式で使用可能な入力モードが格納されます。

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

アクセス関数:

QList<int> inputModes() const

通知シグナル:

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

このプロパティには、利用可能なパターン認識モードの一覧が格納されています。

利用可能なパターン認識モードのリスト。

この列挙型は、QtQuick.VirtualKeyboard 2.0で導入されました。

アクセス関数:

QList<int> patternRecognitionModes() const

Notifier シグナル:

[read-only] previousKey : Qt::Key

このプロパティには、直前にアクティブだったキーが格納されます。

以前に押されたキー。

アクセス関数:

Qt::Key previousKey() const

通知信号:

void previousKeyChanged(Qt::Key key)

[read-only] wordCandidateListModel : QVirtualKeyboardSelectionListModel*

単語候補リストのリストモデル。

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

アクセス関数:

QVirtualKeyboardSelectionListModel *wordCandidateListModel() const

通知信号:

void wordCandidateListModelChanged()

[read-only] wordCandidateListVisibleHint : bool

単語候補リストの表示ヒント。

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

アクセス関数:

bool wordCandidateListVisibleHint() const

Notifierシグナル:

void wordCandidateListVisibleHintChanged()

メンバ関数のドキュメント

Qt::Key QVirtualKeyboardInputEngine::activeKey() const

現在アクティブなキーを返します。アクティブなキーがない場合は、Qt::Key_unknown を返します。

注: プロパティ activeKeyのゲッター 関数です。

[signal] void QVirtualKeyboardInputEngine::activeKeyChanged(Qt::Key key)

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

注: プロパティ「activeKey 」の通知 シグナルです。

QVirtualKeyboardInputContext *QVirtualKeyboardInputEngine::inputContext() const

入力エンジンに関連付けられたInputContext インスタンスを返します。

QVirtualKeyboardAbstractInputMethod *QVirtualKeyboardInputEngine::inputMethod() const

アクティブな入力方式を取得します。

注: プロパティ inputMethodのゲッター 関数です。

関連項目: setInputMethod()。

[signal] void QVirtualKeyboardInputEngine::inputMethodChanged()

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

注: プロパティ `inputMethod`の通知 シグナルです。

[signal] void QVirtualKeyboardInputEngine::inputMethodReset()

入力方式をリセットする必要がある際に発火します。

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

[signal] void QVirtualKeyboardInputEngine::inputMethodUpdate()

注:この 信号は 、入力メソッドが有効になると、自動的にQVirtualKeyboardAbstractInputMethod::update() およびInputMethod::update() に接続されます。

[signal] void QVirtualKeyboardInputEngine::inputModeChanged()

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

注: プロパティ「inputMode 」の通知信号です 。

QList<int> QVirtualKeyboardInputEngine::inputModes() const

利用可能な入力モードのリストを返します。

注: プロパティ `inputModes`のゲッター 関数です。

[signal] void QVirtualKeyboardInputEngine::inputModesChanged()

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

注: プロパティ「inputModes 」の通知信号です 。

QList<int> QVirtualKeyboardInputEngine::patternRecognitionModes() const

サポートされているパターン認識モードの一覧を返します。

注: プロパティ patternRecognitionModesのゲッター関数です 。

[signal, since QtQuick.VirtualKeyboard 2.0] void QVirtualKeyboardInputEngine::patternRecognitionModesChanged()

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

注: プロパティpatternRecognitionModes の通知 シグナルです。

この関数は、QtQuick.VirtualKeyboard 2.0で導入されました。

Qt::Key QVirtualKeyboardInputEngine::previousKey() const

以前にアクティブだったキーを返します。アクティブなキーがない場合は、Qt::Key_unknown を返します。

注: previousKey プロパティのゲッター 関数です。

[signal] void QVirtualKeyboardInputEngine::previousKeyChanged(Qt::Key key)

以前のkey が変更されたことを示します。

注: プロパティ「previousKey 」の通知 シグナルです。

[invokable, since QtQuick.VirtualKeyboard 2.0] bool QVirtualKeyboardInputEngine::reselect(int cursorPosition, const QVirtualKeyboardInputEngine::ReselectFlags &reselectFlags)

この関数は、cursorPosition にある単語を再選択しようとします。reselectFlags は、カーソル位置との関係で単語をどのように選択すべきかというルールを定義します。

単語の再選択に成功した場合、この関数は `true ` を返します。

注:この関数は 、メタオブジェクトシステムおよびQMLから呼び出すことができます。Q_INVOKABLE を参照してください。

この関数は、QtQuick.VirtualKeyboard 2.0 で導入されました。

void QVirtualKeyboardInputEngine::setInputMethod(QVirtualKeyboardAbstractInputMethod *inputMethod)

inputMethod をアクティブな入力方式として設定します。

注: プロパティinputMethod のセッター 関数です。

関連項目:inputMethod()も参照してください 。

[invokable, since QtQuick.VirtualKeyboard 2.0] QVirtualKeyboardTrace *QVirtualKeyboardInputEngine::traceBegin(int traceId, QVirtualKeyboardInputEngine::PatternRecognitionMode patternRecognitionMode, const QVariantMap &traceCaptureDeviceInfo, const QVariantMap &traceScreenInfo)

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

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

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

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

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

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

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

注:この関数は 、メタオブジェクトシステムを介して、および QML から呼び出すことができます。Q_INVOKABLE を参照してください。

この関数は、QtQuick.VirtualKeyboard 2.0 で導入されました。

[invokable] bool QVirtualKeyboardInputEngine::traceEnd(QVirtualKeyboardTrace *trace)

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

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

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

注:この関数は 、メタオブジェクトシステムを介して、またはQMLから呼び出すことができます。Q_INVOKABLE を参照してください。

[invokable] void QVirtualKeyboardInputEngine::virtualKeyCancel()

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

注:この関数は 、メタオブジェクトシステムおよびQMLから呼び出すことができます。Q_INVOKABLE を参照してください。

[invokable] bool QVirtualKeyboardInputEngine::virtualKeyClick(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers)

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

注:この関数は 、メタオブジェクトシステムを介して、またはQMLから呼び出すことができます。Q_INVOKABLE を参照してください。

[signal] void QVirtualKeyboardInputEngine::virtualKeyClicked(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers, bool isAutoRepeat)

指定されたtext およびmodifiers で、仮想key がクリックされたことを示します。isAutoRepeat は、キーが押されている間、イベントが自動的に繰り返されるかどうかを示します。このシグナルは、入力方式がキーイベントを処理した後に発せられます。

[invokable] bool QVirtualKeyboardInputEngine::virtualKeyPress(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers, bool repeat)

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

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

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

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

注:この関数は 、メタオブジェクトシステムおよび QML から呼び出すことができます。Q_INVOKABLE を参照してください。

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

[invokable] bool QVirtualKeyboardInputEngine::virtualKeyRelease(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers)

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

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

注:この関数は 、メタオブジェクトシステムを介して、または QML から呼び出すことができます。Q_INVOKABLE を参照してください。

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