InputEngine QML 类型

将用户输入映射到输入法。更多信息...

导入语句	import QtQuick.VirtualKeyboard
实例化	QVirtualKeyboardInputEngine

所有成员列表，包括继承成员

属性

activeKey : int
inputMethod : InputMethod
inputMode : int
inputModes : list<int>
patternRecognitionModes : list<int> (自 QtQuick.VirtualKeyboard 2.0)
previousKey : int
wordCandidateListModel : SelectionListModel
wordCandidateListVisibleHint : bool

信号

void activeKeyChanged(int key)
void inputMethodChanged()
void inputMethodReset()
void inputMethodUpdate()
void inputModeChanged()
void inputModesChanged()
void patternRecognitionModesChanged() (自 QtQuick.VirtualKeyboard 2.0)
void previousKeyChanged(int key)
void virtualKeyClicked(int key, string text, int modifiers)

方法

Trace traceBegin(int traceId, int patternRecognitionMode, var traceCaptureDeviceInfo, var traceScreenInfo) (自 QtQuick.VirtualKeyboard 2.0)
bool traceEnd(Trace trace)
void virtualKeyCancel()
bool virtualKeyClick(int key, string text, int modifiers)
bool virtualKeyPress(int key, string text, int modifiers, bool repeat)
bool virtualKeyRelease(int key, string text, int modifiers)

详细描述

输入引擎负责将输入事件路由到输入方法。实际的输入逻辑由输入方法实现。

输入引擎还包括默认输入方法，当活动输入方法未处理事件时，它会负责默认处理。

属性文档

activeKey : int [只读]

当前按下键。

inputMethod : InputMethod

使用此属性来设置活动输入方法，或监视活动输入方法何时发生变化。

inputMode : int

使用此属性获取或设置当前输入模式。 InputEngine::inputModes 属性为当前输入方法和区域提供了有效输入模式的列表。

预定义的输入模式包括

InputEngine.InputMode.Latin 拉丁文字的默认输入模式。
InputEngine.InputMode.Numeric 只允许数值输入。
InputEngine.InputMode.Dialable 只允许可拨号输入。
InputEngine.InputMode.Pinyin 中文拼音输入模式。
InputEngine.InputMode.Cangjie 中文笔画输入模式。
InputEngine.InputMode.Zhuyin 中文注音输入模式。
InputEngine.InputMode.Hangul 韩文输入模式。
InputEngine.InputMode.Hiragana 日文平假名输入模式。
InputEngine.InputMode.Katakana 日文片假名输入模式。
InputEngine.InputMode.FullwidthLatin东亚语言的全角拉丁输入模式。
InputEngine.InputMode.Greek希腊文输入模式。
InputEngine.InputMode.Cyrillic西里尔文输入模式。
InputEngine.InputMode.Arabic阿拉伯文输入模式。
InputEngine.InputMode.Hebrew希伯来文输入模式。
InputEngine.InputMode.ChineseHandwriting中文手写。
InputEngine.InputMode.JapaneseHandwriting日文手写。
InputEngine.InputMode.KoreanHandwriting韩文手写。
InputEngine.InputMode.Thai泰文输入模式。
InputEngine.InputMode.Stroke中文笔画输入模式。
InputEngine.InputMode.Romaji日文罗马字输入模式。

inputModes : list<int> [只读]

可用输入模式的列表取决于输入方法和区域。当依赖项之一更改时，此属性将更新。

patternRecognitionModes : list<int> [只读, 自 QtQuick.VirtualKeyboard 2.0 起使用]

可用模式识别模式的列表。

可能值

常量	描述
`InputEngine.PatternRecognitionMode.None`	模式识别不可用。
`InputEngine.PatternRecognitionMode.PatternRecognitionDisabled`	`已废弃` - 使用 `None` 代替。
`InputEngine.PatternRecognitionMode.Handwriting`	手写识别的模式识别模式。
`InputEngine.PatternRecognitionMode.HandwritingRecoginition`	`已废弃` - 使用 `Handwriting` 代替。

此属性自 QtQuick.VirtualKeyboard 2.0 引入。

previousKey : int [只读]

之前按下的键。

wordCandidateListModel : SelectionListModel [只读]

使用此属性以访问单词候选列表的列表模型。

wordCandidateListVisibleHint : bool [只读]

使用此属性以检查单词候选列表在用户界面中是否应该可见。

信号文档

void activeKeyChanged(int key)

指示活动 key 已更改。

注意: 相应的事件处理函数为 onActiveKeyChanged。

void inputMethodChanged()

指示输入法已更改。

注意: 相应的事件处理函数为 onInputMethodChanged。

void inputMethodReset()

当输入法需要重置时发出。

注意: 当输入法激活时，此信号自动连接到 QVirtualKeyboardAbstractInputMethod::reset() 和 InputMethod::reset()。

注意: 相应的事件处理函数为 onInputMethodReset。

void inputMethodUpdate()

注意: 当输入法激活时，此信号自动连接到 QVirtualKeyboardAbstractInputMethod::update() 和 InputMethod::update()。

注意: 相应的事件处理函数为 onInputMethodUpdate。

void inputModeChanged()

指示输入模式已更改。

注意: 相应的事件处理函数为 onInputModeChanged。

void inputModesChanged()

指示可用的输入模式已更改。

注意: 相应的事件处理函数为 onInputModesChanged。

[since QtQuick.VirtualKeyboard 2.0] void patternRecognitionModesChanged()

指示可用的模式识别模式已更改。

预定义的模式识别模式为

InputEngine.PatternRecognitionMode.None 模式识别不可用。
InputEngine.PatternRecognitionMode.PatternRecognitionDisabled 已废弃 使用 InputEngine.PatternRecognitionMode.None
InputEngine.PatternRecognitionMode.Handwriting 编写识别模式的模式识别模式。
InputEngine.PatternRecognitionMode.HandwritingRecoginition 已废弃 使用 InputEngine.PatternRecognitionMode.Handwriting

注意: 相应的事件处理函数为 onPatternRecognitionModesChanged。

此信号是在 QtQuick.VirtualKeyboard 2.0 中引入的。

void previousKeyChanged(int key)

指示上一个 key 已更改。

注意: 相应的事件处理函数为 onPreviousKeyChanged。

void virtualKeyClicked(int key, string text, int modifiers)

指示虚拟 key 被点击，并带有指定的 text 和 modifiers。输入法处理了按键事件后发出此信号。

注意: 相应的事件处理函数为 onVirtualKeyClicked。

方法文档

[自QtQuick.VirtualKeyboard 2.0起] 跟踪 traceBegin(整型 traceId, 整型 patternRecognitionMode, 变量 traceCaptureDeviceInfo, 变量 traceScreenInfo)

开始与输入引擎进行跟踪交互。

跟踪通过唯一的 traceId 来识别。如果输入方法接受事件，输入引擎将分配该ID给跟踪对象。

patternRecognitionMode 指定用于图案的识别模式。

如果当前输入方法接受事件，则返回与该交互相关联的跟踪对象。如果输入方法丢弃事件，则返回空值。

traceCaptureDeviceInfo 提供有关源设备和 traceScreenInfo 提供有关屏幕上下文的信息。

根据定义，跟踪对象在调用 traceEnd() 方法之前保持有效。

通过调用 InputEngine.traceEnd() 方法来结束跟踪交互。

此方法在 QtQuick.VirtualKeyboard 2.0 中引入。

布尔值 traceEnd(跟踪 trace)

结束与输入引擎的跟踪交互。

在调用此函数后， trace 对象可在任何时间点被丢弃。

如果跟踪交互被接受（即，触摸事件不应用于其他操作），则该函数返回 true。

void virtualKeyCancel()

不发出按键事件来恢复活动按键状态。该方法在用户丢弃当前键且需要恢复按键状态时非常有用。

布尔值 virtualKeyClick(整型 key, 字符串 text, 整型 modifiers)

为给定的 key、 text 和 modifiers 发出按键点击事件。如果输入引擎接受按键事件，则返回 true。

布尔值 virtualKeyPress(整型 key, 字符串 text, 整型 modifiers, 布尔值 repeat)

键盘层调用此函数，以指示已按下 key，并带有给定的 text 和 modifiers。

将 key 设置为活动键（按下键）。实际的按键事件在通过 virtualKeyRelease() 方法释放键时触发。可以通过调用 virtualKeyCancel() 来丢弃按键事件。

如果 repeat 为 true，则按键还启动键重复定时器。

如果此输入引擎接受按键，则返回 true。

另请参阅virtualKeyCancel() 和 virtualKeyRelease()。

布尔值 virtualKeyRelease(整型 key, 字符串 text, 整型 modifiers)

在键上释放键盘。如果该事件还没有由重复计时器生成，则该方法会针对输入方法发出一个键盘事件。将文本和 修饰符 传递给输入方法。

如果输入引擎接受了这个键，返回 true。