PySide6.QtPdf.QPdf文档¶

class QPdfDocument¶

QPdfDocument 类加载 PDF 文档并从中渲染页面。更多…

概要¶

注意

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

详细描述¶

class Status¶

此枚举描述了文档的当前状态。

常量

描述

QPdfDocument.Status.Null

文档创建后或关闭后的初始状态。

QPdfDocument.Status.Loading

在调用load()之后，文档完全加载之前的状态。

QPdfDocument.Status.Ready

文档完全加载并且可以访问其数据时的状态。

QPdfDocument.Status.Unloading

在打开的文档上调用了close()后的状态。此时文档仍然有效，可以访问其所有数据。

QPdfDocument.Status.Error

加载后的状态，如果加载失败。

另请参阅

status()

常量	描述
QPdfDocument.Status.Null	文档创建后或关闭后的初始状态。
QPdfDocument.Status.Loading	在调用`load()`之后，文档完全加载之前的状态。
QPdfDocument.Status.Ready	文档完全加载并且可以访问其数据时的状态。
QPdfDocument.Status.Unloading	在打开的文档上调用了`close()`后的状态。此时文档仍然有效，可以访问其所有数据。
QPdfDocument.Status.Error	加载后的状态，如果加载失败。

class Error¶

此枚举描述了在尝试对文档执行最后操作时发生的错误。

常量

描述

QPdfDocument.Error.None

没有发生错误。

QPdfDocument.Error.Unknown

未知类型的错误。

QPdfDocument.Error.DataNotYetAvailable

文档仍在加载中，现在尝试操作还为时过早。

QPdfDocument.Error.FileNotFound

提供给load()的文件未找到。

QPdfDocument.Error.InvalidFileFormat

提供给load()的文件不是有效的PDF文件。

QPdfDocument.Error.IncorrectPassword

提供给setPassword()的密码对此文件不正确。

QPdfDocument.Error.UnsupportedSecurityScheme

QPdfDocument 无法解锁这种类型的PDF文件。

另请参阅

error()

常量	描述
QPdfDocument.Error.None	没有发生错误。
QPdfDocument.Error.Unknown	未知类型的错误。
QPdfDocument.Error.DataNotYetAvailable	文档仍在加载中，现在尝试操作还为时过早。
QPdfDocument.Error.FileNotFound	提供给`load()`的文件未找到。
QPdfDocument.Error.InvalidFileFormat	提供给`load()`的文件不是有效的PDF文件。
QPdfDocument.Error.IncorrectPassword	提供给`setPassword()`的密码对此文件不正确。
QPdfDocument.Error.UnsupportedSecurityScheme	`QPdfDocument` 无法解锁这种类型的PDF文件。

class MetaDataField¶

此枚举描述了元数据的可用字段。

常量

描述

QPdfDocument.MetaDataField.Title

文档的标题作为QString。

QPdfDocument.MetaDataField.Author

创建文档的人员的名称，以QString形式表示。

QPdfDocument.MetaDataField.Subject

文档的主题，以QString形式表示。

QPdfDocument.MetaDataField.Keywords

与文档关联的关键词，以QString形式表示。

QPdfDocument.MetaDataField.Creator

如果文档是从另一种格式转换为PDF的，则创建原始文档的符合产品的名称，以QString形式表示。

QPdfDocument.MetaDataField.Producer

如果文档是从另一种格式转换为PDF的，则转换为PDF的符合产品的名称作为QString。

QPdfDocument.MetaDataField.CreationDate

文档创建日期和时间，格式为QDateTime。

QPdfDocument.MetaDataField.ModificationDate

文档最近修改的日期和时间，以QDateTime表示。

另请参阅

metaData()

常量	描述
QPdfDocument.MetaDataField.Title	文档的标题作为QString。
QPdfDocument.MetaDataField.Author	创建文档的人员的名称，以QString形式表示。
QPdfDocument.MetaDataField.Subject	文档的主题，以QString形式表示。
QPdfDocument.MetaDataField.Keywords	与文档关联的关键词，以QString形式表示。
QPdfDocument.MetaDataField.Creator	如果文档是从另一种格式转换为PDF的，则创建原始文档的符合产品的名称，以QString形式表示。
QPdfDocument.MetaDataField.Producer	如果文档是从另一种格式转换为PDF的，则转换为PDF的符合产品的名称作为QString。
QPdfDocument.MetaDataField.CreationDate	文档创建日期和时间，格式为QDateTime。
QPdfDocument.MetaDataField.ModificationDate	文档最近修改的日期和时间，以QDateTime表示。

class PageModelRole¶

pageModel() 中的角色。

常量

描述

QPdfDocument.PageModelRole.Label

用于显示目的的页码 (QString)。

QPdfDocument.PageModelRole.PointSize

页面大小以点为单位（1/72英寸）（QSizeF）。

常量	描述
QPdfDocument.PageModelRole.Label	用于显示目的的页码 (QString)。
QPdfDocument.PageModelRole.PointSize	页面大小以点为单位（1/72英寸）（QSizeF）。

注意

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

property pageCountᅟ: int¶

此属性保存加载文档中的页数，如果未加载文档，则为0。

Access functions:

pageCount()
信号 pageCountChanged()

property pageModelᅟ: QAbstractListModel¶

此属性保存一个QAbstractListModel的实例，用于提供页面特定的元数据，其中包含文档中每个页面的一个行。

另请参阅

PageModelRole

Access functions:

pageModel()
信号 pageModelChanged()

property passwordᅟ: str¶

此属性保存文档密码。

如果文档受密码保护，用户必须提供密码，应用程序必须设置此属性。否则，不需要。

Access functions:

password()
setPassword()
信号 passwordChanged()

property statusᅟ: QPdfDocument.Status¶

此属性保存文档的当前状态。

Access functions:

status()
信号 statusChanged()

__init__()¶

__init__(parent)

Parameters:: 父对象 – QObject

使用父对象 parent 构建一个新文档。

close()¶

关闭文档。

error()¶

Return type:: 错误

如果status是Error，则返回错误类型；如果没有错误，则返回NoError。

getAllText(page)¶

Parameters:: 页码 – int
Return type:: QPdfSelection

返回给定page上的所有文本及其边界。

getSelection(page, start, end)¶

Parameters:

page – int
start – QPointF
end – QPointF

Return type:

QPdfSelection

返回关于给定page上可以在给定start和end点之间找到的文本的信息（如果有的话）。

getSelectionAtIndex(page, startIndex, maxLength)¶

Parameters:

page – int
startIndex – int
maxLength – int

Return type:

QPdfSelection

返回关于给定page上文本的信息，该文本可以从给定的startIndex开始查找，最多包含maxLength个字符。

load(device)¶

Parameters:: 设备 – QIODevice

从device加载文档内容。

load(fileName)

Parameters:: fileName – str
Return type:: 错误

从fileName加载文档内容。

metaData(field)¶

Parameters:: 字段 – MetaDataField
Return type:: 对象

返回给定field的文档元数据。

pageCount()¶

Return type:: 整数

属性 pageCountᅟ 的获取器。

pageCountChanged(pageCount)¶

Parameters:: pageCount – int

属性 pageCountᅟ 的通知信号。

pageIndexForLabel(label)¶

Parameters:: 标签 – str
Return type:: 整数

返回具有label的页面的索引，如果未找到则返回-1。

另请参阅

pageLabel()

pageLabel(page)¶

Parameters:: 页码 – int
Return type:: 字符串

返回用于显示目的的page编号。

例如，一个文档可能有多个部分，每个部分有不同的编号。可能前言使用罗马数字，正文从第1页开始，附录从A1页开始。每当PDF查看器显示页码时，为了避免混淆用户，它应该与页面角落上打印的“数字”相同，而不是我们在API中使用的从零开始的页面索引（假设文档作者已经使页面标签与打印的数字匹配）。

如果文档没有自定义页码，此函数返回 page + 1。

另请参阅

pageIndexForLabel()

pageModel()¶

Return type:: QAbstractListModel

属性 pageModelᅟ 的获取器。

pageModelChanged()¶

属性 pageModelᅟ 的通知信号。

pagePointSize(page)¶

Parameters:: 页码 – int
Return type:: QSizeF

返回页面 page 的大小，单位为点（1/72 英寸）。

password()¶

Return type:: 字符串

另请参阅

setPassword()

属性 passwordᅟ 的获取器。

passwordChanged()¶

属性 passwordᅟ 的通知信号。

passwordRequired()¶

render(page, imageSize[, options=QPdfDocumentRenderOptions()])¶

Parameters:

page – int
imageSize – QSize
options – QPdfDocumentRenderOptions

Return type:

QImage

根据提供的renderOptions，将page渲染为大小为imageSize的QImage。

返回渲染的页面或在发生错误时返回空图像。

注意：如果imageSize与PDF文档中页面的宽高比不匹配，页面将被缩放渲染，以使其覆盖整个imageSize。

setPassword(password)¶

Parameters:: password – str

另请参阅

password()

属性 passwordᅟ 的设置器。

status()¶

Return type:: 状态

属性 statusᅟ 的获取器。

statusChanged(status)¶

Parameters:: 状态 – Status

属性 statusᅟ 的通知信号。

PySide6.QtPdf.QPdf文档¶

概要¶

属性¶

方法¶

信号¶

详细描述¶