QPrinter(3qt)

NAME
QPrinter - Paint device that prints graphics on a printer

SYNOPSIS

#include <qprinter.h>

Inherits QPaintDevice.

  Public Members
QPrinter ()
~QPrinter ()
const char* printerName () const
void setPrinterName ( const char * )
bool outputToFile () const
void setOutputToFile ( bool )
const char* outputFileName () const
void setOutputFileName ( const char * )
const char* printProgram () const
void setPrintProgram ( const char * )
const char* docName () const
void setDocName ( const char * )
const char* creator () const
void setCreator ( const char * )
Orientation orientation () const
void setOrientation ( Orientation )
PageSize pageSize () const
void setPageSize ( PageSize )
void setPageOrder ( PageOrder )
PageOrder pageOrder () const
void setColorMode ( ColorMode )
ColorMode colorMode () const
int fromPage () const
int toPage () const
void setFromTo ( int fromPage, int toPage )
int minPage () const
int maxPage () const
void setMinMax ( int minPage, int maxPage )
int numCopies () const
void setNumCopies ( int )
bool newPage ()
bool abort ()
bool aborted () const
bool setup ( QWidget * parent = 0 )

  Protected Members
virtual bool cmd ( int, QPainter *, QPDevCmdParam * )
virtual int metric ( int ) const

DESCRIPTION
The QPrinter class is a paint device that prints graphics on a printer.

All window systems that Qt supports, except X11, have built-in printer drivers. For X11, Qt provides PostScript (tm) printing.

Drawing graphics on a printer is almost identical to drawing graphics in a widget or a pixmap. The only difference is that the programmer must think about dividing the document into pages and handling abort commands.

The default coordinate system of a printer is a 72 dpi (dots per inch) system with (0,0) at the upper left corner, with increasing values to the right and downwards. This causes printer output to be roughly the same size as screen output on most screens. You can easily change the coordinate system using QPainter::setViewport(). QPainter::setWindow() and/or QPainter::setWorldMatrix().

The newPage() function should be called to finish the current page and start printing a new page.

If the user decides to abort printing, aborted() will return TRUE. The QPrinter class handles abortion automatically, but the programmer should from time to time check the aborted() flag and stop painting if the print job has been aborted.

Example (a complete application):

    #include <qapplication.h>
    #include <qpainter.h>
    #include <qprinter.h>
    #include <qprintdialog.h>
    int main( int argc, char **argv )
    {
        QApplication a( argc, argv );
        QPrinter prt;
        if ( prt.setup() ) {
            QPainter p;
            p.begin( &prt );
            p.rotate( 55 );
            p.setFont( QFont("times", 144, QFont::Bold) );
            p.drawText( 80,30, "Hello, world!" );
            p.end();
        }
        return 0;
    }

Examples: drawdemo/drawdemo.cpp application/application.cpp

MEMBER FUNCTION DOCUMENTATION

QPrinter::QPrinter ()
Constructs a printer paint device.

QPrinter::~QPrinter ()
Destroys the printer paint device and cleans up.

bool QPrinter::abort ()
Aborts the print job. Returns TRUE if successful, otherwise FALSE.

See also: aborted().

bool QPrinter::aborted () const
Returns TRUE is the printer job was aborted, otherwise FALSE.

See also: abort().

bool QPrinter::cmd ( int c, QPainter * paint, QPDevCmdParam * p ) [virtual protected]
For internal use only.

Reimplemented from QPaintDevice.

QPrinter::ColorMode QPrinter::colorMode() const
Returns the current color mode. The default color more is Color.

See also: setColorMode().

const char * QPrinter::creator () const
Returns the creator name.

See also: setCreator().

const char * QPrinter::docName () const
Returns the document name.

See also: setDocName().

int QPrinter::fromPage () const
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().

int QPrinter::maxPage () const
Returns the max-page setting. The default value is 0.

See also: minPage() and setMinMax().

int QPrinter::metric ( int m ) const [virtual protected]
Internal implementation of the virtual QPaintDevice::metric() function.

Use the QPaintDeviceMetrics class instead.

Reimplemented from QPaintDevice.

int QPrinter::minPage () const
Returns the min-page setting. The default value is 0.

See also: maxPage() and setMinMax().

bool QPrinter::newPage ()
Advances to a new page on the printer. Returns TRUE if successful, otherwise FALSE.

int QPrinter::numCopies () const
Returns the number of copies to be printed. The default value is 1.

See also: setNumCopies().

Orientation QPrinter::orientation () const
Returns the orientation setting. The default value is QPrinter::Portrait.

See also: setOrientation().

const char * QPrinter::outputFileName () const
Returns the name of the output file. There is no default file name.

See also: setOutputFileName() and setOutputToFile().

bool QPrinter::outputToFile () const
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().

QPrinter::PageOrder QPrinter::pageOrder() const
Returns the current page order.

The default page order is FirstPageFirst.

PageSize QPrinter::pageSize () const
Returns the printer page size. The default value is QPrinter::A4.

See also: setPageSize().

const char * QPrinter::printProgram () const
Returns the name of the program that sends the print output to the printer.

The default print program is "lpr" under X11. This function returns 0 for all other window systems.

See also: setPrintProgram().

const char * QPrinter::printerName () const
Returns the printer name. This value is initially set to the name of the default printer.

See also: setPrinterName().

void QPrinter::setColorMode ( ColorMode newColorMode )
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().

void QPrinter::setCreator ( const char * creator )
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".

See also: creator().

void QPrinter::setDocName ( const char * name )
Sets the document name.

void QPrinter::setFromTo ( int fromPage, int toPage )
Sets the from page and to page.

The from-page and to-page settings specify what pages to print.

See also: fromPage(), toPage(), setMinMax() and setup().

void QPrinter::setMinMax ( int minPage, int maxPage )
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 outsize the range specified by min and max pages.

See also: minPage(), maxPage(), setFromTo() and setup().

void QPrinter::setNumCopies ( int numCopies )
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().

void QPrinter::setOrientation ( Orientation orientation )
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().

void QPrinter::setOutputFileName ( const char * fileName )
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().

void QPrinter::setOutputToFile ( bool enable )
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().

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

void QPrinter::setPageSize ( PageSize newPageSize )
Sets the printer page size to newPageSize.

The page size can be one of

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)

See also: pageSize().

void QPrinter::setPrintProgram ( const char * printProg )
Sets the name of the program that should do the print job.

If an output file has been defined, the printer driver will print to the output file instead of directly to the printer.

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

See also: printProgram().

void QPrinter::setPrinterName ( const char * name )
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().

bool QPrinter::setup ( QWidget * parent = 0 )
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

int QPrinter::toPage () const
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().

SEE ALSO
http://www.troll.no/qt/qprinter.html

COPYRIGHT
Copyright 1992-1997 Troll Tech AS. See the LICENSE file included in the distribution for a complete license statement.

AUTHOR
Generated automatically from the source code.