QTextFrame 类
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) | |
| 虚 | ~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。
成员函数文档
[显式] QTextFrame::QTextFrame(QTextDocument *document)
为文本 document 创建一个新的空框架。
[虚拟 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)
设置框架的格式。
另见：frameFormat。
© 2024 Qt公司有限公司。此处包含的文档贡献的版权归各自的所有者所有。提供的文档根据由自由软件基金会发布的GNU自由文档许可证版本1.3的条款获得许可。Qt和相应的标志是芬兰及其它全球国家的Qt公司有限公司的商标。所有其他商标均为各自所有者的财产。
