|  | Home · All Classes · Modules

# QPrintPreviewDialog Class Reference
[QtGui module]

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

Inherits QDialog.

### Methods

- __init__ (self, QWidget parent = None, Qt.WindowFlags flags = 0)
- __init__ (self, QPrinter printer, QWidget parent = None, Qt.WindowFlags flags = 0)
- done (self, int result)
- open (self)
- open (self, QObject receiver, SLOT()SLOT() member)
- open (self, callable receiver)
- QPrinter printer (self)
- setVisible (self, bool visible)

### Qt Signals

- void paintRequested (QPrinter *)

## Detailed Description

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

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 QPrinter.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.

## Method Documentation

### QPrintPreviewDialog.__init__ (self, QWidget parent = None, Qt.WindowFlags flags = 0)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

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 QWidget.setWindowFlags().

### QPrintPreviewDialog.__init__ (self, QPrinter printer, QWidget parent = None, Qt.WindowFlags flags = 0)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

This is an overloaded function.

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

### QPrintPreviewDialog.done (self, int result)

Reimplemented from QDialog.done().

### QPrintPreviewDialog.open (self)

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.

This function was introduced in Qt 4.5.

### QPrintPreviewDialog.open (self, QObject receiver, SLOT()SLOT() member)

### QPrintPreviewDialog.open (self, callable receiver)

### QPrinter QPrintPreviewDialog.printer (self)

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

### QPrintPreviewDialog.setVisible (self, bool visible)

Reimplemented from QWidget.setVisible().

## Qt Signal Documentation

### void paintRequested (QPrinter *)

This is the default overload of this signal.

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.