VirtualKeyboardSettings QML Type

仮想キーボードの設定を行います。詳細...

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

プロパティ

• activeLocales : list<string> (since QtQuick.VirtualKeyboard.Settings 2.0)
• arrowKeyNavigationEnabled : bool (since 6.11)
• availableLocales : list<string> (since QtQuick.VirtualKeyboard.Settings 2.0)
• closeOnReturn : bool (since 6.8)
• defaultDictionaryDisabled : bool (since 6.1)
• defaultInputMethodDisabled : bool (since 6.1)
• fullScreenMode : bool (since QtQuick.VirtualKeyboard.Settings 2.2)
• handwritingModeDisabled : bool (since 6.1)
• hwrTimeoutForAlphabetic : bool (since 6.1)
• hwrTimeoutForCjk : bool (since 6.1)
• inputMethodHints : int (since 6.1)
• keySoundVolume : real (since 6.9)
• locale : string (since QtQuick.VirtualKeyboard.Settings 2.0)
• styleName : string
• userDataPath : bool (since 6.1)
• visibleFunctionKeys : enumeration (since 6.6)
• wordCandidateList (since QtQuick.VirtualKeyboard.Settings 2.2)
  • wordCandidateList.alwaysVisible : bool (since QtQuick.VirtualKeyboard.Settings 2.2)
  • wordCandidateList.autoHideDelay : int (since QtQuick.VirtualKeyboard.Settings 2.2)

信号

• userDataReset()

詳細な説明

この型は、仮想キーボードの設定を行うために使用できる VirtualKeyboardSettings のシングルトンインスタンスを提供します。

なお、設定は現在のアプリケーションのライフタイム中のみ有効であり、設定の変更は永続的ではないことにご注意ください。

たとえば、アプリケーション内でキーボードのスタイルを変更するには：

Component.onCompleted: VirtualKeyboardSettings.styleName = "retro"

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

activeLocales : list<string> [since QtQuick.VirtualKeyboard.Settings 2.0]

このプロパティには、仮想キーボードで有効になっている言語の一覧が含まれています。

有効な言語のリストは利用可能な言語のサブセットであり、アプリケーションの実行期間中に利用可能な言語のリストを制限するために使用できます。

言語のリストは、指定された順序に基づいて表示されます。

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

arrowKeyNavigationEnabled : bool [since 6.11]

このプロパティを使用して、矢印キーによるナビゲーションを有効または無効にします。

このプロパティは Qt 6.11 で導入されました。

availableLocales : list<string> [read-only, since QtQuick.VirtualKeyboard.Settings 2.0]

このプロパティには、仮想キーボードでサポートされている言語の一覧が含まれています。

このリストは読み取り専用であり、仮想キーボードのビルド時の設定に依存します。

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

closeOnReturn : bool [since 6.8]

このプロパティを設定すると、仮想キーボードを非表示にできます。

このプロパティをtrue に設定すると、Qt::Key_Enter またはQt::Key_Return キーが離された際に仮想キーボードが非表示になります。デフォルトはfalse です。

このプロパティは Qt 6.8 で導入されました。

defaultDictionaryDisabled : bool [since 6.1]

このプロパティは、デフォルトの辞書を無効にします。この設定の目的は、標準の辞書の代わりにカスタム辞書のみを使用できるようにすることです。

このプロパティは Qt 6.1 で導入されました。

defaultInputMethodDisabled : bool [since 6.1]

このプロパティは、デフォルトの入力方式を無効にします。この設定の目的は、デフォルトの入力方式をプレーン入力方式で上書きし、その機能を無効にすることです。

このプロパティは Qt 6.1 で導入されました。

fullScreenMode : bool [since QtQuick.VirtualKeyboard.Settings 2.2]

このプロパティは、仮想キーボードのフルスクリーンモードを有効にします。

フルスクリーンモードでは、仮想キーボードは、フォーカスされている入力フィールドの内容を、キーボード上部に位置するフルスクリーン入力フィールドに反映します。

たとえば、画面のアスペクト比が 16:9 より大きい場合にフルスクリーンモードを有効にするには、次のようにします。

Binding {
    target: VirtualKeyboardSettings
    property: "fullScreenMode"
    value: (Screen.width / Screen.height) > (16.0 / 9.0)
}

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

handwritingModeDisabled : bool [since 6.1]

このプロパティを設定すると、システムで手書き入力モードが利用可能な場合でも、そのモードを無効にすることができます。

このプロパティをtrue に設定すると、キーボードレイアウトから手書きボタンが非表示になり、ユーザーは手書き入力モードに切り替えることができなくなります。

このプロパティは Qt 6.1 で導入されました。

hwrTimeoutForAlphabetic : bool [since 6.1]

このプロパティは、アルファベット系言語の手書き文字認識のタイムアウト時間を設定します。

デフォルトでは、タイムアウトは 500 ミリ秒です。

このプロパティは Qt 6.1 で導入されました。

hwrTimeoutForCjk : bool [since 6.1]

このプロパティは、中国語・日本語・韓国語の手書き認識のタイムアウトを設定します。

デフォルトでは、タイムアウトは500ミリ秒です。

このプロパティは Qt 6.1 で導入されました。

inputMethodHints : int [since 6.1]

このプロパティを使用すると、永続的な入力方式のヒントを設定できます。

このプロパティの値は、入力コントロールからの入力方式のヒントと組み合わされます。たとえば、予測テキスト入力を無効にするには、このプロパティをQt::ImhNoPredictiveText に設定します。

このプロパティは Qt 6.1 で導入されました。

keySoundVolume : real [since 6.9]

このプロパティは、キーサウンドの音量レベルを保持します。レベルは [0,1] の範囲です。

このプロパティは Qt 6.9 で導入されました。

locale : string [since QtQuick.VirtualKeyboard.Settings 2.0]

このプロパティは、キーボードのデフォルトのロケールを指定します。

ロケールが指定されていない場合は、代わりにシステムの既定のロケールが使用されます。

キーボードのロケールが新しいデフォルトのロケールと異なる場合、新しいロケールを反映するためにキーボードの言語が直ちに変更されます。ロケールの設定が正しくない場合、またはサポートされているロケールのリストに含まれていない場合は、その設定は無視され、代わりにデフォルト設定が使用されます。

ロケールは、availableLocales のリストに含まれている場合にサポートされます。

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

styleName : string

このプロパティは現在のスタイルを表します。アプリケーションは、styleName に別の値を設定することで、キーボードのスタイルを変更できます。

環境変数 QT_VIRTUALKEYBOARD_STYLE を設定することで、システム全体のキーボードスタイルを変更することができます。

userDataPath : bool [since 6.1]

このプロパティは、仮想キーボードおよびそのプラグインのユーザーデータパスを設定します。

デフォルトでは、ユーザーデータパスは `GenericConfigLocation ` + "/qtvirtualkeyboard" に設定されています。

このプロパティは Qt 6.1 で導入されました。

visibleFunctionKeys : enumeration [since 6.6]

この設定では、キーボードレイアウト上の特定のファンクションキーの表示/非表示を切り替えることができます。ファンクションキーが表示されていない場合でも、歯車メニューからその機能にアクセスすることは可能です。

値は、以下のフラグの組み合わせで指定できます：

• QtVirtualKeyboard.KeyboardFunctionKeys.None すべてのファンクションキーを非表示にする
• QtVirtualKeyboard.KeyboardFunctionKeys.Hide 「ファンクションキーを非表示」が有効
• QtVirtualKeyboard.KeyboardFunctionKeys.Language 言語ファンクションキーを表示
• QtVirtualKeyboard.KeyboardFunctionKeys.All すべてのファンクションキーを表示する

デフォルトはQtVirtualKeyboard.KeyboardFunctionKeys.All です。

このプロパティはQt 6.6で導入されました。

wordCandidateList group

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

シグナルのドキュメント

userDataReset()

アプリケーションは、ユーザーのデータがリセットされる前にこのシグナルを発生させ、ユーザーデータディレクトリ内のすべてのファイルを閉じる必要があることを仮想キーボードに通知します。