QPrintDialog Class | Qt Print Support 5.6

Qt 5.6 | Qt Print Support | C++ Classes | QPrintDialog

Qt 5.6.2 Reference Documentation

# QPrintDialog Class

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

Header: | #include <QPrintDialog>
qmake: | QT += printsupport
Inherits: | QAbstractPrintDialog

- List of all members, including inherited members

## Properties

- options : PrintDialogOptions

## Public Functions

| QPrintDialog(QPrinter *printer, QWidget *parent = Q_NULLPTR)
| QPrintDialog(QWidget *parent = Q_NULLPTR)
| ~QPrintDialog()
void | done(int result)
void | open(QObject *receiver, const char *member)
PrintDialogOptions | options() const
QPrinter * | printer()
void | setOption(PrintDialogOption option, bool on = true)
void | setOptions(PrintDialogOptions options)
void | setVisible(bool visible)
bool | testOption(PrintDialogOption option) const

## Reimplemented Public Functions

virtual int | exec()

- 11 public functions inherited from QAbstractPrintDialog

## Signals

void | accepted(QPrinter *printer)

## Detailed Description

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

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.

      QPrintDialog printDialog(printer, parent);
      if (printDialog.exec() == QDialog::Accepted) {
          // print ...
      }

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

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 QPrintDialog::open().

See also QPageSetupDialog and QPrinter.

## Property Documentation

### options : 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).

This property was introduced in Qt 4.5.

Access functions:

PrintDialogOptions | options() const
void | setOptions(PrintDialogOptions options)

See also setOption() and testOption().

## Member Function Documentation

### QPrintDialog::QPrintDialog(QPrinter *printer, QWidget *parent = Q_NULLPTR)

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

### QPrintDialog::QPrintDialog(QWidget *parent = Q_NULLPTR)

Constructs a print dialog with the given parent.

### QPrintDialog::~QPrintDialog()

Destroys the print dialog.

### `[signal]` void QPrintDialog::accepted(QPrinter *printer)

This signal is emitted when the user accepts the values set in the print dialog. The printer parameter includes the printer that the settings were applied to.

### void QPrintDialog::done(int result)

Closes the dialog and sets its result code to result. If this dialog is shown with exec(), done() causes the local event loop to finish, and exec() to return result.

Note: This function does not apply to the Native Print Dialog on the Mac macOS and Windows platforms, because the dialog is required to be modal and only the user can close it.

See also QDialog::done().

### `[virtual]` int QPrintDialog::exec()

Reimplemented from QAbstractPrintDialog::exec().

### void QPrintDialog::open(QObject *receiver, const char *member)

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.

This function was introduced in Qt 4.5.

### QPrinter *QPrintDialog::printer()

Returns the printer that this printer dialog operates on. This can be useful when using the QPrintDialog::open() method.

### void QPrintDialog::setOption(PrintDialogOption option, bool on = true)

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

See also options and testOption().

### void QPrintDialog::setVisible(bool visible)

### bool QPrintDialog::testOption(PrintDialogOption option) const

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

See also options and setOption().