本页内容

VirtualKeyboardSettings QML Type

提供虚拟键盘的设置。更多...

Import Statement: import QtQuick.VirtualKeyboard.Settings
Since: QtQuick.VirtualKeyboard 1.2

属性

信号

详细说明

该类型提供了一个 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

wordCandidateList.alwaysVisible : bool [since QtQuick.VirtualKeyboard.Settings 2.2]

wordCandidateList.autoHideDelay : int [since QtQuick.VirtualKeyboard.Settings 2.2]

名称描述
autoHideDelay此属性定义当单词候选项列表为空时,隐藏该列表所需的延迟时间(单位为毫秒)。

如果该值为0 ,则列表清空后会立即隐藏。

如果值为-1 ,则该列表将一直显示,直到输入焦点发生变化或输入面板被隐藏为止。

默认值为5000 毫秒。

alwaysVisible此属性定义词汇候选项列表是否应始终保持可见。

默认值为false 。

autoCommitWord此属性启用了自动确认功能,当词汇候选列表缩小到仅剩一个候选词时,该功能即被激活。

当单词候选项列表最初包含多个单词,并在后续输入后缩减为单个单词时,自动确认功能便会生效。该单词将被自动选中并确认,无需用户干预。

该属性默认设置为false 。

这些属性在 QtQuick.VirtualKeyboard.Settings 2.2 中引入。

信号文档

userDataReset()

在用户数据被重置之前,应用程序会触发此信号,以通知虚拟键盘必须关闭用户数据目录中的所有文件。

注意: 相应的处理程序 是onUserDataReset 。

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.