QVirtualKeyboardAbstractInputMethod Class

メンバ関数ドキュメント

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

parent で入力メソッドを構築する。

[virtual noexcept] QVirtualKeyboardAbstractInputMethod::~QVirtualKeyboardAbstractInputMethod()

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

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

入力モードをクリアする。

このメソッドは、この入力メソッドが他の入力メソッドに置き換えられるときに、仮想キーボードから呼び出されます。例えば、仮想キーボードからシグナル・ハンドラを切り離したり、リソースを解放したりするために、setInputMode （）メソッドで実行された操作をクリアしなければならない。

入力モードは、setInputMode （）を呼び出すことで、再び有効にすることができる。ただし、setInputMethod()とclearInputMethod()の呼び出しは釣り合わないことに注意。したがって、たとえば、setInputMethod() は、clearInputMethod() の呼び出しと一致することなく、複数回呼び出される可能性がある。

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

この関数は QtQuick.VirtualKeyboard 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 パラメータには、キーに適用されるキー修飾子が含まれます。

このメソッドは、key イベントが正常に処理された場合、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 パラメータは、リストのゼロベースのインデックスです。

[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()

選択リストの型が変更されると、inputメソッドはこのシグナルを発する。このシグナルをトリガーに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 はスクリーンコンテキストに関する情報を提供する。

input メソッドがイベントを受け入れ、トレース入力をキャプチャしたい場合、新しいQVirtualKeyboardTrace オブジェクトを返さなければならない。このオブジェクトは、traceEnd （）メソッドが呼び出されるまで有効でなければならない。QVirtualKeyboardTrace がスクリーン上にレンダリングされると、QVirtualKeyboardTrace オブジェクトが破棄されるまで、そのオブジェクトはそのまま残ります。

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

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

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

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

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

[virtual slot] void QVirtualKeyboardAbstractInputMethod::update()

このメソッドは、入力メソッドを更新する必要があるときに入力エンジンから呼び出される。入力メソッドは、現在の編集前のテキストを閉じ、内部状態をデフォルトに戻さなければなりません。