QPdfPageRenderer 类
QPdfPageRenderer 类封装了 PDF 文档页面的渲染。更多信息...
头文件 | #include <QPdfPageRenderer> |
继承自 | QObject |
公共类型
枚举类 | RenderMode { MultiThreaded, SingleThreaded } |
属性
- document : QPdfDocument*
- renderMode : RenderMode
公共函数
QPdfPageRenderer(QObject *parent) | |
虚拟 | ~QPdfPageRenderer() override |
QPdfDocument * | document() const |
QPdfPageRenderer::RenderMode | renderMode() const |
quint64 | requestPage(int pageNumber, QSize imageSize, QPdfDocumentRenderOptions options = QPdfDocumentRenderOptions()) |
void | setDocument(QPdfDocument *document) |
void | setRenderMode(QPdfPageRenderer::RenderMode mode) |
信号
void | documentChanged(QPdfDocument *document) |
void | renderModeChanged(QPdfPageRenderer::RenderMode renderMode) |
详细说明
QPdfPageRenderer 包含一个队列,该队列收集通过 requestPage() 触发的所有渲染请求。根据配置的 RenderMode,QPdfPageRenderer 在下一个事件循环调用时在主 UI 线程(RenderMode::SingleThreaded
)或独立的工作线程(RenderMode::MultiThreaded
)中处理此队列,并在渲染完成后通过 pageRendered() 信号为每个请求发出结果。
另请参阅 QPdfDocument.
成员类型文档
enum class QPdfPageRenderer::RenderMode
此枚举描述了页面的渲染方式。
常数 | 值 | 描述 |
---|---|---|
QPdfPageRenderer::RenderMode::MultiThreaded | 0 | 所有页面都在单独的工作线程中渲染。 |
QPdfPageRenderer::RenderMode::SingleThreaded | 1 | 所有页面都在主 UI 线程中渲染(默认)。 |
另请参阅 renderMode() 和 setRenderMode()。
属性文档
document : QPdfDocument*
该属性包含用于渲染页面的文档实例。
默认情况下,此属性为 nullptr
。
访问函数
QPdfDocument * | document() const |
void | setDocument(QPdfDocument *document) |
通知信号
void | documentChanged(QPdfDocument *document) |
另请参阅 document(),setDocument() 和 QPdfDocument。
renderMode : RenderMode
此属性包含渲染器使用的方法以渲染页面。
默认情况下,此属性为 RenderMode::SingleThreaded
。
访问函数
QPdfPageRenderer::RenderMode | renderMode() const |
void | setRenderMode(QPdfPageRenderer::RenderMode mode) |
通知信号
void | renderModeChanged(QPdfPageRenderer::RenderMode renderMode) |
另请参阅 setRenderMode() 和 RenderMode。
成员函数文档
[显式]
QPdfPageRenderer::QPdfPageRenderer(QObject *parent)
使用父对象 parent 构造页面渲染器对象。
[覆盖虚函数 noexcept]
QPdfPageRenderer::~QPdfPageRenderer()
销毁页面渲染器对象。
QPdfDocument *QPdfPageRenderer::document() const
返回该对象渲染页面所用的文档,如果没有设置,则返回 nullptr
。
注意: 属性 document 的获取函数。
另请参阅 setDocument() 和 QPdfDocument。
QPdfPageRenderer::RenderMode QPdfPageRenderer::renderMode() const
返回页面的渲染模式。
注意: 属性 renderMode 的获取函数。
另请参阅 setRenderMode() 和 RenderMode。
quint64 QPdfPageRenderer::requestPage(int pageNumber, QSize imageSize, QPdfDocumentRenderOptions options = QPdfDocumentRenderOptions())
请求渲染器将页面 pageNumber 渲染到大小为 imageSize 的 QImage,并根据提供的 options 渲染。
渲染完成后将发出 pageRendered() 信号,参数是结果。
返回值是一个唯一标识渲染请求的 ID。如果参数相同的请求仍在队列中,则返回该排队请求的 ID。
void QPdfPageRenderer::setDocument(QPdfDocument *document)
设置此对象将渲染的页面所在的 文档。
注意: 属性 document 的设置函数。
另请参阅 document() 和 QPdfDocument。
void QPdfPageRenderer::setRenderMode(QPdfPageRenderer::RenderMode mode)
设置页面的渲染方式为 mode。
注意: 属性 renderMode 的设置函数。
另请参阅 renderMode() 和 RenderMode。
© 2024 The Qt Company Ltd. 以下是各自所有者的版权贡献的文档。所提供的文档是根据自由软件基金会发布、版本 1.3 的 GNU 自由文档许可证 许可使用的。Qt 和相应的标志是 The Qt Company Ltd. 在芬兰和其他国家的商标。所有其他商标均为各自所有者的财产。