QPdfWriter#

The QPdfWriter class is a class to generate PDFs that can be used as a paint device. More

Synopsis#

Functions#

Detailed Description#

QPdfWriter generates PDF out of a series of drawing commands using QPainter . The newPage() method can be used to create several pages.

class PySide6.QtGui.QPdfWriter(device)#

PySide6.QtGui.QPdfWriter(filename)

Parameters

Constructs a PDF writer that will write the pdf to device.

Constructs a PDF writer that will write the pdf to filename.

PySide6.QtGui.QPdfWriter.addFileAttachment(fileName, data[, mimeType=""])#
Parameters

Adds fileName attachment to the PDF with (optional) mimeType. data contains the raw file data to embed into the PDF file.

PySide6.QtGui.QPdfWriter.creator()#
Return type

str

Returns the creator of the document.

See also

setCreator()

PySide6.QtGui.QPdfWriter.documentXmpMetadata()#
Return type

PySide6.QtCore.QByteArray

Gets the document metadata, as it was provided with a call to setDocumentXmpMetadata . It will not return the default metadata.

PySide6.QtGui.QPdfWriter.pdfVersion()#
Return type

PdfVersion

Returns the PDF version for this writer. The default is PdfVersion_1_4.

See also

setPdfVersion()

PySide6.QtGui.QPdfWriter.resolution()#
Return type

int

Returns the resolution of the PDF in DPI.

See also

setResolution()

PySide6.QtGui.QPdfWriter.setCreator(creator)#
Parameters

creator – str

Sets the creator of the document to creator.

See also

creator()

PySide6.QtGui.QPdfWriter.setDocumentXmpMetadata(xmpMetadata)#
Parameters

xmpMetadataPySide6.QtCore.QByteArray

Sets the document metadata. This metadata is not influenced by the setTitle / setCreator methods, so is up to the user to keep it consistent. xmpMetadata contains XML formatted metadata to embed into the PDF file.

PySide6.QtGui.QPdfWriter.setPdfVersion(version)#
Parameters

versionPdfVersion

Sets the PDF version for this writer to version.

If version is the same value as currently set then no change will be made.

See also

pdfVersion()

PySide6.QtGui.QPdfWriter.setResolution(resolution)#
Parameters

resolution – int

Sets the PDF resolution in DPI.

This setting affects the coordinate system as returned by, for example viewport() .

See also

resolution()

PySide6.QtGui.QPdfWriter.setTitle(title)#
Parameters

title – str

Sets the title of the document being created to title.

See also

title()

PySide6.QtGui.QPdfWriter.title()#
Return type

str

Returns the title of the document.

See also

setTitle()