PySide6.QtGui.QAccessibleTextInterface

class QAccessibleTextInterface

QAccessibleTextInterface 类实现了对文本处理的支持。更多…

概要

虚拟方法

注意

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

详细描述

此接口对应于IAccessibleText接口。它应该由显示比普通标签更多文本的小部件实现。标签应该仅由QAccessibleInterface表示，并将其文本作为名称返回（使用text()，类型为Name）。QAccessibleTextInterface通常用于屏幕阅读器可能希望逐行阅读的文本，以及支持文本选择和输入的小部件。例如，此接口是为QLineEdit实现的。

IAccessible2 规范

abstract addSelection(startOffset, endOffset)
Parameters:

  • startOffset – int

  • endOffset – int

选择从startOffset到endOffset的文本。startOffset是将被选择的第一个字符。endOffset是将不被选择的第一个字符。

当对象支持多选时（例如在文字处理器中），这会添加一个新的选择，否则它会替换之前的选择。

选择的内容长度将为endOffset - startOffset个字符。

abstract attributes(offset, startOffset, endOffset)
Parameters:

  • offset – int

  • startOffset – int

  • endOffset – int

Return type:

字符串

返回位置offset处的文本属性。此外，属性的范围在startOffset和endOffset中返回。

abstract characterCount()
Return type:

整数

返回文本的长度（包括空格的总大小）。

abstract characterRect(offset)
Parameters:

offset – int

Return type:

QRect

返回屏幕上位置offset处字符的位置和大小。

abstract cursorPosition()
Return type:

整数

返回当前光标位置。

另请参阅

setCursorPosition()

abstract offsetAtPoint(point)
Parameters:

点 – QPoint

Return type:

整数

返回屏幕坐标中point处字符的偏移量。

abstract removeSelection(selectionIndex)
Parameters:

selectionIndex – int

清除索引为 selectionIndex 的选择。

abstract scrollToSubstring(startIndex, endIndex)
Parameters:

  • startIndex – int

  • endIndex – int

确保在startIndex和endIndex之间的文本是可见的。

abstract selection(selectionIndex, startOffset, endOffset)
Parameters:

  • selectionIndex – int

  • startOffset – int

  • endOffset – int

返回一个选择。选择的大小在startOffset和endOffset中返回。如果没有选择，startOffset和endOffset都是None。

无障碍API支持多选。但对于大多数小部件，仅支持一个选择，且selectionIndex等于0。

另请参阅

setSelection()

abstract selectionCount()
Return type:

整数

返回此文本中的选择数量。

abstract setCursorPosition(position)
Parameters:

position – int

将光标移动到 position。

另请参阅

cursorPosition()

abstract setSelection(selectionIndex, startOffset, endOffset)
Parameters:

  • selectionIndex – int

  • startOffset – int

  • endOffset – int

将选择 selectionIndex 设置为从 startOffset 到 endOffset 的范围。

abstract text(startOffset, endOffset)
Parameters:

  • startOffset – int

  • endOffset – int

Return type:

字符串

返回从startOffset到endOffset的文本。startOffset是将返回的第一个字符。endOffset是将不会返回的第一个字符。

textAfterOffset(offset, boundaryType, startOffset, endOffset)
Parameters:

  • offset – int

  • boundaryType – TextBoundaryType

  • startOffset – int

  • endOffset – int

Return type:

字符串

返回类型为boundaryType的文本项，该文本项紧接在偏移量offset之后，并将startOffset和endOffset的值设置为该项的起始和结束位置；如果没有这样的项，则返回空字符串。在错误情况下，将startOffset和endOffset的值设置为-1。

此默认实现适用于小型文本编辑。文字处理器或文本编辑器应提供其自身的高效实现。此函数不区分段落和行。

注意

此函数无法考虑光标位置。按照惯例，offset 为 -2 表示此函数应使用光标位置作为偏移量。因此，在调用此函数之前，必须将偏移量 -2 转换为光标位置。偏移量 -1 用于文本长度，此函数的自定义实现必须返回结果，就好像长度作为偏移量传入一样。

textAtOffset(offset, boundaryType, startOffset, endOffset)
Parameters:

  • offset – int

  • boundaryType – TextBoundaryType

  • startOffset – int

  • endOffset – int

Return type:

字符串

返回类型为boundaryType的文本项在偏移量offset处，并将startOffset和endOffset值设置为该项的起始和结束位置；如果没有这样的项，则返回空字符串。在错误时，将startOffset和endOffset值设置为-1。

此默认实现适用于小型文本编辑。文字处理器或文本编辑器应提供其自身的高效实现。此函数不区分段落和行。

注意

此函数无法考虑光标位置。按照惯例，offset 为 -2 表示此函数应使用光标位置作为偏移量。因此，在调用此函数之前，必须将偏移量 -2 转换为光标位置。偏移量 -1 用于文本长度，此函数的自定义实现必须返回结果，就好像长度作为偏移量传入一样。

textBeforeOffset(offset, boundaryType, startOffset, endOffset)
Parameters:

  • offset – int

  • boundaryType – TextBoundaryType

  • startOffset – int

  • endOffset – int

Return type:

字符串

返回接近偏移量offset的类型为boundaryType的文本项，并将startOffset和endOffset的值设置为该项的起始和结束位置；如果没有这样的项，则返回空字符串。在错误情况下，将startOffset和endOffset的值设置为-1。

此默认实现适用于小型文本编辑。文字处理器或文本编辑器应提供其自身的高效实现。此函数不区分段落和行。

注意

此函数无法考虑光标位置。按照惯例，offset 为 -2 表示此函数应使用光标位置作为偏移量。因此，在调用此函数之前，必须将偏移量 -2 转换为光标位置。偏移量 -1 用于文本长度，此函数的自定义实现必须返回结果，就好像长度作为偏移量传入一样。