输入法 QML 类型

创建 QML 中输入法的基类型。更多信息...

导入语句	import QtQuick.VirtualKeyboard

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

属性

inputContext : InputContext
inputEngine : InputEngine

信号

selectionListActiveItemChanged(int type, int index)
selectionListChanged(int type)
selectionListsChanged() (自 QtQuick.VirtualKeyboard 2.2)

方法

bool clickPreeditText(int cursorPosition) (自 QtQuick.VirtualKeyboard 2.4)
list<int> inputModes(string locale)
bool keyEvent(int key, string text, int modifiers)
list<int> patternRecognitionModes() (自 QtQuick.VirtualKeyboard 2.0)
bool reselect(int cursorPosition, int reselectFlags) (自 QtQuick.VirtualKeyboard 2.0)
reset()
var selectionListData(int type, int index, int role)
int selectionListItemCount(int type)
void selectionListItemSelected(int type, int index)
list<int> selectionLists()
bool setInputMode(string locale, int inputMode)
bool setTextCase(int textCase)
Trace traceBegin(int traceId, int patternRecognitionMode, var traceCaptureDeviceInfo, var traceScreenInfo) (自 QtQuick.VirtualKeyboard 2.0)
bool traceEnd(Trace trace) (自 QtQuick.VirtualKeyboard 2.0)
update()

详细描述

InputMethod类型允许您创建一个自定义的输入法，该输入法可以被分配给InputEngine。

属性文档

inputContext : InputContext [只读]

输入上下文。

inputEngine : InputEngine [只读]

输入引擎。

信号文档

selectionListActiveItemChanged(int type, int index)

当通过type标识的选项列表中的当前index值发生变化时，输入法会发出此信号。

注意：相应的处理程序是onSelectionListActiveItemChanged。

selectionListChanged(int type)

当选项列表的内容发生变化时，输入法会发出此信号。type参数指定了哪个选项列表已更改。

注意：相应的处理程序是onSelectionListChanged。

[since QtQuick.VirtualKeyboard 2.2] selectionListsChanged()

当选项列表类型发生变化时，输入法会发出此信号。此信号将触发调用selectionLists()方法，允许输入法更新选项列表类型。

注意：相应的处理程序是onSelectionListsChanged。

该信号在QtQuick.VirtualKeyboard 2.2中引入。

方法文档

[since QtQuick.VirtualKeyboard 2.4] bool clickPreeditText(int cursorPosition)

当用户在cursorPosition位置点击预编辑文本时调用。

如果函数返回true，则表示它处理了事件。否则，输入会回退到reselect()以进行进一步处理。

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

list<int> inputModes(string locale)

返回locale的输入模式列表。

bool keyEvent(int key, string text, int modifiers)

此方法用于处理由输入引擎生成的按键事件。

key参数指定要处理的键的代码。键代码不区分大小写字母。参数text包含键的Unicode文本。参数modifiers包含应用于key的键修饰符。

如果方法返回true，表示按键事件被成功处理。如果返回值是false，则按键事件将被重新路由到默认输入法以进行进一步处理。

[since QtQuick.VirtualKeyboard 2.0] list<int> patternRecognitionModes()

返回支持的图案识别模式列表。

输入引擎调用此方法以查询支持的图案识别模式的列表。

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

[自QtQuick.VirtualKeyboard 2.0以来] bool reselect(int cursorPosition, int reselectFlags)

此方法尝试重新选择位于cursorPosition处的单词。 reselectFlags定义了单词相对于光标位置应该如何选择的规则。

InputEngine.WordBeforeCursor 激活光标之前的单词。当此标志单独使用时，单词必须正好在光标结束。
InputEngine.WordAfterCursor 激活光标之后的单词。当此标志单独使用时，单词必须正好在光标开始。
InputEngine.WordAtCursor 激活光标处的单词。此标志是上述标志的组合，只是单词不能从或到光标开始或结束。

如果单词成功重新选中，该方法返回true。

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

reset()

当此输入法需要重置时，输入法引擎会调用此方法。输入法必须仅重置其内部状态。与update()方法的区别在于，reset()仅修改输入法状态；它不得修改输入上下文。

var selectionListData(int type, int index, int role)

返回由type指定的选择列表项的数据。 role参数指定请求哪些数据。index参数是从中选择列表的零索引。

int selectionListItemCount(int type)

返回由type指定的选择列表中的项数。

void selectionListItemSelected(int type, int index)

当用户选择了索引为index的项时，会调用此方法。选择列表通过参数type识别。

list<int> selectionLists()

返回用于此输入法的选择类型列表。

输入法处于激活状态，以及每次输入法提示更新时，都会由输入法引擎调用此方法。输入法可以通过返回所需的选取列表类型来保留选取列表。

输入法可以在任何时候通过发出selectionListsChanged()信号，要求输入法引擎更新选取列表。此信号将会触发对的方法调用，允许输入法更新选取列表类型。

bool setInputMode(string locale, int inputMode)

为此输入法更改inputMode和locale。如果成功，该方法返回true。

bool setTextCase(int textCase)

为此输入法更新textCase。如果成功，该方法返回true。

文字大小写的可能值：

InputEngine.Lower 小写字符串。
InputEngine.Upper 大写字符串。

[自 QtQuick.VirtualKeyboard 2.0 开始] 跟踪 traceBegin(int traceId, int patternRecognitionMode, var traceCaptureDeviceInfo, var traceScreenInfo)

当与指定的 patternRecognitionMode 开始跟踪交互时调用此方法。跟踪通过 traceId 唯一标识。 traceCaptureDeviceInfo 提供有关源设备的信息，而 traceScreenInfo 提供有关屏幕上下文的信息。

如果输入方法接受事件并想捕获跟踪输入，则必须返回一个新的跟踪对象。此对象必须在调用 InputMethod.traceEnd() 方法之前保持有效。如果跟踪被渲染在屏幕上，它将保留在那里，直到跟踪对象被销毁。

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

[自 QtQuick.VirtualKeyboard 2.0 开始] bool traceEnd(跟踪跟踪)

当跟踪交互结束时调用此方法。输入方法应在调用此函数后的一段时间内销毁跟踪对象。成功时返回 true。

有关如何访问收集到的数据的跟踪 API，请参阅。

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

update()

当输入方法需要更新时由输入引擎调用此方法。输入方法必须关闭当前预编辑文本并恢复内部状态到默认值。