PySide6.QtPdf.QPdfPageRenderer¶

class QPdfPageRenderer¶

QPdfPageRenderer 类封装了PDF文档页面的渲染。更多…

概要¶

属性¶

• documentᅟ - 此对象渲染页面的实例

• renderModeᅟ - 渲染器用于渲染页面的模式

方法¶

• def __init__()

• def document()

• def renderMode()

• def requestPage()

• def setDocument()

• def setRenderMode()

信号¶

• def documentChanged()

• def pageRendered()

• def renderModeChanged()

注意

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

详细描述¶

QPdfPageRenderer 包含一个队列，用于收集通过 requestPage() 调用的所有渲染请求。根据配置的 RenderMode，QPdfPageRenderer 在下一次事件循环调用时在主 UI 线程中处理此队列（RenderMode::SingleThreaded）或在单独的工作线程中处理（RenderMode::MultiThreaded），并在渲染完成后通过 pageRendered() 信号为每个请求发出结果。

另请参阅

QPdfDocument

class RenderMode¶

此枚举描述了页面的渲染方式。

常量	描述
QPdfPageRenderer.RenderMode.MultiThreaded	所有页面都在一个单独的工作线程中渲染。
QPdfPageRenderer.RenderMode.SingleThreaded	所有页面都在主UI线程中渲染（默认）。

另请参阅

renderMode() setRenderMode()

注意

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

property documentᅟ: QPdfDocument¶

此属性保存此对象从中渲染页面的文档实例。

默认情况下，此属性为 nullptr。

另请参阅

document() setDocument() QPdfDocument

Access functions:

• document()

• setDocument()

• 信号 documentChanged()

property renderModeᅟ: QPdfPageRenderer.RenderMode¶

此属性保存渲染器用于渲染页面的模式。

默认情况下，此属性为 RenderMode::SingleThreaded。

另请参阅

setRenderMode() RenderMode

Access functions:

• renderMode()

• setRenderMode()

• 信号 renderModeChanged()

__init__()¶

__init__(parent)

Parameters:

父对象 – QObject

使用父对象 parent 构造一个页面渲染器对象。

document()¶

Return type:

QPdfDocument

返回此对象渲染页面的文档，如果之前未设置，则返回nullptr。

另请参阅

setDocument() QPdfDocument

属性 documentᅟ 的获取器。

documentChanged(document)¶

Parameters:

文档 – QPdfDocument

属性 documentᅟ 的通知信号。

pageRendered(pageNumber, imageSize, image, options, requestId)¶

Parameters:

• pageNumber – int

• imageSize – QSize

• image – QImage

• options – QPdfDocumentRenderOptions

• requestId – int

renderMode()¶

Return type:

RenderMode

返回页面渲染的模式。

另请参阅

setRenderMode() RenderMode

属性 renderModeᅟ 的获取器。

renderModeChanged(renderMode)¶

Parameters:

renderMode – RenderMode

属性 renderModeᅟ 的通知信号。

requestPage(pageNumber, imageSize[, options=QPdfDocumentRenderOptions()])¶

Parameters:

• pageNumber – int

• imageSize – QSize

• options – QPdfDocumentRenderOptions

Return type:

整数

请求渲染器根据提供的options将页面pageNumber渲染为大小为imageSize的QImage。

一旦渲染完成，将发出带有结果作为参数的 pageRendered() 信号。

返回值是一个唯一标识渲染请求的ID。如果具有相同参数的请求仍在队列中，则返回该队列请求的ID。

setDocument(document)¶

Parameters:

文档 – QPdfDocument

设置此对象从中渲染页面的document。

另请参阅

document() QPdfDocument

属性 documentᅟ 的设置器。

setRenderMode(mode)¶

Parameters:

mode – RenderMode

设置页面渲染的模式为mode。

另请参阅

renderMode() RenderMode

属性 renderModeᅟ 的设置器。