QQuickTextDocument Class
QQuickTextDocument 类提供了对 QQuickTextEdit 的QTextDocument 的访问。更多内容...
| 头文件： | #include <QQuickTextDocument> |
| CMake： | find_package(Qt6 REQUIRED COMPONENTS Quick) target_link_libraries(mytarget PRIVATE Qt6::Quick) |
| qmake： | QT += quick |
| 在 QML 中： | TextDocument |
| 继承自： | QObject |
属性
(technology preview)errorString : QString(technology preview)modified : bool(technology preview)source : QUrl(technology preview)status : Status
公共函数
| QQuickTextDocument(QQuickItem *parent) | |
| QString | errorString() const |
| bool | isModified() const |
(technology preview) void | save() |
(technology preview) void | saveAs(const QUrl &url) |
| void | setModified(bool modified) |
| void | setSource(const QUrl &url) |
(since 6.7) void | setTextDocument(QTextDocument *document) |
| QUrl | source() const |
| QQuickTextDocument::Status | status() const |
| QTextDocument * | textDocument() const |
信号
(technology preview) void | errorStringChanged() |
(technology preview) void | modifiedChanged() |
(technology preview) void | sourceChanged() |
(technology preview) void | statusChanged() |
(since 6.7) void | textDocumentChanged() |
详细描述
该类提供对 QQuickTextEdit 元素的QTextDocument 的访问。此功能旨在支持使用 Qt 的富文本处理功能，包括文档修改。它还可用于输出内容（例如通过 `QTextDocumentWriter`），或提供额外的格式设置（例如通过 `QSyntaxHighlighter`）。
属性文档
[read-only, technology preview] errorString : QString
此枚举目前处于技术预览阶段，内容可能会有变动。
该属性包含一个易于理解的字符串，用于描述加载或保存过程中发生的错误（如有）
默认情况下，该字符串为空。
该枚举在 Qt 6.7 中引入。
访问函数：
| QString | errorString() const |
通知信号：
| void | errorStringChanged() |
另请参阅 status 、source 、save() 以及saveAs()。
[technology preview] modified : bool
此枚举目前处于技术预览阶段，可能会有变动。
该属性用于标识文档是否已被用户修改
该属性表示文档自上次加载或保存以来是否已被用户修改。默认情况下，该属性值为false 。
与QTextDocument::modified 类似，您可以设置modified属性：例如，将其设置为false ，以便将source 属性设置为另一个URL（从而丢弃用户的更改）。
该枚举在 Qt 6.7 中引入。
访问函数：
| bool | isModified() const |
| void | setModified(bool modified) |
Notifier 信号：
| void | modifiedChanged() |
另请参阅 QTextDocument::modified 。
[technology preview] source : QUrl
此枚举目前处于技术预览阶段，内容可能会有变动。
该属性存储用于加载文档内容的 URL
QQuickTextDocument 可以处理 Qt 支持的任何文本格式，并从 Qt 支持的任何 URL 方案加载。
当文档的modified 状态为true 时，无法更改source 属性。如果用户已修改文档内容，您应提示用户是否要save()，否则请先将modified 设置为false 以丢弃更改，然后再将source 属性设置为另一个URL。
该枚举在 Qt 6.7 中引入。
访问函数：
| QUrl | source() const |
| void | setSource(const QUrl &url) |
通知器信号：
| void | sourceChanged() |
另请参阅 QTextDocumentWriter::supportedDocumentFormats()。
[read-only, technology preview] status : Status
此枚举目前处于技术预览阶段，内容可能会有变动。
此属性用于存储文档加载或保存的状态
该属性用于表示文档加载或保存的状态。其取值可能为以下之一：
| 常量 | 描述 |
|---|---|
Null | 尚未加载任何文件 |
Loading | 已开始从source 读取 |
Loaded | 读取已成功完成 |
Saving | 在调用save()或saveAs()后，已开始写入文件 |
Saved | 写入已成功完成 |
ReadError | 从 xml-ph-0000@deepl.internal 读取时发生错误source |
WriteError | 在调用save() 或saveAs() 时发生错误 |
NonLocalFileError | saveAs() 调用时，URL 指向的是远程资源而非本地文件 |
此枚举在 Qt 6.7 中引入。
访问函数：
| QQuickTextDocument::Status | status() const |
通知信号：
| void | statusChanged() |
另请参阅 errorString 、source 、save() 以及saveAs()。
成员函数文档
QQuickTextDocument::QQuickTextDocument(QQuickItem *parent)
创建一个 QQuickTextDocument 对象，并将parent 作为其父对象。
[signal, technology preview] void QQuickTextDocument::errorStringChanged()
此功能处于技术预览阶段，可能会有所变动。
注意： 属性errorString 的Notifier 信号。
[signal, technology preview] void QQuickTextDocument::modifiedChanged()
此功能处于技术预览阶段，可能会有变动。
注意： 属性modified 的Notifier 信号。
[invokable, technology preview] void QQuickTextDocument::save()
此功能处于技术预览阶段，可能会有变动。
将内容保存到与source 中指定的文件和格式相同的文件中。
注意：您可以将内容 保存到本地文件，或在 Android 设备上保存到content 中的 URL。
注意： 可以通过元对象系统和 QML 调用此 函数。请参阅Q_INVOKABLE 。
该函数在 Qt 6.7 中引入。
[invokable, technology preview] void QQuickTextDocument::saveAs(const QUrl &url)
此功能处于技术预览阶段，内容可能会有变动。
将内容保存到由url 指定的文件和格式中。
url 中的文件扩展名指定了文件格式（由QMimeDatabase::mimeTypeForUrl() 确定）。
注意：您可以 将内容保存到本地文件，或在 Android 上保存到content URL。
注意： 可通过元对象系统和 QML 调用此 函数。参见Q_INVOKABLE 。
该函数在 Qt 6.7 中引入。
[since 6.7] void QQuickTextDocument::setTextDocument(QTextDocument *document)
将给定的document 进行设置。
调用方保留对该文档的所有权。
此函数在 Qt 6.7 中引入。
另请参阅 textDocument()。
[signal, technology preview] void QQuickTextDocument::sourceChanged()
此功能处于技术预览阶段，可能会有变动。
注意： 属性source 的Notifier 信号。
[signal, technology preview] void QQuickTextDocument::statusChanged()
此功能处于技术预览阶段，可能会有变动。
注意： 属性status 的监听器 信号。
QTextDocument *QQuickTextDocument::textDocument() const
返回指向QTextDocument 对象的指针。
另请参阅 setTextDocument()。
[signal, since 6.7] void QQuickTextDocument::textDocumentChanged()
当底层的QTextDocument 被另一个实例替换时，会发出此信号。
该函数于 Qt 6.7 中引入。
另请参阅 setTextDocument()。
© 2026 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.
