QPrinter Class

Member Function Documentation

QPrinter::QPrinter(const QPrinterInfo &printer, QPrinter::PrinterMode mode = ScreenResolution)

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

QPrinter::QPrinter(QPrinter::PrinterMode mode = ScreenResolution)

Creates a new printer object with the given mode.

[virtual] QPrinter::~QPrinter()

Destroys the printer object and frees any allocated resources. If the printer is destroyed while a print job is in progress this may or may not affect the print job.

bool QPrinter::abort()

Aborts the current print run. Returns true if the print run was successfully aborted and printerState() will return QPrinter::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.

bool QPrinter::collateCopies() const

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.

See also setCollateCopies().

QPrinter::ColorMode QPrinter::colorMode() const

Returns the current color mode.

See also setColorMode().

int QPrinter::copyCount() const

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

See also setCopyCount() and supportsMultipleCopies().

QString QPrinter::creator() const

Returns the name of the application that created the document.

See also setCreator().

QString QPrinter::docName() const

Returns the document name.

See also setDocName() and QPrintEngine::PrintEnginePropertyKey.

QPrinter::DuplexMode QPrinter::duplex() const

Returns the current duplex mode.

See also setDuplex().

bool QPrinter::fontEmbeddingEnabled() const

Returns true if font embedding is enabled.

See also setFontEmbeddingEnabled().

int QPrinter::fromPage() const

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.

See also setFromTo(), toPage(), and pageRanges().

bool QPrinter::fullPage() const

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.

See also setFullPage() and QPagedPaintDevice::pageLayout().

bool QPrinter::isValid() const

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 QPrinter::newPage().

    QPrinter printer;
    printer.setOutputFormat(QPrinter::PdfFormat);
    printer.setOutputFileName("/foobar/nonwritable.pdf");
    QPainter painter;
    if (! painter.begin(&printer)) { // failed to open file
        qWarning("failed to open file, is it writable?");
        return 1;
    }
    painter.drawText(10, 10, "Test");
    if (! printer.newPage()) {
        qWarning("failed in flushing page to disk, disk full?");
        return 1;
    }
    painter.drawText(10, 10, "Test 2");
    painter.end();

See also setPrinterName().

[override virtual] bool QPrinter::newPage()

Reimplements: QPagedPaintDevice::newPage().

Tells the printer to eject the current page and to continue printing on a new page. Returns true if this was successful; otherwise returns false.

Calling newPage() on an inactive QPrinter object will always fail.

QString QPrinter::outputFileName() const

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

See also setOutputFileName() and QPrintEngine::PrintEnginePropertyKey.

QPrinter::OutputFormat QPrinter::outputFormat() const

Returns the output format for this printer.

See also setOutputFormat().

QPrinter::PageOrder QPrinter::pageOrder() const

Returns the current page order.

The default page order is FirstPageFirst.

See also setPageOrder().

QRectF QPrinter::pageRect(QPrinter::Unit unit) const

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 QPagedPaintDevice::pageLayout().

[override virtual] QPaintEngine *QPrinter::paintEngine() const

Reimplements: QPaintDevice::paintEngine() const.

Returns the paint engine used by the printer.

QRectF QPrinter::paperRect(QPrinter::Unit unit) const

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

See also pageRect().

QPrinter::PaperSource QPrinter::paperSource() const

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

See also setPaperSource().

[since 5.10] QPagedPaintDevice::PdfVersion QPrinter::pdfVersion() const

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

This function was introduced in Qt 5.10.

See also setPdfVersion().

QPrintEngine *QPrinter::printEngine() const

Returns the print engine used by the printer.

QString QPrinter::printProgram() const

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() and setPrinterSelectionOption().

QPrinter::PrintRange QPrinter::printRange() const

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

QString QPrinter::printerName() const

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

See also setPrinterName().

QString QPrinter::printerSelectionOption() const

Returns the printer options selection string. This is useful only if the print command has been explicitly set.

The default value (an empty string) implies that the printer should be selected in a system-dependent manner.

Any other value implies that the given value should be used.

This function always returns an empty string on Windows and Mac.

See also setPrinterSelectionOption() and setPrintProgram().

QPrinter::PrinterState QPrinter::printerState() const

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

int QPrinter::resolution() const

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

See also setResolution().

void QPrinter::setCollateCopies(bool collate)

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

void QPrinter::setColorMode(QPrinter::ColorMode newColorMode)

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

See also colorMode().

void QPrinter::setCopyCount(int count)

Sets the number of copies to be printed to count.

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

See also copyCount() and supportsMultipleCopies().

void QPrinter::setCreator(const QString &creator)

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

void QPrinter::setDocName(const QString &name)

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.

See also docName() and QPrintEngine::PrintEnginePropertyKey.

void QPrinter::setDuplex(QPrinter::DuplexMode duplex)

Enables double sided printing based on the duplex mode.

See also duplex().

[protected] void QPrinter::setEngines(QPrintEngine *printEngine, QPaintEngine *paintEngine)

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(), and setOutputFormat().

void QPrinter::setFontEmbeddingEnabled(bool enable)

Enabled or disables font embedding depending on enable.

See also fontEmbeddingEnabled().

void QPrinter::setFromTo(int from, int to)

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.

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

See also fromPage(), toPage(), and pageRanges().

void QPrinter::setFullPage(bool fp)

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(), QPagedPaintDevice::pageLayout(), and QPagedPaintDevice::setPageSize().

void QPrinter::setOutputFileName(const QString &fileName)

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.

See also outputFileName() and setOutputFormat().

void QPrinter::setOutputFormat(QPrinter::OutputFormat format)

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

See also outputFormat() and setPrinterName().

void QPrinter::setPageOrder(QPrinter::PageOrder pageOrder)

Sets the page order to pageOrder.

The page order can be QPrinter::FirstPageFirst or QPrinter::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().

void QPrinter::setPaperSource(QPrinter::PaperSource source)

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

[since 5.10] void QPrinter::setPdfVersion(QPagedPaintDevice::PdfVersion version)

Sets the PDF version for this printer to version.

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

This function was introduced in Qt 5.10.

See also pdfVersion().

void QPrinter::setPrintProgram(const QString &printProg)

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

void QPrinter::setPrintRange(QPrinter::PrintRange range)

Sets the print range option in to be range.

See also printRange().

void QPrinter::setPrinterName(const QString &name)

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.

See also printerName(), isValid(), and setOutputFormat().

void QPrinter::setPrinterSelectionOption(const QString &option)

Sets the printer to use option to select the printer. option is null by default (which implies that Qt should be smart enough to guess correctly), but it can be set to other values to use a specific printer selection option.

If the printer selection option is changed while the printer is active, the current print job may or may not be affected.

This function has no effect on Windows or Mac.

See also printerSelectionOption() and setPrintProgram().

void QPrinter::setResolution(int dpi)

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.

See also resolution() and QPagedPaintDevice::setPageSize().

QList<QPrinter::PaperSource> QPrinter::supportedPaperSources() const

Returns the supported paper sizes for this printer.

The values will be either a value that matches an entry in the QPrinter::PaperSource enum or a driver spesific value. The driver spesific values are greater than the constant DMBIN_USER declared in wingdi.h.

QList<int> QPrinter::supportedResolutions() const

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

bool QPrinter::supportsMultipleCopies() const

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.

See also setCopyCount() and copyCount().

int QPrinter::toPage() const

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.

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

See also setFromTo(), fromPage(), and pageRanges().