PySide6.QtQuick.QQuickTextDocument¶

class QQuickTextDocument¶

QQuickTextDocument 类提供了对 QQuickTextEdit 的 QTextDocument 的访问。更多…

概要¶

属性¶

errorStringᅟ - 描述加载或保存过程中发生的错误（如果有）的可读字符串
modifiedᅟ - 文档是否已被用户修改
sourceᅟ - 从中加载文档内容的URL
statusᅟ - 文档加载或保存的状态

方法¶

def __init__()
def errorString()
def isModified()
def save()
def saveAs()
def setModified()
def setSource()
def setTextDocument()
def source()
def status()
def textDocument()

注意

本文档可能包含从C++自动翻译到Python的代码片段。我们始终欢迎对代码片段翻译的贡献。如果您发现翻译问题，您也可以通过在我们的https:/bugreports.qt.io/projects/PYSIDE上创建工单来告知我们。

详细描述¶

该类提供了对QQuickTextEdit元素的QTextDocument的访问。这是为了允许使用Qt的富文本处理功能，包括文档修改。它也可以用于输出内容，例如使用QTextDocumentWriter，或提供额外的格式化，例如使用QSyntaxHighlighter。

class Status¶: 在版本6.7中添加。

注意

当使用from __feature__ import true_property时，属性可以直接使用，否则通过访问器函数使用。

property errorStringᅟ: str¶

此属性包含一个描述加载或保存过程中发生的错误（如果有）的人类可读字符串。

默认情况下，此字符串为空。

另请参阅

status source save() saveAs()

Access functions:

errorString()
信号 errorStringChanged()

property modifiedᅟ: bool¶

此属性表示文档是否已被用户修改。

此属性表示文档自上次加载或保存以来是否已被用户修改。默认情况下，此属性为false。

与QTextDocument::modified一样，您可以设置modified属性：例如，将其设置为false以允许将source属性设置为不同的URL（从而丢弃用户的更改）。

另请参阅

modified

Access functions:

isModified()
setModified()
信号 modifiedChanged()

property sourceᅟ: QUrl¶

此属性保存从中加载文档内容的URL。

QQuickTextDocument 可以处理Qt支持的任何文本格式，从Qt支持的任何URL方案加载。

当文档的modified状态为true时，source属性不能被更改。如果用户已经修改了文档内容，您应该提示用户是否要save()，或者通过将modified设置为false来放弃更改，然后再将source属性设置为不同的URL。

另请参阅

supportedDocumentFormats()

Access functions:

source()
setSource()
信号 sourceChanged()

property statusᅟ: QQuickTextDocument.Status¶

此属性保存文档加载或保存的状态。

此属性保存文档加载或保存的状态。它可以是以下之一：

空值

没有文件被加载

另请参阅

errorString source save() saveAs()

Access functions:

status()
信号 statusChanged()

__init__(parent)¶

Parameters:: 父级 – QQuickItem

使用parent作为父对象构造一个QQuickTextDocument对象。

errorString()¶

Return type:: 字符串

属性 errorStringᅟ 的获取器。

errorStringChanged()¶

属性 errorStringᅟ 的通知信号。

isModified()¶

Return type:: 布尔

属性 modifiedᅟ 的获取器。

modifiedChanged()¶

属性 modifiedᅟ 的通知信号。

save()¶

将内容保存到由source指定的相同文件和格式中。

注意

您只能保存到已挂载的文件系统上的文件。

另请参阅

source saveAs()

saveAs(url)¶

Parameters:: url – QUrl

将内容保存到由url指定的文件和格式中。

url 中的文件扩展名指定了文件格式（由 QMimeDatabase::mimeTypeForUrl() 确定）。

注意

您只能保存到已挂载的文件系统上的文件。

另请参阅

source save()

setModified(modified)¶

Parameters:: 修改 – bool

另请参阅

isModified()

属性 modifiedᅟ 的设置器。

setSource(url)¶

Parameters:: url – QUrl

另请参阅

source()

属性 sourceᅟ 的设置器。

setTextDocument(document)¶

Parameters:: 文档 – QTextDocument

设置给定的 document。

调用者保留文档的所有权。

另请参阅

textDocument()

source()¶

Return type:: QUrl

另请参阅

setSource()

属性 sourceᅟ 的获取器。

sourceChanged()¶

属性 sourceᅟ 的通知信号。

status()¶

Return type:: 状态

属性 statusᅟ 的获取器。

statusChanged()¶

属性 statusᅟ 的通知信号。

textDocument()¶

Return type:: QTextDocument

返回指向 QTextDocument 对象的指针。

另请参阅

setTextDocument()

textDocumentChanged()¶

当底层的QTextDocument被替换为不同的实例时，会发出此信号。

另请参阅

setTextDocument()