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, …, Romaji }
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中国語のZhuyin入力モード。
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日本語ローマ字入力モード

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

この enum は単語の再選択ルールを指定します。

定数説明
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 : const 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 : const QList<int>

このプロパティは、アクティブな入力メソッドで利用可能な入力モードを保持する。

利用可能な入力モードのリストは、入力メソッドとロケールに依存する。依存関係のいずれかが変更されると、このプロパティは更新される。

アクセス関数:

QList<int> inputModes() const

ノーティファイアシグナル:

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

このプロパティは、利用可能なパターン認識モードのリストを保持する。

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

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

アクセス関数です:

QList<int> patternRecognitionModes() const

通知シグナル

[read-only] previousKey : const Qt::Key

このプロパティは、直前にアクティブであったキーを保持する。

前に押されたキー。

アクセス関数:

Qt::Key previousKey() const

ノーティファイア信号:

void previousKeyChanged(Qt::Key key)

[read-only] wordCandidateListModel : QVirtualKeyboardSelectionListModel* const

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

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

アクセス関数

QVirtualKeyboardSelectionListModel *wordCandidateListModel() const

通知シグナル

void wordCandidateListModelChanged()

[read-only] wordCandidateListVisibleHint : const bool

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

このプロパティを使用して、単語候補リストをUIで表示するかどうかをチェックします。

アクセス関数

bool wordCandidateListVisibleHint() const

通知シグナル

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)

与えられたkeytextmodifiers のキークリックイベントを発する。キーイベントが入力エンジンに受け入れられた場合はtrue を返す。

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

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

仮想のkey が、与えられたtextmodifiers でクリックされたことを示す。isAutoRepeat は、キーが押されている間、イベントが自動的に繰り返されるかどうかを示す。このシグナルは、入力メソッドがキーイベントを処理した後に発せられます。

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

与えられたtextmodifiers で、key が押されたことを示すためにキーボードレイヤーによって呼び出される。

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

キーが押されると、repeattrue の場合、キーリピート・タイマーも開始されます。

キーがこの入力エンジンに受け入れられた場合はtrue を返す。

注意: この関数はメタオブジェクトシステムやQMLから呼び出すことができます。Q_INVOKABLE を参照。

virtualKeyCancel() およびvirtualKeyRelease()も参照

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

key でキーを解放する。イベントがリピーター・タイマーによって生成されていない場合、このメソッドは入力メソッドのキー・イベントを発行する。textmodifiers が入力メソッドに渡される。

キーが入力エンジンに受け入れられた場合はtrue を返す。

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

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