From d796c9dd933ab96ec83b9a634feedd5d32e1ba3f Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Tue, 8 Nov 2011 12:31:36 -0600 Subject: Test conversion to TQt3 from Qt3 8c6fc1f8e35fd264dd01c582ca5e7549b32ab731 --- doc/html/qprinter.html | 758 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 758 insertions(+) create mode 100644 doc/html/qprinter.html (limited to 'doc/html/qprinter.html') diff --git a/doc/html/qprinter.html b/doc/html/qprinter.html new file mode 100644 index 000000000..3727da28e --- /dev/null +++ b/doc/html/qprinter.html @@ -0,0 +1,758 @@ + + + + + +TQPrinter Class + + + + + + + +
+ +Home + | +All Classes + | +Main Classes + | +Annotated + | +Grouped Classes + | +Functions +

TQPrinter Class Reference

+ +

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

#include <qprinter.h> +

Inherits TQPaintDevice. +

List of all member functions. +

Public Members

+ +

Detailed Description

+ + +The TQPrinter class is a paint device that paints on a printer. +

+ + +

On Windows it uses the built-in printer drivers. On X11 it +generates postscript and sends that to lpr, lp, or another print +command. +

TQPrinter is used in much the same way as TQWidget and TQPixmap are +used. The big difference is that you must keep track of the pages. +

TQPrinter supports a number of settable parameters, most of which +can be changed by the end user when the application calls +TQPrinter::setup(). +

The most important parameters are: +

+

Except where noted, you can only call the set functions before +setup(), or between TQPainter::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 TQPrinter::setup(). +

Once you start printing, calling newPage() is essential. You will +probably also need to look at the TQPaintDeviceMetrics for the +printer (see the print + function in the Application walk-through). In previous versions, +paint device metrics were valid only after the TQPrinter has been set +up, i.e. after setup() has returned successfully. This is no longer +the case and paint device metrics can be requested safely before set up. +

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 (via the standard C setlocale() function) that doen't do this +before using TQPrinter. The "C" locale works well for this. +

The TrueType font embedding for TQt'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. + +

Member Type Documentation

+

TQPrinter::ColorMode

+ +

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

+

TQPrinter::Orientation

+ +

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

This type interacts with TQPrinter::PageSize and +TQPrinter::setFullPage() to determine the final size of the page +available to the application. + +

TQPrinter::PageOrder

+ +

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

+

TQPrinter::PageSize

+ +

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

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

TQPrinter::PaperSource

+ +

This enum type specifies what paper source TQPrinter is to use. +TQPrinter 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. +

+

TQPrinter::PrintRange

+ +

This enum is used to specify which print range the application +should use to print. +

See also setPrintRange() and printRange(). + +

TQPrinter::PrinterMode

+ +

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

+

TQPrinter::PrinterOption

+ +

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

Member Function Documentation

+

TQPrinter::TQPrinter ( PrinterMode m = ScreenResolution ) +

+Constructs a printer paint device with mode m. +

See also TQPrinter::PrinterMode. + +

TQPrinter::~TQPrinter () +

+Destroys the printer paint device and cleans up. + +

bool TQPrinter::abort () +

+Aborts the print job. Returns TRUE if successful; otherwise +returns FALSE. +

See also aborted(). + +

bool TQPrinter::aborted () const +

+Returns TRUE if the print job was aborted; otherwise returns +FALSE. +

See also abort(). + +

ColorMode TQPrinter::colorMode () const +

+Returns the current color mode. The default color mode is Color. +

See also setColorMode(). + +

TQString TQPrinter::creator () const +

+ +

Returns the name of the application that created the document. +

See also setCreator(). + +

TQString TQPrinter::docName () const +

+ +

Returns the document name. +

See also setDocName(). + +

int TQPrinter::fromPage () const +

+ +

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

bool TQPrinter::fullPage () const +

+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 details and caveats. +

See also setFullPage(), PageSize, and TQPaintDeviceMetrics. + +

bool TQPrinter::isOptionEnabled ( PrinterOption option ) +

+Returns TRUE if the printer option with identifier option is enabled; +otherwise returns FALSE. +

See also setOptionEnabled(). + +

TQSize TQPrinter::margins () const +

+Returns the width of the left margin and the height of the top +margin of the printer. On Unix, this is a best-effort guess, not +based on perfect knowledge. +

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 +TQPrinter. +

See also setFullPage(), TQPaintDeviceMetrics, and PageSize. + +

void TQPrinter::margins ( uint * top, uint * left, uint * bottom, uint * right ) const +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

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 +TQPrinter. +

See also setFullPage(), TQPaintDeviceMetrics, and PageSize. + +

int TQPrinter::maxPage () const +

+ +

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

int TQPrinter::minPage () const +

+ +

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

bool TQPrinter::newPage () +

+Advances to a new page on the printer. Returns TRUE if successful; +otherwise returns FALSE. + +

Examples: action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. +

int TQPrinter::numCopies () const +

+ +

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

This value will return the number of times the application is +retquired 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(). + +

Orientation TQPrinter::orientation () const +

+ +

Returns the orientation setting. The default value is TQPrinter::Portrait. +

See also setOrientation(). + +

TQString TQPrinter::outputFileName () const +

+ +

Returns the name of the output file. There is no default file +name. +

See also setOutputFileName() and setOutputToFile(). + +

bool TQPrinter::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 and Mac OS X. +

See also setOutputToFile() and setOutputFileName(). + +

PageOrder TQPrinter::pageOrder () const +

+Returns the current page order. +

The default page order is FirstPageFirst. +

Bugs and limitations: +

+

PageSize TQPrinter::pageSize () const +

+ +

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

See also setPageSize(). + +

PaperSource TQPrinter::paperSource () const +

+Returns the currently set paper source of the printer. +

See also setPaperSource(). + +

TQString TQPrinter::printProgram () const +

+ +

Returns the name of the program that sends the print output to the +printer. +

The default is to return a null string; meaning that TQPrinter 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(). + +

PrintRange TQPrinter::printRange () const +

+Returns the PageRange of the TQPrinter. After the print setup dialog +has been opened, this function returns the value selected by the user. +

See also setPrintRange(). + +

TQString TQPrinter::printerName () const +

+ +

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

See also setPrinterName(). + +

TQString TQPrinter::printerSelectionOption () const +

+Returns the printer options selection string. This is useful only +if the print command has been explicitly set. +

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

int TQPrinter::resolution () const [virtual] +

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

See also setResolution(). + +

void TQPrinter::setColorMode ( ColorMode newColorMode ) [virtual] +

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

See also colorMode(). + +

void TQPrinter::setCreator ( const TQString & creator ) [virtual] +

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

This function is only applicable to the X11 version of TQt. If no +creator name is specified, the creator will be set to "TQt" +followed by some version number. +

See also creator(). + +

void TQPrinter::setDocName ( const TQString & name ) [virtual] +

+Sets the document name to name. + +

void TQPrinter::setFromTo ( int fromPage, int toPage ) [virtual] +

+Sets the from-page and to-page settings to fromPage and toPage respectively. +

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

void TQPrinter::setFullPage ( bool fp ) [virtual] +

+Sets TQPrinter 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 +TQPaintDeviceMetrics will report something smaller than the size +indicated by PageSize. (Note that TQPrinter may be wrong on Unix +systems - it does not have perfect knowledge of the physical +printer.) +

If you set fp to TRUE, TQPaintDeviceMetrics 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(), TQPaintDeviceMetrics, and fullPage(). + +

Examples: action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. +

void TQPrinter::setMargins ( uint top, uint left, uint bottom, uint right ) +

+Sets the printer margins to the sizes specified in top, left, +bottom and right. +

This function currently only has an effect on Unix systems. +

See also margins(). + +

void TQPrinter::setMinMax ( int minPage, int maxPage ) [virtual] +

+Sets the min-page and max-page settings to minPage and maxPage respectively. +

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

void TQPrinter::setNumCopies ( int numCopies ) [virtual] +

+Sets the number of copies to be printed to numCopies. +

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

See also numCopies() and setup(). + +

void TQPrinter::setOptionEnabled ( PrinterOption option, bool enable ) +

+Enables the printer option with the identifier option if enable is TRUE, and disables option option if enable is FALSE. +

See also isOptionEnabled(). + +

void TQPrinter::setOrientation ( Orientation orientation ) [virtual] +

+Sets the print orientation to orientation. +

The orientation can be either TQPrinter::Portrait or TQPrinter::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 TQPrinter::setup()). +

Windows only! This option can be changed while printing and will +take effect from the next call to newPage() +

See also orientation(). + +

void TQPrinter::setOutputFileName ( const TQString & fileName ) [virtual] +

+Sets the name of the output file to fileName. +

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

void TQPrinter::setOutputToFile ( bool enable ) [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 and Mac OS X. +

See also outputToFile() and setOutputFileName(). + +

void TQPrinter::setPageOrder ( PageOrder newPageOrder ) [virtual] +

+Sets the page order to newPageOrder. +

The page order can be TQPrinter::FirstPageFirst or TQPrinter::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(). +

Bugs and limitations: +

+

void TQPrinter::setPageSize ( PageSize newPageSize ) [virtual] +

+Sets the printer page size to newPageSize if that size is +supported. The result if undefined if newPageSize is not +supported. +

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

void TQPrinter::setPaperSource ( PaperSource source ) [virtual] +

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

See also paperSource(). + +

void TQPrinter::setPrintProgram ( const TQString & printProg ) [virtual] +

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

See also printProgram(). + +

void TQPrinter::setPrintRange ( PrintRange range ) +

+Sets the default selected page range to be used when the print setup +dialog is opened to range. If the PageRange specified by range is +currently disabled the function does nothing. +

See also printRange(). + +

void TQPrinter::setPrinterName ( const TQString & name ) [virtual] +

+Sets the printer name to 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(). + +

void TQPrinter::setPrinterSelectionOption ( const TQString & option ) [virtual] +

+Sets the printer to use option to select the printer. option +is null by default (which implies that TQt should be smart enough +to guess correctly), but it 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. +

See also printerSelectionOption(). + +

void TQPrinter::setResolution ( int dpi ) [virtual] +

+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, TQPaintDeviceMetrics and TQPainter::viewport(). +

The value depends on the PrintingMode used in the TQPrinter +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(). + +

void TQPrinter::setWinPageSize ( short winPageSize ) +

+Windows only, using this function is not portable! +Sets the windows page size value that is used by the DEVMODE +struct. The winPageSize value must be one of the DMPAPER_ defines +from wingdi.h. + +

bool TQPrinter::setup ( TQWidget * parent = 0 ) +

+Opens a printer setup dialog, with parent parent, and asks the +user to specify which printer they wish to use and what settings +it should have. +

Returns TRUE if the user pressed "OK" to print, or FALSE if the +user canceled the operation. + +

Examples: action/application.cpp, application/application.cpp, drawdemo/drawdemo.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. +

int TQPrinter::toPage () const +

+ +

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

short TQPrinter::winPageSize () const +

+Returns the Windows page size value as used by the DEVMODE +struct (Windows only). Using this function is not portable. +

Use pageSize() to get the PageSize, e.g. 'A4', 'Letter', etc. + + +

+This file is part of the TQt toolkit. +Copyright © 1995-2007 +Trolltech. All Rights Reserved.

+ +
Copyright © 2007 +TrolltechTrademarks +
TQt 3.3.8
+
+ -- cgit v1.2.1