QTextFrame Class
QTextFrame 类表示QTextDocument 中的一个框架 ... 更多...
| 头文件： | #include <QTextFrame> |
| CMake： | find_package(Qt6 REQUIRED COMPONENTS Gui)target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake： | QT += gui |
| 继承： | QTextObject |
| 继承于： |
- 所有成员（包括继承成员）列表
- QTextFrame 是富文本处理 API 的一部分。
注意：该类中的所有函数都是可重入的。
公共类型
公共函数
| QTextFrame(QTextDocument *document) | |
| virtual | ~QTextFrame() |
| QTextFrame::iterator | begin() const |
| QList<QTextFrame *> | childFrames() const |
| QTextFrame::iterator | end() const |
| QTextCursor | firstCursorPosition() const |
| int | firstPosition() const |
| QTextFrameFormat | frameFormat() const |
| QTextCursor | lastCursorPosition() const |
| int | lastPosition() const |
| QTextFrame * | parentFrame() const |
| void | setFrameFormat(const QTextFrameFormat &format) |
详细说明
文本框为文档中的文本提供结构。它们被用作其他文档元素的通用容器。文本框通常是通过QTextCursor::insertFrame() 创建的。
框架可用于在富文本文档中创建分层结构。每个文档都有一个根框架（QTextDocument::rootFrame()) ，根框架下的每个框架都有一个父框架和一个（可能为空）子框架列表。父框架可以通过parentFrame() 找到，而childFrames() 函数则提供了一个子框架列表。
每个框架至少包含一个文本块，以便文本游标在其中插入新的文档元素。因此，QTextFrame::iterator 类用于遍历给定框架内的块和子框架。通过begin() 和end() 可以找到框架中的第一个和最后一个子元素。
帧还有一个格式（用QTextFrameFormat 指定），可以用setFormat() 设置，用format() 读取。
使用firstCursorPosition() 和lastCursorPosition() 函数可以获得指向帧内第一个和最后一个有效光标位置的文本光标。使用firstPosition() 和lastPosition() 可以查找帧在文档中的范围。
您可以使用QTextFrame::iterator 类遍历框架的内容：它提供了对文本块和子框架内部列表的只读访问。
另请参阅 QTextCursor 和QTextDocument 。
成员函数文档
[explicit] QTextFrame::QTextFrame(QTextDocument *document)
为文本创建一个新的空框document 。
[virtual noexcept] QTextFrame::~QTextFrame()
销毁文本框。
警告 文本框归文档所有，因此切勿自行销毁。要从文档中删除文本框，请使用QTextCursor 删除其内容。
QTextFrame::iterator QTextFrame::begin() const
返回指向框架内第一个文档元素的迭代器。更多信息请参阅STL-style-Iterators文档。
另请参见 end().
QList<QTextFrame *> QTextFrame::childFrames() const
返回框架的子框架列表（可能为空）。
另请参见 parentFrame()。
QTextFrame::iterator QTextFrame::end() const
返回一个迭代器，指向经过框架内最后一个文档元素的位置。更多信息，请参阅STL-Style Iterators文档。
另请参见 begin().
QTextCursor QTextFrame::firstCursorPosition() const
返回框架内的第一个光标位置。
另请参阅 lastCursorPosition()、firstPosition() 和lastPosition()。
int QTextFrame::firstPosition() const
返回框架内第一个文档的位置。
另请参阅 lastPosition()、firstCursorPosition() 和lastCursorPosition()。
QTextFrameFormat QTextFrame::frameFormat() const
返回帧的格式。
另请参阅 setFrameFormat().
QTextCursor QTextFrame::lastCursorPosition() const
返回光标在框架内的最后位置。
另请参阅 firstCursorPosition()、firstPosition() 和lastPosition()。
int QTextFrame::lastPosition() const
返回框架内最后一个文档的位置。
另请参阅 firstPosition()、firstCursorPosition() 和lastCursorPosition()。
QTextFrame *QTextFrame::parentFrame() const
返回框架的父框架。如果框架是文档的根框架，则返回 0。
另请参阅 childFrames() 和QTextDocument::rootFrame()。
void QTextFrame::setFrameFormat(const QTextFrameFormat &format)
设置帧的format 。
另请参阅 frameFormat() 。
© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
