QPdfWriter

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

Inheritance diagram of PySide2.QtGui.QPdfWriter

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 QPdfWriter(device)

QPdfWriter(filename)

param device

QIODevice

param filename

unicode

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

PySide2.QtGui.QPdfWriter.addFileAttachment(fileName, data[, mimeType=""])
Parameters
  • fileName – unicode

  • dataQByteArray

  • mimeType – unicode

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

PySide2.QtGui.QPdfWriter.creator()
Return type

unicode

Returns the creator of the document.

See also

setCreator()

PySide2.QtGui.QPdfWriter.documentXmpMetadata()
Return type

QByteArray

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

PySide2.QtGui.QPdfWriter.pdfVersion()
Return type

PdfVersion

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

See also

setPdfVersion()

PySide2.QtGui.QPdfWriter.resolution()
Return type

int

Returns the resolution of the PDF in DPI.

See also

setResolution()

PySide2.QtGui.QPdfWriter.setCreator(creator)
Parameters

creator – unicode

Sets the creator of the document to creator .

See also

creator()

PySide2.QtGui.QPdfWriter.setDocumentXmpMetadata(xmpMetadata)
Parameters

xmpMetadataQByteArray

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.

PySide2.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()

PySide2.QtGui.QPdfWriter.setResolution(resolution)
Parameters

resolutionint

Sets the PDF resolution in DPI.

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

See also

resolution()

PySide2.QtGui.QPdfWriter.setTitle(title)
Parameters

title – unicode

Sets the title of the document being created to title .

See also

title()

PySide2.QtGui.QPdfWriter.title()
Return type

unicode

Returns the title of the document.

See also

setTitle()