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}{键类型枚举} 定义。

例如，SpaceKey 将此值设置为QtVirtualKeyboard.KeyType.SpaceKey。

该属性在 Qt 6.1 中引入。

noKeyEvent : bool [since QtQuick.VirtualKeyboard 1.3]

该属性控制键是否会触发用于输入法处理的键事件。当值为 true 时，键事件将被禁用。

默认情况下，如果键不是未知键或文本不为空，则会触发键事件。

该属性自 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()

按下该键时会触发此信号，从而可以对该键进行自定义处理。