PySide6.QtGui.QInputMethod¶

class QInputMethod¶

QInputMethod 类提供了对活动文本输入方法的访问。更多…

概要¶

属性¶

• anchorRectangleᅟ - 输入项的锚定矩形在窗口坐标中

• animatingᅟ - 当虚拟键盘正在打开或关闭时为True

• cursorRectangleᅟ - 输入项的窗口坐标中的光标矩形

• inputDirectionᅟ - 当前输入方向

• inputItemClipRectangleᅟ - 输入项在窗口坐标中的裁剪矩形

• keyboardRectangleᅟ - 虚拟键盘在窗口坐标中的几何形状

• localeᅟ - 当前输入区域设置

• visibleᅟ - 虚拟键盘在屏幕上的可见性

方法¶

• def anchorRectangle()

• def cursorRectangle()

• def inputDirection()

• def inputItemClipRectangle()

• def inputItemRectangle()

• def inputItemTransform()

• def isAnimating()

• def isVisible()

• def keyboardRectangle()

• def locale()

• def setInputItemRectangle()

• def setInputItemTransform()

• def setVisible()

插槽¶

• def commit()

• def hide()

• def invokeAction()

• def reset()

• def show()

• def update()

信号¶

• def anchorRectangleChanged()

• def animatingChanged()

• def cursorRectangleChanged()

• def inputDirectionChanged()

• def inputItemClipRectangleChanged()

• def keyboardRectangleChanged()

• def localeChanged()

• def visibleChanged()

静态函数¶

• def queryFocusObject()

注意

本文档可能包含从C++自动翻译到Python的代码片段。我们始终欢迎对代码片段翻译的贡献。如果您发现翻译问题，您也可以通过在我们的https:/bugreports.qt.io/projects/PYSIDE上创建工单来告知我们。

详细描述¶

QInputMethod 被文本编辑器用于集成到平台文本输入方法中，更常见的是被应用程序视图用于查询各种文本输入方法相关的信息，如虚拟键盘的可见性和键盘尺寸。

Qt Quick 还通过 Qt 全局对象在 QML 中提供了对 QInputMethod 的访问，作为 Qt.inputMethod 属性。

class Action¶

表示用户执行的操作类型。

常量	描述
QInputMethod.Click	正常的点击/轻触
QInputMethod.ContextMenu	上下文菜单点击/轻触（例如右键或长按）

另请参阅

invokeAction()

注意

当使用from __feature__ import true_property时，属性可以直接使用，否则通过访问器函数使用。

property anchorRectangleᅟ: QRectF¶

此属性保存输入项在窗口坐标中的锚点矩形。

锚定矩形通常被各种文本编辑控件使用，如文本预测弹出窗口，用于跟随文本选择。

Access functions:

• anchorRectangle()

• 信号 anchorRectangleChanged()

property animatingᅟ: bool¶

当虚拟键盘正在打开或关闭时，此属性为True。

当键盘完全打开或关闭时，动画为false。当animating为true且visibility为true时，键盘正在打开。当animating为true且visibility为false时，键盘正在关闭。

Access functions:

• isAnimating()

• 信号 animatingChanged()

property cursorRectangleᅟ: QRectF¶

此属性保存输入项在窗口坐标中的光标矩形。

光标矩形通常被各种文本编辑控件使用，如文本预测弹出窗口，用于跟随正在输入的文本。

Access functions:

• cursorRectangle()

• 信号 cursorRectangleChanged()

property inputDirectionᅟ: Qt.LayoutDirection¶

此属性保存当前输入方向。

Access functions:

• inputDirection()

• 信号 inputDirectionChanged()

property inputItemClipRectangleᅟ: QRectF¶

此属性保存输入项在窗口坐标中的裁剪矩形。

裁剪后的输入矩形通常被各种输入方法用来确定输入方法（例如虚拟键盘）可用的屏幕空间大小。

Access functions:

• inputItemClipRectangle()

• 信号 inputItemClipRectangleChanged()

property keyboardRectangleᅟ: QRectF¶

此属性保存虚拟键盘在窗口坐标中的几何形状。

如果无法知道键盘的几何形状，这可能是一个空矩形。这是Android上浮动键盘的情况。

Access functions:

• keyboardRectangle()

• 信号 keyboardRectangleChanged()

property localeᅟ: QLocale¶

此属性保存当前输入区域设置。

Access functions:

• locale()

• 信号 localeChanged()

property visibleᅟ: bool¶

此属性表示虚拟键盘在屏幕上的可见性。

对于没有虚拟键盘的设备，输入法可见性保持为false。

另请参阅

show() hide()

Access functions:

• isVisible()

• 信号 visibleChanged()

anchorRectangle()¶

Return type:

QRectF

属性 anchorRectangleᅟ 的获取器。

anchorRectangleChanged()¶

属性 anchorRectangleᅟ 的通知信号。

animatingChanged()¶

属性 animatingᅟ 的通知信号。

commit()¶

将用户当前正在输入的单词提交到编辑器中。该函数主要由具有文本预测功能的输入方法以及用于输入字符的脚本与实际附加到编辑器的脚本不同的方法所需。任何中断文本输入的操作都需要通过调用commit()函数来刷新输入状态，例如当光标移动到其他地方时。

cursorRectangle()¶

Return type:

QRectF

属性 cursorRectangleᅟ 的获取器。

cursorRectangleChanged()¶

属性 cursorRectangleᅟ 的通知信号。

hide()¶

请求关闭虚拟键盘。

通常应用程序不需要调用此函数，当文本编辑器失去焦点时，例如当父视图关闭时，键盘应自动关闭。

inputDirection()¶

Return type:

LayoutDirection

属性 inputDirectionᅟ 的获取器。

inputDirectionChanged(newDirection)¶

Parameters:

newDirection – LayoutDirection

属性 inputDirectionᅟ 的通知信号。

inputItemClipRectangle()¶

Return type:

QRectF

属性 inputItemClipRectangleᅟ 的获取器。

inputItemClipRectangleChanged()¶

属性 inputItemClipRectangleᅟ 的通知信号。

inputItemRectangle()¶

Return type:

QRectF

返回输入项在输入项坐标中的几何形状。

另请参阅

setInputItemRectangle()

inputItemTransform()¶

Return type:

QTransform

返回从输入项坐标到窗口坐标的转换。

另请参阅

setInputItemTransform()

invokeAction(a, cursorPosition)¶

Parameters:

• a – 操作

• cursorPosition – int

当用户点击当前正在输入的单词时，由输入项调用，如操作a和给定的cursorPosition所示。输入法通常使用此信息向用户提供更多的单词建议。

isAnimating()¶

Return type:

布尔

属性 animatingᅟ 的获取器。

isVisible()¶

Return type:

布尔

属性 visibleᅟ 的获取器。

keyboardRectangle()¶

Return type:

QRectF

属性 keyboardRectangleᅟ 的获取器。

keyboardRectangleChanged()¶

属性 keyboardRectangleᅟ 的通知信号。

locale()¶

Return type:

QLocale

属性 localeᅟ 的获取器。

localeChanged()¶

属性 localeᅟ 的通知信号。

static queryFocusObject(query, argument)¶

Parameters:

• query – InputMethodQuery

• argument – 对象

Return type:

对象

发送 query 到当前焦点对象，并使用参数 argument 返回结果。

reset()¶

重置输入法状态。例如，文本编辑器通常在插入文本之前调用此方法，以使小部件准备好接受文本。

当聚焦的编辑器发生变化时，输入法会自动重置。

setInputItemRectangle(rect)¶

Parameters:

矩形 – QRectF

将输入项的几何形状设置为rect，以输入项坐标表示。每当项在场景内移动或焦点发生变化时，需要由聚焦窗口（如QQuickCanvas）更新此设置。

另请参阅

inputItemRectangle()

setInputItemTransform(transform)¶

Parameters:

transform – QTransform

将输入项坐标到窗口坐标的转换设置为transform。每当项在场景内移动时，焦点窗口（如QQuickCanvas）需要更新项转换。

另请参阅

inputItemTransform()

setVisible(visible)¶

Parameters:

visible – 布尔值

控制键盘的可见性。相当于调用 show()（如果 visible 是 true）或 hide()（如果 visible 是 false）。

另请参阅

isVisible() show() hide()

show()¶

请求虚拟键盘打开。如果平台不提供虚拟键盘，则可见性保持为false。

通常应用程序不需要调用此函数，当文本编辑器获得焦点时，键盘应自动打开。

update(queries)¶

Parameters:

查询 – InputMethodQuery 的组合

由输入项调用，以在编辑器的输入法查询属性发生状态变化时通知平台输入法。调用函数时，必须使用queries参数来告知发生了什么变化，输入法可以使用该参数来查询它感兴趣的属性QInputMethodQueryEvent。

特别是在光标位置发生变化时调用update非常重要，因为这通常会导致其他查询属性（如周围文本和文本选择）也发生变化。为了方便起见，与光标位置一起经常变化的属性已被分组在Qt::ImQueryInput值中。

visibleChanged()¶

属性 visibleᅟ 的通知信号。