| Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions | |
The QPrinter class is a paint device that paints 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 in much the same way as QWidget and QPixmap are used. The big difference is that you must keep track of the pages.
QPrinter supports a number of settable parameters, most of which can be changed by the end user when the application calls QPrinter::setup().
The most important parameters are:
Except where noted, you can only call the set functions before setup(), or between QPainter::end() and setup(). (Some may take effect between setup() and begin(), or between begin() and end(), but that's strictly undocumented and such behaviour may differ depending on platform.)
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 these functions to establish defaults before you ask the user through QPrinter::setup().
Once you start printing, calling newPage() is essential. You will probably also need to look at the QPaintDeviceMetrics for the printer (see the print function in the Application walk-through). Note that the paint device metrics are valid only after the QPrinter has been set up, i.e. after setup() has returned successfully.
If you want to abort the print job, abort() will try its best to stop printing. It may cancel the entire job or just some of it.
If your current locale converts "," to ".", you will need to set a locale that doen't do this (e.g. the "C" locale) before using QPrinter.
The TrueType font embedding for Qt's postscript driver uses code by David Chappell of Trinity College Computing Center.
Copyright 1995, Trinity College Computing Center. Written by David Chappell.
Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. This software is provided "as is" without express or implied warranty.
TrueType font support. These functions allow PPR to generate PostScript fonts from Microsoft compatible TrueType font files.
The functions in this file do most of the work to convert a TrueType font to a type 3 PostScript font.
Most of the material in this file is derived from a program called "ttf2ps" which L. S. Ng posted to the usenet news group "comp.sources.postscript". The author did not provide a copyright notice or indicate any restrictions on use.
Last revised 11 July 1995.
See also Graphics Classes and Image Processing Classes.
This enum type is used to indicate whether QPrinter should print in color or not.
This enum type (not to be confused with Qt::Orientation) is used to specify each page's orientation.
This type interacts with QPrinter::PageSize and QPrinter::setFullPage() to determine the final size of the page available to the application.
This enum type is used by QPrinter to tell the application program how to print.
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 (see QPaintDeviceMetrics).
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 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.
Note: this is currently only implemented for Windows.
This enum is used to specify which print range the application should use to print.
See also setPrintRange() and printRange().
This enum describes the mode the printer should work in. It basically presets a certain resolution and working mode.
This enum describes various printer options that appear in the printer setup dialog. It is used to enable and disable these options in the setup dialog.
See also setOptionEnabled() and isOptionEnabled().
See also QPrinter::PrinterMode.
See also aborted().
See also abort().
See also setColorMode().
Returns the name of the application that created the document.
See also setCreator().
Returns the document name.
See also setDocName().
Returns the from-page setting. The default value is 0.
If fromPage() and toPage() both return 0 this signifies 'print the whole document'.
The programmer is responsible for reading this setting and printing accordingly.
See also setFromTo() and toPage().
See setFullPage() for details and caveats.
See also setFullPage(), PageSize, and QPaintDeviceMetrics.
See also setOptionEnabled().
If you have called setFullPage( TRUE ), margins().width() may be treated as the smallest sane left margin you can use, and margins().height() as the smallest sane top margin 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.
Sets top, left, bottom and right to the margins of the printer. On Unix, this is a best-effort guess, not based on perfect knowledge.
If you have called setFullPage( TRUE ), the four values specify the smallest sane margins you can use.
If you have called setFullPage( FALSE ) (this is the default), the margins are automatically subtracted from the pageSize() by QPrinter.
See also setFullPage(), QPaintDeviceMetrics, and PageSize.
Returns the max-page setting. A user can't choose a higher page number than maxPage() when they select a print range. The default value is 0.
See also minPage(), setMinMax(), and setFromTo().
Returns the min-page setting, i.e. the lowest page number a user is allowed to choose. The default value is 0.
See also maxPage(), setMinMax(), and setFromTo().
Examples: action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp.
Returns the number of copies to be printed. The default value is 1.
After a call to setup(), 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 the application in those cases have to make an explicit call to the print code for each copy.
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().
The default page order is FirstPageFirst.
Returns the printer page size. The default value is system-dependent.
See also setPageSize().
See also setPaperSource().
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().
See also setPrintRange().
Returns the printer name. This value is initially set to the name of the default printer.
See also setPrinterName().
The default value (a null string) implies that the printer should be selected in a system-dependent manner.
Any other value implies that the given value should be used.
See also setPrinterSelectionOption().
See also setResolution().
See also colorMode().
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().
The from-page and to-page settings specify what pages to print.
If fromPage() and toPage() both return 0 this signifies 'print the whole document'.
This function is useful mostly to set a default value that the user can override in the print dialog when you call setup().
See also fromPage(), toPage(), setMinMax(), and setup().
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 on Unix systems - it does not have perfect knowledge of the physical printer.)
If you set fp to TRUE, QPaintDeviceMetrics will report the exact same size as indicated by PageSize, but you cannot print on all of that - you must take care of the output margins yourself.
See also PageSize, setPageSize(), QPaintDeviceMetrics, and fullPage().
Example: helpviewer/helpwindow.cpp.
This function currently only has an effect on Unix systems.
See also margins().
The min-page and max-page restrict the from-page and to-page settings. When the printer setup dialog appears, the user cannot select a from page or a to page that are outside the range specified by min and max pages.
See also minPage(), maxPage(), setFromTo(), and setup().
The printer driver reads this setting and prints the specified number of copies.
See also numCopies() and setup().
See also isOptionEnabled().
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 setting won't take effect until the printer dialog is shown (using QPrinter::setup()).
Windows only! This option can be changed while printing and will take effect from the next call to newPage()
See also orientation().
Setting a null or empty name (0 or "") disables output to a file, i.e. calls setOutputToFile(FALSE). Setting a non-empty name enables output to a file, i.e. calls setOutputToFile(TRUE).
This function is currently only supported under X11.
See also outputFileName() and setOutputToFile().
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().
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().
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, setFullPage(), and setResolution().
Windows only! This option can be changed while printing and will take effect from the next call to newPage()
See also paperSource().
On X11, this function sets the program to call with the PostScript output. On other platforms, it has no effect.
See also printProgram().
See also printRange().
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().
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().
This setting affects the coordinate system as returned by, for example, QPaintDeviceMetrics and QPainter::viewport().
The value depends on the PrintingMode used in the QPrinter constructor. By default, the dpi value of the screen is used.
This function must be called before setup() to have an effect on all platforms.
See also resolution() and setPageSize().
Returns TRUE if the user pressed "OK" to print, or FALSE if the user cancelled the operation.
Examples: action/application.cpp, application/application.cpp, drawdemo/drawdemo.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp.
Returns the to-page setting. The default value is 0.
If fromPage() and toPage() both return 0 this signifies 'print the whole document'.
The programmer is responsible for reading this setting and printing accordingly.
See also setFromTo() and fromPage().
Use pageSize() to get the PageSize, e.g. 'A4', 'Letter', etc.
This file is part of the Qt toolkit. Copyright © 1995-2003 Trolltech. All Rights Reserved.
| Copyright © 2003 Trolltech | Trademarks | Qt version 3.2.0b2
|