QtGui.QPrinter Class Reference

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

Inheritance diagram for QtGui.QPrinter:

Collaboration diagram for QtGui.QPrinter:

Public Types
enum	ColorMode { Color = 1, GrayScale = 0 }
	More...
enum	DuplexMode { DuplexAuto = 1, DuplexLongSide = 2, DuplexNone = 0, DuplexShortSide = 3 }
	More...
enum	Orientation { Landscape = 1, Portrait = 0 }
	More...
enum	OutputFormat { NativeFormat = 0, PdfFormat = 1, PostScriptFormat = 2 }
	More...
enum	PageOrder { FirstPageFirst = 0, LastPageFirst = 1 }
	More...
enum	PaperSize {   A0 = 5, A1 = 6, A2 = 7, A3 = 8,   A4 = 0, A5 = 9, A6 = 10, A7 = 11,   A8 = 12, A9 = 13, B0 = 14, B1 = 15,   B10 = 16, B2 = 17, B3 = 18, B4 = 19,   B5 = 1, B6 = 20, B7 = 21, B8 = 22,   B9 = 23, C5E = 24, Comm10E = 25, Custom = 30,   DLE = 26, Executive = 4, Folio = 27, Ledger = 28,   Legal = 3, Letter = 2, NPageSize = 30, NPaperSize = 30,   Tabloid = 29 }
	More...
enum	PaperSource {   Auto = 6, Cassette = 11, Envelope = 4, EnvelopeManual = 5,   FormSource = 12, LargeCapacity = 10, LargeFormat = 9, Lower = 1,   Manual = 3, MaxPageSource = 13, Middle = 2, OnlyOne = 0,   SmallFormat = 8, Tractor = 7 }
	More...
enum	PrintRange { AllPages = 0, CurrentPage = 3, PageRange = 2, Selection = 1 }
	More...
enum	PrinterMode { HighResolution = 2, PrinterResolution = 1, ScreenResolution = 0 }
	More...
enum	PrinterState { Aborted = 2, Active = 1, Error = 3, Idle = 0 }
enum	Unit {   Cicero = 5, DevicePixel = 6, Didot = 4, Inch = 2,   Millimeter = 0, Pica = 3, Point = 1 }
	More...
Public Types inherited from QtGui.QPaintDevice
enum	PaintDeviceMetric {   PdmDepth = 6, PdmDpiX = 7, PdmDpiY = 8, PdmHeight = 2,   PdmHeightMM = 4, PdmNumColors = 5, PdmPhysicalDpiX = 9, PdmPhysicalDpiY = 10,   PdmWidth = 1, PdmWidthMM = 3 }
	More...

Public Member Functions
	QPrinter (QPrinterInfo printer, QPrinter.PrinterMode mode=QPrinter.PrinterMode.ScreenResolution)
	QPrinter (QPrinter.PrinterMode mode=QPrinter.PrinterMode.ScreenResolution)
override void	CreateProxy ()
new bool	Abort ()
new int	ActualNumCopies ()
override int	DevType ()
new int	FromPage ()
override System.IntPtr	GetDC ()
new void	GetPageMargins (ref double left, ref double top, ref double right, ref double bottom, QPrinter.Unit unit)
new bool	IsValid ()
new bool	NewPage ()
new QRect	PageRect ()
new QRectF	PageRect (QPrinter.Unit arg1)
override QPaintEngine	PaintEngine ()
new QRect	PaperRect ()
new QRectF	PaperRect (QPrinter.Unit arg1)
new QPrinter.PaperSize	paperSize ()
new QSizeF	paperSize (QPrinter.Unit unit)
new QPrintEngine	PrintEngine ()
new QPrinter.PrinterState	printerState ()
override void	ReleaseDC (System.IntPtr hdc)
new void	SetFromTo (int fromPage, int toPage)
new void	SetPageMargins (double left, double top, double right, double bottom, QPrinter.Unit unit)
new void	SetPaperSize (QSizeF paperSize, QPrinter.Unit unit)
new void	SetPaperSize (QPrinter.PaperSize arg1)
new System.Collections.Generic.List < QPrinter.PaperSource >	SupportedPaperSources ()
new System.Collections.Generic.List < System.Int32 >	SupportedResolutions ()
new bool	SupportsMultipleCopies ()
new int	ToPage ()
new void	Dispose ()
Public Member Functions inherited from QtGui.QPaintDevice
new int	ColorCount ()
new int	Depth ()
new int	Height ()
new int	HeightMM ()
new int	LogicalDpiX ()
new int	LogicalDpiY ()
new int	NumColors ()
new bool	PaintingActive ()
new int	PhysicalDpiX ()
new int	PhysicalDpiY ()
new int	Width ()
new int	WidthMM ()
new void	Dispose ()
Public Member Functions inherited from QtGui.IQPaintDevice
new int	ColorCount ()
new int	Depth ()
int	DevType ()
System.IntPtr	GetDC ()
new int	Height ()
new int	HeightMM ()
new int	LogicalDpiX ()
new int	LogicalDpiY ()
new int	NumColors ()
QPaintEngine	PaintEngine ()
new bool	PaintingActive ()
new int	PhysicalDpiX ()
new int	PhysicalDpiY ()
void	ReleaseDC (System.IntPtr hdc)
new int	Width ()
new int	WidthMM ()

Protected Member Functions
	QPrinter (System.Type dummy)
override int	Metric (QPaintDevice.PaintDeviceMetric arg1)
new void	SetEngines (QPrintEngine printEngine, QPaintEngine paintEngine)
Protected Member Functions inherited from QtGui.QPaintDevice
	QPaintDevice (System.Type dummy)
	QPaintDevice ()

Properties
new bool	CollateCopies [get, set]
new QPrinter.ColorMode	colorMode [get, set]
new int	CopyCount [get, set]
new string	Creator [get, set]
new string	DocName [get, set]
new bool	DoubleSidedPrinting [get, set]
new QPrinter.DuplexMode	Duplex [get, set]
new bool	FontEmbeddingEnabled [get, set]
new bool	FullPage [get, set]
new int	NumCopies [get, set]
new QPrinter.Orientation	orientation [get, set]
new string	OutputFileName [get, set]
new QPrinter.OutputFormat	outputFormat [get, set]
new QPrinter.PageOrder	pageOrder [get, set]
new QPrinter.PaperSize	PageSize [get, set]
new QPrinter.PaperSource	paperSource [get, set]
new string	PrintProgram [get, set]
new QPrinter.PrintRange	printRange [get, set]
new string	PrinterName [get, set]
new int	Resolution [get, set]
new int	WinPageSize [get, set]
Properties inherited from QtGui.QPaintDevice
virtual System.IntPtr	SmokeObject [get, set]
new ushort	Painters [get, set]

Additional Inherited Members
Protected Attributes inherited from QtGui.QPaintDevice
SmokeInvocation	interceptor

Detailed Description

The QPrinter class is a paint device that paints on 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 are:

setOrientation() tells QPrinter which page orientation to use.

setPaperSize() tells QPrinter what paper 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.

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 and Printing with Qt.

Member Enumeration Documentation

enum QtGui.QPrinter.ColorMode

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

Enumerator:

Color	Print in color if available, otherwise in grayscale.
GrayScale	Print in grayscale, even on color printers.

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

This enum was introduced or modified in Qt 4.4.

Enumerator:

DuplexAuto	The printer's default setting is used to determine whether duplex printing is used.
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
DuplexNone	Single sided (simplex) printing only.
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

enum QtGui.QPrinter.Orientation

This enum type (not to be confused with Orientation) is used to specify each page's orientation.

This type interacts with QPrinter::PaperSize and QPrinter::setFullPage() to determine the final size of the page available to the application.

Enumerator:

Landscape	The page's width is greater than its height.
Portrait	The page's height is greater than its width.

enum QtGui.QPrinter.OutputFormat

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

See also outputFormat(), setOutputFormat(), and setOutputFileName().

Enumerator:

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.
PdfFormat	QPrinter will generate its output as a searchable PDF file. This mode is the default when printing to a file.
PostScriptFormat	QPrinter will generate its output as in the PostScript format. (This feature was introduced in Qt 4.2.)

enum QtGui.QPrinter.PageOrder

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

Enumerator:

FirstPageFirst	The lowest-numbered page should be printed first.
LastPageFirst	The highest-numbered page should be printed first.

enum QtGui.QPrinter.PaperSize

This enum type specifies what paper size QPrinter should use. QPrinter does not check that the paper size is available; it just uses this information, together with QPrinter::Orientation and QPrinter::setFullPage(), to determine the printable area.

The defined sizes (with setFullPage(true)) are:

With setFullPage(false) (the default), the metrics will be a bit smaller; how much depends on the printer in use.

This enum was introduced or modified in Qt 4.4.

Enumerator:

A0	841 x 1189 mm
A1	594 x 841 mm
A2	420 x 594 mm
A3	297 x 420 mm
A4	210 x 297 mm, 8.26 x 11.69 inches
A5	148 x 210 mm
A6	105 x 148 mm
A7	74 x 105 mm
A8	52 x 74 mm
A9	37 x 52 mm
B0	1000 x 1414 mm
B1	707 x 1000 mm
B10	31 x 44 mm
B2	500 x 707 mm
B3	353 x 500 mm
B4	250 x 353 mm
B5	176 x 250 mm, 6.93 x 9.84 inches
B6	125 x 176 mm
B7	88 x 125 mm
B8	62 x 88 mm
B9	33 x 62 mm
C5E	163 x 229 mm
Comm10E	105 x 241 mm, U.S. Common 10 Envelope
Custom	Unknown, or a user defined size.
DLE	110 x 220 mm
Executive	7.5 x 10 inches, 190.5 x 254 mm
Folio	210 x 330 mm
Ledger	431.8 x 279.4 mm
Legal	8.5 x 14 inches, 215.9 x 355.6 mm
Letter	8.5 x 11 inches, 215.9 x 279.4 mm
NPageSize
NPaperSize
Tabloid	279.4 x 431.8 mm

enum QtGui.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.

Enumerator:

Auto
Cassette
Envelope
EnvelopeManual
FormSource
LargeCapacity
LargeFormat
Lower
Manual
MaxPageSource
Middle
OnlyOne
SmallFormat
Tractor

enum QtGui.QPrinter.PrinterMode

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

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:

HighResolution	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.
PrinterResolution	This value is deprecated. Is is equivalent to ScreenResolution on Unix and HighResolution on Windows and Mac. Due do the difference between ScreenResolution and HighResolution, use of this value may lead to non-portable printer code.
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.

enum QtGui.QPrinter.PrinterState

Enumerator:

Aborted
Active
Error
Idle

enum QtGui.QPrinter.PrintRange

Used to specify the print range selection option.

See also QAbstractPrintDialog::PrintRange.

Enumerator:

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

enum QtGui.QPrinter.Unit

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

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 dependant and is based on the actual pixels, or dots, on the printer.

This enum was introduced or modified in Qt 4.4.

Enumerator:

Cicero
DevicePixel
Didot
Inch
Millimeter
Pica
Point

Constructor & Destructor Documentation

QtGui.QPrinter.QPrinter ( System.Type  dummy )

protected

QtGui.QPrinter.QPrinter	(	QPrinterInfo	printer,
		QPrinter.PrinterMode	mode = QPrinter.PrinterMode.ScreenResolution
	)

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

This function was introduced in Qt 4.4.

QtGui.QPrinter.QPrinter

(

QPrinter.PrinterMode

mode = QPrinter.PrinterMode.ScreenResolution

)

Creates a new printer object with the given mode.

Member Function Documentation

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

new int QtGui.QPrinter.ActualNumCopies

(

)

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.

This function was introduced in Qt 4.6.

See also setNumCopies() and numCopies().

override void QtGui.QPrinter.CreateProxy ( )

virtual

Reimplemented from QtGui.QPaintDevice.

override int QtGui.QPrinter.DevType ( )

virtual

Reimplemented from QtGui.QPaintDevice.

new void QtGui.QPrinter.Dispose

(

)

new int QtGui.QPrinter.FromPage

(

)

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.

This function was introduced in Qt 4.1.

See also setFromTo() and toPage().

override System.IntPtr QtGui.QPrinter.GetDC ( )

virtual

Reimplemented from QtGui.QPaintDevice.

new void QtGui.QPrinter.GetPageMargins	(	ref double	left,
		ref double	top,
		ref double	right,
		ref double	bottom,
		QPrinter.Unit	unit
	)

Returns the page margins for this printer in left, top, right, bottom. The unit of the returned margins are specified with the unit parameter.

This function was introduced in Qt 4.4.

new bool QtGui.QPrinter.IsValid

(

)

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("/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();

This function was introduced in Qt 4.4.

See also setPrinterName().

override int QtGui.QPrinter.Metric ( QPaintDevice.PaintDeviceMetric  metric )

protectedvirtual

Returns the metric information for the given paint device metric.

See also PaintDeviceMetric.

Reimplemented from QtGui.QPaintDevice.

new bool QtGui.QPrinter.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.

new QRect QtGui.QPrinter.PageRect

(

)

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

new QRectF QtGui.QPrinter.PageRect

(

QPrinter.Unit

arg1

)

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.

This function was introduced in Qt 4.4.

See also paperSize().

override QPaintEngine QtGui.QPrinter.PaintEngine ( )

virtual

Reimplemented from QPaintDevice::paintEngine().

Returns the paint engine used by the printer.

Implements QtGui.QPaintDevice.

new QRect QtGui.QPrinter.PaperRect

(

)

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

The unit of the returned rectangle is DevicePixel.

See also pageRect().

new QRectF QtGui.QPrinter.PaperRect

(

QPrinter.Unit

arg1

)

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

This function was introduced in Qt 4.4.

See also pageRect().

new QPrinter.PaperSize QtGui.QPrinter.paperSize

(

)

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

This function was introduced in Qt 4.4.

See also setPaperSize(), pageRect(), and paperRect().

new QSizeF QtGui.QPrinter.paperSize

(

QPrinter.Unit

unit

)

Returns the paper size in unit.

This function was introduced in Qt 4.4.

See also setPaperSize().

new QPrintEngine QtGui.QPrinter.PrintEngine

(

)

Returns the print engine used by the printer.

This function was introduced in Qt 4.1.

new QPrinter.PrinterState QtGui.QPrinter.printerState

(

)

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

override void QtGui.QPrinter.ReleaseDC ( System.IntPtr  hdc )

virtual

Reimplemented from QtGui.QPaintDevice.

new void QtGui.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.

This function was introduced in Qt 4.1.

See also printEngine(), paintEngine(), and setOutputFormat().

new void QtGui.QPrinter.SetFromTo	(	int	fromPage,
		int	toPage
	)

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

This function was introduced in Qt 4.1.

See also fromPage() and toPage().

new void QtGui.QPrinter.SetPageMargins	(	double	left,
		double	top,
		double	right,
		double	bottom,
		QPrinter.Unit	unit
	)

This function sets the left, top, right and bottom page margins for this printer. The unit of the margins are specified with the unit parameter.

This function was introduced in Qt 4.4.

new void QtGui.QPrinter.SetPaperSize	(	QSizeF	paperSize,
		QPrinter.Unit	unit
	)

Sets the paper size based on paperSize in unit.

This function was introduced in Qt 4.4.

See also paperSize().

new void QtGui.QPrinter.SetPaperSize

(

QPrinter.PaperSize

arg1

)

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

The default paper size is driver-dependent.

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

This function was introduced in Qt 4.4.

See also paperSize(), PaperSize, setFullPage(), setResolution(), pageRect(), and paperRect().

new System.Collections.Generic.List<QPrinter.PaperSource> QtGui.QPrinter.SupportedPaperSources

(

)

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.

Warning: This function is only available in windows.

new System.Collections.Generic.List<System.Int32> QtGui.QPrinter.SupportedResolutions

(

)

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

new bool QtGui.QPrinter.SupportsMultipleCopies

(

)

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.

This function was introduced in Qt 4.7.

See also setCopyCount() and copyCount().

new int QtGui.QPrinter.ToPage

(

)

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.

This function was introduced in Qt 4.1.

See also setFromTo() and fromPage().

Property Documentation

new bool QtGui.QPrinter.CollateCopies

getset

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.

This function was introduced in Qt 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.

This function was introduced in Qt 4.1.

new QPrinter.ColorMode QtGui.QPrinter.colorMode

getset

Returns the current color mode.

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

new int QtGui.QPrinter.CopyCount

getset

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

This function was introduced in Qt 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.

This function was introduced in Qt 4.7.

new string QtGui.QPrinter.Creator

getset

Returns the name of the application that created the document.

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.

new string QtGui.QPrinter.DocName

getset

Returns the document 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.

new bool QtGui.QPrinter.DoubleSidedPrinting

getset

Returns true if double side printing is enabled.

Currently this option is only supported on X11.

This function was introduced in Qt 4.2.

Enables double sided printing if doubleSided is true; otherwise disables it.

Currently this option is only supported on X11.

This function was introduced in Qt 4.2.

new QPrinter.DuplexMode QtGui.QPrinter.Duplex

getset

Returns the current duplex mode.

Currently this option is only supported on X11.

This function was introduced in Qt 4.4.

Enables double sided printing based on the duplex mode.

Currently this option is only supported on X11.

This function was introduced in Qt 4.4.

new bool QtGui.QPrinter.FontEmbeddingEnabled

getset

Returns true if font embedding is enabled.

Currently this option is only supported on X11.

This function was introduced in Qt 4.1.

Enabled or disables font embedding depending on enable.

Currently this option is only supported on X11.

This function was introduced in Qt 4.1.

new bool QtGui.QPrinter.FullPage

getset

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.

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

new int QtGui.QPrinter.NumCopies

getset

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.

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.

new QPrinter.Orientation QtGui.QPrinter.orientation

getset

Returns the orientation setting. This is driver-dependent, but is usually QPrinter::Portrait.

Sets the print orientation to orientation.

The orientation can be either QPrinter::Portrait or QPrinter::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.

new string QtGui.QPrinter.OutputFileName

getset

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

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 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 Qt's 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.

new QPrinter.OutputFormat QtGui.QPrinter.outputFormat

getset

Returns the output format for this printer.

This function was introduced in Qt 4.1.

Sets the output format for this printer to format.

This function was introduced in Qt 4.1.

new QPrinter.PageOrder QtGui.QPrinter.pageOrder

getset

Returns the current page order.

The default page order is FirstPageFirst.

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.

new QPrinter.PaperSize QtGui.QPrinter.PageSize

getset

Returns the printer page size. The default value is driver-dependent.

Use paperSize() instead.

Sets the printer page size based on newPageSize.

Use setPaperSize() instead.

new QPrinter.PaperSource QtGui.QPrinter.paperSource

getset

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

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

new string QtGui.QPrinter.PrinterName

getset

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

Sets the printer name to name.

new string QtGui.QPrinter.PrintProgram

getset

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.

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 PostScript output. On other platforms, it has no effect.

new QPrinter.PrintRange QtGui.QPrinter.printRange

getset

Returns the page range of the QPrinter. After the print setup dialog has been opened, this function returns the value selected by the user.

This function was introduced in Qt 4.1.

Sets the print range option in to be range.

This function was introduced in Qt 4.1.

new int QtGui.QPrinter.Resolution

getset

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

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.

new int QtGui.QPrinter.WinPageSize

getset

Returns the page size used by the printer under Windows.

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

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

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