The QTextObjectInterface class allows drawing of custom text objects in QTextDocument s. More

Inheritance diagram of PySide2.QtGui.QTextObjectInterface

Detailed Description

A text object describes the structure of one or more elements in a text document; for instance, images imported from HTML are implemented using text objects. A text object knows how to lay out and draw its elements when a document is being rendered.

Qt allows custom text objects to be inserted into a document by registering a custom object type with QTextCharFormat . A QTextObjectInterface must also be implemented for this type and be registered with the QAbstractTextDocumentLayout of the document. When the object type is encountered while rendering a QTextDocument , the intrinsicSize() and drawObject() functions of the interface are called.

The following list explains the required steps of inserting a custom text object into a document:

A class implementing a text object needs to inherit both QObject and QTextObjectInterface . QObject must be the first class inherited. For instance:

class SvgTextObject : public QObject, public QTextObjectInterface

The data of a text object is usually stored in the QTextCharFormat using setProperty() , and then retrieved with property() .


Copy and Paste operations ignore custom text objects.

class PySide2.QtGui.QTextObjectInterface
PySide2.QtGui.QTextObjectInterface.drawObject(painter, rect, doc, posInDocument, format)

Draws this text object using the specified painter .

The size of the rectangle, rect , to draw in is the size previously calculated by intrinsicSize() . The rectangles position is relative to the painter .

You also get the document (doc ) and the position (posInDocument ) of the format in that document.

See also


PySide2.QtGui.QTextObjectInterface.intrinsicSize(doc, posInDocument, format)
Return type:


The function returns the size of the text object represented by format in the given document (doc ) at the given position (posInDocument ).

The size calculated will be used for subsequent calls to drawObject() for this format .

See also