QPdfWriter 类

QPdfWriter 类是生成可用作描绘设备的 PDF 的类。 更多...

头: #include <QPdfWriter>
qmake: QT += gui
继承: QObject and QPagedPaintDevice

公共函数

QPdfWriter (QIODevice * device )
QPdfWriter (const QString & filename )
virtual ~QPdfWriter ()
void addFileAttachment (const QString & fileName , const QByteArray & data , const QString & mimeType = QString())
QString creator () const
QByteArray documentXmpMetadata () const
QPageLayout pageLayout () const
QPagedPaintDevice::PdfVersion pdfVersion () const
int resolution () const
void setCreator (const QString & creator )
void setDocumentXmpMetadata (const QByteArray & xmpMetadata )
bool setPageLayout (const QPageLayout & newPageLayout )
bool setPageMargins (const QMarginsF & margins )
bool setPageMargins (const QMarginsF & margins , QPageLayout::Unit units )
bool setPageOrientation (QPageLayout::Orientation orientation )
bool setPageSize (const QPageSize & pageSize )
void setPdfVersion (QPagedPaintDevice::PdfVersion version )
void setResolution (int resolution )
void setTitle (const QString & title )
QString title () const

重实现公共函数

virtual bool newPage () override
(obsolete) virtual void setMargins (const QPagedPaintDevice::Margins & m ) override
(obsolete) virtual void setPageSize (QPagedPaintDevice::PageSize size ) override
(obsolete) virtual void setPageSizeMM (const QSizeF & size ) override

重实现保护函数

virtual QPaintEngine * paintEngine () const override

详细描述

QPdfWriter 从一系列绘制命令生成 PDF,使用 QPainter newPage () 方法可用于创建多个页面。

成员函数文档编制

QPdfWriter:: QPdfWriter ( QIODevice * device )

构造 PDF 写入器,将 PDF 写入到 device .

QPdfWriter:: QPdfWriter (const QString & filename )

构造 PDF 写入器,将 PDF 写入到 filename .

[虚拟] QPdfWriter:: ~QPdfWriter ()

销毁 PDF 写入器。

void QPdfWriter:: addFileAttachment (const QString & fileName , const QByteArray & data , const QString & mimeType = QString())

添加 fileName 附件到 PDF 采用 (可选) mimeType . data 包含要嵌入到 PDF 文件中的原生文件数据。

该函数在 Qt 5.15 引入。

QString QPdfWriter:: creator () const

返回文档创建者。

另请参阅 setCreator ().

QByteArray QPdfWriter:: documentXmpMetadata () const

获取文档元数据,因为它被提供当调用 setDocumentXmpMetadata 。它不会返回默认元数据。

该函数在 Qt 5.15 引入。

另请参阅 setDocumentXmpMetadata ().

[override virtual] bool QPdfWriter:: newPage ()

重实现: QPagedPaintDevice::newPage ().

QPageLayout QPdfWriter:: pageLayout () const

返回当前页面的布局。使用此方法以访问当前 QPageSize , QPageLayout::Orientation , QMarginsF ,fullRect() 和 paintRect()。

注意:不可以在返回对象上使用 setter,必须单独调用 QPdfWriter 方法或使用 setPageLayout ().

该函数在 Qt 5.3 引入。

另请参阅 setPageLayout (), setPageSize (), setPageOrientation (),和 setPageMargins ().

[override virtual protected] QPaintEngine *QPdfWriter:: paintEngine () const

重实现: QPaintDevice::paintEngine () const.

QPagedPaintDevice::PdfVersion QPdfWriter:: pdfVersion () const

返回此写入器的 PDF 版本。默认为 PdfVersion_1_4 .

该函数在 Qt 5.10 引入。

另请参阅 setPdfVersion ().

int QPdfWriter:: resolution () const

返回 PDF 分辨率 (以 DPI 为单位)。

该函数在 Qt 5.3 引入。

另请参阅 setResolution ().

void QPdfWriter:: setCreator (const QString & creator )

将文档创建者设为 creator .

另请参阅 creator ().

void QPdfWriter:: setDocumentXmpMetadata (const QByteArray & xmpMetadata )

设置文档元数据。此元数据不受影响通过 setTitle / setCreator 方法,因此,取决于用户是否要保持一致。 xmpMetadata 包含可嵌入 PDF 文件中的 XML 格式元数据。

该函数在 Qt 5.15 引入。

另请参阅 documentXmpMetadata ().

bool QPdfWriter:: setPageLayout (const QPageLayout & newPageLayout )

将 PDF 页面布局设为 newPageLayout .

应先调用这当调用 QPainter::begin (),或立即调用在调用 newPage () 以将新页面布局应用到新页面之前。不应调用任何描绘方法,在调用 setPageLayout() 和 newPage () 之间因为可能使用了错误的描绘规格。

返回 true 若页面布局被成功设为 newPageLayout .

该函数在 Qt 5.3 引入。

另请参阅 pageLayout ().

bool QPdfWriter:: setPageMargins (const QMarginsF & margins )

设置 PDF 页面 margins 在当前页面布局单位。

应先调用这当调用 QPainter::begin (),或立即调用在调用 newPage () 以将新边距应用到新页面之前。不应调用任何描绘方法,在调用 setPageMargins() 和 newPage () 之间因为可能使用了错误的描绘规格。

要获取当前页面边距,使用 pageLayout ().margins().

返回 true 若页面边距被成功设为 margins .

该函数在 Qt 5.3 引入。

另请参阅 pageLayout ().

bool QPdfWriter:: setPageMargins (const QMarginsF & margins , QPageLayout::Unit units )

设置 PDF 页面 margins 定义以给定 units .

应先调用这当调用 QPainter::begin (),或立即调用在调用 newPage () 以将新边距应用到新页面之前。不应调用任何描绘方法,在调用 setPageMargins() 和 newPage () 之间因为可能使用了错误的描绘规格。

要获取当前页面边距,使用 pageLayout ().margins().

返回 true 若页面边距被成功设为 margins .

该函数在 Qt 5.3 引入。

另请参阅 pageLayout ().

bool QPdfWriter:: setPageOrientation ( QPageLayout::Orientation orientation )

设置 PDF 页面 orientation .

页面取向用于定义页面大小的取向,当获取页面矩形时。

应先调用这当调用 QPainter::begin (),或立即调用在调用 newPage () 以将新取向应用到新页面之前。不应调用任何描绘方法,在调用 setPageOrientation() 和 newPage () 之间因为可能使用了错误的描绘规格。

要获取当前 QPageLayout::Orientation 使用 pageLayout ().orientation().

返回 true 若页面取向被成功设为 orientation .

该函数在 Qt 5.3 引入。

另请参阅 pageLayout ().

bool QPdfWriter:: setPageSize (const QPageSize & pageSize )

将 PDF 页面尺寸设为 pageSize .

要获取当前 QPageSize 使用 pageLayout (). pageSize ().

应先调用这当调用 QPainter::begin (),或立即调用在调用 newPage () 以将新页面尺寸应用到新页面之前。不应调用任何描绘方法,在调用 setPageSize() 和 newPage () 之间因为可能使用了错误的描绘规格。

返回 true 若页面大小被成功设为 pageSize .

该函数在 Qt 5.3 引入。

另请参阅 pageLayout ().

void QPdfWriter:: setPdfVersion ( QPagedPaintDevice::PdfVersion version )

将此写入器的 PDF 版本设为 version .

version 与目前设置的值相同,则不会有任何改变。

该函数在 Qt 5.10 引入。

另请参阅 pdfVersion ().

void QPdfWriter:: setResolution ( int resolution )

设置 PDF resolution 以 DPI 为单位。

此设置影响返回坐标系,例如 QPainter::viewport ().

该函数在 Qt 5.3 引入。

另请参阅 resolution ().

void QPdfWriter:: setTitle (const QString & title )

将正在创建的文档的标题设为 title .

另请参阅 title ().

QString QPdfWriter:: title () const

返回文档标题。

另请参阅 setTitle ().