class QInputMethod#

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

Inheritance diagram of PySide6.QtGui.QInputMethod

概要#

属性#

方法#

槽函数#

信号#

静态函数#

注意

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

详细描述#

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

Qt Quick 也通过 Qt 全局对象作为 Qt.inputMethod 属性提供对 QInputMethod 的访问。

class Action#

指示用户执行的动作类型。

常量

描述

QInputMethod.Click

一个正常点击/触摸

QInputMethod.ContextMenu

上下文菜单点击/触摸(例如右键点击或长按)

另请参阅

invokeAction()

注意

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

property anchorRectangleᅟ: QRectF#

此属性持有输入项目的锚定矩形,单位为窗口坐标。

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

访问函数
property animatingᅟ: bool#

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

当键盘完全打开或关闭时,动画为 false。当 animatingtruevisibilitytrue 时,键盘正在打开。当 animatingtruevisibility 为 false 时,键盘正在关闭。

访问函数
属性cursorRectangleᅟ: QRectF#

此属性保存输入项的指针矩形,以窗口坐标表示。

指针矩形通常被各种文本编辑控件(如文本预测弹出窗口)用于跟随正在输入的文本。

访问函数
属性inputDirectionᅟ: Qt.LayoutDirection#

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

访问函数
属性inputItemClipRectangleᅟ: QRectF#

此属性保存输入项的裁剪矩形,以窗口坐标表示。

裁剪输入矩形通常被各种输入方法用于确定输入方法(如虚拟键盘)可用的屏幕空间量。

访问函数
属性keyboardRectangleᅟ: QRectF#

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

若无法知道键盘的几何形状,则该矩形可能为空。在Android上,这是一个浮动键盘的情况。

访问函数
属性localeᅟ: QLocale#

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

访问函数
属性visibleᅟ: bool#

此属性保存虚拟键盘在屏幕上的可见性。

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

另请参阅

show() hide()

访问函数
anchorRectangle()#
返回类型:

QRectF

属性 anchorRectangle 的获取器。

anchorRectangleChanged()#

属性 anchorRectangle 的通知信号。

animatingChanged()#

属性 animating 的通知信号。

commit()#

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

cursorRectangle()#
返回类型:

QRectF

属性 cursorRectangle 的获取器。

cursorRectangleChanged()#

属性 cursorRectangle 的通知信号。

hide()#

请求虚拟键盘关闭。

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

inputDirection()#
返回类型:

布局方向

属性 inputDirection 的获取器。

inputDirectionChanged(newDirection)#
参数:

newDirectionLayoutDirection

属性 inputDirection 的通知信号。

inputItemClipRectangle()#
返回类型:

QRectF

属性 inputItemClipRectangle 的获取器。

inputItemClipRectangleChanged()#

属性 inputItemClipRectangle 的通知信号。

inputItemRectangle()#
返回类型:

QRectF

返回输入项的几何形状,以输入项坐标为单位。

inputItemTransform()#
返回类型:

QTransform

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

invokeAction(a, cursorPosition)#
参数:
  • a - Action

  • cursorPosition - int

当用户按下由动作 a 和给定的 cursorPosition 指示的当前编写的单词时,由输入项调用。输入法通常会使用此信息向用户提供更多单词建议。

isAnimating()#
返回类型:

bool

属性 animating 的获取器。

isVisible()#
返回类型:

bool

属性 visible 的获取器。

keyboardRectangle()#
返回类型:

QRectF

属性 keyboardRectangle 的获取器。

keyboardRectangleChanged()#

属性 keyboardRectangle 的通知信号。

locale()#
返回类型:

QLocale

属性 locale 的获取器。

localeChanged()#

属性 locale 的通知信号。

static queryFocusObject(query, argument)#
参数:
返回类型:

对象

query 与参数 argument 一起发送到当前焦点对象,并返回结果。

reset()#

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

当焦点编辑器更改时,输入法将自动重置。

setInputItemRectangle(rect)#
参数:

rectQRectF

将输入项的几何形状设置为 rect,在输入项坐标系中。当项在场景内部移动或在焦点更改时,此几何形状需要由焦点窗口(如 QQuickCanvas)等更新。

另请参阅

inputItemRectangle()

setInputItemTransform(transform)#
参数:

transformQTransform

设置从输入项坐标系到窗口坐标系的变换为 transform。当项在场景内部移动时,需要由焦点窗口(如 QQuickCanvas)等更新项的变换。

另请参阅

inputItemTransform()

setVisible(visible)#
参数:

visible – 布尔型

控制键盘的可见性。等价于调用 show()(当 visibletrue)或 hide()(当 visiblefalse)。

另请参阅

isVisible() show() hide()

show()#

请求开启虚拟键盘。如果该平台不提供虚拟键盘,可见性将保持为false。

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

update(queries)#
参数:

queriesInputMethodQuery 的组合

由输入项调用,以通知平台输入法编辑器的输入法查询属性发生变化时。当调用函数 queries 参数时,需要指定变化的哪些内容,输入法可以使用这些内容来查询其感兴趣的属性 QInputMethodQueryEvent

特别是,当光标位置改变时,每次调用 update 都非常重要,因为这通常会导致其他查询属性,如周围文本和文本选择等发生变化。通常与光标位置一起变化的属性已组为 Qt::ImQueryInput 以方便使用。

visibleChanged()#

属性 visible 的通知信号。