QTextObject

PyQt5.QtGui.QTextObject

Inherits from QObject.

Inherited by QTextBlockGroup, QTextFrame.

Description

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

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, Text Object Example.

Methods

__init__(QTextDocument)

TODO

---

document() → QTextDocument

Returns the document this object belongs to.

See also

format().

---

format() → QTextFormat

Returns the text object’s format.

See also

setFormat(), document().

---

formatIndex() → int

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

See also

allFormats().

---

objectIndex() → int

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

---

setFormat(QTextFormat)

Sets the text object’s format.

See also

format().