Viadeo Twitter Google Bookmarks ! Facebook Digg del.icio.us MySpace Yahoo MyWeb Blinklist Netvouz Reddit Simpy StumbleUpon Bookmarks Windows Live Favorites 
Logo Documentation Qt ·  Page d'accueil  ·  Toutes les classes  ·  Classes principales  ·  Annotées  ·  Classes groupées  ·  Modules  ·  Fonctions  · 

QPrinter Class Reference
[QtGui module]

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

#include <QPrinter>

Inherits QPaintDevice.

Public Types

Public Functions

Protected Functions

  • void setEngines ( QPrintEngine * printEngine, QPaintEngine * paintEngine )

Detailed Description

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

On Windows or Mac OS X, QPrinter uses the built-in printer drivers. On X11, QPrinter generates postscript and sends that to lpr, lp, or another printProgram(). QPrinter can also print to any other QPrintEngine.

QPrinter is used in much the same way as QWidget and QPixmap are used. The big difference is that you must keep track of pages.

QPrinter supports a number of settable parameters, most of which can be changed by the end user through a QAbstractPrintDialog 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.
  • setPageSize() tells QPrinter what page 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. The default is false, so that by default you should be able to paint on (0,0). If true the origin of the coordinate system will be in the top left corner of the paper and most probably the printer will not be able to paint something there due to its physical margins.
  • setNumCopies() tells QPrinter how many copies of the document it should print.

Many of the settable functions can only be called before the actual printing begins (i.e., before QPainter::begin() is called). This usually makes sense (e.g., you can't 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.

Once you start printing, calling newPage() is essential. You will probably also need to look at the device metrics for the printer.

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.

If your current locale converts "," to ".", you will need to set a locale that doesn't do this (e.g. the "C" locale) before using QPrinter.


Member Type Documentation

enum QPrinter::ColorMode

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

ConstantValueDescription
QPrinter::Color1print in color if available, otherwise in grayscale.
QPrinter::GrayScale0print in grayscale, even on color printers.

enum QPrinter::Orientation

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

ConstantValueDescription
QPrinter::Portrait0the page's height is greater than its width.
QPrinter::Landscape1the 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.

enum QPrinter::OutputFormat

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

ConstantValueDescription
QPrinter::NativeFormat0QPrinter will print output in the method given by the platform it is running on, e.g. This is how printing was traditionally done in Qt. This mode is the default.
QPrinter::PdfFormat1QPrinter will generate its output as a PDF file. As of Qt 4.1.3 PDF files generated by Qt are searchable on all platforms.

enum QPrinter::PageOrder

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

ConstantValueDescription
QPrinter::FirstPageFirst0the lowest-numbered page should be printed first.
QPrinter::LastPageFirst1the highest-numbered page should be printed first.

enum QPrinter::PageSize

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:

ConstantValueDescription
QPrinter::A05841 x 1189 mm
QPrinter::A16594 x 841 mm
QPrinter::A27420 x 594 mm
QPrinter::A38297 x 420 mm
QPrinter::A40210 x 297 mm, 8.26 x 11.69 inches
QPrinter::A59148 x 210 mm
QPrinter::A610105 x 148 mm
QPrinter::A71174 x 105 mm
QPrinter::A81252 x 74 mm
QPrinter::A91337 x 52 mm
QPrinter::B0141030 x 1456 mm
QPrinter::B115728 x 1030 mm
QPrinter::B101632 x 45 mm
QPrinter::B217515 x 728 mm
QPrinter::B318364 x 515 mm
QPrinter::B419257 x 364 mm
QPrinter::B51182 x 257 mm, 7.17 x 10.13 inches
QPrinter::B620128 x 182 mm
QPrinter::B72191 x 128 mm
QPrinter::B82264 x 91 mm
QPrinter::B92345 x 64 mm
QPrinter::C5E24163 x 229 mm
QPrinter::Comm10E25105 x 241 mm, U.S. Common 10 Envelope
QPrinter::DLE26110 x 220 mm
QPrinter::Executive47.5 x 10 inches, 191 x 254 mm
QPrinter::Folio27210 x 330 mm
QPrinter::Ledger28432 x 279 mm
QPrinter::Legal38.5 x 14 inches, 216 x 356 mm
QPrinter::Letter28.5 x 11 inches, 216 x 279 mm
QPrinter::Tabloid29279 x 432 mm
QPrinter::Custom30Unknown size

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

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

ConstantValue
QPrinter::OnlyOne0
QPrinter::Lower1
QPrinter::Middle2
QPrinter::Manual3
QPrinter::Envelope4
QPrinter::EnvelopeManual5
QPrinter::Auto6
QPrinter::Tractor7
QPrinter::SmallFormat8
QPrinter::LargeFormat9
QPrinter::LargeCapacity10
QPrinter::Cassette11
QPrinter::FormSource12

enum QPrinter::PrintRange

Used to specify the print range selection option.

ConstantValueDescription
QPrinter::AllPages0All pages should be printed.
QPrinter::Selection1Only the selection should be printed.
QPrinter::PageRange2The specified page range should be printed.

See also QAbstractPrintDialog::PrintRange.

enum QPrinter::PrinterMode

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

ConstantValueDescription
QPrinter::ScreenResolution0Sets 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.
QPrinter::PrinterResolution1This 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.
QPrinter::HighResolution2Use printer resolution on Windows, and set the resolution of the Postscript driver to 600dpi.

enum QPrinter::PrinterState

ConstantValue
QPrinter::Idle0
QPrinter::Active1
QPrinter::Aborted2
QPrinter::Error3


Member Function Documentation

QPrinter::QPrinter ( PrinterMode mode = ScreenResolution )

Creates a new printer object with the given mode.

QPrinter::~QPrinter ()

Destroys the printer object and frees any allocated resources. If the printer is destroyed while a print job is in progress this may or may not affect the print job.

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

bool QPrinter::collateCopies () const

Returns true if collation is turned on when multiple copies is selected. Returns false if it is turned off when multiple copies is selected.

This function was introduced in Qt 4.1.

See also setCollateCopies().

ColorMode QPrinter::colorMode () const

Returns the current color mode.

See also setColorMode().

QString QPrinter::creator () const

Returns the name of the application that created the document.

See also setCreator().

QString QPrinter::docName () const

Returns the document name.

See also setDocName().

bool QPrinter::fontEmbeddingEnabled () const

Returns true is font embedding is enabled.

Currently this option is only supported on X11.

This function was introduced in Qt 4.1.

See also setFontEmbeddingEnabled().

int QPrinter::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'.

This function was introduced in Qt 4.1.

See also setFromTo() and toPage().

bool QPrinter::fullPage () const

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.

See also setFullPage() and PageSize.

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

int QPrinter::numCopies () const

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

On Windows and Mac OS X, 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.

See also setNumCopies().

Orientation QPrinter::orientation () const

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

See also setOrientation().

QString QPrinter::outputFileName () const

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

See also setOutputFileName().

OutputFormat QPrinter::outputFormat () const

Returns the output format for this printer

This function was introduced in Qt 4.1.

See also setOutputFormat().

PageOrder QPrinter::pageOrder () const

Returns the current page order.

The default page order is FirstPageFirst.

See also setPageOrder().

QRect QPrinter::pageRect () const

Returns the page's rectangle; this is usually smaller than the paperRect() since the page normally has margins between its borders and the paper.

See also pageSize().

PageSize QPrinter::pageSize () const

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

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

QPaintEngine * QPrinter::paintEngine () const   [virtual]

Returns the paint engine used by the printer.

Reimplemented from QPaintDevice.

QRect QPrinter::paperRect () const

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

See also pageRect().

PaperSource QPrinter::paperSource () const

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

See also setPaperSource().

QPrintEngine * QPrinter::printEngine () const

Returns the print engine used by the printer.

This function was introduced in Qt 4.1.

QString QPrinter::printProgram () const

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.

See also setPrintProgram() and setPrinterSelectionOption().

PrintRange QPrinter::printRange () const

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.

See also setPrintRange().

QString QPrinter::printerName () const

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

See also setPrinterName().

QString QPrinter::printerSelectionOption () const

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

The default value (an empty string) implies that the printer should be selected in a system-dependent manner.

Any other value implies that the given value should be used.

Warning: This function is not available on Windows.

See also setPrinterSelectionOption().

PrinterState QPrinter::printerState () const

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

int QPrinter::resolution () const

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

See also setResolution().

void QPrinter::setCollateCopies ( bool collate )

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.

See also collateCopies().

void QPrinter::setColorMode ( ColorMode newColorMode )

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

See also colorMode().

void QPrinter::setCreator ( const QString & creator )

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.

See also creator().

void QPrinter::setDocName ( const QString & name )

Sets the document name to name.

See also docName().

void QPrinter::setEngines ( QPrintEngine * printEngine, QPaintEngine * paintEngine )   [protected]

This function is used by subclasses of QPrinter to specify custom print engine and paint engine.

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

void QPrinter::setFontEmbeddingEnabled ( bool enable )

Enabled or disables font embedding depending on enable.

Currently this option is only supported on X11.

This function was introduced in Qt 4.1.

See also fontEmbeddingEnabled().

void QPrinter::setFromTo ( int from, int to )

Sets the from-page and to-page settings to from and to respectively.

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

If from and to 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().

This function was introduced in Qt 4.1.

See also fromPage() and toPage().

void QPrinter::setFullPage ( bool fp )

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 the device metrics 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 fp is true, the device metrics will report the exact same size as indicated by PageSize. It probably isn't possible to print on the entire page because of the printer's physical margins, so the application must account for the margins itself.

See also PageSize, setPageSize(), fullPage(), width(), and height().

void QPrinter::setNumCopies ( int numCopies )

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

void QPrinter::setOrientation ( Orientation orientation )

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 and Mac OS X, this option can be changed while printing and will take effect from the next call to newPage().

See also orientation().

void QPrinter::setOutputFileName ( const QString & fileName )

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.

See also outputFileName() and setOutputToFile().

void QPrinter::setOutputFormat ( OutputFormat format )

Sets the output format for this printer to format.

Setting the output format will reset the state of the printer

This function was introduced in Qt 4.1.

See also outputFormat().

void QPrinter::setPageOrder ( PageOrder pageOrder )

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.

See also pageOrder().

void QPrinter::setPageSize ( PageSize newPageSize )

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 driver-dependent.

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

See also pageSize(), PageSize, setFullPage(), setResolution(), pageRect(), and paperRect().

void QPrinter::setPaperSource ( PaperSource source )

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 QPrinter::setPrintProgram ( const QString & printProg )

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 QPrinter::setPrintRange ( PrintRange range )

Sets the print range option in to be range.

This function was introduced in Qt 4.1.

See also printRange().

void QPrinter::setPrinterName ( const QString & name )

Sets the printer name to name.

See also printerName().

void QPrinter::setPrinterSelectionOption ( const QString & option )

Sets the printer to use option to select the printer. option is null by default (which implies that Qt 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.

Warning: This function is not available on Windows.

See also printerSelectionOption().

void QPrinter::setResolution ( int dpi )

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.

See also resolution() and setPageSize().

void QPrinter::setWinPageSize ( int pageSize )

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

See also winPageSize().

QList<int> QPrinter::supportedResolutions () const

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

int QPrinter::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.

This function was introduced in Qt 4.1.

See also setFromTo() and fromPage().

int QPrinter::winPageSize () const

Returns the page size used by the printer under Windows.

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

See also setWinPageSize().

Publicité

Best Of

Actualités les plus lues

Semaine
Mois
Année
  1. Les développeurs détestent-ils les antivirus ? Un programmeur manifeste sa haine envers ces solutions de sécurité 23
  2. «Le projet de loi des droits du développeur» : quelles conditions doivent remplir les entreprises pour que le développeur puisse réussir ? 39
  3. Une nouvelle ère d'IHM 3D pour les automobiles, un concept proposé par Digia et implémenté avec Qt 3
  4. Qt Creator 2.5 est sorti en beta, l'EDI supporte maintenant plus de fonctionnalités de C++11 2
  5. PySide devient un add-on Qt et rejoint le Qt Project et le modèle d'open gouvernance 1
  6. Vingt sociétés montrent leurs décodeurs basés sur Qt au IPTV World Forum, en en exploitant diverses facettes (déclaratif, Web, widgets) 0
  7. Thread travailleur avec Qt en utilisant les signaux et les slots, un article de Christophe Dumez traduit par Thibaut Cuvelier 1
  1. « Quelque chose ne va vraiment pas avec les développeurs "modernes" », un développeur à "l'ancienne" critique la multiplication des bibliothèques 94
  2. Apercevoir la troisième dimension ou l'utilisation multithreadée d'OpenGL dans Qt, un article des Qt Quarterly traduit par Guillaume Belz 0
  3. Pourquoi les programmeurs sont-ils moins payés que les gestionnaires de programmes ? Manquent-ils de pouvoir de négociation ? 49
  4. Les développeurs ignorent-ils trop les failles découvertes dans leur code ? Prenez-vous en compte les remarques des autres ? 17
  5. Les développeurs détestent-ils les antivirus ? Un programmeur manifeste sa haine envers ces solutions de sécurité 23
  6. Quelles nouveautés de C++11 Visual C++ doit-il rapidement intégrer ? Donnez-nous votre avis 10
  7. Qt Commercial : Digia organise un webinar gratuit le 27 mars sur la conception d'interfaces utilisateur et d'applications avec le framework 0
Page suivante

Le Qt Labs au hasard

Logo

QLocale : à propos du temps (et des dates, et des langues, et des...)

Les Qt Labs sont les laboratoires des développeurs de Qt, où ils peuvent partager des impressions sur le framework, son utilisation, ce que pourrait être son futur. Lire l'article.

Communauté

Ressources

Liens utiles

Contact

  • Vous souhaitez rejoindre la rédaction ou proposer un tutoriel, une traduction, une question... ? Postez dans le forum Contribuez ou contactez-nous par MP ou par email (voir en bas de page).

Qt dans le magazine

Cette page est une traduction d'une page de la documentation de Qt, écrite par Nokia Corporation and/or its subsidiary(-ies). Les éventuels problèmes résultant d'une mauvaise traduction ne sont pas imputables à Nokia. Qt 4.1
Copyright © 2012 Developpez LLC. Tous droits réservés Developpez LLC. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents et images sans l'autorisation expresse de Developpez LLC. Sinon, vous encourez selon la loi jusqu'à 3 ans de prison et jusqu'à 300 000 E de dommages et intérêts. Cette page est déposée à la SACD.
Vous avez déniché une erreur ? Un bug ? Une redirection cassée ? Ou tout autre problème, quel qu'il soit ? Ou bien vous désirez participer à ce projet de traduction ? N'hésitez pas à nous contacter ou par MP !
 
 
 
 
Partenaires

Hébergement Web