Skip to content

PdfWriter

Qt Base Class: QPdfWriter

Signature: QPdfWriter(self, device: PySide6.QtCore.QIODevice) -> None QPdfWriter(self, filename: str) -> None

Base classes

Name Children Inherits
ObjectMixin
prettyqt.core.object
PagedPaintDeviceMixin
prettyqt.gui.pagedpaintdevice
QPdfWriter
PySide6.QtGui
QPdfWriter(self, device: PySide6.QtCore.QIODevice) -> None

⋔ Inheritance diagram

graph TD
  1473245643152["gui.PdfWriter"]
  1473299815024["core.ObjectMixin"]
  140713234304496["builtins.object"]
  1473245618752["gui.PagedPaintDeviceMixin"]
  1473245548480["gui.PaintDeviceMixin"]
  1473289236896["QtGui.QPdfWriter"]
  1473288842240["QtCore.QObject"]
  1473291690208["Shiboken.Object"]
  1473300089200["QtGui.QPagedPaintDevice"]
  1473300082368["QtGui.QPaintDevice"]
  1473299815024 --> 1473245643152
  140713234304496 --> 1473299815024
  1473245618752 --> 1473245643152
  1473245548480 --> 1473245618752
  140713234304496 --> 1473245548480
  1473289236896 --> 1473245643152
  1473288842240 --> 1473289236896
  1473291690208 --> 1473288842240
  140713234304496 --> 1473291690208
  1473300089200 --> 1473289236896
  1473300082368 --> 1473300089200
  1473291690208 --> 1473300082368

🛈 DocStrings

Bases: ObjectMixin, PagedPaintDeviceMixin, QPdfWriter

Class to generate PDFs that can be used as a paint device.

Source code in prettyqt\gui\pdfwriter.py
class PdfWriter(core.ObjectMixin, gui.PagedPaintDeviceMixin, gui.QPdfWriter):
    """Class to generate PDFs that can be used as a paint device."""

    def set_desktop_resolution(self):
        primary = gui.app().primaryScreen()
        dpi = primary.logicalDotsPerInch()
        self.setResolution(int(dpi))

    def set_page_margins(
        self,
        margins: datatypes.MarginsFType,
        unit: gui.pagelayout.UnitStr | gui.PageLayout.Unit | None = None,
    ) -> bool:
        margins = datatypes.to_marginsf(margins)
        if unit is None:
            return self.setPageMargins(margins)
        return self.setPageMargins(margins, gui.pagelayout.UNITS.get_enum_value(unit))

    def get_pdf_version(self) -> gui.pagedpaintdevice.PdfVersionStr:
        return gui.pagedpaintdevice.PDF_VERSION.inverse[self.pdfVersion()]

    def set_pdf_version(
        self,
        version: gui.pagedpaintdevice.PdfVersionStr | gui.PagedPaintDevice.PdfVersion,
    ):
        """Set pdf version.

        Args:
            version: pdf version
        """
        self.setPdfVersion(gui.pagedpaintdevice.PDF_VERSION.get_enum_value(version))

set_pdf_version(version: gui.pagedpaintdevice.PdfVersionStr | gui.PagedPaintDevice.PdfVersion)

Set pdf version.

Parameters:

Name Type Description Default
version PdfVersionStr | PdfVersion

pdf version

required
Source code in prettyqt\gui\pdfwriter.py
def set_pdf_version(
    self,
    version: gui.pagedpaintdevice.PdfVersionStr | gui.PagedPaintDevice.PdfVersion,
):
    """Set pdf version.

    Args:
        version: pdf version
    """
    self.setPdfVersion(gui.pagedpaintdevice.PDF_VERSION.get_enum_value(version))

⌗ Property table

Qt Property Type Doc
objectName QString