PySide6.QtGui.QTextObject

class QTextObject

The QTextObject class is a base class for different kinds of objects that can group parts of a QTextDocument together.

Details

The common grouping text objects are lists ( QTextList ), frames ( QTextFrame ), and tables ( QTextTable ). A text object has an associated format() and document() .

There are essentially two kinds of text objects: those that are used with blocks (block formats), and those that are used with characters (character formats). The first kind are derived from QTextBlockGroup , and the second kind from QTextFrame .

You rarely need to use this class directly. When creating custom text objects, you will also need to reimplement createObject() which acts as a factory method for creating text objects.

See also

QTextDocument

Inheritance diagram of PySide6.QtGui.QTextObject

Inherited by: QTextFrame, QTextTable, QTextBlockGroup, QTextList

Synopsis

Methods

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

__init__(doc)
Parameters:

doc – QTextDocument

Creates a new QTextObject for the given document.

Warning

This function should never be called directly, but only from createObject() .

document()
Return type:

QTextDocument

Returns the document this object belongs to.

See also

format()

format()
Return type:

QTextFormat

Returns the text object’s format.

formatIndex()
Return type:

int

Returns the index of the object’s format in the document’s internal list of formats.

See also

allFormats()

objectIndex()
Return type:

int

Returns the object index of this object. This can be used together with setObjectIndex() .

setFormat(format)
Parameters:

format – QTextFormat

Sets the text object’s format.

See also

format()