\reentrant More...

#include <qprinter.h>

Inheritance diagram for QPrinter:

Collaboration diagram for QPrinter:

Public Types
enum	PrinterMode { ScreenResolution , PrinterResolution , HighResolution }
	This enum describes the mode the printer should work in. More...

enum	PageOrder { FirstPageFirst , LastPageFirst }
	This enum type is used by QPrinter to tell the application program how to print. More...

enum	ColorMode { GrayScale , Color }
	This enum type is used to indicate whether QPrinter should print in color or not. More...

enum	PaperSource { OnlyOne , Lower , Middle , Manual , Envelope , EnvelopeManual , Auto , Tractor , SmallFormat , LargeFormat , LargeCapacity , Cassette , FormSource , MaxPageSource , CustomSource , LastPaperSource = CustomSource , Upper = OnlyOne }
	This enum type specifies what paper source QPrinter is to use. More...

enum	PrinterState { Idle , Active , Aborted , Error }
	\value Idle \value Active \value Aborted \value Error More...

enum	OutputFormat { NativeFormat , PdfFormat }
	The OutputFormat enum is used to describe the format QPrinter should use for printing. More...

enum	PrintRange { AllPages , Selection , PageRange , CurrentPage }
	Used to specify the print range selection option. More...

enum	Unit { Millimeter , Point , Inch , Pica , Didot , Cicero , DevicePixel }

Public Types inherited from QPagedPaintDevice
enum	PdfVersion { PdfVersion_1_4 , PdfVersion_A1b , PdfVersion_1_6 }
	The PdfVersion enum describes the version of the PDF file that is produced by QPrinter or QPdfWriter. More...

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric { PdmWidth = 1 , PdmHeight , PdmWidthMM , PdmHeightMM , PdmNumColors , PdmDepth , PdmDpiX , PdmDpiY , PdmPhysicalDpiX , PdmPhysicalDpiY , PdmDevicePixelRatio , PdmDevicePixelRatioScaled }

Public Member Functions
	QPrinter (PrinterMode mode=ScreenResolution)
	Creates a new printer object with the given mode.

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

	~QPrinter ()
	Destroys the printer object and frees any allocated resources.

int	devType () const override

void	setOutputFormat (OutputFormat format)

OutputFormat	outputFormat () const

void	setPdfVersion (PdfVersion version)

PdfVersion	pdfVersion () const

void	setPrinterName (const QString &)
	Sets the printer name to name.

QString	printerName () const
	Returns the printer name.

bool	isValid () const

void	setOutputFileName (const QString &)
	Sets the name of the output file to fileName.

QString	outputFileName () const
	Returns the name of the output file.

void	setPrintProgram (const QString &)
	Sets the name of the program that should do the print job to printProg.

QString	printProgram () const
	Returns the name of the program that sends the print output to the printer.

void	setDocName (const QString &)
	Sets the document name to name.

QString	docName () const
	Returns the document name.

void	setCreator (const QString &)
	Sets the name of the application that created the document to creator.

QString	creator () const
	Returns the name of the application that created the document.

void	setPageOrder (PageOrder)
	Sets the page order to pageOrder.

PageOrder	pageOrder () const
	Returns the current page order.

void	setColorMode (ColorMode)
	Sets the printer's color mode to newColorMode, which can be either `Color` or `GrayScale`.

ColorMode	colorMode () const
	Returns the current color mode.

void	setCollateCopies (bool collate)

bool	collateCopies () const

void	setCopyCount (int)

int	copyCount () const

bool	supportsMultipleCopies () const

Public Member Functions inherited from QPagedPaintDevice
	~QPagedPaintDevice ()
	Destroys the object.

virtual bool	setPageLayout (const QPageLayout &pageLayout)

virtual bool	setPageSize (const QPageSize &pageSize)

virtual bool	setPageOrientation (QPageLayout::Orientation orientation)

virtual bool	setPageMargins (const QMarginsF &margins, QPageLayout::Unit units=QPageLayout::Millimeter)

QPageLayout	pageLayout () const

virtual void	setPageRanges (const QPageRanges &ranges)

QPageRanges	pageRanges () const

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

bool	paintingActive () const

int	width () const

int	height () const

int	widthMM () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	physicalDpiX () const

int	physicalDpiY () const

qreal	devicePixelRatio () const

qreal	devicePixelRatioF () const

int	colorCount () const

int	depth () const

Protected Member Functions
void	setEngines (QPrintEngine printEngine, QPaintEngine paintEngine)
	This function is used by subclasses of QPrinter to specify custom print and paint engines (printEngine and paintEngine, respectively).

Protected Member Functions inherited from QPagedPaintDevice
	QPagedPaintDevice (QPagedPaintDevicePrivate *dd)

QPagedPaintDevicePrivate *	dd ()

Protected Member Functions inherited from QPaintDevice
	QPaintDevice () noexcept

virtual void	initPainter (QPainter *painter) const

virtual QPaintDevice *	redirected (QPoint *offset) const

virtual QPainter *	sharedPainter () const

Friends
class	QPrintDialogPrivate

class	QAbstractPrintDialog

class	QAbstractPrintDialogPrivate

class	QPrintPreviewWidgetPrivate

class	QTextDocument

class	QPageSetupWidget

enum	DuplexMode { DuplexNone = 0 , DuplexAuto , DuplexLongSide , DuplexShortSide }

void	setResolution (int)
	Requests that the printer prints at dpi or as near to dpi as possible.

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

void	setFullPage (bool)
	If fp is true, enables support for painting over the entire page; otherwise restricts painting to the printable area reported by the device.

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

void	setPaperSource (PaperSource)
	Sets the paper source setting to source.

PaperSource	paperSource () const
	Returns the printer's paper source.

void	setDuplex (DuplexMode duplex)

DuplexMode	duplex () const

QList< int >	supportedResolutions () const
	Returns a list of the resolutions (a list of dots-per-inch integers) that the printer says it supports.

void	setFontEmbeddingEnabled (bool enable)

bool	fontEmbeddingEnabled () const

QRectF	paperRect (Unit) const

QRectF	pageRect (Unit) const

QString	printerSelectionOption () const
	Returns the printer options selection string.

void	setPrinterSelectionOption (const QString &)
	Sets the printer to use option to select the printer.

bool	newPage () override
	Tells the printer to eject the current page and to continue printing on a new page.

bool	abort ()
	Aborts the current print run.

PrinterState	printerState () const
	Returns the current state of the printer.

QPaintEngine *	paintEngine () const override
	Returns the paint engine used by the printer.

QPrintEngine *	printEngine () const

void	setFromTo (int fromPage, int toPage)

int	fromPage () const

int	toPage () const

void	setPrintRange (PrintRange range)

PrintRange	printRange () const

int	metric (PaintDeviceMetric) const override

Additional Inherited Members
Static Public Member Functions inherited from QPaintDevice
static qreal	devicePixelRatioFScale ()

Protected Attributes inherited from QPagedPaintDevice
QPagedPaintDevicePrivate *	d

Protected Attributes inherited from QPaintDevice
ushort	painters

Detailed Description

\reentrant

The QPrinter class is a paint device that paints on a printer.

\inmodule QtPrintSupport

This device represents a series of pages of printed output, and is used in almost exactly the same way as other paint devices such as QWidget and QPixmap. A set of additional functions are provided to manage device-specific features, such as orientation and resolution, and to step through the pages in a document as it is generated.

When printing directly to a printer on Windows or \macos, QPrinter uses the built-in printer drivers. On X11, QPrinter uses the \l{Common Unix Printing System (CUPS)} to send PDF output to the printer. As an alternative, the printProgram() function can be used to specify the command or utility to use instead of the system default.

Note that setting parameters like paper size and resolution on an invalid printer is undefined. You can use QPrinter::isValid() to verify this before changing any parameters.

QPrinter supports a number of parameters, most of which can be changed by the end user through a \l{QPrintDialog}{print dialog}. In general, QPrinter passes these functions onto the underlying QPrintEngine.

The most important parameters are: \list

setPageLayout() tells QPrinter which page orientation to use, and what size to expect from the printer.
setResolution() tells QPrinter what resolution you wish the printer to provide, in dots per inch (DPI).
setFullPage() tells QPrinter whether you want to deal with the full page or just with the part the printer can draw on.
setCopyCount() tells QPrinter how many copies of the document it should print. \endlist

Many of these functions can only be called before the actual printing begins (i.e., before QPainter::begin() is called). This usually makes sense because, for example, it's not possible to change the number of copies when you are halfway through printing. There are also some settings that the user sets (through the printer dialog) and that applications are expected to obey. See QAbstractPrintDialog's documentation for more details.

When QPainter::begin() is called, the QPrinter it operates on is prepared for a new page, enabling the QPainter to be used immediately to paint the first page in a document. Once the first page has been painted, newPage() can be called to request a new blank page to paint on, or QPainter::end() can be called to finish printing. The second page and all following pages are prepared using a call to newPage() before they are painted.

The first page in a document does not need to be preceded by a call to newPage(). You only need to calling newPage() after QPainter::begin() if you need to insert a blank page at the beginning of a printed document. Similarly, calling newPage() after the last page in a document is painted will result in a trailing blank page appended to the end of the printed document.

If you want to abort the print job, abort() will try its best to stop printing. It may cancel the entire job or just part of it.

Since QPrinter can print to any QPrintEngine subclass, it is possible to extend printing support to cover new types of printing subsystem by subclassing QPrintEngine and reimplementing its interface.

See also: QPrintDialog, {Qt Print Support}

Definition at line 27 of file qprinter.h.

Member Enumeration Documentation

◆ ColorMode

enum QPrinter::ColorMode

This enum type is used to indicate whether QPrinter should print in color or not.

\value Color print in color if available, otherwise in grayscale.

\value GrayScale print in grayscale, even on color printers.

Enumerator
GrayScale
Color

Definition at line 42 of file qprinter.h.

◆ DuplexMode

enum QPrinter::DuplexMode

Since: 4.4

This enum is used to indicate whether printing will occur on one or both sides of each sheet of paper (simplex or duplex printing).

\value DuplexNone Single sided (simplex) printing only. \value DuplexAuto The printer's default setting is used to determine whether duplex printing is used. \value DuplexLongSide Both sides of each sheet of paper are used for printing. The paper is turned over its longest edge before the second side is printed \value DuplexShortSide Both sides of each sheet of paper are used for printing. The paper is turned over its shortest edge before the second side is printed

Enumerator
DuplexNone
DuplexAuto
DuplexLongSide
DuplexShortSide

Definition at line 84 of file qprinter.h.

◆ OutputFormat

enum QPrinter::OutputFormat

The OutputFormat enum is used to describe the format QPrinter should use for printing.

\value NativeFormat QPrinter will print output using a method defined by the platform it is running on. This mode is the default when printing directly to a printer.

\value PdfFormat QPrinter will generate its output as a searchable PDF file. This mode is the default when printing to a file.

See also: outputFormat(), setOutputFormat(), setOutputFileName()

Enumerator
NativeFormat
PdfFormat

Definition at line 69 of file qprinter.h.

◆ PageOrder

enum QPrinter::PageOrder

This enum type is used by QPrinter to tell the application program how to print.

\value FirstPageFirst the lowest-numbered page should be printed first.

\value LastPageFirst the highest-numbered page should be printed first.

Enumerator
FirstPageFirst
LastPageFirst

Definition at line 39 of file qprinter.h.

◆ PaperSource

enum QPrinter::PaperSource

This enum type specifies what paper source QPrinter is to use.

QPrinter does not check that the paper source is available; it just uses this information to try and set the paper source. Whether it will set the paper source depends on whether the printer has that particular source.

Warning: This is currently only implemented for Windows.

\value Auto \value Cassette \value Envelope \value EnvelopeManual \value FormSource \value LargeCapacity \value LargeFormat \value Lower \value MaxPageSource Deprecated, use LastPaperSource instead \value Middle \value Manual \value OnlyOne \value Tractor \value SmallFormat \value Upper \value CustomSource A PaperSource defined by the printer that is unknown to Qt \value LastPaperSource The highest valid PaperSource value, currently CustomSource

Enumerator
OnlyOne
Lower
Middle
Manual
Envelope
EnvelopeManual
Auto
Tractor
SmallFormat
LargeFormat
LargeCapacity
Cassette
FormSource
MaxPageSource
CustomSource
LastPaperSource
Upper

Definition at line 45 of file qprinter.h.

◆ PrinterMode

enum QPrinter::PrinterMode

This enum describes the mode the printer should work in.

It basically presets a certain resolution and working mode.

\value ScreenResolution Sets the resolution of the print device to the screen resolution. This has the big advantage that the results obtained when painting on the printer will match more or less exactly the visible output on the screen. It is the easiest to use, as font metrics on the screen and on the printer are the same. This is the default value. ScreenResolution will produce a lower quality output than HighResolution and should only be used for drafts.

\value PrinterResolution This value is deprecated. It is equivalent to ScreenResolution on Unix and HighResolution on Windows and Mac. Due to the difference between ScreenResolution and HighResolution, use of this value may lead to non-portable printer code.

\value HighResolution On Windows, sets the printer resolution to that defined for the printer in use. For PDF printing, sets the resolution of the PDF driver to 1200 dpi.

Note: When rendering text on a QPrinter device, it is important to realize that the size of text, when specified in points, is independent of the resolution specified for the device itself. Therefore, it may be useful to specify the font size in pixels when combining text with graphics to ensure that their relative sizes are what you expect.

Enumerator
ScreenResolution
PrinterResolution
HighResolution

Definition at line 31 of file qprinter.h.

◆ PrinterState

enum QPrinter::PrinterState

\value Idle \value Active \value Aborted \value Error

Enumerator
Idle
Active
Aborted
Error

Definition at line 64 of file qprinter.h.

◆ PrintRange

enum QPrinter::PrintRange

Used to specify the print range selection option.

\value AllPages All pages should be printed. \value Selection Only the selection should be printed. \value PageRange The specified page range should be printed. \value CurrentPage Only the current page should be printed.

See also: setPrintRange(), printRange(), QAbstractPrintDialog::PrintRange

Enumerator
AllPages
Selection
PageRange
CurrentPage

Definition at line 72 of file qprinter.h.

◆ Unit

enum QPrinter::Unit

Since: 4.4

This enum type is used to specify the measurement unit for page and paper sizes.

\value Millimeter \value Point \value Inch \value Pica \value Didot \value Cicero \value DevicePixel

Note the difference between Point and DevicePixel. The Point unit is defined to be 1/72th of an inch, while the DevicePixel unit is resolution dependent and is based on the actual pixels, or dots, on the printer.

Enumerator
Millimeter
Point
Inch
Pica
Didot
Cicero
DevicePixel

Definition at line 74 of file qprinter.h.

Constructor & Destructor Documentation

◆ QPrinter() [1/2]

QPrinter::QPrinter ( PrinterMode mode = ScreenResolution )

explicit

Creates a new printer object with the given mode.

Definition at line 446 of file qprinter.cpp.

References QPrinterPrivate::init().

Here is the call graph for this function:

◆ QPrinter() [2/2]

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

explicit

Since: 4.4

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

Definition at line 458 of file qprinter.cpp.

References QPrinterPrivate::init().

Here is the call graph for this function:

◆ ~QPrinter()

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.

Definition at line 509 of file qprinter.cpp.

References QPagedPaintDevice::d.

Member Function Documentation

◆ abort()

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.

Definition at line 1263 of file qprinter.cpp.

References QPagedPaintDevice::d.

◆ collateCopies()

bool QPrinter::collateCopies ( ) const

Since: 4.1

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

Definition at line 951 of file qprinter.cpp.

References QPagedPaintDevice::d, and QPrintEngine::PPK_CollateCopies.

◆ colorMode()

QPrinter::ColorMode QPrinter::colorMode ( ) const

Returns the current color mode.

See also: setColorMode()

Definition at line 882 of file qprinter.cpp.

References QPagedPaintDevice::d, and QPrintEngine::PPK_ColorMode.

◆ copyCount()

int QPrinter::copyCount ( ) const

Since: 4.7

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

See also: setCopyCount(), supportsMultipleCopies()

Definition at line 914 of file qprinter.cpp.

References QPagedPaintDevice::d, and QPrintEngine::PPK_CopyCount.

Referenced by QPrinterPrivate::changeEngines().

Here is the caller graph for this function:

◆ creator()

QString QPrinter::creator ( ) const

Returns the name of the application that created the document.

See also: setCreator()

Definition at line 802 of file qprinter.cpp.

References QPagedPaintDevice::d, and QPrintEngine::PPK_Creator.

Referenced by setCreator().

Here is the caller graph for this function:

◆ devType()

int QPrinter::devType ( ) const

overridevirtual

Reimplemented from QPaintDevice.

Definition at line 610 of file qprinter.cpp.

References QInternal::Printer.

◆ docName()

QString QPrinter::docName ( ) const

Returns the document name.

See also: setDocName(), QPrintEngine::PrintEnginePropertyKey

Definition at line 772 of file qprinter.cpp.

References QPagedPaintDevice::d, and QPrintEngine::PPK_DocumentName.

Referenced by QPrintPreviewDialogPrivate::init().

Here is the caller graph for this function:

◆ duplex()

QPrinter::DuplexMode QPrinter::duplex ( ) const

Since: 4.4

Returns the current duplex mode.

See also: setDuplex()

Definition at line 1147 of file qprinter.cpp.

References QPagedPaintDevice::d, and QPrintEngine::PPK_Duplex.

Referenced by setDuplex().

Here is the caller graph for this function:

◆ fontEmbeddingEnabled()

bool QPrinter::fontEmbeddingEnabled ( ) const

Since: 4.1

Returns true if font embedding is enabled.

See also: setFontEmbeddingEnabled()

Definition at line 1103 of file qprinter.cpp.

References QPagedPaintDevice::d, and QPrintEngine::PPK_FontEmbedding.

◆ fromPage()

int QPrinter::fromPage ( ) const

Since: 4.1

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.

Note: If fromPage() and toPage() both return 0, this indicates that {the whole document will be printed}.

See also: setFromTo(), toPage(), pageRanges()

Definition at line 1369 of file qprinter.cpp.

References QPagedPaintDevice::d, QPageRanges::firstPage(), and QPagedPaintDevicePrivate::pageRanges.

Referenced by QAbstractPrintDialog::QAbstractPrintDialog(), and QAbstractPrintDialogPrivate::setPrinter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fullPage()

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

Definition at line 1016 of file qprinter.cpp.

References QPagedPaintDevice::d, and QPrintEngine::PPK_FullPage.

◆ isValid()

bool QPrinter::isValid ( ) const

Since: 4.4

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

Definition at line 674 of file qprinter.cpp.

References QPagedPaintDevice::d, and qApp.

Referenced by QPrintPreviewDialogPrivate::init().

Here is the caller graph for this function:

◆ metric()

int QPrinter::metric ( PaintDeviceMetric id ) const

overrideprotectedvirtual

Returns the metric for the given id.

Reimplemented from QPaintDevice.

Definition at line 1192 of file qprinter.cpp.

References QPagedPaintDevice::d.

◆ newPage()

bool QPrinter::newPage ( )

overridevirtual

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.

Implements QPagedPaintDevice.

Definition at line 1246 of file qprinter.cpp.

References Active, and QPagedPaintDevice::d.

Referenced by main().

Here is the caller graph for this function:

◆ outputFileName()

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: QPrintEngine::PrintEnginePropertyKey

Definition at line 692 of file qprinter.cpp.

References QPagedPaintDevice::d, and QPrintEngine::PPK_OutputFileName.

Referenced by QPrintPreviewDialogPrivate::_q_print().

Here is the caller graph for this function:

◆ outputFormat()

QPrinter::OutputFormat QPrinter::outputFormat ( ) const

Since: 4.1

Returns the output format for this printer.

Definition at line 570 of file qprinter.cpp.

References QPagedPaintDevice::d.

Referenced by QPrintPreviewDialogPrivate::_q_print(), QUnixPageSetupDialogPrivate::init(), QPrintPreviewDialogPrivate::init(), QPrintDialogPrivate::openCocoaPrintPanel(), QPageSetupDialogPrivate::setPrinter(), setPrinterName(), and warnIfNotNative().

Here is the caller graph for this function:

◆ pageOrder()

QPrinter::PageOrder QPrinter::pageOrder ( ) const

Returns the current page order.

The default page order is FirstPageFirst.

Definition at line 855 of file qprinter.cpp.

References QPagedPaintDevice::d, and QPrintEngine::PPK_PageOrder.

Referenced by setPageOrder().

Here is the caller graph for this function:

◆ pageRect()

QRectF QPrinter::pageRect ( Unit unit ) const

Since: 4.4

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

Definition at line 1162 of file qprinter.cpp.

References DevicePixel, QPagedPaintDevice::pageLayout(), QPageLayout::paintRect(), QPageLayout::paintRectPixels(), and resolution().

Here is the call graph for this function:

◆ paintEngine()

QPaintEngine * QPrinter::paintEngine ( ) const

overridevirtual

Returns the paint engine used by the printer.

Implements QPaintDevice.

Definition at line 1201 of file qprinter.cpp.

References QPagedPaintDevice::d.

Referenced by setEngines().

Here is the caller graph for this function:

◆ paperRect()

QRectF QPrinter::paperRect ( Unit unit ) const

Since: 4.4

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

See also: pageRect()

Definition at line 1179 of file qprinter.cpp.

References DevicePixel, QPageLayout::fullRect(), QPageLayout::fullRectPixels(), QPagedPaintDevice::pageLayout(), and resolution().

Here is the call graph for this function:

◆ paperSource()

QPrinter::PaperSource QPrinter::paperSource ( ) const

Returns the printer's paper source.

This is Manual or a printer tray or paper cassette.

Definition at line 1076 of file qprinter.cpp.

References QPagedPaintDevice::d, and QPrintEngine::PPK_PaperSource.

◆ pdfVersion()

QPrinter::PdfVersion QPrinter::pdfVersion ( ) const

Since: 5.10

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

Definition at line 602 of file qprinter.cpp.

References QPagedPaintDevice::d.

◆ printEngine()

QPrintEngine * QPrinter::printEngine ( ) const

Since: 4.1

Returns the print engine used by the printer.

Definition at line 1212 of file qprinter.cpp.

References QPagedPaintDevice::d.

Referenced by QMacPageSetupDialogPrivate::openCocoaPageLayout(), QPrintDialogPrivate::openCocoaPrintPanel(), and setEngines().

Here is the caller graph for this function:

◆ printerName()

QString QPrinter::printerName ( ) const

Returns the printer name.

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

See also: setPrinterName()

Definition at line 621 of file qprinter.cpp.

References QPagedPaintDevice::d, and QPrintEngine::PPK_PrinterName.

Referenced by QPrinterInfo::QPrinterInfo(), QUnixPageSetupDialogPrivate::init(), QPrintDialogPrivate::openWindowsPrintDialogModally(), and setPrinterName().

Here is the caller graph for this function:

◆ printerSelectionOption()

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(), setPrintProgram()

Definition at line 1324 of file qprinter.cpp.

References QPagedPaintDevice::d, and QPrintEngine::PPK_SelectionOption.

◆ printerState()

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

Definition at line 1274 of file qprinter.cpp.

References QPagedPaintDevice::d.

◆ printProgram()

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(), setPrinterSelectionOption()

Definition at line 743 of file qprinter.cpp.

References QPagedPaintDevice::d, and QPrintEngine::PPK_PrinterProgram.

◆ printRange()

QPrinter::PrintRange QPrinter::printRange ( ) const

Since: 4.1

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

Definition at line 1444 of file qprinter.cpp.

References QPagedPaintDevice::d.

◆ resolution()

int QPrinter::resolution ( ) const

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

See also: setResolution()

Definition at line 1051 of file qprinter.cpp.

References QPagedPaintDevice::d, and QPrintEngine::PPK_Resolution.

Referenced by pageRect(), paperRect(), and QPrintPreviewWidgetPrivate::populateScene().

Here is the caller graph for this function:

◆ setCollateCopies()

void QPrinter::setCollateCopies ( bool collate )

Since: 4.1

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

Definition at line 968 of file qprinter.cpp.

References ABORT_IF_ACTIVE, QPagedPaintDevice::d, and QPrintEngine::PPK_CollateCopies.

◆ setColorMode()

void QPrinter::setColorMode ( ColorMode newColorMode )

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

See also: colorMode()

Definition at line 869 of file qprinter.cpp.

References ABORT_IF_ACTIVE, QPagedPaintDevice::d, and QPrintEngine::PPK_ColorMode.

◆ setCopyCount()

void QPrinter::setCopyCount ( int count )

Since: 4.7

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(), supportsMultipleCopies()

Definition at line 899 of file qprinter.cpp.

References ABORT_IF_ACTIVE, QPagedPaintDevice::d, and QPrintEngine::PPK_CopyCount.

◆ setCreator()

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

Definition at line 819 of file qprinter.cpp.

References ABORT_IF_ACTIVE, creator(), QPagedPaintDevice::d, and QPrintEngine::PPK_Creator.

Here is the call graph for this function:

◆ setDocName()

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(), QPrintEngine::PrintEnginePropertyKey

Definition at line 789 of file qprinter.cpp.

References ABORT_IF_ACTIVE, QPagedPaintDevice::d, and QPrintEngine::PPK_DocumentName.

◆ setDuplex()

void QPrinter::setDuplex ( DuplexMode duplex )

Since: 4.4

Enables double sided printing based on the duplex mode.

See also: duplex()

Definition at line 1134 of file qprinter.cpp.

References QPagedPaintDevice::d, duplex(), and QPrintEngine::PPK_Duplex.

Referenced by QPrintDialogPrivate::setupPrinter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setEngines()

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

protected

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

Since: 4.1

Definition at line 492 of file qprinter.cpp.

References QPagedPaintDevice::d, paintEngine(), and printEngine().

Here is the call graph for this function:

◆ setFontEmbeddingEnabled()

void QPrinter::setFontEmbeddingEnabled ( bool enable )

Since: 4.1

Enabled or disables font embedding depending on enable.

See also: fontEmbeddingEnabled()

Definition at line 1090 of file qprinter.cpp.

References QPagedPaintDevice::d, and QPrintEngine::PPK_FontEmbedding.

◆ setFromTo()

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

Since: 4.1

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.

Note: Pages in a document are numbered according to the convention that the first page is page 1. However, if from and to are both set to 0, the {whole document will be printed}.

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(), pageRanges()

Definition at line 1415 of file qprinter.cpp.

References QPageRanges::addRange(), QPageRanges::clear(), QPagedPaintDevice::d, and QPagedPaintDevicePrivate::pageRanges.

Here is the call graph for this function:

◆ setFullPage()

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 \l{QPaintDevice::PaintDeviceMetric}{device metrics} will report the exact same dimensions as indicated byQPageSize}. 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(), QPagedPaintDevice::setPageSize()

Definition at line 998 of file qprinter.cpp.

References QPagedPaintDevice::d, fp, and QPrintEngine::PPK_FullPage.

◆ setOutputFileName()

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

Definition at line 717 of file qprinter.cpp.

References ABORT_IF_ACTIVE, Qt::CaseInsensitive, QPagedPaintDevice::d, fileName, NativeFormat, PdfFormat, QPrintEngine::PPK_OutputFileName, and setOutputFormat().

Referenced by QPrintPreviewDialogPrivate::_q_print(), and main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOutputFormat()

void QPrinter::setOutputFormat ( OutputFormat format )

Since: 4.1

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: setPrinterName()

Definition at line 549 of file qprinter.cpp.

References QPagedPaintDevice::d, and NativeFormat.

Referenced by main(), MainWindow::printPdf(), setOutputFileName(), and setPrinterName().

Here is the caller graph for this function:

◆ setPageOrder()

void QPrinter::setPageOrder ( 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.

Definition at line 839 of file qprinter.cpp.

References ABORT_IF_ACTIVE, QPagedPaintDevice::d, FirstPageFirst, pageOrder(), QPagedPaintDevicePrivate::pageOrderAscending, and QPrintEngine::PPK_PageOrder.

Here is the call graph for this function:

◆ setPaperSource()

void QPrinter::setPaperSource ( 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()

Definition at line 1066 of file qprinter.cpp.

References QPagedPaintDevice::d, and QPrintEngine::PPK_PaperSource.

Referenced by QPageSetupWidget::setupPrinter().

Here is the caller graph for this function:

◆ setPdfVersion()

void QPrinter::setPdfVersion ( PdfVersion version )

Since: 5.10

Sets the PDF version for this printer to version.

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

Definition at line 583 of file qprinter.cpp.

References QPagedPaintDevice::d, and PdfFormat.

◆ setPrinterName()

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

Definition at line 638 of file qprinter.cpp.

References ABORT_IF_ACTIVE, QPagedPaintDevice::d, NativeFormat, outputFormat(), PdfFormat, QPrintEngine::PPK_PrinterName, QPrinterInfo::printerInfo(), printerName(), and setOutputFormat().

Here is the call graph for this function:

◆ setPrinterSelectionOption()

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(), setPrintProgram()

Definition at line 1346 of file qprinter.cpp.

References QPagedPaintDevice::d, and QPrintEngine::PPK_SelectionOption.

◆ setPrintProgram()

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

Definition at line 759 of file qprinter.cpp.

References ABORT_IF_ACTIVE, QPagedPaintDevice::d, and QPrintEngine::PPK_PrinterProgram.

◆ setPrintRange()

void QPrinter::setPrintRange ( PrintRange range )

Since: 4.1

Sets the print range option in to be range.

Definition at line 1427 of file qprinter.cpp.

References QPagedPaintDevice::d, QPagedPaintDevicePrivate::printSelectionOnly, and Selection.

◆ setResolution()

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

Definition at line 1036 of file qprinter.cpp.

References ABORT_IF_ACTIVE, QPagedPaintDevice::d, and QPrintEngine::PPK_Resolution.

◆ supportedResolutions()

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

Definition at line 1226 of file qprinter.cpp.

References QPagedPaintDevice::d, QPrintEngine::PPK_SupportedResolutions, QVariant::toInt(), and var.

Here is the call graph for this function:

◆ supportsMultipleCopies()

bool QPrinter::supportsMultipleCopies ( ) const

Since: 4.7

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(), copyCount()

Definition at line 934 of file qprinter.cpp.

References QPagedPaintDevice::d, and QPrintEngine::PPK_SupportsMultipleCopies.

◆ toPage()

int QPrinter::toPage ( ) const

Since: 4.1

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.

Note: If fromPage() and toPage() both return 0, this indicates that {the whole document will be printed}.

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

See also: setFromTo(), fromPage(), pageRanges()

Definition at line 1393 of file qprinter.cpp.

References QPagedPaintDevice::d, QPageRanges::lastPage(), and QPagedPaintDevicePrivate::pageRanges.

Referenced by QAbstractPrintDialog::QAbstractPrintDialog(), and QAbstractPrintDialogPrivate::setPrinter().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ QAbstractPrintDialog

friend class QAbstractPrintDialog

friend

Definition at line 179 of file qprinter.h.

◆ QAbstractPrintDialogPrivate

friend class QAbstractPrintDialogPrivate

friend

Definition at line 180 of file qprinter.h.

◆ QPageSetupWidget

friend class QPageSetupWidget

friend

Definition at line 183 of file qprinter.h.

◆ QPrintDialogPrivate

friend class QPrintDialogPrivate

friend

Definition at line 178 of file qprinter.h.

◆ QPrintPreviewWidgetPrivate

friend class QPrintPreviewWidgetPrivate

friend

Definition at line 181 of file qprinter.h.

◆ QTextDocument

friend class QTextDocument

friend

Definition at line 182 of file qprinter.h.

The documentation for this class was generated from the following files:

qtbase/src/printsupport/kernel/qprinter.h (e2fef733be92e95ff28225196e14ffeb98d61a1f)
qtbase/src/printsupport/kernel/qprinter.cpp (367e6ff0b20be47fdc9ddd72866053ec60cbe254)

Public Types

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ColorMode

◆ DuplexMode

◆ OutputFormat

◆ PageOrder

◆ PaperSource

◆ PrinterMode

◆ PrinterState

◆ PrintRange

◆ Unit

Constructor & Destructor Documentation

◆ QPrinter() [1/2]

◆ QPrinter() [2/2]

◆ ~QPrinter()

Member Function Documentation

◆ abort()

◆ collateCopies()

◆ colorMode()

◆ copyCount()

◆ creator()

◆ devType()

◆ docName()

◆ duplex()

◆ fontEmbeddingEnabled()

◆ fromPage()

◆ fullPage()

◆ isValid()

◆ metric()

◆ newPage()

◆ outputFileName()

◆ outputFormat()

◆ pageOrder()

◆ pageRect()

◆ paintEngine()

◆ paperRect()

◆ paperSource()

◆ pdfVersion()

◆ printEngine()

◆ printerName()

◆ printerSelectionOption()

◆ printerState()

◆ printProgram()

◆ printRange()

◆ resolution()

◆ setCollateCopies()

◆ setColorMode()

◆ setCopyCount()

◆ setCreator()

◆ setDocName()

◆ setDuplex()

◆ setEngines()

◆ setFontEmbeddingEnabled()

◆ setFromTo()

◆ setFullPage()

◆ setOutputFileName()

◆ setOutputFormat()

◆ setPageOrder()

◆ setPaperSource()

◆ setPdfVersion()

◆ setPrinterName()

◆ setPrinterSelectionOption()

◆ setPrintProgram()

◆ setPrintRange()

◆ setResolution()

◆ supportedResolutions()

◆ supportsMultipleCopies()

◆ toPage()

Friends And Related Symbol Documentation

◆ QAbstractPrintDialog

◆ QAbstractPrintDialogPrivate

◆ QPageSetupWidget

◆ QPrintDialogPrivate

◆ QPrintPreviewWidgetPrivate

◆ QTextDocument