InputMethod QML Type

QMLで入力メソッドを作成するための基本タイプ。詳細...

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

プロパティ

• inputContext : InputContext
• inputEngine : InputEngine

信号

• selectionListActiveItemChanged(int type, int index)
• selectionListChanged(int type)
• selectionListsChanged() (since QtQuick.VirtualKeyboard 2.2)

方法

• bool clickPreeditText(int cursorPosition) (since QtQuick.VirtualKeyboard 2.4)
• list<int> inputModes(string locale)
• bool keyEvent(int key, string text, int modifiers)
• list<int> patternRecognitionModes() (since QtQuick.VirtualKeyboard 2.0)
• bool reselect(int cursorPosition, int reselectFlags) (since QtQuick.VirtualKeyboard 2.0)
• void reset()
• var selectionListData(int type, int index, int role)
• int selectionListItemCount(int type)
• void selectionListItemSelected(int type, int index)
• list<int> selectionLists()
• bool setInputMode(string locale, int inputMode)
• bool setTextCase(int textCase)
• Trace traceBegin(int traceId, int patternRecognitionMode, var traceCaptureDeviceInfo, var traceScreenInfo) (since QtQuick.VirtualKeyboard 2.0)
• bool traceEnd(Trace trace) (since QtQuick.VirtualKeyboard 2.0)
• void update()

詳細な説明

InputMethod 型を使用すると、InputEngine に割り当て可能なカスタム入力メソッドを作成できます。

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

inputContext : InputContext [read-only]

入力コンテキスト。

inputEngine : InputEngine [read-only]

入力エンジン。

Signal ドキュメント

selectionListActiveItemChanged(int type, int index)

入力メソッドは、type で指定された選択リスト内で、現在のindex が変更されたときに、このシグナルを発行します。

selectionListChanged(int type)

この入力メソッドは、選択リストの内容が変更されたときにこのシグナルを発行します。type パラメータは、どの選択リストが変更されたかを指定します。

[since QtQuick.VirtualKeyboard 2.2] selectionListsChanged()

この入力メソッドは、選択リストの型が変更された際にこのシグナルを発行します。このシグナルにより、selectionLists() メソッドが呼び出され、入力メソッドが選択リストの型を更新できるようになります。

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

メソッドのドキュメント

[since QtQuick.VirtualKeyboard 2.4] bool clickPreeditText(int cursorPosition)

cursorPosition にあるプレエディットテキストをユーザーがクリックしたときに呼び出されます。

この関数は、イベントを処理する場合はtrue を返す必要があります。そうでない場合、入力はさらなる処理のためにreselect() にフォールバックします。

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

list<int> inputModes(string locale)

locale の入力モードのリストを返します。

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

このメソッドの目的は、入力エンジンによって生成されたキーイベントを処理することです。

key パラメータは、処理対象のキーのコードを指定します。キーコードは、大文字と小文字を区別しません。text パラメータには、キーに対応するUnicodeテキストが含まれます。modifiers パラメータには、key に適用されるキー修飾子が含まれます。

このメソッドは、キーイベントの処理に成功した場合に `true ` を返します。戻り値が `false` の場合、キーイベントはさらなる処理のためにデフォルトの入力メソッドにリダイレクトされます。

[since QtQuick.VirtualKeyboard 2.0] list<int> patternRecognitionModes()

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

このメソッドは、入力エンジンによって呼び出され、サポートされているパターン認識モードのリストを照会します。

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

[since QtQuick.VirtualKeyboard 2.0] bool reselect(int cursorPosition, int reselectFlags)

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

• InputEngine.WordBeforeCursor カーソルの直前の単語をアクティブにする。このフラグのみが使用される場合、単語はカーソル位置で正確に終わらなければならない。
• InputEngine.WordAfterCursor カーソルの後の単語をアクティブにします。このフラグのみが使用される場合、単語はカーソル位置で正確に終わっていなければなりません。
• InputEngine.WordAtCursor カーソル位置にある単語をアクティブにします。このフラグは上記のフラグを組み合わせたものですが、単語がカーソル位置で始まったり終わったりしてはならない点が異なります。

単語の再選択に成功した場合、このメソッドはtrue を返します。

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

void reset()

このメソッドは、この入力方式をリセットする必要がある場合に、入力エンジンによって呼び出されます。入力方式は、その内部状態のみをリセットしなければなりません。update() メソッドとの主な違いは、reset() が入力方式の状態のみを変更し、入力コンテキストを変更してはならないという点です。

var selectionListData(int type, int index, int role)

type で指定された選択リストの項目データを返します。role パラメータは、どのデータを要求するかを指定します。index パラメータは、選択リスト内のゼロを基点とするインデックスです。

int selectionListItemCount(int type)

type で指定された選択リスト内の項目数を返します。

void selectionListItemSelected(int type, int index)

このメソッドは、index にある項目がユーザーによって選択された際に呼び出されます。選択リストは、type パラメータによって指定されます。

list<int> selectionLists()

この入力方式で使用される選択タイプのリストを返します。

このメソッドは、入力方式がアクティブ化される際、および入力方式のヒントが更新されるたびに、入力エンジンによって呼び出されます。入力方式は、必要な選択リストの種類を返すことで、選択リストを予約することができます。

入力メソッドは、selectionListsChanged() シグナルを発行することで、いつでも入力エンジンに選択リストの更新を要求できます。このシグナルは本メソッドの呼び出しをトリガーし、入力メソッドが選択リストのタイプを更新できるようにします。

bool setInputMode(string locale, int inputMode)

この入力メソッドの `inputMode ` および `locale ` を変更します。処理が成功した場合、このメソッドは `true ` を返します。

bool setTextCase(int textCase)

この入力メソッドのtextCase を更新します。処理が成功すると、このメソッドはtrue を返します。

text_case の取り得る値は次のとおりです。

• InputEngine.Lower 小文字のテキスト。
• InputEngine.Upper 大文字のテキスト。

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

このメソッドは、指定されたpatternRecognitionMode に対してトレースのやり取りが開始されたときに呼び出されます。トレースはtraceId によって一意に識別されます。traceCaptureDeviceInfo はソースデバイスに関する情報を提供し、traceScreenInfo は画面コンテキストに関する情報を提供します。

入力メソッドがイベントを受け入れ、トレース入力をキャプチャする場合は、新しい Trace オブジェクトを返さなければなりません。このオブジェクトは、InputMethod.traceEnd() メソッドが呼び出されるまで有効な状態を維持する必要があります。トレースが画面上にレンダリングされた場合、Trace オブジェクトが破棄されるまで画面上に表示されたままになります。

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

[since QtQuick.VirtualKeyboard 2.0] bool traceEnd(Trace trace)

このメソッドは、トレースのインタラクションが終了したときに呼び出されます。入力メソッドは、この関数が呼び出された後、適宜trace オブジェクトを破棄する必要があります。成功した場合はtrue を返します。

収集されたデータへのアクセス方法については、「入力メソッド用トレースAPI」を参照してください。

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

void update()

このメソッドは、入力方式の更新が必要な際に入力エンジンによって呼び出されます。入力方式は、現在のプレエディットテキストを閉じ、内部状態をデフォルトの状態に戻す必要があります。