|
|
The QPrinter class is a paint device that paint on a printer. More...
#include <qprinter.h>
Inherits QPaintDevice.
On Windows, it uses the built-in printer drivers. On X11, it generates postscript and sends that to lpr, lp or another print command.
QPrinter is used much the same way that QWidget and QPixmap are used. The big difference is that you must keep track of the pages.
QPrinter supports a number of settable parameters, mostly related to pages, and most can be changed by the end user in when the application calls QPrinter::setup().
The most important ones are:
There are also some settings that the user sets (through the printer dialog) and that applications are expected to obey:
You can of course call e.g. setPageOrder() to establish a default before you ask the user through setup().
Once you've started printing, newPage() is essential. You will probably also need to look at the QPaintDeviceMetrics for the printer (see the simple print function in the Application walk-through). Note that the paint device metrics are only valid after the QPrinter has been set up; i.e. after setup() has returned successfully. If you want high-quality printing with accurate margins, setFullPage( TRUE ) is a must.
If you want to abort the print job, abort() will make a best effort. It may cancel the entire job, or just some of it.
Examples: drawdemo/drawdemo.cpp
Color - print in color if available, else in grayscale. This
is the default.
GrayScale - print in grayscale, even on color printers.
Might be a little faster than Color.
Portrait - (the default) means to print such that the page's
height is greater than its width.
Landscape - means to print such that the page's width is
greater than its height.
This type interacts with QPrinter::PageSize and QPrinter::setFullPage() to determine the final size of the page available to the application.
QPrinter::FirstPageFirst - the lowest-numbered page should
be printed first.
QPrinter::LastPageFirst - the highest-numbered page should
be printed first.
The defined sizes (with setFullPage( TRUE )) are
QPrinter::A0 (841 x 1189 mm)
QPrinter::A1 (594 x 841 mm)
QPrinter::A2 (420 x 594 mm)
QPrinter::A3 (297 x 420 mm)
QPrinter::A4 (210x297 mm, 8.26x11.7 inches)
QPrinter::A5 (148 x 210 mm)
QPrinter::A6 (105 x 148 mm)
QPrinter::A7 (74 x 105 mm)
QPrinter::A8 (52 x 74 mm)
QPrinter::A9 (37 x 52 mm)
QPrinter::B0 (1030 x 1456 mm)
QPrinter::B1 (728 x 1030 mm)
QPrinter::B10 (32 x 45 mm)
QPrinter::B2 (515 x 728 mm)
QPrinter::B3 (364 x 515 mm)
QPrinter::B4 (257 x 364 mm)
QPrinter::B5 (182x257 mm, 7.17x10.13 inches)
QPrinter::B6 (128 x 182 mm)
QPrinter::B7 (91 x 128 mm)
QPrinter::B8 (64 x 91 mm)
QPrinter::B9 (45 x 64 mm)
QPrinter::C5E (163 x 229 mm)
QPrinter::Comm10E (105 x 241 mm, US Common #10 Envelope)
QPrinter::DLE (110 x 220 mm)
QPrinter::Executive (7.5x10 inches, 191x254 mm)
QPrinter::Folio (210 x 330 mm)
QPrinter::Ledger (432 x 279 mm)
QPrinter::Legal (8.5x14 inches, 216x356 mm)
QPrinter::Letter (8.5x11 inches, 216x279 mm)
QPrinter::Tabloid (279 x 432 mm)
With setFullPage( FALSE ) (the default), the metrics will be a bit smaller. How much depends on the printer in use.
Constructs a printer paint device.
Destructs the printer paint device and cleans up.
Aborts the print job. Returns TRUE if successful, otherwise FALSE.
See also aborted().
Returns TRUE is the printer job was aborted, otherwise FALSE.
See also abort().
Returns the current color mode. The default color mode is Color.
See also setColorMode().
Returns the creator name.
See also setCreator().
Returns the document name.
See also setDocName().
Returns the from-page setting. The default value is 0.
The programmer is responsible for reading this setting and print accordingly.
See also setFromTo() and toPage().
Returns TRUE if the origin of the printer's coordinate system is at the corner of the sheet, and FALSE if it is at the edge of the printable area.
See setFullPage() for more detail and some warnings.
See also setFullPage(), PageSize and QPaintDeviceMetrics.
Returns the width of the left/right and top/bottom margins of the printer. This is a best-effort guess, not based on perfect knowledge.
If you have called setFullPage( TRUE ) (this is recommended for high-quality printing), margins().width() may be treated as the smallest sane left/right margin you can use, and margins().height() as the smallest sane top/bottom margins you can use.
If you have called setFullPage( FALSE ) (this is the default), margins() is automatically subtracted from the pageSize() by QPrinter.
See also setFullPage(), QPaintDeviceMetrics and PageSize.
Returns the max-page setting. The default value is 0.
See also minPage() and setMinMax().
[virtual protected]Internal implementation of the virtual QPaintDevice::metric() function.
Use the QPaintDeviceMetrics class instead.
Reimplemented from QPaintDevice.
Returns the min-page setting. The default value is 0.
See also maxPage() and setMinMax().
Advances to a new page on the printer. Returns TRUE if successful, otherwise FALSE.
Returns the number of copies to be printed. The default value is 1.
See also setNumCopies().
Returns the orientation setting. The default value is QPrinter::Portrait.
See also setOrientation().
Returns the name of the output file. There is no default file name.
See also setOutputFileName() and setOutputToFile().
Returns TRUE if the output should be written to a file, or FALSE if the output should be sent directly to the printer. The default setting is FALSE.
This function is currently only supported under X11.
See also setOutputToFile() and setOutputFileName().
Returns the current page order.
The default page order is FirstPageFirst.
Returns the printer page size. The default value is system-dependent.
See also setPageSize().
Returns the name of the program that sends the print output to the printer.
The default is to return a null 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 Windows, this function returns the name of the printer device driver.
See also setPrintProgram() and setPrinterSelectionOption().
Returns the printer name. This value is initially set to the name of the default printer.
See also setPrinterName().
Returns the printer options selection string. This is only useful if the print command has been explicitly set.
The default value (a null string) implies to select printer in a system-dependent manner.
Any other value implies to use that value.
See also setPrinterSelectionOption().
Sets the printer's color mode to newColorMode, which can be
one of Color (the default) and GrayScale.
A future version of Qt will modify its printing accordingly. At
present, QPrinter behaves as if Color is selected.
See also colorMode().
[virtual]Sets the creator name.
Calling this function only has effect for the X11 version of Qt. The creator name is the name of the application that created the document. If no creator name is specified, then the creator will be set to "Qt" with some version number.
See also creator().
[virtual]Sets the document name.
[virtual]Sets the from page and to page.
The from-page and to-page settings specify what pages to print.
This function is useful mostly for setting a default value that the user can override in the print dialog when you call setup().
See also fromPage(), toPage(), setMinMax() and setup().
[virtual]Sets QPrinter to have the origin of the coordinate system at the top left corner of the paper if fp is TRUE, or where it thinks the top left corner of the printable area is if fp is FALSE.
The default is FALSE: You can (probably) print on (0,0), and QPaintDeviceMetrics will report something smaller than the size indicated by PageSize. (Note that QPrinter may be wrong - it does not have perfect knowledge of the physical printer.)
If you set it to TRUE, QPaintDeviceMetrics will report the exact same size as indicated by PageSize, but you cannot print on all of that - you have to take care of the output margins yourself.
If the page-size mode is changed while the printer is active, the current print job may or may not be affected.
See also PageSize, setPageSize(), QPaintDeviceMetrics and fullPage().
[virtual]Sets the min page and max page.
The min-page and max-page restrict the from-page and to-page settings. When the printer setup dialog comes up, the user cannot select from and to that are outside the range specified by min and max pages.
See also minPage(), maxPage(), setFromTo() and setup().
[virtual]Sets the number of pages to be printed.
The printer driver reads this setting and prints the specified number of copies.
See also numCopies() and setup().
Sets the print orientation.
The orientation can be either QPrinter::Portrait or
QPrinter::Landscape.
The printer driver reads this setting and prints using the specified orientation.
See also orientation().
[virtual]Sets the name of the output file.
Setting a null name (0 or "") disables output to a file, i.e. calls setOutputToFile(FALSE); Setting non-null name enables output to a file, i.e. calls setOutputToFile(TRUE).
This function is currently only supported under X11.
See also outputFileName() and setOutputToFile().
[virtual]Specifies whether the output should be written to a file or sent directly to the printer.
Will output to a file if enable is TRUE, or will output directly to the printer if enable is FALSE.
This function is currently only supported under X11.
See also outputToFile() and setOutputFileName().
Sets the page order to newPageOrder.
The page order can be QPrinter::FirstPageFirst or QPrinter::LastPageFirst. The application programmer is responsible
for reading the page order and printing accordingly.
This function is useful mostly for setting a default value that the user can override in the print dialog when you call setup().
Sets the printer page size to newPageSize.
The default page size is system-dependent.
This function is useful mostly for setting a default value that the user can override in the print dialog when you call setup().
See also pageSize(), PageSize and setFullPage().
[virtual]Sets the name of the program that should do the print job.
On X11, this function sets the program to call with the PostScript output. On other platforms, it has no effect.
See also printProgram().
[virtual]Sets the printer name.
The default printer will be used if no printer name is set.
Under X11, the PRINTER environment variable defines the default printer. Under any other window system, the window system defines the default printer.
See also printerName().
[virtual]Sets the printer to use option to select printer. option is null by default, meaning to be a little smart, but 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.
Opens a printer setup dialog and asks the user to specify what printer to use and miscellaneous printer settings.
Returns TRUE if the user pressed "OK" to print, or FALSE if the user cancelled the operation.
Examples: drawdemo/drawdemo.cpp
Returns the to-page setting. The default value is 0.
The programmer is responsible for reading this setting and print accordingly.
See also setFromTo() and fromPage().
[virtual protected]For internal use only.
Reimplemented from QPaintDevice.
Search the documentation, FAQ, qt-interest archive and more (uses
www.trolltech.com):
This file is part of the Qt toolkit, copyright © 1995-2000 Trolltech, all rights reserved.
| Copyright © 2000 Trolltech | Trademarks | Qt version 2.2.1
|