QQuickTextDocument 类
QQuickTextDocument 类提供对 QQuickTextEdit 的 QTextDocument 的访问。 更多...
| 头文件 | #include <QQuickTextDocument> |
| CMake | find_package(Qt6 REQUIRED COMPONENTS Quick) target_link_libraries(mytarget PRIVATE Qt6::Quick) |
| qmake | QT += quick |
| 由以下类实例化 | TextDocument |
| 继承自 | QObject |
属性
(实验性)errorString : const QString(实验性)modified : bool(实验性)source : QUrl(实验性)status : const Status
公共函数
| QQuickTextDocument(QQuickItem *parent) | |
| QString | errorString() const |
| bool | isModified() const |
(实验性) void | save() |
(实验性) void | saveAs(const QUrl &url) |
| void | setModified(bool modified) |
| void | setSource(const QUrl &url) |
(自 6.7) void | setTextDocument(QTextDocument *document) |
| QUrl | source() const |
| QQuickTextDocument::Status | status() const |
| QTextDocument * | textDocument() const |
信号
(实验性) void | errorStringChanged() |
(实验性) void | modifiedChanged() |
(实验性) void | sourceChanged() |
(实验性) void | statusChanged() |
(自 6.7) void | textDocumentChanged() |
详细说明
此类提供了对 QQuickTextEdit 元素的 QTextDocument 的访问。此访问提供以使用 Qt 的 富文本处理 功能，包括文档的修改。它还可以用于输出内容，例如使用 QTextDocumentWriter，或提供额外的格式化，例如使用 QSyntaxHighlighter。
属性文档
[只读，实验性] errorString : const QString
此属性仍在开发中，可能发生变化。
此属性保存了描述在加载或保存过程中发生的错误的可读字符串，如果有任何错误。
默认情况下，此字符串为空。
此属性自 Qt 6.7 中引入。
访问函数
| QString | errorString() const |
通知信号
| void | errorStringChanged() |
[初版] modified : bool
此属性仍在开发中，可能发生变化。
此属性保存了文档是否已被用户修改。
此属性保存了自上次加载或保存以来，文档是否已被用户修改。默认情况下，此属性为 false。
与 QTextDocument::modified 相似，您可以设置修改属性：例如，将其设置为 false 以允许将 源 属性设置为不同的 URL（从而丢弃用户的更改）。
此属性自 Qt 6.7 中引入。
访问函数
| bool | isModified() const |
| void | setModified(bool modified) |
通知信号
| void | modifiedChanged() |
[只读，初版] source : QUrl
此属性仍在开发中，可能发生变化。
此属性保存从加载文档内容所在的 URL。
QQuickTextDocument 可以处理 Qt 支持的任何文本格式，并从 Qt 支持的任何 URL 方案加载。
当文档的 modified 状态为 true 时，不能更改 source 属性。如果用户已修改文档内容，您应该提示用户是否 保存，否则在将 source 属性设置为不同 URL 之前，将 modified 设置为 false 以丢弃更改。
此属性自 Qt 6.7 中引入。
访问函数
| QUrl | source() const |
| void | setSource(const QUrl &url) |
通知信号
| void | sourceChanged() |
另请参阅QTextDocumentWriter::supportedDocumentFormats。
[只读，初版] status : const Status
此属性仍在开发中，可能发生变化。
此属性保存文档加载或保存的状态。
此属性保存文档加载或保存的状态。它可以包含以下之一：
| 常量 | 描述 |
|---|---|
空 | 尚未加载文件 |
正在加载 | 从 源 开始读取 |
加载完成 | 读取成功完成 |
正在保存 | 在 保存() 或 另存为() 后开始文件写入 |
已保存 | 写入成功完成 |
读取错误 | 在从 源 读取时出现错误 |
写入错误 | 在 保存() 或 另存为() 中出现错误 |
非本地文件错误 | 另存为() 被调用来指向远程资源而不是本地文件 |
此属性自 Qt 6.7 中引入。
访问函数
| QQuickTextDocument::Status | status() const |
通知信号
| void | statusChanged() |
成员函数文档
QQuickTextDocument::QQuickTextDocumentQQuickItem *parent)
使用父对象parent构建一个QQuickTextDocument对象。
信号[信号， 初步] void QQuickTextDocument::errorStringChanged()
此功能处于开发中，可能会更改。
注意： 属性errorString的通知信号。
信号[信号， 初步] void QQuickTextDocument::modifiedChanged()
此功能处于开发中，可能会更改。
注意： 属性modified的通知信号。
函数[可调用， 初步] void QQuickTextDocument::save()
此功能处于开发中，可能会更改。
将内容保存到由source指定的相同文件和格式。
注意： 您只能保存到已挂载的文件系统上的文件。
注意： 您可以通过元对象系统从QML调用此函数。请参阅Q_INVOKABLE。
此功能自Qt 6.7引入。
函数[可调用， 初步] void QQuickTextDocument::saveAs(const QUrl &url)
此功能处于开发中，可能会更改。
将内容保存到由url指定的文件和格式。
url中的文件扩展名指定文件格式（由QMimeDatabase::mimeTypeForUrl确定）。
注意： 您只能保存到已挂载的文件系统上的文件。
注意： 您可以通过元对象系统从QML调用此函数。请参阅Q_INVOKABLE。
此功能自Qt 6.7引入。
函数[since 6.7] void QQuickTextDocument::setTextDocument(QTextDocument *document)
设置给定的document。
调用者保留该文档的所有权。
此功能自Qt 6.7引入。
另请参阅 textDocument。
信号[信号， 初步] void QQuickTextDocument::sourceChanged()
此功能处于开发中，可能会更改。
注意： 属性source的通知信号。
信号[信号， 初步] void QQuickTextDocument::statusChanged()
此功能处于开发中，可能会更改。
注意： 属性status的通知信号。
QTextDocument *QQuickTextDocument::textDocument() const
返回一个指向QTextDocument对象的指针。
另请参阅 setTextDocument。
信号[since 6.7] void QQuickTextDocument::textDocumentChanged()
当底层QTextDocument被替换为不同实例时，将发出此信号。
此功能自Qt 6.7引入。
另请参阅 setTextDocument。
© 2024 The Qt Company Ltd. 本文档中包含的贡献作品的版权属于各自的拥有者。本提供的文档采用 Free Software Foundation 发布的、在 GNU 自由文档许可证版本 1.3 条款进行许可。Qt 及相关标志是 The Qt Company Ltd 在芬兰和其他国家/地区的商标。所有其他商标均为其各自所有者的财产。
