QTextFrame

The QTextFrame class represents a frame in a QTextDocument . More

Inheritance diagram of PySide6.QtGui.QTextFrame

Inherited by: QTextTable

Synopsis

Functions

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.

class PySide6.QtGui.QTextFrame(doc)
Parameters

docPySide6.QtGui.QTextDocument

Creates a new empty frame for the text document.

PySide6.QtGui.QTextFrame.__iter__()
Return type

object

PySide6.QtGui.QTextFrame.begin()
Return type

PySide6.QtGui.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()

PySide6.QtGui.QTextFrame.childFrames()
Return type

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

See also

parentFrame()

PySide6.QtGui.QTextFrame.end()
Return type

PySide6.QtGui.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()

PySide6.QtGui.QTextFrame.firstCursorPosition()
Return type

PySide6.QtGui.QTextCursor

Returns the first cursor position inside the frame.

PySide6.QtGui.QTextFrame.firstPosition()
Return type

int

Returns the first document position inside the frame.

PySide6.QtGui.QTextFrame.frameFormat()
Return type

PySide6.QtGui.QTextFrameFormat

Returns the frame’s format.

See also

setFrameFormat()

PySide6.QtGui.QTextFrame.lastCursorPosition()
Return type

PySide6.QtGui.QTextCursor

Returns the last cursor position inside the frame.

PySide6.QtGui.QTextFrame.lastPosition()
Return type

int

Returns the last document position inside the frame.

PySide6.QtGui.QTextFrame.parentFrame()
Return type

PySide6.QtGui.QTextFrame

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

PySide6.QtGui.QTextFrame.setFrameFormat(format)
Parameters

formatPySide6.QtGui.QTextFrameFormat

Sets the frame’s format.

See also

frameFormat()