PySide6.QtPrintSupport.QPrintPreviewDialog

class QPrintPreviewDialog

The QPrintPreviewDialog class provides a dialog for previewing and configuring page layouts for printer output. More…

Synopsis

Methods

• def __init__()

• def open()

• def printer()

Signals

• def paintRequested()

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

Using QPrintPreviewDialog in your existing application is straightforward:

1. Create the QPrintPreviewDialog .

   You can construct a QPrintPreviewDialog with an existing QPrinter object, or you can have QPrintPreviewDialog create one for you, which will be the system default printer.

2. Connect the paintRequested() signal to a slot.

   When the dialog needs to generate a set of preview pages, the paintRequested() signal will be emitted. You can use the exact same code for the actual printing as for having the preview generated, including calling newPage() to start a new page in the preview. Connect a slot to the paintRequested() signal, where you draw onto the QPrinter object that is passed into the slot.

3. Call exec().

   Call QPrintPreviewDialog::exec() to show the preview dialog.

See also

QPrinter QPrintDialog QPageSetupDialog QPrintPreviewWidget

__init__([parent=None[, flags=Qt.WindowFlags()]])

Parameters:

• parent – QWidget

• flags – Combination of WindowType

This is an overloaded function.

This will create an internal QPrinter object, which will use the system default printer.

__init__(printer[, parent=None[, flags=Qt.WindowFlags()]])

Parameters:

• printer – QPrinter

• parent – QWidget

• flags – Combination of WindowType

Constructs a QPrintPreviewDialog based on printer and with parent as the parent widget. The widget flags flags are passed on to the QWidget constructor.

See also

setWindowFlags()

open(receiver, member)

Parameters:

• receiver – QObject

• member – str

This is an overloaded function.

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

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

paintRequested(printer)

Parameters:

printer – QPrinter

This signal is emitted when the QPrintPreviewDialog needs to generate a set of preview pages.

The printer instance supplied is the paint device onto which you should paint the contents of each page, using the QPrinter instance in the same way as you would when printing directly.

printer()

Return type:

QPrinter

Returns a pointer to the QPrinter object this dialog is currently operating on.