QPrinter Class

Documentation des fonctions membres

[explicit] QPrinter::QPrinter(QPrinter::PrinterMode mode = ScreenResolution)

Crée un nouvel objet imprimante avec l'adresse mode.

[explicit] QPrinter::QPrinter(const QPrinterInfo &printer, QPrinter::PrinterMode mode = ScreenResolution)

Crée un nouvel objet imprimante avec les données printer et mode.

[virtual noexcept] QPrinter::~QPrinter()

Détruit l'objet imprimante et libère les ressources allouées. Si l'imprimante est détruite alors qu'un travail d'impression est en cours, cela peut ou non affecter le travail d'impression.

bool QPrinter::abort()

Abandonne l'impression en cours. Renvoie true si l'impression a été interrompue avec succès et printerState() renvoie QPrinter::Aborted; sinon, false.

Il n'est pas toujours possible d'interrompre un travail d'impression. Par exemple, toutes les données ont été envoyées à l'imprimante, mais celle-ci ne peut pas ou ne veut pas annuler le travail lorsqu'on le lui demande.

bool QPrinter::collateCopies() const

Renvoie true si la collation est activée lorsque plusieurs copies sont sélectionnées. Renvoie false s'il est désactivé lorsque l'option "copies multiples" est sélectionnée. Lorsque l'assemblage est désactivé, l'impression de chaque page individuelle sera répétée de la quantité numCopies() avant que la page suivante ne soit lancée. Lorsque l'assemblage est activé, toutes les pages sont imprimées avant que la copie suivante de ces pages ne commence.

Voir également setCollateCopies().

QPrinter::ColorMode QPrinter::colorMode() const

Renvoie le mode de couleur actuel.

Voir aussi setColorMode().

int QPrinter::copyCount() const

Renvoie le nombre de copies qui seront imprimées. La valeur par défaut est 1.

Voir aussi setCopyCount() et supportsMultipleCopies().

QString QPrinter::creator() const

Renvoie le nom de l'application qui a créé le document.

Voir aussi setCreator().

QString QPrinter::docName() const

Renvoie le nom du document.

Voir aussi setDocName() et QPrintEngine::PrintEnginePropertyKey.

QPrinter::DuplexMode QPrinter::duplex() const

Renvoie le mode duplex actuel.

Voir aussi setDuplex().

bool QPrinter::fontEmbeddingEnabled() const

Renvoie true si l'intégration des polices est activée.

Voir aussi setFontEmbeddingEnabled().

int QPrinter::fromPage() const

Renvoie le numéro de la première page d'une série de pages à imprimer (paramètre "à partir de la page"). Les pages d'un document sont numérotées selon la convention suivante : la première page est la page 1.

Par défaut, cette fonction renvoie une valeur spéciale de 0, ce qui signifie que le paramètre "from page" n'est pas défini.

Voir également setFromTo(), toPage() et pageRanges().

bool QPrinter::fullPage() const

Renvoie true si l'origine du système de coordonnées de l'imprimante se trouve au coin de la page et false si elle se trouve au bord de la zone imprimable.

Voir setFullPage() pour plus de détails et d'avertissements.

Voir aussi setFullPage() et QPagedPaintDevice::pageLayout().

bool QPrinter::isValid() const

Renvoie true si l'imprimante sélectionnée est une imprimante valide dans le système ou une imprimante purement PDF ; sinon, renvoie false.

Pour détecter d'autres échecs, vérifiez la sortie de QPainter::begin() ou QPrinter::newPage().

    QPrinter printer ; printer.setOutputFormat(QPrinter::PdfFormat) ; printer.setOutputFileName("/foobar/nonwritable.pdf") ; QPainter painter ; if (! painter.begin(&printer)) { // échec de l'ouverture du fichier        qWarning("failed to open file, is it writable?");
       return 1; } painter.drawText(10, 10, "Test") ; if (! printer.newPage()) {        qWarning("failed in flushing page to disk, disk full?");
       return 1; } painter.drawText(10, 10, "Test 2") ; painter.end() ;

Voir aussi setPrinterName().

[override virtual] bool QPrinter::newPage()

Réimplémente : QPagedPaintDevice::newPage().

Indique à l'imprimante d'éjecter la page en cours et de poursuivre l'impression sur une nouvelle page. Renvoie true si l'opération est réussie, sinon false.

L'appel à newPage() sur un objet QPrinter inactif échouera toujours.

QString QPrinter::outputFileName() const

Renvoie le nom du fichier de sortie. Par défaut, il s'agit d'une chaîne vide (indiquant que l'imprimante ne doit pas imprimer dans le fichier).

Voir aussi setOutputFileName() et QPrintEngine::PrintEnginePropertyKey.

QPrinter::OutputFormat QPrinter::outputFormat() const

Renvoie le format de sortie de cette imprimante.

Voir aussi setOutputFormat().

QPrinter::PageOrder QPrinter::pageOrder() const

Renvoie l'ordre actuel des pages.

L'ordre des pages par défaut est FirstPageFirst.

Voir aussi setPageOrder().

QRectF QPrinter::pageRect(QPrinter::Unit unit) const

Renvoie le rectangle de la page en unit; il est généralement plus petit que paperRect() car la page a normalement des marges entre ses bords et le papier.

Voir aussi QPagedPaintDevice::pageLayout().

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

Réimplémente : QPaintDevice::paintEngine() const.

Renvoie le moteur de peinture utilisé par l'imprimante.

QRectF QPrinter::paperRect(QPrinter::Unit unit) const

Renvoie le rectangle du papier en unit; il est généralement plus grand que pageRect().

Voir aussi pageRect().

QPrinter::PaperSource QPrinter::paperSource() const

Renvoie la source de papier de l'imprimante. Il s'agit de Manual ou d'un bac d'imprimante ou d'une cassette papier.

Voir également setPaperSource().

QPagedPaintDevice::PdfVersion QPrinter::pdfVersion() const

Renvoie la version PDF de cette imprimante. La valeur par défaut est PdfVersion_1_4.

Voir aussi setPdfVersion().

QPrintEngine *QPrinter::printEngine() const

Renvoie le moteur d'impression utilisé par l'imprimante.

QString QPrinter::printProgram() const

Renvoie le nom du programme qui envoie les données d'impression à l'imprimante.

La valeur par défaut est une chaîne vide, ce qui signifie que QPrinter essaiera d'être intelligent d'une manière qui dépend du système. Sur X11 uniquement, vous pouvez lui donner une valeur différente pour utiliser un programme d'impression spécifique. Sur les autres plates-formes, cette option renvoie une chaîne vide.

Voir aussi setPrintProgram() et setPrinterSelectionOption().

QPrinter::PrintRange QPrinter::printRange() const

Renvoie la plage de pages du site QPrinter. Après l'ouverture de la boîte de dialogue de configuration de l'impression, cette fonction renvoie la valeur sélectionnée par l'utilisateur.

Voir également setPrintRange().

QString QPrinter::printerName() const

Renvoie le nom de l'imprimante. Cette valeur est initialement définie sur le nom de l'imprimante par défaut.

Voir aussi setPrinterName().

QString QPrinter::printerSelectionOption() const

Renvoie la chaîne de sélection des options d'impression. Ceci n'est utile que si la commande d'impression a été explicitement définie.

La valeur par défaut (une chaîne vide) implique que l'imprimante doit être sélectionnée en fonction du système.

Toute autre valeur implique que la valeur donnée doit être utilisée.

Cette fonction renvoie toujours une chaîne vide sous Windows et Mac.

Voir aussi setPrinterSelectionOption() et setPrintProgram().

QPrinter::PrinterState QPrinter::printerState() const

Renvoie l'état actuel de l'imprimante. Cet état n'est pas toujours exact (par exemple, si l'imprimante n'est pas en mesure de communiquer son état au système d'exploitation).

int QPrinter::resolution() const

Renvoie la résolution supposée actuelle de l'imprimante, telle que définie par setResolution() ou par le pilote d'imprimante.

Voir aussi setResolution().

void QPrinter::setCollateCopies(bool collate)

Définit la valeur par défaut de la case à cocher Collation lors de l'affichage de la boîte de dialogue d'impression. Si collate est vrai, la fonction setCollateCopiesEnabled() sera activée. La valeur par défaut est false. Cette valeur sera modifiée par ce que l'utilisateur appuie dans la boîte de dialogue d'impression.

Voir également collateCopies().

void QPrinter::setColorMode(QPrinter::ColorMode newColorMode)

Définit le mode couleur de l'imprimante sur newColorMode, qui peut être Color ou GrayScale.

Voir également colorMode().

void QPrinter::setCopyCount(int count)

Définit le nombre de copies à imprimer sur count.

Le pilote d'imprimante lit ce paramètre et imprime le nombre de copies spécifié.

Voir également copyCount() et supportsMultipleCopies().

void QPrinter::setCreator(const QString &creator)

Définit le nom de l'application qui a créé le document à creator.

Cette fonction ne s'applique qu'à la version X11 de Qt. Si aucun nom de créateur n'est spécifié, le créateur sera "Qt" suivi d'un numéro de version.

Voir aussi creator().

void QPrinter::setDocName(const QString &name)

Définit le nom du document à name.

Sous X11, le nom du document est par exemple utilisé comme nom de fichier de sortie par défaut dans QPrintDialog. Notez que le nom du document n'affecte pas le nom du fichier si l'imprimante imprime vers un fichier. Pour cela, utilisez la fonction setOutputFile().

Voir également docName() et QPrintEngine::PrintEnginePropertyKey.

void QPrinter::setDuplex(QPrinter::DuplexMode duplex)

Active l'impression recto-verso en fonction du mode duplex.

Voir aussi duplex().

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

Cette fonction est utilisée par les sous-classes de QPrinter pour spécifier des moteurs d'impression et de peinture personnalisés (printEngine et paintEngine, respectivement).

QPrinter n'est pas propriétaire des moteurs, vous devez donc gérer ces instances de moteurs vous-même.

Notez que le changement de moteur réinitialise l'état de l'imprimante et toutes ses propriétés.

Voir également printEngine(), paintEngine() et setOutputFormat().

void QPrinter::setFontEmbeddingEnabled(bool enable)

Active ou désactive l'intégration des polices en fonction de enable.

Voir aussi fontEmbeddingEnabled().

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

Définit la plage de pages à imprimer pour couvrir les pages dont les numéros sont spécifiés par from et to, où from correspond à la première page de la plage et to à la dernière.

Cette fonction est principalement utilisée pour définir une valeur par défaut que l'utilisateur peut remplacer dans la boîte de dialogue d'impression lorsque vous appelez setup().

Voir également fromPage(), toPage() et pageRanges().

void QPrinter::setFullPage(bool fp)

Si fp est vrai, cela permet de peindre sur toute la page ; sinon, cela limite la peinture à la zone imprimable indiquée par le périphérique.

Par défaut, l'impression sur toute la page est désactivée. Dans ce cas, l'origine du système de coordonnées de QPrinter coïncide avec le coin supérieur gauche de la zone imprimable.

Si l'impression pleine page est activée, l'origine du système de coordonnées de QPrinter coïncide avec le coin supérieur gauche du papier lui-même. Dans ce cas, le site device metrics indiquera exactement les mêmes dimensions que celles indiquées par {QPageSize}. Il se peut qu'il ne soit pas possible d'imprimer sur la totalité de la page physique en raison des marges de l'imprimante, de sorte que l'application doit tenir compte des marges elle-même.

Voir également fullPage(), QPagedPaintDevice::pageLayout() et QPagedPaintDevice::setPageSize().

void QPrinter::setOutputFileName(const QString &fileName)

Définit le nom du fichier de sortie à fileName.

La définition d'un nom nul ou vide (0 ou "") désactive l'impression vers un fichier. La définition d'un nom non vide permet d'imprimer dans un fichier.

Cela peut modifier la valeur de outputFormat(). Si le nom du fichier a le suffixe ".pdf", le PDF est généré. Si le nom du fichier a un suffixe autre que ".pdf", le format de sortie utilisé est celui défini avec setOutputFormat().

QPrinter utilise respectivement les moteurs d'impression PDF multiplateforme de Qt PDF. Si vous pouvez produire ce format nativement, par exemple macOS peut générer des PDF à partir de son moteur d'impression, redéfinissez le format de sortie à NativeFormat.

Voir également outputFileName() et setOutputFormat().

void QPrinter::setOutputFormat(QPrinter::OutputFormat format)

Définit le format de sortie de cette imprimante à format.

Si format est la même valeur que celle actuellement définie, aucune modification ne sera apportée.

Si format est NativeFormat, l'imprimante par défaut sera printerName. Si aucune imprimante valide n'est configurée, aucune modification ne sera apportée. Si vous souhaitez associer NativeFormat à une imprimante spécifique ( printerName ), utilisez setPrinterName().

Voir également outputFormat() et setPrinterName().

void QPrinter::setPageOrder(QPrinter::PageOrder pageOrder)

Définit l'ordre des pages à pageOrder.

L'ordre des pages peut être QPrinter::FirstPageFirst ou QPrinter::LastPageFirst. L'application est responsable de la lecture de l'ordre des pages et de l'impression en conséquence.

Cette fonction est surtout utile pour définir une valeur par défaut que l'utilisateur peut remplacer dans la boîte de dialogue d'impression.

Cette fonction n'est supportée que sous X11.

Voir également pageOrder().

void QPrinter::setPaperSource(QPrinter::PaperSource source)

Définit le paramètre de la source de papier sur source.

Windows uniquement : Cette option peut être modifiée pendant l'impression et prendra effet lors du prochain appel à newPage().

Voir également paperSource().

void QPrinter::setPdfVersion(QPagedPaintDevice::PdfVersion version)

Définit la version PDF pour cette imprimante à version.

Si version est la même valeur que celle actuellement définie, aucune modification ne sera apportée.

Voir également pdfVersion().

void QPrinter::setPrintProgram(const QString &printProg)

Définit le nom du programme qui doit effectuer le travail d'impression à printProg.

Sur X11, cette fonction définit le programme à appeler avec la sortie PDF. Sur les autres plateformes, elle n'a aucun effet.

Voir aussi printProgram().

void QPrinter::setPrintRange(QPrinter::PrintRange range)

Définit l'option d'intervalle d'impression in comme étant range.

Voir aussi printRange().

void QPrinter::setPrinterName(const QString &name)

Définit le nom de l'imprimante à name.

Si name est vide, le format de sortie sera défini sur PdfFormat.

Si name n'est pas une imprimante valide, aucun changement ne sera effectué.

Si name est une imprimante valide, le format de sortie sera défini sur NativeFormat.

Voir aussi printerName(), isValid() et setOutputFormat().

void QPrinter::setPrinterSelectionOption(const QString &option)

Configure l'imprimante pour qu'elle utilise option pour sélectionner l'imprimante. option est nul par défaut (ce qui implique que Qt devrait être assez intelligent pour deviner correctement), mais il peut être défini à d'autres valeurs pour utiliser une option de sélection d'imprimante spécifique.

Si l'option de sélection de l'imprimante est modifiée alors que l'imprimante est active, le travail d'impression en cours peut être affecté ou non.

Cette fonction n'a aucun effet sur Windows ou Mac.

Voir également printerSelectionOption() et setPrintProgram().

void QPrinter::setResolution(int dpi)

Demande que l'imprimante imprime à dpi ou le plus près possible de dpi.

Ce paramètre affecte le système de coordonnées renvoyé, par exemple, par QPainter::viewport().

Cette fonction doit être appelée avant QPainter::begin() pour avoir un effet sur toutes les plates-formes.

Voir aussi resolution() et QPagedPaintDevice::setPageSize().

QList<QPrinter::PaperSource> QPrinter::supportedPaperSources() const

Renvoie les formats de papier pris en charge par cette imprimante.

Les valeurs seront soit une valeur correspondant à une entrée de l'enum QPrinter::PaperSource, soit une valeur spécifique au pilote. Les valeurs spécifiques au pilote sont supérieures à la constante DMBIN_USER déclarée dans wingdi.h.

QList<int> QPrinter::supportedResolutions() const

Renvoie une liste des résolutions (une liste de nombres entiers de points par pouce) que l'imprimante dit prendre en charge.

Pour X11, où toutes les impressions se font directement au format PDF, cette fonction renvoie toujours une liste d'un seul élément contenant uniquement la résolution PDF, c'est-à-dire 72 (72 ppp - mais voir PrinterMode).

bool QPrinter::supportsMultipleCopies() const

Renvoie true si l'imprimante prend en charge l'impression de plusieurs copies du même document en un seul travail ; sinon, elle renvoie false.

Sur la plupart des systèmes, cette fonction renvoie true. Cependant, sur les systèmes X11 qui ne prennent pas en charge CUPS, cette fonction renvoie false. Cela signifie que l'application doit gérer le nombre de copies en imprimant le même document le nombre de fois requis.

Voir aussi setCopyCount() et copyCount().

int QPrinter::toPage() const

Renvoie le numéro de la dernière page d'une série de pages à imprimer (paramètre "à la page"). Les pages d'un document sont numérotées selon la convention suivante : la première page est la page 1.

Par défaut, cette fonction renvoie une valeur spéciale de 0, ce qui signifie que le paramètre "to page" n'est pas défini.

Le programmeur est responsable de la lecture de ce paramètre et de l'impression en conséquence.

Voir également setFromTo(), fromPage() et pageRanges().