QQuickTextDocument Class
QQuickTextDocument 类提供了对 QQuickTextEdit 的QTextDocument 的访问。更多
| Header： | #include <QQuickTextDocument> |
| CMake： | find_package(Qt6 REQUIRED COMPONENTS Quick)target_link_libraries(mytarget PRIVATE Qt6::Quick) |
| qmake： | QT += quick |
| 在 QML 中： | TextDocument |
| 继承： | QObject |
属性
(preliminary)errorString : const QString(preliminary)modified : bool(preliminary)source : QUrl(preliminary)status : const Status
公共功能
| QQuickTextDocument(QQuickItem *parent) | |
| QString | errorString() const |
| bool | isModified() const |
(preliminary) void | save() |
(preliminary) 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 |
信号
(preliminary) void | errorStringChanged() |
(preliminary) void | modifiedChanged() |
(preliminary) void | sourceChanged() |
(preliminary) void | statusChanged() |
(since 6.7) void | textDocumentChanged() |
详细说明
该类提供对QTextDocument QQuickTextEdit 元素的访问。它允许使用 Qt 的富文本处理功能，包括文档修改。它还可用于输出内容，例如QTextDocumentWriter ，或提供额外的格式，例如QSyntaxHighlighter 。
属性文档
[read-only, preliminary] errorString : const QString
此属性正在开发中，可能会有更改。
该属性包含一个可读字符串，用于描述加载或保存过程中发生的错误（如果有）。
默认情况下，该字符串为空。
此属性在 Qt 6.7 中引入。
访问函数：
| QString | errorString() const |
Notifier 信号：
| void | errorStringChanged() |
另请参阅 status,source,save() 和saveAs() 。
[preliminary] modified : bool
此属性正在开发中，可能会有变动。
该属性显示文档是否被用户修改过
自上次加载或保存文档以来，用户是否修改过该文档，由该属性决定。默认情况下，该属性为false 。
与QTextDocument::modified 一样，您可以设置修改属性：例如，将其设置为false ，以便将source 属性设置为不同的 URL（从而丢弃用户的修改）。
该属性在 Qt 6.7 中引入。
访问功能：
| bool | isModified() const |
| void | setModified(bool modified) |
Notifier 信号：
| void | modifiedChanged() |
另请参阅 QTextDocument::modified 。
[preliminary] source : QUrl
此属性正在开发中，可能会有更改。
该属性包含加载文档内容的 URL
QQuickTextDocument 可处理 Qt 支持的任何文本格式，并可从 Qt 支持的任何 URL 方案加载。
当文档的modified 状态为true 时，不能更改source 属性。如果用户修改了文档内容，则应提示用户是否save() ，或者在将source 属性设置为不同的 URL 之前，通过将modified 设置为false 来放弃更改。
此属性在 Qt 6.7 中引入。
访问功能：
| QUrl | source() const |
| void | setSource(const QUrl &url) |
Notifier 信号：
| void | sourceChanged() |
另请参阅 QTextDocumentWriter::supportedDocumentFormats().
[read-only, preliminary] status : const Status
此属性正在开发中，可能会有更改。
此属性用于保存加载或保存文档的状态
该属性表示文档加载或保存的状态。它可以是
| 常量 | 说明 |
|---|---|
Null | 未加载文件 |
Loading | 已开始从source 读取 |
Loaded | 读取已成功完成 |
Saving | 在save() 或saveAs() 之后开始写入文件 |
Saved | 写入已成功完成 |
ReadError | 从以下文件读取时发生错误source |
WriteError | 在save() 或saveAs() 中发生错误 |
NonLocalFileError | saveAs调用 () 时 URL 指向远程资源而非本地文件 |
此属性在 Qt 6.7 中引入。
访问函数：
| QQuickTextDocument::Status | status() const |
Notifier 信号：
| void | statusChanged() |
另请参阅 errorString,source,save() 和saveAs() 。
成员函数文档
QQuickTextDocument::QQuickTextDocument(QQuickItem *parent)
以parent 作为父对象，构造一个 QQuickTextDocument 对象。
[signal, preliminary] void QQuickTextDocument::errorStringChanged()
此功能正在开发中，可能会有更改。
注： 物业通知信号errorString 。
[signal, preliminary] void QQuickTextDocument::modifiedChanged()
此功能正在开发中，可能会有更改。
注： 物业通知信号modified 。
[invokable, preliminary] void QQuickTextDocument::save()
此功能正在开发中，可能会有更改。
将内容保存到source 指定的相同文件和格式。
注： 只能保存到file on a mounted filesystem 。
注： 可通过元对象系统和 QML 调用此函数。请参阅Q_INVOKABLE 。
此函数在 Qt 6.7 中引入。
[invokable, preliminary] void QQuickTextDocument::saveAs(const QUrl &url)
此功能正在开发中，可能会有更改。
将内容保存到url 指定的文件和格式。
url 中的文件扩展名指定了文件格式（由QMimeDatabase::mimeTypeForUrl() 决定）。
注： 只能保存到file on a mounted filesystem 。
注： 可通过元对象系统和 QML 调用此函数。请参见Q_INVOKABLE 。
此函数在 Qt 6.7 中引入。
[since 6.7] void QQuickTextDocument::setTextDocument(QTextDocument *document)
设置给定的document 。
调用者保留文档的所有权。
此函数在 Qt 6.7 中引入。
另请参阅 textDocument()。
[signal, preliminary] void QQuickTextDocument::sourceChanged()
此功能正在开发中，可能会有更改。
注： 物业通知信号source 。
[signal, preliminary] void QQuickTextDocument::statusChanged()
此功能正在开发中，可能会有更改。
注： 物业通知信号status 。
QTextDocument *QQuickTextDocument::textDocument() const
返回指向QTextDocument 对象的指针。
另请参阅 setTextDocument().
[signal, since 6.7] void QQuickTextDocument::textDocumentChanged()
当底层QTextDocument 被替换为不同的实例时，将发出该信号。
该函数在 Qt 6.7 中引入。
另请参阅 setTextDocument()。
© 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.
