QTextFrame ¶

概要 ¶

详细描述 ¶

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() ，和 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.

另请参阅

QTextCursor QTextDocument

class QTextFrame ( doc ) ¶

param doc

QTextDocument

Creates a new empty frame for the text document .

PySide2.QtGui.QTextFrame. __iter__ ( ) ¶

返回类型

PyObject

PySide2.QtGui.QTextFrame. begin ( ) ¶

返回类型

iterator

Returns an iterator pointing to the first document element inside the frame. Please see the document STL-style-Iterators 了解更多信息。

另请参阅

end()

PySide2.QtGui.QTextFrame. childFrames ( ) ¶

返回类型

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

另请参阅

parentFrame()

PySide2.QtGui.QTextFrame. end ( ) ¶

返回类型

iterator

Returns an iterator pointing to the position past the last document element inside the frame. Please see the document STL 样式迭代器 了解更多信息。

另请参阅

begin()

PySide2.QtGui.QTextFrame. firstCursorPosition ( ) ¶

返回类型

QTextCursor

Returns the first cursor position inside the frame.

另请参阅

lastCursorPosition() firstPosition() lastPosition()

PySide2.QtGui.QTextFrame. firstPosition ( ) ¶

返回类型

int

Returns the first document position inside the frame.

另请参阅

lastPosition() firstCursorPosition() lastCursorPosition()

PySide2.QtGui.QTextFrame. frameFormat ( ) ¶

返回类型

QTextFrameFormat

Returns the frame’s format.

另请参阅

setFrameFormat()

PySide2.QtGui.QTextFrame. lastCursorPosition ( ) ¶

返回类型

QTextCursor

Returns the last cursor position inside the frame.

另请参阅

firstCursorPosition() firstPosition() lastPosition()

PySide2.QtGui.QTextFrame. lastPosition ( ) ¶

返回类型

int

Returns the last document position inside the frame.

另请参阅

firstPosition() firstCursorPosition() lastCursorPosition()

PySide2.QtGui.QTextFrame. parentFrame ( ) ¶

返回类型

QTextFrame

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

另请参阅

childFrames() rootFrame()

PySide2.QtGui.QTextFrame. setFrameFormat ( format ) ¶

参数

format – QTextFrameFormat

Sets the frame’s format .

另请参阅

frameFormat()