QAccessibleTextInterface#

The QAccessibleTextInterface class implements support for text handling. More…

Synopsis#

Virtual functions#

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

This interface corresponds to the IAccessibleText interface. It should be implemented for widgets that display more text than a plain label. Labels should be represented by only QAccessibleInterface and return their text as name ( text() with Name as type). The QAccessibleTextInterface is typically for text that a screen reader might want to read line by line, and for widgets that support text selection and input. This interface is, for example, implemented for QLineEdit.

IAccessible2 Specification

class PySide6.QtGui.QAccessibleTextInterface#
abstract PySide6.QtGui.QAccessibleTextInterface.addSelection(startOffset, endOffset)#
Parameters:

  • startOffset – int

  • endOffset – int

Select the text from startOffset to endOffset. The startOffset is the first character that will be selected. The endOffset is the first character that will not be selected.

When the object supports multiple selections (e.g. in a word processor), this adds a new selection, otherwise it replaces the previous selection.

The selection will be endOffset - startOffset characters long.

abstract PySide6.QtGui.QAccessibleTextInterface.attributes(offset, startOffset, endOffset)#
Parameters:

  • offset – int

  • startOffset – int

  • endOffset – int

Return type:

str

Returns the text attributes at the position offset. In addition the range of the attributes is returned in startOffset and endOffset.

abstract PySide6.QtGui.QAccessibleTextInterface.characterCount()#
Return type:

int

Returns the length of the text (total size including spaces).

abstract PySide6.QtGui.QAccessibleTextInterface.characterRect(offset)#
Parameters:

offset – int

Return type:

PySide6.QtCore.QRect

Returns the position and size of the character at position offset in screen coordinates.

abstract PySide6.QtGui.QAccessibleTextInterface.cursorPosition()#
Return type:

int

Returns the current cursor position.

abstract PySide6.QtGui.QAccessibleTextInterface.offsetAtPoint(point)#
Parameters:

point – PySide6.QtCore.QPoint

Return type:

int

Returns the offset of the character at the point in screen coordinates.

abstract PySide6.QtGui.QAccessibleTextInterface.removeSelection(selectionIndex)#
Parameters:

selectionIndex – int

Clears the selection with index selectionIndex.

abstract PySide6.QtGui.QAccessibleTextInterface.scrollToSubstring(startIndex, endIndex)#
Parameters:

  • startIndex – int

  • endIndex – int

Ensures that the text between startIndex and endIndex is visible.

abstract PySide6.QtGui.QAccessibleTextInterface.selection(selectionIndex, startOffset, endOffset)#
Parameters:

  • selectionIndex – int

  • startOffset – int

  • endOffset – int

Returns a selection. The size of the selection is returned in startOffset and endOffset. If there is no selection both startOffset and endOffset are None.

The accessibility APIs support multiple selections. For most widgets though, only one selection is supported with selectionIndex equal to 0.

See also

setSelection()

abstract PySide6.QtGui.QAccessibleTextInterface.selectionCount()#
Return type:

int

Returns the number of selections in this text.

abstract PySide6.QtGui.QAccessibleTextInterface.setCursorPosition(position)#
Parameters:

position – int

Moves the cursor to position.

See also

cursorPosition()

abstract PySide6.QtGui.QAccessibleTextInterface.setSelection(selectionIndex, startOffset, endOffset)#
Parameters:

  • selectionIndex – int

  • startOffset – int

  • endOffset – int

Set the selection selectionIndex to the range from startOffset to endOffset.

abstract PySide6.QtGui.QAccessibleTextInterface.text(startOffset, endOffset)#
Parameters:

  • startOffset – int

  • endOffset – int

Return type:

str

Returns the text from startOffset to endOffset. The startOffset is the first character that will be returned. The endOffset is the first character that will not be returned.

PySide6.QtGui.QAccessibleTextInterface.textAfterOffset(offset, boundaryType, startOffset, endOffset)#
Parameters:

  • offset – int

  • boundaryType – TextBoundaryType

  • startOffset – int

  • endOffset – int

Return type:

str

Returns the text item of type boundaryType that is right after offset offset and sets startOffset and endOffset values to the start and end positions of that item; returns an empty string if there is no such an item. Sets startOffset and endOffset values to -1 on error.

This default implementation is provided for small text edits. A word processor or text editor should provide their own efficient implementations. This function makes no distinction between paragraphs and lines.

Note

this function can not take the cursor position into account. By convention an offset of -2 means that this function should use the cursor position as offset. Thus an offset of -2 must be converted to the cursor position before calling this function. An offset of -1 is used for the text length and custom implementations of this function have to return the result as if the length was passed in as offset.

PySide6.QtGui.QAccessibleTextInterface.textAtOffset(offset, boundaryType, startOffset, endOffset)#
Parameters:

  • offset – int

  • boundaryType – TextBoundaryType

  • startOffset – int

  • endOffset – int

Return type:

str

Returns the text item of type boundaryType at offset offset and sets startOffset and endOffset values to the start and end positions of that item; returns an empty string if there is no such an item. Sets startOffset and endOffset values to -1 on error.

This default implementation is provided for small text edits. A word processor or text editor should provide their own efficient implementations. This function makes no distinction between paragraphs and lines.

Note

this function can not take the cursor position into account. By convention an offset of -2 means that this function should use the cursor position as offset. Thus an offset of -2 must be converted to the cursor position before calling this function. An offset of -1 is used for the text length and custom implementations of this function have to return the result as if the length was passed in as offset.

PySide6.QtGui.QAccessibleTextInterface.textBeforeOffset(offset, boundaryType, startOffset, endOffset)#
Parameters:

  • offset – int

  • boundaryType – TextBoundaryType

  • startOffset – int

  • endOffset – int

Return type:

str

Returns the text item of type boundaryType that is close to offset offset and sets startOffset and endOffset values to the start and end positions of that item; returns an empty string if there is no such an item. Sets startOffset and endOffset values to -1 on error.

This default implementation is provided for small text edits. A word processor or text editor should provide their own efficient implementations. This function makes no distinction between paragraphs and lines.

Note

this function can not take the cursor position into account. By convention an offset of -2 means that this function should use the cursor position as offset. Thus an offset of -2 must be converted to the cursor position before calling this function. An offset of -1 is used for the text length and custom implementations of this function have to return the result as if the length was passed in as offset.