class QPrinter

The QPrinter class is a paint device that paints on a printer. More…

Inheritance diagram of PySide6.QtPrintSupport.QPrinter

Synopsis

Methods

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

This device represents a series of pages of printed output, and is used in almost exactly the same way as other paint devices such as QWidget and QPixmap. A set of additional functions are provided to manage device-specific features, such as orientation and resolution, and to step through the pages in a document as it is generated.

When printing directly to a printer on Windows or macOS, QPrinter uses the built-in printer drivers. On X11, QPrinter uses the Common Unix Printing System (CUPS) to send PDF output to the printer. As an alternative, the printProgram() function can be used to specify the command or utility to use instead of the system default.

Note that setting parameters like paper size and resolution on an invalid printer is undefined. You can use isValid() to verify this before changing any parameters.

QPrinter supports a number of parameters, most of which can be changed by the end user through a print dialog . In general, QPrinter passes these functions onto the underlying QPrintEngine .

The most important parameters are:

  • setPageLayout() tells QPrinter which page orientation to use, and what size to expect from the printer.

  • setResolution() tells QPrinter what resolution you wish the printer to provide, in dots per inch (DPI).

  • setFullPage() tells QPrinter whether you want to deal with the full page or just with the part the printer can draw on.

  • setCopyCount() tells QPrinter how many copies of the document it should print.

Many of these functions can only be called before the actual printing begins (i.e., before QPainter::begin() is called). This usually makes sense because, for example, it’s not possible to change the number of copies when you are halfway through printing. There are also some settings that the user sets (through the printer dialog) and that applications are expected to obey. See QAbstractPrintDialog ‘s documentation for more details.

When QPainter::begin() is called, the QPrinter it operates on is prepared for a new page, enabling the QPainter to be used immediately to paint the first page in a document. Once the first page has been painted, newPage() can be called to request a new blank page to paint on, or QPainter::end() can be called to finish printing. The second page and all following pages are prepared using a call to newPage() before they are painted.

The first page in a document does not need to be preceded by a call to newPage() . You only need to calling newPage() after QPainter::begin() if you need to insert a blank page at the beginning of a printed document. Similarly, calling newPage() after the last page in a document is painted will result in a trailing blank page appended to the end of the printed document.

If you want to abort the print job, abort() will try its best to stop printing. It may cancel the entire job or just part of it.

Since QPrinter can print to any QPrintEngine subclass, it is possible to extend printing support to cover new types of printing subsystem by subclassing QPrintEngine and reimplementing its interface.

See also

QPrintDialog Qt Print Support

class PrinterMode

This enum describes the mode the printer should work in. It basically presets a certain resolution and working mode.

Constant

Description

QPrinter.ScreenResolution

Sets the resolution of the print device to the screen resolution. This has the big advantage that the results obtained when painting on the printer will match more or less exactly the visible output on the screen. It is the easiest to use, as font metrics on the screen and on the printer are the same. This is the default value. ScreenResolution will produce a lower quality output than HighResolution and should only be used for drafts.

QPrinter.PrinterResolution

This value is deprecated. It is equivalent to ScreenResolution on Unix and HighResolution on Windows and Mac. Due to the difference between ScreenResolution and HighResolution, use of this value may lead to non-portable printer code.

QPrinter.HighResolution

On Windows, sets the printer resolution to that defined for the printer in use. For PDF printing, sets the resolution of the PDF driver to 1200 dpi.

Note

When rendering text on a QPrinter device, it is important to realize that the size of text, when specified in points, is independent of the resolution specified for the device itself. Therefore, it may be useful to specify the font size in pixels when combining text with graphics to ensure that their relative sizes are what you expect.

class PageOrder

This enum type is used by QPrinter to tell the application program how to print.

Constant

Description

QPrinter.FirstPageFirst

the lowest-numbered page should be printed first.

QPrinter.LastPageFirst

the highest-numbered page should be printed first.
class ColorMode

This enum type is used to indicate whether QPrinter should print in color or not.

Constant

Description

QPrinter.Color

print in color if available, otherwise in grayscale.

QPrinter.GrayScale

print in grayscale, even on color printers.
class PaperSource

This enum type specifies what paper source QPrinter is to use. QPrinter does not check that the paper source is available; it just uses this information to try and set the paper source. Whether it will set the paper source depends on whether the printer has that particular source.

Warning

This is currently only implemented for Windows.

Constant

Description

QPrinter.Auto

QPrinter.Cassette

QPrinter.Envelope

QPrinter.EnvelopeManual

QPrinter.FormSource

QPrinter.LargeCapacity

QPrinter.LargeFormat

QPrinter.Lower

QPrinter.MaxPageSource

Deprecated, use LastPaperSource instead

QPrinter.Middle

QPrinter.Manual

QPrinter.OnlyOne

QPrinter.Tractor

QPrinter.SmallFormat

QPrinter.Upper

QPrinter.CustomSource

A PaperSource defined by the printer that is unknown to Qt

QPrinter.LastPaperSource

The highest valid PaperSource value, currently CustomSource
class PrinterState

Constant

Description

QPrinter.Idle

QPrinter.Active

QPrinter.Aborted

QPrinter.Error
class OutputFormat

The OutputFormat enum is used to describe the format QPrinter should use for printing.

Constant

Description

QPrinter.NativeFormat

QPrinter will print output using a method defined by the platform it is running on. This mode is the default when printing directly to a printer.

QPrinter.PdfFormat

QPrinter will generate its output as a searchable PDF file. This mode is the default when printing to a file.

See also

outputFormat() setOutputFormat() setOutputFileName()

class PrintRange

Used to specify the print range selection option.

Constant

Description

QPrinter.AllPages

All pages should be printed.

QPrinter.Selection

Only the selection should be printed.

QPrinter.PageRange

The specified page range should be printed.

QPrinter.CurrentPage

Only the current page should be printed.

See also

setPrintRange() printRange() PrintRange

class Unit

This enum type is used to specify the measurement unit for page and paper sizes.

Constant

Description

QPrinter.Millimeter

QPrinter.Point

QPrinter.Inch

QPrinter.Pica

QPrinter.Didot

QPrinter.Cicero

QPrinter.DevicePixel

Note the difference between Point and DevicePixel. The Point unit is defined to be 1/72th of an inch, while the DevicePixel unit is resolution dependent and is based on the actual pixels, or dots, on the printer.

class DuplexMode

This enum is used to indicate whether printing will occur on one or both sides of each sheet of paper (simplex or duplex printing).

Constant

Description

QPrinter.DuplexNone

Single sided (simplex) printing only.

QPrinter.DuplexAuto

The printer’s default setting is used to determine whether duplex printing is used.

QPrinter.DuplexLongSide

Both sides of each sheet of paper are used for printing. The paper is turned over its longest edge before the second side is printed

QPrinter.DuplexShortSide

Both sides of each sheet of paper are used for printing. The paper is turned over its shortest edge before the second side is printed
__init__([mode=QPrinter.PrinterMode.ScreenResolution])
Parameters:

mode – PrinterMode

Creates a new printer object with the given mode.

__init__(printer[, mode=QPrinter.PrinterMode.ScreenResolution])
Parameters:

Creates a new printer object with the given printer and mode.

abort()
Return type:

bool

Aborts the current print run. Returns true if the print run was successfully aborted and printerState() will return Aborted ; otherwise returns false.

It is not always possible to abort a print job. For example, all the data has gone to the printer but the printer cannot or will not cancel the job when asked to.

collateCopies()
Return type:

bool

Returns true if collation is turned on when multiple copies is selected. Returns false if it is turned off when multiple copies is selected. When collating is turned off the printing of each individual page will be repeated the numCopies() amount before the next page is started. With collating turned on all pages are printed before the next copy of those pages is started.

colorMode()
Return type:

ColorMode

Returns the current color mode.

See also

setColorMode()

copyCount()
Return type:

int

Returns the number of copies that will be printed. The default value is 1.

creator()
Return type:

str

Returns the name of the application that created the document.

See also

setCreator()

docName()
Return type:

str

Returns the document name.

duplex()
Return type:

DuplexMode

Returns the current duplex mode.

See also

setDuplex()

fontEmbeddingEnabled()
Return type:

bool

Returns true if font embedding is enabled.

fromPage()
Return type:

int

Returns the number of the first page in a range of pages to be printed (the “from page” setting). Pages in a document are numbered according to the convention that the first page is page 1.

By default, this function returns a special value of 0, meaning that the “from page” setting is unset.

Note

If fromPage() and toPage() both return 0, this indicates that the whole document will be printed.

See also

setFromTo() toPage() pageRanges()

fullPage()
Return type:

bool

Returns true if the origin of the printer’s coordinate system is at the corner of the page and false if it is at the edge of the printable area.

See setFullPage() for details and caveats.

isValid()
Return type:

bool

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Returns true if the printer currently selected is a valid printer in the system, or a pure PDF printer; otherwise returns false.

To detect other failures check the output of QPainter::begin() or newPage() .

printer = QPrinter()
printer.setOutputFormat(QPrinter.PdfFormat)
printer.setOutputFileName("/foobar/nonwritable.pdf")
painter = QPainter()
if not painter.begin(printer): # failed to open file
    qWarning("failed to open file, is it writable?")
    return 1

painter.drawText(10, 10, "Test")
if not printer.newPage():
    qWarning("failed in flushing page to disk, disk full?")
    return 1

painter.drawText(10, 10, "Test 2")
painter.end()

See also

setPrinterName()

outputFileName()
Return type:

str

Returns the name of the output file. By default, this is an empty string (indicating that the printer shouldn’t print to file).

outputFormat()
Return type:

OutputFormat

Returns the output format for this printer.

pageOrder()
Return type:

PageOrder

Returns the current page order.

The default page order is FirstPageFirst.

See also

setPageOrder()

pageRect(arg__1)
Parameters:

arg__1 – Unit

Return type:

QRectF

Returns the page’s rectangle in unit; this is usually smaller than the paperRect() since the page normally has margins between its borders and the paper.

See also

pageLayout()

paperRect(arg__1)
Parameters:

arg__1 – Unit

Return type:

QRectF

Returns the paper’s rectangle in unit; this is usually larger than the pageRect() .

See also

pageRect()

paperSource()
Return type:

PaperSource

Returns the printer’s paper source. This is Manual or a printer tray or paper cassette.

See also

setPaperSource()

pdfVersion()
Return type:

PdfVersion

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

See also

setPdfVersion()

printEngine()
Return type:

QPrintEngine

Returns the print engine used by the printer.

printProgram()
Return type:

str

Returns the name of the program that sends the print output to the printer.

The default is to return an empty string; meaning that QPrinter will try to be smart in a system-dependent way. On X11 only, you can set it to something different to use a specific print program. On the other platforms, this returns an empty string.

See also

setPrintProgram() setPrinterSelectionOption()

printRange()
Return type:

PrintRange

Returns the page range of the QPrinter . After the print setup dialog has been opened, this function returns the value selected by the user.

See also

setPrintRange()

printerName()
Return type:

str

Returns the printer name. This value is initially set to the name of the default printer.

See also

setPrinterName()

printerState()
Return type:

PrinterState

Returns the current state of the printer. This may not always be accurate (for example if the printer doesn’t have the capability of reporting its state to the operating system).

resolution()
Return type:

int

Returns the current assumed resolution of the printer, as set by setResolution() or by the printer driver.

See also

setResolution()

setCollateCopies(collate)
Parameters:

collate – bool

Sets the default value for collation checkbox when the print dialog appears. If collate is true, it will enable setCollateCopiesEnabled(). The default value is false. This value will be changed by what the user presses in the print dialog.

See also

collateCopies()

setColorMode(arg__1)
Parameters:

arg__1 – ColorMode

Sets the printer’s color mode to newColorMode, which can be either Color or GrayScale.

See also

colorMode()

setCopyCount(arg__1)
Parameters:

arg__1 – int

Sets the number of copies to be printed to count.

The printer driver reads this setting and prints the specified number of copies.

setCreator(arg__1)
Parameters:

arg__1 – str

Sets the name of the application that created the document to creator.

This function is only applicable to the X11 version of Qt. If no creator name is specified, the creator will be set to “Qt” followed by some version number.

See also

creator()

setDocName(arg__1)
Parameters:

arg__1 – str

Sets the document name to name.

On X11, the document name is for example used as the default output filename in QPrintDialog . Note that the document name does not affect the file name if the printer is printing to a file. Use the setOutputFile() function for this.

setDuplex(duplex)
Parameters:

duplex – DuplexMode

Enables double sided printing based on the duplex mode.

See also

duplex()

setEngines(printEngine, paintEngine)
Parameters:

This function is used by subclasses of QPrinter to specify custom print and paint engines (printEngine and paintEngine, respectively).

QPrinter does not take ownership of the engines, so you need to manage these engine instances yourself.

Note that changing the engines will reset the printer state and all its properties.

See also

printEngine() paintEngine() setOutputFormat()

setFontEmbeddingEnabled(enable)
Parameters:

enable – bool

Enabled or disables font embedding depending on enable.

setFromTo(fromPage, toPage)
Parameters:

  • fromPage – int

  • toPage – int

Sets the range of pages to be printed to cover the pages with numbers specified by from and to, where from corresponds to the first page in the range and to corresponds to the last.

Note

Pages in a document are numbered according to the convention that the first page is page 1. However, if from and to are both set to 0, the whole document will be printed.

This function is mostly used to set a default value that the user can override in the print dialog when you call setup().

setFullPage(arg__1)
Parameters:

arg__1 – bool

If fp is true, enables support for painting over the entire page; otherwise restricts painting to the printable area reported by the device.

By default, full page printing is disabled. In this case, the origin of the QPrinter ‘s coordinate system coincides with the top-left corner of the printable area.

If full page printing is enabled, the origin of the QPrinter ‘s coordinate system coincides with the top-left corner of the paper itself. In this case, the device metrics will report the exact same dimensions as indicated by {QPageSize}. It may not be possible to print on the entire physical page because of the printer’s margins, so the application must account for the margins itself.

See also

fullPage() setPageSize()

setOutputFileName(arg__1)
Parameters:

arg__1 – str

Sets the name of the output file to fileName.

Setting a null or empty name (0 or “”) disables printing to a file. Setting a non-empty name enables printing to a file.

This can change the value of outputFormat() . If the file name has the “.pdf” suffix PDF is generated. If the file name has a suffix other than “.pdf”, the output format used is the one set with setOutputFormat() .

QPrinter uses Qt’s cross-platform PDF print engines respectively. If you can produce this format natively, for example macOS can generate PDF’s from its print engine, set the output format back to NativeFormat .

setOutputFormat(format)
Parameters:

format – OutputFormat

Sets the output format for this printer to format.

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

If format is NativeFormat then the printerName will be set to the default printer. If there are no valid printers configured then no change will be made. If you want to set NativeFormat with a specific printerName then use setPrinterName() .

setPageOrder(arg__1)
Parameters:

arg__1 – PageOrder

Sets the page order to pageOrder.

The page order can be FirstPageFirst or LastPageFirst . The application is responsible for reading the page order and printing accordingly.

This function is mostly useful for setting a default value that the user can override in the print dialog.

This function is only supported under X11.

See also

pageOrder()

setPaperSource(arg__1)
Parameters:

arg__1 – PaperSource

Sets the paper source setting to source.

Windows only: This option can be changed while printing and will take effect from the next call to newPage()

See also

paperSource()

setPdfVersion(version)
Parameters:

version – PdfVersion

Sets the PDF version for this printer to version.

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

See also

pdfVersion()

setPrintProgram(arg__1)
Parameters:

arg__1 – str

Sets the name of the program that should do the print job to printProg.

On X11, this function sets the program to call with the PDF output. On other platforms, it has no effect.

See also

printProgram()

setPrintRange(range)
Parameters:

range – PrintRange

Sets the print range option in to be range.

See also

printRange()

setPrinterName(arg__1)
Parameters:

arg__1 – str

Sets the printer name to name.

If the name is empty then the output format will be set to PdfFormat .

If the name is not a valid printer then no change will be made.

If the name is a valid printer then the output format will be set to NativeFormat .

setResolution(arg__1)
Parameters:

arg__1 – int

Requests that the printer prints at dpi or as near to dpi as possible.

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

This function must be called before QPainter::begin() to have an effect on all platforms.

supportedResolutions()
Return type:

.list of int

Returns a list of the resolutions (a list of dots-per-inch integers) that the printer says it supports.

For X11 where all printing is directly to PDF, this function will always return a one item list containing only the PDF resolution, i.e., 72 (72 dpi – but see PrinterMode ).

supportsMultipleCopies()
Return type:

bool

Returns true if the printer supports printing multiple copies of the same document in one job; otherwise false is returned.

On most systems this function will return true. However, on X11 systems that do not support CUPS, this function will return false. That means the application has to handle the number of copies by printing the same document the required number of times.

toPage()
Return type:

int

Returns the number of the last page in a range of pages to be printed (the “to page” setting). Pages in a document are numbered according to the convention that the first page is page 1.

By default, this function returns a special value of 0, meaning that the “to page” setting is unset.

Note

If fromPage() and toPage() both return 0, this indicates that the whole document will be printed.

The programmer is responsible for reading this setting and printing accordingly.