The QPrinter class is a paint device which outputs to a printer. More...

Inheritance diagram for QPrinter:

Public Typedefs
using	Orientation = QPageLayout::Orientation

using	Unit = QPageSize::Unit

Public Types
enum	ColorMode

enum	DuplexMode

enum	OutputFormat

enum	PageOrder

enum	PaperSource

enum	PrinterMode

enum	PrinterState

enum	PrintRange

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric

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

	QPrinter (PrinterMode mode=ScreenResolution)

	~QPrinter ()

bool	abort ()

int	actualNumCopies () const

bool	collateCopies () const

ColorMode	colorMode () const

int	copyCount () const

QString	creator () const

QString	docName () const

bool	doubleSidedPrinting () const

DuplexMode	duplex () const

bool	fontEmbeddingEnabled () const

int	fromPage () const

bool	fullPage () const

bool	isValid () const

QMarginsF	margins (QPageSize::Unit unit) const

bool	newPage () override

int	numCopies () const

Orientation	orientation () const

QString	outputFileName () const

OutputFormat	outputFormat () const

QPageLayout	pageLayout () const override

PageOrder	pageOrder () const

QRect	pageRect () const

QRectF	pageRect (Unit unit) const

QPaintEngine *	paintEngine () const override

QString	paperName () const

QRect	paperRect () const

QRectF	paperRect (Unit unit) const

QPageSize::PageSizeId	paperSize () const

QSizeF	paperSize (Unit unit) const

PaperSource	paperSource () const

QPrintEngine *	printEngine () const

QString	printerName () const

QString	printerSelectionOption () const

PrinterState	printerState () const

QString	printProgram () const

PrintRange	printRange () const

int	resolution () const

void	setCollateCopies (bool collate)

void	setColorMode (ColorMode colorMode)

void	setCopyCount (int count)

void	setCreator (const QString &creator)

void	setDocName (const QString &name)

void	setDoubleSidedPrinting (bool enable)

void	setDuplex (DuplexMode enable)

void	setFontEmbeddingEnabled (bool enable)

void	setFromTo (int fromPage, int toPage)

void	setFullPage (bool fullPage)

void	setMargins (const QMarginsF &margins) override

void	setNumCopies (int numCopies)

void	setOrientation (Orientation orientation)

void	setOutputFileName (const QString &fileName)

void	setOutputFormat (OutputFormat format)

bool	setPageLayout (const QPageLayout &newPageLayout) override

bool	setPageMargins (const QMarginsF &margins) override

bool	setPageMargins (const QMarginsF &margins, QPageSize::Unit units) override

void	setPageOrder (PageOrder pageOrder)

bool	setPageOrientation (QPageLayout::Orientation orientation) override

bool	setPageSize (const QPageSize &pageSize) override

void	setPageSize (QPageSize::PageSizeId sizeId) override

void	setPageSizeMM (const QSizeF &size) override

void	setPaperName (const QString &paperName)

void	setPaperSize (const QSizeF &paperSize, Unit unit)

void	setPaperSize (QPageSize::PageSizeId paperSize)

void	setPaperSource (PaperSource source)

void	setPrinterName (const QString &name)

void	setPrinterSelectionOption (const QString &option)

void	setPrintProgram (const QString &command)

void	setPrintRange (PrintRange range)

void	setResolution (int dpi)

void	setWinPageSize (int pageSize)

QList< PaperSource >	supportedPaperSources () const

QList< int >	supportedResolutions () const

bool	supportsMultipleCopies () const

int	toPage () const

int	winPageSize () const

Public Methods inherited from QPagedPaintDevice
	QPagedPaintDevice ()

	~QPagedPaintDevice ()

QMarginsF	margins () const

QPageSize::PageSizeId	pageSize () const

QSizeF	pageSizeMM () const

Public Methods inherited from QPaintDevice
virtual	~QPaintDevice ()

int	colorCount () const

int	depth () const

int	devicePixelRatio () const

qreal	devicePixelRatioF () const

int	height () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

bool	paintingActive () const

int	physicalDpiX () const

int	physicalDpiY () const

int	width () const

int	widthMM () const

Protected Methods
int	metric (PaintDeviceMetric) const override

void	setEngines (QPrintEngine printEngine, QPaintEngine paintEngine)

Protected Methods inherited from QPaintDevice
	QPaintDevice ()

Friends
class	QAbstractPrintDialog

class	QTextDocument

Detailed Description

The QPrinter class is a paint device which outputs to a printer.

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 Mac OS X, QPrinter uses the built in printer drivers. On X11, QPrinter uses the "Common Unix Printing System (CUPS)" or the standard Unix "lpr" utility to send PostScript or 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 print dialog. In general, QPrinter passes these functions onto the underlying QPrintEngine.

The most important parameters for QPrinter are the following:

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 is 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, Printer Support

Member Typedef Documentation

QPrinter::Orientation

Typedef for QPageLayout::Orientation.

QPrinter::Unit

Typedef for QPageSize::Unit.

Member Enumeration Documentation

enum QPrinter::ColorMode

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

Constant	Value	Description
`QPrinter::Color`	`1`	Print in color if available, otherwise in grayscale
`QPrinter::GrayScale`	`0`	Print in grayscale, even on color printers

enum QPrinter::DuplexMode

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

Constant	Value	Description
`QPrinter::DuplexNone`	`0`	Single sided (simplex) printing only.
`QPrinter::DuplexAuto`	`1`	Printer's default setting is used to determine whether duplex printing is used.
`QPrinter::DuplexLongSide`	`2`	Both sides are used, paper is turned over its longest edge before the second side is printed
`QPrinter::DuplexShortSide`	`3`	Both sides are used, paper is turned over its shortest edge before the second side is printed

enum QPrinter::OutputFormat

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

Constant	Value	Description
`QPrinter::NativeFormat`	`0`	Prints using a platform specific method, this mode is the default when printing directly to a printer.
`QPrinter::PdfFormat`	`1`	Generate a PDF file with a search index, this is the default when printing to a file
`QPrinter::PostScriptFormat`	`2`	Generate output in PostScript format

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

enum QPrinter::PageOrder

This enum type is used by QPrinter to instruct the application which order pages should be printed.

Constant	Value	Description
`QPrinter::FirstPageFirst`	`0`	Lowest-numbered page should be printed first
`QPrinter::LastPageFirst`	`1`	Highest-numbered page should be printed first

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.

Constant	Value	Description
`QPrinter::Auto`	`6`
`QPrinter::Cassette`	`11`
`QPrinter::Envelope`	`4`
`QPrinter::EnvelopeManual`	`5`
`QPrinter::FormSource`	`12`
`QPrinter::LargeCapacity`	`10`
`QPrinter::LargeFormat`	`9`
`QPrinter::Lower`	`1`
`QPrinter::MaxPageSource`	`13`
`QPrinter::Middle`	`2`
`QPrinter::Manual`	`3`
`QPrinter::OnlyOne`	`0`
`QPrinter::Tractor`	`7`
`QPrinter::SmallFormat`	`8`

Warning: This is currently only implemented for Windows.

enum QPrinter::PrinterMode

This enum describes the mode the printer should work in. It basically presets a certain resolution and working mode.

Constant	Value	Description
`QPrinter::ScreenResolution`	`0`	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.
`QPrinter::PrinterResolution`	`1`	Deprecated, 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.
`QPrinter::HighResolution`	`2`	On Windows, sets the printer resolution to that defined for the printer in use. For PostScript printing, sets the resolution of the PostScript 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.

enum QPrinter::PrinterState

This enum describes the status of the printer.

Constant	Value	Description
`QPrinter::Idle`	`0`
`QPrinter::Active`	`1`
`QPrinter::Aborted`	`2`
`QPrinter::Error`	`3`

enum QPrinter::PrintRange

Used to specify the print range selection option.

Constant	Value	Description
`QPrinter::AllPages`	`0`	All pages should be printed
`QPrinter::Selection`	`1`	Only the selection should be printed
`QPrinter::PageRange`	`2`	Specified page range should be printed
`QPrinter::CurrentPage`	`3`	Only the current page should be printed

See also: QAbstractPrintDialog::PrintRange

Constructor & Destructor Documentation

QPrinter::QPrinter ( PrinterMode mode = ScreenResolution )

explicit

Creates a new printer object with the given mode.

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

explicit

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

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.

Method Documentation

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 can not or will not cancel the job when asked to.

int QPrinter::actualNumCopies ( ) const

deprecated

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

This function always returns the actual value specified in the print dialog or using setNumCopies().

Use copyCount() instead.

See also: setNumCopies(), numCopies()

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

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

bool QPrinter::doubleSidedPrinting ( ) const

Returns true if double side printing is enabled.

Currently this option is only supported on X11.

See also: setDoubleSidedPrinting()

DuplexMode QPrinter::duplex ( ) const

Returns the current duplex mode.

Currently this option is only supported on X11.

See also: setDuplex()

bool QPrinter::fontEmbeddingEnabled ( ) const

Returns true if font embedding is enabled.

Currently this option is only supported on X11.

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 method returns 0 which means the "from page" setting is not set. If fromPage() and toPage() both return 0, this indicates the entire document will be printed.

See also: setFromTo(), toPage()

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 also: setFullPage(), QPageSize::PageSizeId

bool QPrinter::isValid ( ) const

Returns true if the printer currently selected is a valid printer in the system, or a pure PDF/PostScript 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("/copperspice/output.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 1");
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()

QMarginsF QPrinter::margins ( QPageSize::Unit unit ) const

Returns the page margins for this printer. The unit of the returned margins are specified with the unit parameter.

int QPrinter::metric ( PaintDeviceMetric metric ) const

overrideprotectedvirtual

Returns the metric information for the given paint device metric.

See also: PaintDeviceMetric

Reimplemented from QPaintDevice::metric()

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

int QPrinter::numCopies ( ) const

deprecated

Deprecated:: Returns the number of copies to be printed. The default value is 1.

On Windows, Mac OS X and X11 systems that support CUPS, this will always return 1 as these operating systems can internally handle the number of copies.

On X11, this value will return the number of times the application is required to print in order to match the number specified in the printer setup dialog. This has been done since some printer drivers are not capable of buffering up the copies and in those cases the application must make an explicit call to the print code for each copy.

Use copyCount() in conjunction with supportsMultipleCopies() instead.

See also: setNumCopies(), actualNumCopies()

Orientation QPrinter::orientation ( ) const

Returns the orientation setting. This is driver dependent, however the value is usually QPageLayout::Portrait.

See also: setOrientation()

QString QPrinter::outputFileName ( ) const

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

See also: setOutputFileName(), QPrintEngine::PrintEnginePropertyKey

OutputFormat QPrinter::outputFormat ( ) const

Returns the output format for this printer.

See also: setOutputFormat()

QPageLayout QPrinter::pageLayout ( ) const

overridevirtual

Returns the current page layout.

Use this method to access the current QPageSize, QMarginsF, QPageLayout::Orientation, QPageLayout::fullRect(), and QPageLayout::paintRect().

Since the return value is a copy of the current page layout, modifying properties will not affect the paint device. To change the print settings use methods like QPdfWriter::setPageMargins() or QPdfWriter::setPageLayout().

See also: setPageLayout(), setPageSize(), setPageOrientation(), setPageMargins()

Reimplemented from QPagedPaintDevice::pageLayout()

PageOrder QPrinter::pageOrder ( ) const

Returns the current page order. The default page order is FirstPageFirst.

See also: setPageOrder()

QRect QPrinter::pageRect ( ) const

Returns the page's rectangle; this is usually smaller than the paperRect() since the page normally has margins between its borders and the paper.

The unit of the returned rectangle is DevicePixel.

See also: paperSize()

QRectF QPrinter::pageRect ( 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: paperSize()

QPaintEngine * QPrinter::paintEngine ( ) const

overridevirtual

Returns the paint engine used by the printer.

Implements QPaintDevice::paintEngine()

QString QPrinter::paperName ( ) const

This method is obsolete and only provided to support older source code. Use pageLayout().pageSize().name() instead.

Returns the paper name of the paper set on the printer. The default value is driver dependent.

See also: setPaperName(), pageLayout()

QRect QPrinter::paperRect ( ) const

Returns the paper's rectangle, this is usually larger than the pageRect().

The unit of the returned rectangle is DevicePixel.

See also: pageRect()

QRectF QPrinter::paperRect ( Unit unit ) const

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

See also: pageRect()

QPageSize::PageSizeId QPrinter::paperSize ( ) const

This method is obsolete and only provided to support older source code. Use pageLayout().pageSize().id() instead.

Returns the printer paper size. The default value is driver dependent.

See also: setPaperSize(), pageRect(), paperRect()

QSizeF QPrinter::paperSize ( Unit unit ) const

Returns the paper size in unit.

See also: setPaperSize()

PaperSource QPrinter::paperSource ( ) const

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

See also: setPaperSource()

QPrintEngine * QPrinter::printEngine ( ) const

Returns the print engine used by the printer.

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 the given value should be used.

Warning: This method is not available on Windows.

See also: setPrinterSelectionOption()

PrinterState QPrinter::printerState ( ) const

Returns the current state of the printer. This may not always be accurate (for example if the printer does not have the capability of reporting its state to the operating system).

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.

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

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

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

Sets the printer's color mode to colorMode, 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(), supportsMultipleCopies()

void QPrinter::setCreator ( const QString & creator )

Sets the name of the application that created the document to creator.

This method is only applicable in X11. If no creator name is specified, the creator will be set to "CopperSpice" followed by some version number.

See also: creator()

void QPrinter::setDocName ( const QString & name )

Sets the document name to name.

As an example, on X11 the document name is used as the default output filename in QPrintDialog. The document name does not affect the file name if the printer is printing to a file. Use setOutputFile() when printing to a file.

See also: docName(), QPrintEngine::PrintEnginePropertyKey

void QPrinter::setDoubleSidedPrinting ( bool enable )

Enables double sided printing if enable is true, otherwise it is disabled. Currently this option is only supported on X11.

See also: doubleSidedPrinting()

void QPrinter::setDuplex ( DuplexMode enable )

Enables double sided printing based on the enable mode. Currently this option is only supported on X11.

See also: duplex()

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

protected

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

void QPrinter::setFontEmbeddingEnabled ( bool enable )

Enabled or disables font embedding depending on enable. Currently this option is only supported on X11.

See also: fontEmbeddingEnabled()

void QPrinter::setFromTo	(	int	fromPage,
		int	toPage
	)

Sets the range of pages to be printed to cover the pages with numbers specified by fromPage and toPage, where fromPage corresponds to the first page in the range and toPage corresponds to the last.

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

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

See also: fromPage(), toPage()

void QPrinter::setFullPage ( bool fullPage )

If fullPage 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 the enum QPageSize::PageSizeId. 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(), setPaperSize(), width(), height(), Printer Support

void QPrinter::setMargins ( const QMarginsF & margins )

overridevirtual

Sets the page margins using margins. Margins are specified in millimeters. The margins are a hint to drawing methods and do not affect the coordinate system or clipping.

See also: margins()

Reimplemented from QPagedPaintDevice::setMargins()

void QPrinter::setNumCopies ( int numCopies )

deprecated

Deprecated:: Sets the number of copies to be printed to numCopies.

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

Use setCopyCount() instead.

See also: numCopies()

void QPrinter::setOrientation ( Orientation orientation )

Sets the print orientation to orientation. The orientation can be either QPageLayout::Portrait or QPageLayout::Landscape. The printer driver reads this setting and prints using the specified orientation.

On Windows, this option can be changed while printing and will take effect from the next call to newPage(). On Mac OS X, changing the orientation during a print job has no effect.

See also: orientation()

void QPrinter::setOutputFileName ( const QString & fileName )

Sets the name of the output file to fileName. Setting an empty name 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 suffix ".ps" then PostScript is automatically selected as output format. If the file name has the ".pdf" suffix PDF is generated. If the file name has a suffix other than ".ps" and ".pdf", the output format used is the one set with setOutputFormat().

QPrinter uses the CopperSpice cross-platform PostScript or PDF print engines respectively. If you can produce this format natively, for example Mac OS X can generate PDF's from its print engine, set the output format back to NativeFormat.

See also: outputFileName(), setOutputFormat()

void QPrinter::setOutputFormat ( OutputFormat format )

Sets the output format for this printer to format.

See also: outputFormat()

bool QPrinter::setPageLayout ( const QPageLayout & newPageLayout )

overridevirtual

Sets the page layout to newPageLayout. Returns true if the page layout was successfully set to newPageLayout.

You should call this method before calling QPainter::begin(), or immediately before calling newPage() to apply the new page layout to a new page. You should not call any painting methods between a call to setPageLayout() and newPage() as the wrong paint metrics may be used.

See also: pageLayout()

Reimplemented from QPagedPaintDevice::setPageLayout()

bool QPrinter::setPageMargins ( const QMarginsF & margins )

overridevirtual

Sets the page margins in the current page layout units. Returns true if the page margins was successfully set to margins.

You should call this method before calling QPainter::begin() or immediately before calling newPage() to apply the new margins to a new page. You should not call any painting methods between a call to setPageMargins() and newPage() as the wrong paint metrics may be used.

To get the current page margins use QPageLayout::pageMargins().

See also: pageLayout()

Reimplemented from QPagedPaintDevice::setPageMargins()

bool QPrinter::setPageMargins	(	const QMarginsF &	margins,
		QPageSize::Unit	units
	)

overridevirtual

Sets the page margins defined in the given units. Returns true if the page margins were successfully set to margins.

You should call this method before calling QPainter::begin() or immediately before calling newPage() to apply the new margins to a new page. You should not call any painting methods between a call to setPageMargins() and newPage() as the wrong paint metrics may be used.

To get the current page margins use QPageLayout::margins().

See also: pageLayout()

Reimplemented from QPagedPaintDevice::setPageMargins()

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. Mostly useful for setting a default value that the user can override in the print dialog.

This method is only supported under X11.

See also: pageOrder()

bool QPrinter::setPageOrientation ( QPageLayout::Orientation orientation )

overridevirtual

Sets the page orientation to QPageLayout::Portrait or QPageLayout::Landscape. Returns true if the page orientation was successfully set to orientation. The page orientation is used to define the orientation of the page size when obtaining the page rect.

To obtain the current QPageLayout::Orientation use pageLayout().pageOrientation().

On Windows and Mac this property can be changed while printing and will take effect from the next call to newPage().

See also: pageLayout(), setPageLayout()

Reimplemented from QPagedPaintDevice::setPageOrientation()

bool QPrinter::setPageSize ( const QPageSize & pageSize )

overridevirtual

Sets the page size to pageSize. To get the current QPageSize use QPageLayout::pageSize(). Returns true if the page size was successfully set to pageSize.

See also: pageSize(), pageLayout(), setPageLayout()

Reimplemented from QPagedPaintDevice::setPageSize()

void QPrinter::setPageSize ( QPageSize::PageSizeId sizeId )

overridevirtual

Sets the page size using the page size enum value of sizeId.

Reimplemented from QPagedPaintDevice::setPageSize()

void QPrinter::setPageSizeMM ( const QSizeF & size )

overridevirtual

Sets the page size to size. size is specified in millimeters. If the size matches a standard QPageSize::PageSizeId then the page size will be used, otherwise the enum value of QPageSize::Custom will be set.

See also: pageSizeMM()

Reimplemented from QPagedPaintDevice::setPageSizeMM()

void QPrinter::setPaperName ( const QString & paperName )

This method is obsolete and only provided to support older source code. Use setPageSize() instead and pass the appropriate QPageSize::PageSizeId.

Sets the paper used by the printer to paperName.

See also: paperName(), setPageSize()

void QPrinter::setPaperSize	(	const QSizeF &	paperSize,
		Unit	unit
	)

Sets the paper size based on paperSize in unit.

See also: paperSize()

void QPrinter::setPaperSize ( QPageSize::PageSizeId paperSize )

Sets the printer paper size to paperSize if that size is supported. The result is undefined if newPaperSize is not supported. The default paper size is driver dependent.

This method is useful mostly for setting a default value that the user can override in the print dialog.

See also: paperSize(), setFullPage(), setResolution(), pageRect(), paperRect(), QPageSize::PageSizeId

void QPrinter::setPaperSource ( PaperSource source )

Sets the paper source setting to source.

On Windows only, this option can be changed while printing and will take effect from the next call to newPage().

See also: paperSource()

void QPrinter::setPrinterName ( const QString & name )

Sets the printer name to name.

See also: printerName(), isValid()

void QPrinter::setPrinterSelectionOption ( const QString & option )

This method uses option to specify which printer should be used. This value is only meaningful on Unix systems.

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

See also: printerSelectionOption()

void QPrinter::setPrintProgram ( const QString & command )

Sets the name of the program that should do the print job to command.

On X11 only, this method sets the program to call with the PostScript output. On other platforms the method has no effect.

See also: printProgram()

void QPrinter::setPrintRange ( PrintRange range )

Sets the print range option in to be range.

See also: printRange()

void QPrinter::setResolution ( int dpi )

A request to the printer to use dpi or as near to this value as possible. This setting affects the coordinate system as returned by, for example QPainter::viewport().

This method must be called before QPainter::begin() to have an effect on all platforms.

See also: resolution(), setPaperSize()

void QPrinter::setWinPageSize ( int pageSize )

Sets the page size to be used by the printer under Windows to pageSize.

Warning: This method is not portable so you may prefer to use setPaperSize() instead.

See also: winPageSize()

QList< 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 specific value. The driver specific values are greater than the constant DMBIN_USER declared in wingdi.h.

Warning: This function is only available in windows.

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 postscript, this function will always return a one item list containing only the postscript 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(), 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.

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

int QPrinter::winPageSize ( ) const

Returns the page size used by the printer under Windows.

Warning: This function is not portable so you may prefer to use paperSize() instead.

See also: setWinPageSize()

Public Typedefs

Public Types

Public Methods

Protected Methods

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Method Documentation