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
drawObject() functions of the interface are called.
The following list explains the required steps of inserting a custom text object into a document:
objectTypeis an integer with a value greater or equal to
QTextCharFormatobject and set the object type to the chosen type using the setObjectType() function.
ObjectReplacementCharacterwith the aforementioned
QTextCharFormatof the chosen object type into the document. As mentioned, the functions of
drawObject()will then be called with the
QTextFormatas parameter whenever the replacement character is encountered.
A class implementing a text object needs to inherit both
QObject must be the first class inherited. For instance:
class SvgTextObject(QObject, QTextObjectInterface): Q_OBJECT Q_INTERFACES(QTextObjectInterface)
The data of a text object is usually stored in the
setProperty() , and then retrieved with
Copy and Paste operations ignore custom text objects.
- class PySide6.QtGui.QTextObjectInterface¶
- PySide6.QtGui.QTextObjectInterface.drawObject(painter, rect, doc, posInDocument, format)¶
Draws this text object using the specified
The size of the rectangle,
rect, to draw in is the size previously calculated by
intrinsicSize() . The rectangles position is relative to the
You also get the document (
doc) and the position (
posInDocument) of the
format in that document.
- PySide6.QtGui.QTextObjectInterface.intrinsicSize(doc, posInDocument, format)¶
The function returns the size of the text object represented by
format in the given document (
doc) at the given position (
The size calculated will be used for subsequent calls to
drawObject() for this
© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.