QVirtualKeyboardAbstractInputMethod Class

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

[explicit] QVirtualKeyboardAbstractInputMethod::QVirtualKeyboardAbstractInputMethod(QObject *parent = nullptr)

parent を使用して入力メソッドを構築します。

[virtual noexcept] QVirtualKeyboardAbstractInputMethod::~QVirtualKeyboardAbstractInputMethod()

入力メソッドを破棄し、割り当てられたすべてのリソースを解放します。

[virtual slot, since 6.1] void QVirtualKeyboardAbstractInputMethod::clearInputMode()

入力モードを解除します。

このメソッドは、この入力方式が別の入力方式に置き換えられる際に、仮想キーボードによって呼び出されます。このメソッドでは、setInputMode() メソッドによって行われた操作を解除する必要があります。例えば、仮想キーボードからのシグナルハンドラを解除したり、リソースを解放したりします。

setInputMode() を呼び出すことで、入力モードを再度有効にすることができます。ただし、setInputMethod() と clearInputMethod() の呼び出しは必ずしも対称的ではない点に注意してください。したがって、例えば、clearInputMethod() の呼び出しがないまま、setInputMethod() が複数回呼び出される可能性があります。

デフォルトの実装では何も行われません。

この関数は Qt 6.1 で導入されました。

[virtual, since QtQuick.VirtualKeyboard 2.4] bool QVirtualKeyboardAbstractInputMethod::clickPreeditText(int cursorPosition)

cursorPosition にある事前編集テキストをユーザーがクリックした際に呼び出されます。

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

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

QVirtualKeyboardInputContext *QVirtualKeyboardAbstractInputMethod::inputContext() const

入力メソッドに関連付けられた入力コンテキストを返します。このメソッドは、入力メソッドがアクティブでない場合、NULL を返します。

QVirtualKeyboardInputEngine *QVirtualKeyboardAbstractInputMethod::inputEngine() const

その入力方式に関連付けられている入力エンジンを返します。このメソッドは、入力方式がアクティブでない場合、NULL を返します。

[pure virtual] QList<QVirtualKeyboardInputEngine::InputMode> QVirtualKeyboardAbstractInputMethod::inputModes(const QString &locale)

locale の入力モードの一覧を返します。

[pure virtual] bool QVirtualKeyboardAbstractInputMethod::keyEvent(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers)

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

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

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

[virtual, since QtQuick.VirtualKeyboard 2.0] QList<QVirtualKeyboardInputEngine::PatternRecognitionMode> QVirtualKeyboardAbstractInputMethod::patternRecognitionModes() const

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

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

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

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

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

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

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

[virtual slot] void QVirtualKeyboardAbstractInputMethod::reset()

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

[signal] void QVirtualKeyboardAbstractInputMethod::selectionListActiveItemChanged(QVirtualKeyboardSelectionListModel::Type type, int index)

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

[signal] void QVirtualKeyboardAbstractInputMethod::selectionListChanged(QVirtualKeyboardSelectionListModel::Type type)

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

[virtual] QVariant QVirtualKeyboardAbstractInputMethod::selectionListData(QVirtualKeyboardSelectionListModel::Type type, int index, QVirtualKeyboardSelectionListModel::Role role)

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

[virtual] int QVirtualKeyboardAbstractInputMethod::selectionListItemCount(QVirtualKeyboardSelectionListModel::Type type)

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

[virtual] void QVirtualKeyboardAbstractInputMethod::selectionListItemSelected(QVirtualKeyboardSelectionListModel::Type type, int index)

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

[virtual] bool QVirtualKeyboardAbstractInputMethod::selectionListRemoveItem(QVirtualKeyboardSelectionListModel::Type type, int index)

このメソッドは、index にある項目を辞書から削除する必要がある場合に呼び出されます。選択リストは、type パラメータによって指定されます。単語の削除に成功した場合、この関数はtrue を返します。

[virtual] QList<QVirtualKeyboardSelectionListModel::Type> QVirtualKeyboardAbstractInputMethod::selectionLists()

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

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

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

[signal, since QtQuick.VirtualKeyboard 2.2] void QVirtualKeyboardAbstractInputMethod::selectionListsChanged()

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

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

[pure virtual] bool QVirtualKeyboardAbstractInputMethod::setInputMode(const QString &locale, QVirtualKeyboardInputEngine::InputMode inputMode)

この入力メソッドのinputMode およびlocale を設定します。成功した場合はtrue を返します。

[pure virtual] bool QVirtualKeyboardAbstractInputMethod::setTextCase(QVirtualKeyboardInputEngine::TextCase textCase)

この入力メソッドのtextCase を更新します。このメソッドは、成功した場合にtrue を返します。

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

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

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

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

[virtual, since QtQuick.VirtualKeyboard 2.0] bool QVirtualKeyboardAbstractInputMethod::traceEnd(QVirtualKeyboardTrace *trace)

このメソッドは、トレースのインタラクションが終了したときに呼び出されます。入力メソッドは、この関数が呼び出された後、適宜trace オブジェクトを破棄する必要があります。収集されたデータへのアクセス方法については、「入力メソッド向けのトレースAPI」を参照してください。

トレースインタラクションが受け入れられた場合、このメソッドはtrue を返します。

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

[virtual slot] void QVirtualKeyboardAbstractInputMethod::update()

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