class QTextFrame

The QTextFrame class represents a frame in a QTextDocument . More

Inheritance diagram of PySide6.QtGui.QTextFrame

Inherited by: QTextTable

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

Detailed Description

Text frames provide structure for the text in a document. They are used as generic containers for other document elements. Frames are usually created by using insertFrame() .

Frames can be used to create hierarchical structures in rich text documents. Each document has a root frame ( rootFrame() ), and each frame beneath the root frame has a parent frame and a (possibly empty) list of child frames. The parent frame can be found with parentFrame() , and the childFrames() function provides a list of child frames.

Each frame contains at least one text block to enable text cursors to insert new document elements within. As a result, the iterator class is used to traverse both the blocks and child frames within a given frame. The first and last child elements in the frame can be found with begin() and end() .

A frame also has a format (specified using QTextFrameFormat ) which can be set with setFormat() and read with format() .

Text cursors can be obtained that point to the first and last valid cursor positions within a frame; use the firstCursorPosition() and lastCursorPosition() functions for this. The frame’s extent in the document can be found with firstPosition() and lastPosition() .

You can iterate over a frame’s contents using the iterator class: this provides read-only access to its internal list of text blocks and child frames.

__init__(doc)
Parameters:

docQTextDocument

Creates a new empty frame for the text document.

__iter__()
Return type:

object

begin()
Return type:

iterator

Returns an iterator pointing to the first document element inside the frame. Please see the document STL-style-Iterators for more information.

See also

end()

childFrames()
Return type:

.list of QTextFrame

Returns a (possibly empty) list of the frame’s child frames.

See also

parentFrame()

end()
Return type:

iterator

Returns an iterator pointing to the position past the last document element inside the frame. Please see the document STL-Style Iterators for more information.

See also

begin()

firstCursorPosition()
Return type:

QTextCursor

Returns the first cursor position inside the frame.

firstPosition()
Return type:

int

Returns the first document position inside the frame.

frameFormat()
Return type:

QTextFrameFormat

Returns the frame’s format.

See also

setFrameFormat()

lastCursorPosition()
Return type:

QTextCursor

Returns the last cursor position inside the frame.

lastPosition()
Return type:

int

Returns the last document position inside the frame.

parentFrame()
Return type:

QTextFrame

Returns the frame’s parent frame. If the frame is the root frame of a document, this will return 0.

setFrameFormat(format)
Parameters:

formatQTextFrameFormat

Sets the frame’s format.

See also

frameFormat()