QTextObject#
The QTextObject class is a base class for different kinds of objects that can group parts of a QTextDocument together. More…
Inherited by: QTextFrame, QTextTable, QTextBlockGroup, QTextList
Synopsis#
Functions#
def
document()def
format()def
formatIndex()def
objectIndex()def
setFormat(format)
Detailed Description#
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
- class PySide6.QtGui.QTextObject(doc)#
- Parameters
Creates a new QTextObject for the given document.
Warning
This function should never be called directly, but only from createObject() .
- PySide6.QtGui.QTextObject.document()#
- Return type
Returns the document this object belongs to.
See also
- PySide6.QtGui.QTextObject.format()#
- Return type
Returns the text object’s format.
See also
- PySide6.QtGui.QTextObject.formatIndex()#
- Return type
int
Returns the index of the object’s format in the document’s internal list of formats.
See also
- PySide6.QtGui.QTextObject.objectIndex()#
- Return type
int
Returns the object index of this object. This can be used together with setObjectIndex() .
- PySide6.QtGui.QTextObject.setFormat(format)#
- Parameters
format –
PySide6.QtGui.QTextFormat
Sets the text object’s format.
See also