QPrintDialog

The QPrintDialog class provides a dialog for specifying the printer’s configuration. More

Inheritance diagram of PySide2.QtPrintSupport.QPrintDialog

Synopsis

Functions

Signals

Detailed Description

The dialog allows users to change document-related settings, such as the paper size and orientation, type of print (color or grayscale), range of pages, and number of copies to print.

Controls are also provided to enable users to choose from the printers available, including any configured network printers.

Typically, QPrintDialog objects are constructed with a QPrinter object, and executed using the exec() function.

printDialog = QPrintDialog(printer, parent)
if printDialog.exec_() == QDialog.Accepted:
    # print ...

If the dialog is accepted by the user, the QPrinter object is correctly configured for printing.

plastique-printdialog1

plastique-printdialog-properties2

The printer dialog (shown above in Plastique style) enables access to common printing properties. On X11 platforms that use the CUPS printing system, the settings for each available printer can be modified via the dialog’s Properties push button.

On Windows and macOS, the native print dialog is used, which means that some QWidget and QDialog properties set on the dialog won’t be respected. The native print dialog on macOS does not support setting printer options, i.e. setOptions() and setOption() have no effect.

In Qt 4.4, it was possible to use the static functions to show a sheet on macOS. This is no longer supported in Qt 4.5. If you want this functionality, use open() .

class PySide2.QtPrintSupport.QPrintDialog(printer[, parent=None])

PySide2.QtPrintSupport.QPrintDialog([parent=None])

param parent

PySide2.QtWidgets.QWidget

param printer

PySide2.QtPrintSupport.QPrinter

Constructs a new modal printer dialog for the given printer with the given parent .

PySide2.QtPrintSupport.QPrintDialog.accepted(printer)
Parameters

printerPySide2.QtPrintSupport.QPrinter

PySide2.QtPrintSupport.QPrintDialog.open(receiver, member)
Parameters

This is an overloaded function.

Opens the dialog and connects its accepted() signal to the slot specified by receiver and member .

The signal will be disconnected from the slot when the dialog is closed.

PySide2.QtPrintSupport.QPrintDialog.options()
Return type

PrintDialogOptions

This property holds the various options that affect the look and feel of the dialog.

By default, all options are disabled.

Options should be set before showing the dialog. Setting them while the dialog is visible is not guaranteed to have an immediate effect on the dialog (depending on the option and on the platform).

PySide2.QtPrintSupport.QPrintDialog.setOption(option[, on=true])
Parameters

Sets the given option to be enabled if on is true; otherwise, clears the given option .

PySide2.QtPrintSupport.QPrintDialog.setOptions(options)
Parameters

optionsPrintDialogOptions

This property holds the various options that affect the look and feel of the dialog.

By default, all options are disabled.

Options should be set before showing the dialog. Setting them while the dialog is visible is not guaranteed to have an immediate effect on the dialog (depending on the option and on the platform).

PySide2.QtPrintSupport.QPrintDialog.testOption(option)
Parameters

optionPrintDialogOption

Return type

bool

Returns true if the given option is enabled; otherwise, returns false.

See also

options setOption()