PySide6.QtGui.QTextFrame¶

class QTextFrame¶

QTextFrame 类表示 QTextDocument 中的一个框架。More_…

继承者： QTextTable

概要¶

方法¶

def __init__()
def __iter__()
def begin()
def childFrames()
def end()
def firstCursorPosition()
def firstPosition()
def frameFormat()
def lastCursorPosition()
def lastPosition()
def parentFrame()
def setFrameFormat()

注意

本文档可能包含从C++自动翻译到Python的代码片段。我们始终欢迎对代码片段翻译的贡献。如果您发现翻译问题，您也可以通过在我们的https:/bugreports.qt.io/projects/PYSIDE上创建工单来告知我们。

详细描述¶

文本框架为文档中的文本提供了结构。它们被用作其他文档元素的通用容器。框架通常通过使用insertFrame()来创建。

框架可用于在富文本文档中创建层次结构。每个文档都有一个根框架（rootFrame()），根框架下的每个框架都有一个父框架和一个（可能为空的）子框架列表。可以使用parentFrame()找到父框架，而childFrames()函数提供了子框架的列表。

每个框架至少包含一个文本块，以便文本光标可以在其中插入新的文档元素。因此，iterator 类用于遍历给定框架内的块和子框架。可以使用 begin() 和 end() 找到框架中的第一个和最后一个子元素。

一个框架也有一个格式（使用QTextFrameFormat指定），可以通过setFormat()设置，并通过format()读取。

可以获取指向帧内第一个和最后一个有效光标位置的文本光标；使用firstCursorPosition()和lastCursorPosition()函数来实现这一点。可以使用firstPosition()和lastPosition()找到帧在文档中的范围。

你可以使用iterator类来遍历框架的内容：这提供了对其内部文本块和子框架列表的只读访问。

另请参阅

QTextCursor QTextDocument

__init__(doc)¶

Parameters:: 文档 – QTextDocument

为文本 document 创建一个新的空框架。

__iter__()¶

Return type:: 对象

begin()¶

Return type:: iterator

返回一个指向框架内第一个文档元素的迭代器。有关更多信息，请参阅文档STL-style-Iterators。

另请参阅

end()

childFrames()¶

Return type:: QTextFrame的列表

返回框架的子框架的（可能为空的）列表。

另请参阅

parentFrame()

end()¶

Return type:: iterator

返回一个指向帧内最后一个文档元素之后位置的迭代器。有关更多信息，请参阅文档STL-Style Iterators。

另请参阅

begin()

firstCursorPosition()¶

Return type:: QTextCursor

返回框架内的第一个光标位置。

另请参阅

lastCursorPosition() firstPosition() lastPosition()

firstPosition()¶

Return type:: 整数

返回框架内的第一个文档位置。

另请参阅

lastPosition() firstCursorPosition() lastCursorPosition()

frameFormat()¶

Return type:: QTextFrameFormat

返回帧的格式。

另请参阅

setFrameFormat()

lastCursorPosition()¶

Return type:: QTextCursor

返回框架内的最后一个光标位置。

另请参阅

firstCursorPosition() firstPosition() lastPosition()

lastPosition()¶

Return type:: 整数

返回框架内的最后一个文档位置。

另请参阅

firstPosition() firstCursorPosition() lastCursorPosition()

parentFrame()¶

Return type:: QTextFrame

返回框架的父框架。如果框架是文档的根框架，则返回0。

另请参阅

childFrames() rootFrame()

setFrameFormat(format)¶

Parameters:: 格式 – QTextFrameFormat

设置框架的format。

另请参阅

frameFormat()

class iterator¶

迭代器类提供了一个迭代器，用于读取QTextFrame的内容。More_…

概要¶

方法¶

def __init__()
def __iter__()
def __next__()
def atEnd()
def currentBlock()
def currentFrame()
def __ne__()
def __iadd__()
def __isub__()
def __eq__()
def parentFrame()

注意

详细描述¶

一个框架由任意序列的QTextBlock和子QTextFrame组成。这个类提供了一种方法来遍历框架的子对象，并读取它们的内容。它不提供修改框架内容的方法。

__init__()¶

构造一个无效的迭代器。

__iter__()¶

Return type:: 对象

__next__()¶

Return type:: 对象

atEnd()¶

Return type:: 布尔

如果当前项是文本框架中的最后一项，则返回 true。

currentBlock()¶

Return type:: QTextBlock

返回迭代器当前指向的块。如果迭代器指向子帧，则返回的块无效。

另请参阅

currentFrame()

currentFrame()¶

Return type:: QTextFrame

返回迭代器当前指向的帧，如果迭代器当前指向一个块，则返回None。

另请参阅

currentBlock()

__ne__(o)¶

Parameters:: o – iterator
Return type:: 布尔

如果迭代器与other迭代器不同，则返回true；否则返回false。

__iadd__()¶

Return type:: iterator

将迭代器移动到下一个帧或块。

另请参阅

currentBlock() currentFrame()

__iadd__(arg__1)

Parameters:: arg__1 – 整数
Return type:: iterator

后缀 ++ 运算符 (i++) 将迭代器推进到文本框架中的下一个项目，并返回一个指向旧项目的迭代器。

__isub__()¶

Return type:: iterator

将迭代器移动到前一帧或块。

另请参阅

currentBlock() currentFrame()

__isub__(arg__1)

Parameters:: arg__1 – 整数
Return type:: iterator

后缀 -- 运算符 (i--) 使当前帧中的前一个项目，并返回一个指向旧项目的迭代器。

__eq__(o)¶

Parameters:: o – iterator
Return type:: 布尔

如果迭代器与other迭代器相同，则返回true；否则返回false。

parentFrame()¶

Return type:: QTextFrame

返回当前框架的父框架。

另请参阅

currentFrame() parentFrame()