PySide6.QtGui.QTextDocumentWriter¶

class QTextDocumentWriter¶

QTextDocumentWriter 类提供了一个格式无关的接口，用于将 QTextDocument 写入文件或其他设备。更多…

在版本4.5中添加。

概要¶

方法¶

def __init__()
def device()
def fileName()
def format()
def setDevice()
def setFileName()
def setFormat()
def write()

静态函数¶

def supportedDocumentFormats()

注意

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

详细描述¶

要编写文档，请使用文件名或设备对象构造一个QTextDocumentWriter对象，并指定要写入的文档格式。您可以稍后使用setFormat()构造写入器并设置格式。

调用write()将文档写入设备。如果文档成功写入，此函数将返回true。然而，如果在写入文档时发生错误，它将返回false。

调用 supportedDocumentFormats() 以获取 QTextDocumentWriter 可以写入的格式列表。

由于支持的输出格式的功能差异很大，编写器仅为每种格式输出适当的对象子集。这通常包括文档中包含的格式化文本和图像。

__init__()¶

构造一个空的QTextDocumentWriter对象。在写入之前，您必须调用setFormat()来设置文档格式，然后调用setDevice()或setFileName()。

__init__(device, format)

Parameters:

设备 – QIODevice
format – QByteArray

构造一个QTextDocumentWriter对象，以指定的format文档格式写入给定的device。

__init__(fileName[, format=QByteArray()])

Parameters:

fileName – str
format – QByteArray

构造一个QTextDocumentWriter对象，该对象将使用format指定的文档格式写入名为fileName的文件。如果未提供format，QTextDocumentWriter将通过检查fileName的扩展名来检测文档格式。

device()¶

Return type:: QIODevice

返回当前分配的设备，如果未分配设备，则返回None。

另请参阅

setDevice()

fileName()¶

Return type:: 字符串

如果当前分配的设备是QFile，或者已经调用了setFileName()，此函数将返回要写入的文件名。在所有其他情况下，它将返回一个空字符串。

另请参阅

setFileName() setDevice()

format()¶

Return type:: QByteArray

返回用于写入文档的格式。

另请参阅

setFormat()

setDevice(device)¶

Parameters:: 设备 – QIODevice

将写入器的设备设置为指定的device。如果已经设置了设备，旧设备将被移除，但其他方面保持不变。

如果设备尚未打开，QTextDocumentWriter 将尝试通过调用 open() 以 WriteOnly 模式打开设备。

注意

这对于某些设备将不起作用，例如QProcess、QTcpSocket和QUdpSocket，这些设备在打开之前需要进行一些配置。

另请参阅

device() setFileName()

setFileName(fileName)¶

Parameters:: fileName – str

设置要写入的文件名为fileName。在内部，QTextDocumentWriter将创建一个QFile并以WriteOnly模式打开它，并在写入文档时使用此文件。

另请参阅

fileName() setDevice()

setFormat(format)¶

Parameters:: format – QByteArray

警告

本节包含从C++自动翻译到Python的代码片段，可能包含错误。

设置用于将文档写入指定format的格式。format是一个不区分大小写的文本字符串。例如：

writer = QTextDocumentWriter()
writer.setFormat("odf") # same as writer.setFormat("ODF")

你可以调用supportedDocumentFormats()来获取QTextDocumentWriter支持的所有格式的完整列表。

另请参阅

format()

static supportedDocumentFormats()¶

Return type:: .list of QByteArray

返回由QTextDocumentWriter支持的文档格式列表。

默认情况下，Qt可以写入以下格式：

格式

描述

纯文本

纯文本

HTML

超文本标记语言

markdown

Markdown（CommonMark 或 GitHub 方言）

ODF

开放文档格式

另请参阅

setFormat()

格式	描述
纯文本	纯文本
HTML	超文本标记语言
markdown	Markdown（CommonMark 或 GitHub 方言）
ODF	开放文档格式

write(document)¶

Parameters:: 文档 – QTextDocument
Return type:: 布尔

将给定的document写入指定的设备或文件，如果成功则返回true；否则返回false。

write(fragment)

Parameters:: 片段 – QTextDocumentFragment
Return type:: 布尔