BaseKey QML Type

すべてのキー型に共通する親クラス。詳細...

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

プロパティ

• active : bool
• alternativeKeys : var
• displayAlternativeKeys : var (since 6.2)
• displayText : string
• effectiveAlternativeKeys : var (since QtQuick.VirtualKeyboard 2.0)
• effectiveAlternativeKeysHighlightIndex : int (since QtQuick.VirtualKeyboard 2.0)
• functionKey : bool
• highlighted : bool
• key : int
• keyPanelDelegate : alias
• keyType : int (since 6.1)
• noKeyEvent : bool (since QtQuick.VirtualKeyboard 1.3)
• noModifier : bool (since QtQuick.VirtualKeyboard 1.3)
• pressed : bool
• repeat : bool
• showPreview : bool
• smallText : string (since QtQuick.VirtualKeyboard 2.0)
• smallTextVisible : bool (since QtQuick.VirtualKeyboard 2.0)
• soundEffect : url (since QtQuick.VirtualKeyboard 1.1)
• text : string
• uppercased : bool
• weight : real

信号

• clicked()

詳細説明

BaseKeyは、キーボードレイアウト内のすべてのキーに共通する型です。

この型は、レイアウト内で直接使用すべきではありません。代わりに、KeyやEnterKey などの専用のキー型を使用してください。

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

active : bool

このプロパティは、キーのアクティブ状態を保持します。

キーが押されると、このプロパティは自動的に true に設定されます。

alternativeKeys : var

代替キーのリストを設定します。

このプロパティには、文字列または文字列のリストを設定できます。値が文字列の場合、代替キーはその文字列を構成する個々の文字として表示されます。値が文字列のリストである場合は、そのリストが代わりに使用されます。

このプロパティが設定されたキーを長押しすると、代替キーがユーザーに表示されます。

デフォルトは空のリストです。

displayAlternativeKeys : var [since 6.2]

このプロパティを使用すると、「代替キー」ビューでユーザーに表示されるキー文字列のリストを上書きすることができます。

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

displayText : string

表示テキストを設定します。

この文字列はキーボードレイアウトに表示されます。

デフォルト値はキーテキストです。

effectiveAlternativeKeys : var [read-only, since QtQuick.VirtualKeyboard 2.0]

このプロパティには、ユーザーに提示される有効な代替キーが含まれます。

このリストには、alternativeKeys に含まれる項目から、text 項目を除いたものが含まれています。

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

effectiveAlternativeKeysHighlightIndex : int [read-only, since QtQuick.VirtualKeyboard 2.0]

このプロパティには、effectiveAlternativeKeys 内のハイライトされた項目のインデックスが含まれます。

このインデックスは、alternativeKeys 内のキー「text 」のインデックスから算出されます。

たとえば、代替キーに「çcċčć」が含まれており、キーtext が「c」の場合、このインデックスは 1 となり、ユーザーに実際に表示される代替キーは「ç[ċ]čć」となります。

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

functionKey : bool

ファンクションキーの属性を設定します。

デフォルト値は false です。

highlighted : bool

キーのハイライト状態を設定します。

デフォルト値は false です。

key : int

入力方式の処理に使用するキーコードを設定します。

デフォルトは Qt.Key_unknown です。

keyPanelDelegate : alias

キーのキーパネルデリゲートを設定します。

このプロパティは、キーの装飾に不可欠です。キーパネルデリゲートが設定されていない場合、キーは表示されません。このプロパティは、継承されたキー型で割り当てる必要があります。

keyType : int [since 6.1]

Key 専用キーのタイプ。取り得る値は、{QtVirtualKeyboard::KeyType}{key type enumeration} で定義されています。

たとえば、SpaceKey は、この値をQtVirtualKeyboard.KeyType.SpaceKey に設定します。

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

noKeyEvent : bool [since QtQuick.VirtualKeyboard 1.3]

このプロパティは、入力メソッド処理のためにキーがキーイベントを発行するかどうかを制御します。true の場合、キーイベントは無効になります。

デフォルトでは、キーが「unknown」でなく、かつテキストが空でない場合、キーイベントが発生します。

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

noModifier : bool [since QtQuick.VirtualKeyboard 1.3]

送信されるキーのキー修飾子を無効にします。

デフォルト値は false です。

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

pressed : bool

このプロパティは、キーの押下状態を保持します。

キーが有効かつアクティブな場合にのみ、押下状態は true になります。キーの状態が「押下」になると、入力エンジンに対してキーダウンイベントが発生します。キーが離されると、キーアップイベントが発生します。

repeat : bool

キーリピート属性を設定します。

リピートが有効になっている場合、キーが押されている間、入力イベントが繰り返し発生します。alternativeKeys も設定されている場合は、リピートを使用しないでください。

デフォルトは false です。

showPreview : bool

「プレビューを表示」属性を設定します。

デフォルトでは、ファンクションキーや、フォーカスされている入力項目（パスワードフィールドなど）が表示しているテキストを非表示にしている場合、文字プレビューのポップアップは表示されません。後者の場合、プレビューが表示されると、入力項目によって隠されている文字が露わになってしまいます。

smallText : string [since QtQuick.VirtualKeyboard 2.0]

キーの隅に表示される小さなテキストを設定します。

有効な代替キーのデフォルト項目に基づくデフォルト値。

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

smallTextVisible : bool [since QtQuick.VirtualKeyboard 2.0]

小さなテキストの表示設定を指定します。

デフォルト値は親から継承されます。

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

soundEffect : url [read-only, since QtQuick.VirtualKeyboard 1.1]

このプロパティには、キーが押された際に再生される効果音が格納されます。

効果音はキーボードスタイルで定義されているため、このプロパティは読み取り専用です。

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

text : string

入力方式の処理に使用するキーテキストを設定します。

ほとんどの場合、これはキーコードのUnicode表現です。

デフォルト値は空の文字列です。

uppercased : bool

このプロパティは、キーの大文字状態を保持します。

デフォルトでは、このプロパティはキーボードの大文字/小文字の状態を反映します。

weight : real

キーの相対的な大きさを決定するキーの重み値を設定します。

このプロパティを使用して、レイアウト内のキーのサイズを変更します。

デフォルト値は、レイアウト階層におけるキーの親要素から継承されます。

シグナルのドキュメント

clicked()

このシグナルは、キーが押されたときにトリガーされ、キーに対するカスタム処理を可能にします。