InputMethod QML Type (Singleton)

QMLアプリケーションからQInputMethod にアクセスできるようにします。詳細...

注：この型は QML シングルトンです。QML エンジン内には、この型のインスタンスが 1 つしか存在しません。

• 継承されたメンバーを含む、すべてのメンバーの一覧

プロパティ

• anchorRectangle : rect
• animating : bool
• cursorRectangle : rect
• inputDirection : enumeration
• inputItemClipRectangle : rect
• keyboardRectangle : rect
• locale : Locale
• visible : bool

方法

• void commit()
• void hide()
• void invokeAction(var a, int cursorPosition)
• void reset()
• void show()
• void update(enumeration queries)

詳細な説明

InputMethodシングルトンを使用すると、アプリケーションのQInputMethod オブジェクトおよびそのすべてのプロパティとスロットにアクセスできます。詳細については、QInputMethod のドキュメントを参照してください。

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

anchorRectangle : rect

入力項目のアンカー矩形をウィンドウ座標で指定します。

アンカー矩形は、テキスト選択範囲を追跡するために、テキスト予測ポップアップなどのさまざまなテキスト編集コントロールでよく使用されます。

animating : bool

仮想キーボードが開かれているか閉じられている場合にtrueとなります。

このプロパティの値は、キーボードが完全に開いているか閉じている場合は false になります。animating がtrue で、visibility がtrue の場合、キーボードは開かれている最中です。animating がtrue で、visibility が false の場合、キーボードは閉じられている最中です。

cursorRectangle : rect

ウィンドウ座標での入力項目のカーソル矩形。

カーソル矩形は、入力中のテキストを追跡するために、テキスト予測ポップアップなど、さまざまなテキスト編集コントロールでよく使用されます。

inputDirection : enumeration

現在の入力方向。

取り得る値：

inputItemClipRectangle : rect

ウィンドウ座標系における入力項目のクリップされた矩形。

切り取られた入力矩形は、さまざまな入力方式（例：仮想キーボード）において、その入力方式が利用できる画面領域の広さを決定するために頻繁に使用されます。

keyboardRectangle : rect

ウィンドウ座標系における仮想キーボードの形状。

キーボードの形状を特定できない場合、これは空の矩形になる可能性があります。Androidのフローティングキーボードがこれに該当します。

locale : Locale

現在の入力ロケール。

visible : bool

画面上の仮想キーボードの表示状態

仮想キーボードを搭載していないデバイスでは、このプロパティの値は false のままとなります。

show() およびhide()も参照してください 。

メソッドのドキュメント

void commit()

ユーザーが現在入力している単語をエディタにコミットします。この関数は、主にテキスト予測機能を備えた入力メソッドや、文字入力に使用されるスクリプトと、実際にエディタに追加されるスクリプトが異なるメソッドで必要とされます。 テキスト入力中に発生するあらゆる操作（例えば、カーソルを別の場所に移動させる場合など）は、commit() 関数を呼び出して入力状態を確定させる必要があります。

void hide()

仮想キーボードを閉じるよう要求します。

通常、テキストエディタがフォーカスを失った場合（たとえば、親ビューが閉じられた場合など）、キーボードは自動的に閉じられるため、アプリケーションがこの関数を呼び出す必要はありません。

void invokeAction(var a, int cursorPosition)

ユーザーが現在入力中の単語をタップした際に、入力項目によって呼び出されます。これは、アクション `a ` および指定された `cursorPosition` によって示されます。入力メソッドでは、この情報を利用して、ユーザーにさらに多くの単語候補を提示することがよくあります。

QInputMethod::Actionも参照してください 。

void reset()

入力メソッドの状態をリセットします。たとえば、テキストエディタでは通常、テキストを挿入する前にこのメソッドを呼び出し、ウィジェットがテキストを受け入れる準備ができるようにします。

フォーカスされているエディタが変更されると、入力方式は自動的にリセットされます。

void show()

仮想キーボードを開くよう要求します。プラットフォームが仮想キーボードを提供していない場合、可視性は false のままとなります。

通常、テキストエディタにフォーカスが移るとキーボードが自動的に開くため、アプリケーションがこの関数を呼び出す必要はありません。

void update(enumeration queries)

エディタの入力方式クエリ属性に状態の変化が生じた際、プラットフォームの入力方式に通知するために、入力アイテムによって呼び出されます。この関数を呼び出す際は、queries パラメータを使用して、どのような変更があったかを伝える必要があります。入力方式はこれを利用して、QInputMethodQueryEvent を通じて、関心のある属性についてクエリを実行することができます。

特に、カーソル位置が変更されるたびに `update()` を呼び出すことが重要です。これは、カーソル位置の変更に伴い、周囲のテキストやテキストの選択範囲といった他のクエリ属性も変更されることが多いためです。カーソル位置とともに頻繁に変更される属性は、利便性のため `Qt::ImQueryInput ` の値にまとめられています。

Qt::InputMethodQueriesも参照してください 。