QPrinter Class

Dokumentation der Mitgliedsfunktionen

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

Erstellt ein neues Druckerobjekt mit dem angegebenen „ mode “.

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

Erstellt ein neues Druckerobjekt mit den angegebenen Werten für „ printer “ und „ mode “.

[virtual noexcept] QPrinter::~QPrinter()

Löscht das Druckerobjekt und gibt alle zugewiesenen Ressourcen frei. Wird der Drucker gelöscht, während ein Druckauftrag ausgeführt wird, kann dies Auswirkungen auf den Druckauftrag haben oder auch nicht.

bool QPrinter::abort()

Bricht den aktuellen Druckvorgang ab. Gibt „ true “ zurück, wenn der Druckvorgang erfolgreich abgebrochen wurde, und „ printerState()“ gibt „ QPrinter::Aborted “ zurück; andernfalls wird „ false “ zurückgegeben.

Es ist nicht immer möglich, einen Druckauftrag abzubrechen. Beispielsweise wurden bereits alle Daten an den Drucker gesendet, aber der Drucker kann oder will den Auftrag auf Anfrage nicht abbrechen.

bool QPrinter::collateCopies() const

Gibt „ true “ zurück, wenn die Sortierfunktion aktiviert ist und „Multiple Copies“ ausgewählt wurde. Gibt „ false “ zurück, wenn sie deaktiviert ist und „Multiple Copies“ ausgewählt wurde. Bei deaktivierter Sortierfunktion wird jede einzelne Seite die durch „numCopies()“ angegebene Anzahl an Malen gedruckt, bevor mit der nächsten Seite begonnen wird. Bei aktivierter Sortierfunktion werden alle Seiten gedruckt, bevor mit der nächsten Kopie dieser Seiten begonnen wird.

Siehe auch setCollateCopies().

QPrinter::ColorMode QPrinter::colorMode() const

Gibt den aktuellen Farbmodus zurück.

Siehe auch „ setColorMode()“.

int QPrinter::copyCount() const

Gibt die Anzahl der zu druckenden Exemplare zurück. Der Standardwert ist 1.

Siehe auch setCopyCount() und supportsMultipleCopies().

QString QPrinter::creator() const

Gibt den Namen der Anwendung zurück, die das Dokument erstellt hat.

Siehe auch „ setCreator()“.

QString QPrinter::docName() const

Gibt den Dokumentnamen zurück.

Siehe auch setDocName() und QPrintEngine::PrintEnginePropertyKey.

QPrinter::DuplexMode QPrinter::duplex() const

Gibt den aktuellen Duplex-Modus zurück.

Siehe auch „ setDuplex()“.

bool QPrinter::fontEmbeddingEnabled() const

Gibt „ true “ zurück, wenn die Schriftarteneinbettung aktiviert ist.

Siehe auch setFontEmbeddingEnabled().

int QPrinter::fromPage() const

Gibt die Nummer der ersten Seite in einem zu druckenden Seitenbereich zurück (die Einstellung „Startseite“). Die Seiten in einem Dokument werden nach der Konvention nummeriert, dass die erste Seite die Seite 1 ist.

Standardmäßig gibt diese Funktion den Sonderwert 0 zurück, was bedeutet, dass die Einstellung „Startseite“ nicht festgelegt ist.

Siehe auch setFromTo(), toPage() und pageRanges().

bool QPrinter::fullPage() const

Gibt „ true “ zurück, wenn der Ursprung des Koordinatensystems des Druckers an der Ecke der Seite liegt, und „false“, wenn er am Rand des druckbaren Bereichs liegt.

Einzelheiten und Hinweise finden Sie unter „ setFullPage()“.

Siehe auch „ setFullPage()“ und „ QPagedPaintDevice::pageLayout()“.

bool QPrinter::isValid() const

Gibt „ true “ zurück, wenn der aktuell ausgewählte Drucker ein gültiger Drucker im System oder ein reiner PDF-Drucker ist; andernfalls wird „ false “ zurückgegeben.

Um weitere Fehler zu erkennen, überprüfen Sie die Ausgabe von ` QPainter::begin()` oder ` QPrinter::newPage()`.

    QPrinter printer;
    printer.setOutputFormat(QPrinter::PdfFormat);
    printer.setOutputFileName("/foobar/nonwritable.pdf");
    QPainter painter;
    if (! painter.begin(&printer)) { // Datei konnte nicht geöffnet werden
        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();

Siehe auch setPrinterName().

[override virtual] bool QPrinter::newPage()

Implementiert: QPagedPaintDevice::newPage().

Weist den Drucker an, die aktuelle Seite auszugeben und den Druckvorgang auf einer neuen Seite fortzusetzen. Gibt „ true “ zurück, wenn dies erfolgreich war; andernfalls wird „ false “ zurückgegeben.

Der Aufruf von `newPage()` bei einem inaktiven ` QPrinter `-Objekt schlägt immer fehl.

QString QPrinter::outputFileName() const

Gibt den Namen der Ausgabedatei zurück. Standardmäßig ist dies eine leere Zeichenkette (was bedeutet, dass der Drucker nicht in eine Datei drucken soll).

Siehe auch setOutputFileName() und QPrintEngine::PrintEnginePropertyKey.

QPrinter::OutputFormat QPrinter::outputFormat() const

Gibt das Ausgabeformat für diesen Drucker zurück.

Siehe auch setOutputFormat().

QPrinter::PageOrder QPrinter::pageOrder() const

Gibt die aktuelle Seitenreihenfolge zurück.

Die Standard-Seitenreihenfolge lautet „ FirstPageFirst “.

Siehe auch ` setPageOrder()`.

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

Gibt das Rechteck der Seite in „ unit “ zurück; dieses ist in der Regel kleiner als das von „ paperRect()“, da die Seite normalerweise Ränder zwischen ihren Begrenzungen und dem Papier aufweist.

Siehe auch ` QPagedPaintDevice::pageLayout()`.

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

Implementiert neu: ` QPaintDevice::paintEngine()` const.

Gibt die vom Drucker verwendete Zeichen-Engine zurück.

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

Gibt das Rechteck des Papiers in ` unit` zurück; dieses ist in der Regel größer als das von ` pageRect()`.

Siehe auch ` pageRect()`.

QPrinter::PaperSource QPrinter::paperSource() const

Gibt die Papierquelle des Druckers zurück. Dies ist entweder „ Manual “ oder ein Druckerfach bzw. eine Papierkassette.

Siehe auch „ setPaperSource()“.

QPagedPaintDevice::PdfVersion QPrinter::pdfVersion() const

Gibt die PDF-Version für diesen Drucker zurück. Der Standardwert ist PdfVersion_1_4.

Siehe auch setPdfVersion().

QPrintEngine *QPrinter::printEngine() const

Gibt die vom Drucker verwendete Druck-Engine zurück.

QString QPrinter::printProgram() const

Gibt den Namen des Programms zurück, das die Druckausgabe an den Drucker sendet.

Standardmäßig wird eine leere Zeichenkette zurückgegeben; das bedeutet, dass „ QPrinter “ versucht, sich systemabhängig intelligent zu verhalten. Nur unter X11 können Sie einen anderen Wert festlegen, um ein bestimmtes Druckprogramm zu verwenden. Auf den anderen Plattformen gibt diese Funktion eine leere Zeichenkette zurück.

Siehe auch setPrintProgram() und setPrinterSelectionOption().

QPrinter::PrintRange QPrinter::printRange() const

Gibt den Seitenbereich des „ QPrinter “ zurück. Nachdem der Dialog zum Einrichten des Druckers geöffnet wurde, gibt diese Funktion den vom Benutzer ausgewählten Wert zurück.

Siehe auch setPrintRange().

QString QPrinter::printerName() const

Gibt den Druckernamen zurück. Dieser Wert ist zunächst auf den Namen des Standarddruckers gesetzt.

Siehe auch ` setPrinterName()`.

QString QPrinter::printerSelectionOption() const

Gibt die Zeichenfolge zur Auswahl der Druckeroptionen zurück. Dies ist nur dann sinnvoll, wenn der Druckbefehl explizit festgelegt wurde.

Der Standardwert (eine leere Zeichenkette) bedeutet, dass der Drucker systemabhängig ausgewählt werden soll.

Jeder andere Wert bedeutet, dass der angegebene Wert verwendet werden soll.

Diese Funktion gibt unter Windows und Mac immer eine leere Zeichenkette zurück.

Siehe auch setPrinterSelectionOption() und setPrintProgram().

QPrinter::PrinterState QPrinter::printerState() const

Gibt den aktuellen Status des Druckers zurück. Dieser ist möglicherweise nicht immer korrekt (beispielsweise wenn der Drucker nicht in der Lage ist, seinen Status an das Betriebssystem zu melden).

int QPrinter::resolution() const

Gibt die aktuell vom Drucker verwendete Auflösung zurück, wie sie durch setResolution() oder durch den Druckertreiber festgelegt wurde.

Siehe auch ` setResolution()`.

void QPrinter::setCollateCopies(bool collate)

Legt den Standardwert für das Kontrollkästchen „Sortieren“ fest, wenn der Druckdialog angezeigt wird. Wenn „ collate “ auf „true“ gesetzt ist, wird „setCollateCopiesEnabled()“ aktiviert. Der Standardwert ist „false“. Dieser Wert wird durch die Auswahl des Benutzers im Druckdialog geändert.

Siehe auch collateCopies().

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

Stellt den Farbmodus des Druckers auf „ newColorMode “ ein, wobei dies entweder „ Color “ oder „ GrayScale “ sein kann.

Siehe auch „ colorMode()“.

void QPrinter::setCopyCount(int count)

Legt die Anzahl der zu druckenden Kopien auf „ count “ fest.

Der Druckertreiber liest diese Einstellung aus und druckt die angegebene Anzahl an Kopien.

Siehe auch „ copyCount()“ und „ supportsMultipleCopies()“.

void QPrinter::setCreator(const QString &creator)

Setzt den Namen der Anwendung, die das Dokument erstellt hat, auf „ creator “.

Diese Funktion gilt nur für die X11-Version von Qt. Wenn kein Erstellername angegeben wird, wird als Erstellername „Qt“ gefolgt von einer Versionsnummer gesetzt.

Siehe auch creator().

void QPrinter::setDocName(const QString &name)

Legt den Dokumentnamen auf „ name “ fest.

Unter X11 wird der Dokumentname beispielsweise als Standard-Ausgabedateiname in ` QPrintDialog` verwendet. Beachten Sie, dass der Dokumentname keinen Einfluss auf den Dateinamen hat, wenn der Drucker in eine Datei druckt. Verwenden Sie hierfür die Funktion `setOutputFile()`.

Siehe auch „ docName()“ und „ QPrintEngine::PrintEnginePropertyKey “.

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

Aktiviert den beidseitigen Druck im Modus „ duplex “.

Siehe auch „ duplex“ ().

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

Diese Funktion wird von Unterklassen von ` QPrinter ` verwendet, um benutzerdefinierte Druck- und Zeichen-Engines anzugeben (jeweils `printEngine ` und ` paintEngine`).

QPrinter übernimmt nicht die Verantwortung für die Engines, daher müssen Sie diese Engine-Instanzen selbst verwalten.

Beachten Sie, dass durch das Ändern der Engines der Druckerstatus und alle seine Eigenschaften zurückgesetzt werden.

Siehe auch printEngine(), paintEngine() und setOutputFormat().

void QPrinter::setFontEmbeddingEnabled(bool enable)

Aktiviert oder deaktiviert die Einbettung von Schriftarten je nach enable.

Siehe auch fontEmbeddingEnabled().

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

Legt den zu druckenden Seitenbereich so fest, dass er die Seiten mit den in from und to angegebenen Seitenzahlen umfasst, wobei from der ersten Seite im Bereich und to der letzten Seite entspricht.

Diese Funktion wird hauptsächlich verwendet, um einen Standardwert festzulegen, den der Benutzer im Druckdialog überschreiben kann, wenn Sie setup() aufrufen.

Siehe auch fromPage(), toPage() und pageRanges().

void QPrinter::setFullPage(bool fp)

Wenn „ fp “ auf „true“ gesetzt ist, wird die Unterstützung für das Zeichnen auf der gesamten Seite aktiviert; andernfalls wird das Zeichnen auf den vom Gerät gemeldeten Druckbereich beschränkt.

Standardmäßig ist der Vollseitendruck deaktiviert. In diesem Fall fällt der Ursprung des Koordinatensystems von „ QPrinter “ mit der oberen linken Ecke des druckbaren Bereichs zusammen.

Ist der Vollseitendruck aktiviert, fällt der Ursprung des Koordinatensystems von ` QPrinter` mit der oberen linken Ecke des Papiers selbst zusammen. In diesem Fall meldet der „ device metrics “ genau dieselben Abmessungen wie in {QPageSize} angegeben. Aufgrund der Ränder des Druckers ist es unter Umständen nicht möglich, auf der gesamten physischen Seite zu drucken; daher muss die Anwendung die Ränder selbst berücksichtigen.

Siehe auch fullPage(), QPagedPaintDevice::pageLayout() und QPagedPaintDevice::setPageSize().

void QPrinter::setOutputFileName(const QString &fileName)

Legt den Namen der Ausgabedatei auf „ fileName “ fest.

Die Angabe eines Nullwerts oder eines leeren Namens (0 oder „“) deaktiviert die Ausgabe in eine Datei. Die Angabe eines nicht leeren Namens aktiviert die Ausgabe in eine Datei.

Dies kann den Wert von ` outputFormat()` ändern. Wenn der Dateiname die Endung „.pdf“ hat, wird eine PDF-Datei erzeugt. Wenn der Dateiname eine andere Endung als „.pdf“ hat, wird das Ausgabeformat verwendet, das mit ` setOutputFormat()` festgelegt wurde.

QPrinter verwendet jeweils die plattformübergreifenden PDF-Druck-Engines von Qt PDF. Wenn Sie dieses Format nativ erzeugen können – beispielsweise kann macOS PDFs über seine eigene Druck-Engine generieren –, setzen Sie das Ausgabeformat wieder auf „ NativeFormat “.

Siehe auch outputFileName() und setOutputFormat().

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

Legt das Ausgabeformat für diesen Drucker auf „ format “ fest.

Wenn „ format “ mit dem aktuell eingestellten Wert übereinstimmt, wird keine Änderung vorgenommen.

Wenn „ format “ den Wert „ NativeFormat “ hat, wird „ printerName “ auf den Standarddrucker gesetzt. Sind keine gültigen Drucker konfiguriert, erfolgt keine Änderung. Wenn Sie „ NativeFormat “ mit einem bestimmten „ printerName “ festlegen möchten, verwenden Sie „ setPrinterName()“.

Siehe auch outputFormat() und setPrinterName().

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

Legt die Seitenreihenfolge auf „ pageOrder “ fest.

Die Seitenreihenfolge kann „ QPrinter::FirstPageFirst “ oder „ QPrinter::LastPageFirst “ lauten. Die Anwendung ist dafür verantwortlich, die Seitenreihenfolge auszulesen und entsprechend zu drucken.

Diese Funktion ist vor allem nützlich, um einen Standardwert festzulegen, den der Benutzer im Druckdialog überschreiben kann.

Diese Funktion wird nur unter X11 unterstützt.

Siehe auch pageOrder().

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

Legt die Papierquelle auf „ source “ fest.

Nur Windows: Diese Option kann während des Druckvorgangs geändert werden und wird ab dem nächsten Aufruf von ` newPage()` wirksam.

Siehe auch ` paperSource()`.

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

Legt die PDF-Version für diesen Drucker auf „ version “ fest.

Wenn „ version “ mit dem aktuell eingestellten Wert übereinstimmt, wird keine Änderung vorgenommen.

Siehe auch „ pdfVersion()“.

void QPrinter::setPrintProgram(const QString &printProg)

Legt den Namen des Programms, das den Druckauftrag ausführen soll, auf „ printProg “ fest.

Unter X11 legt diese Funktion das Programm fest, das für die PDF-Ausgabe aufgerufen werden soll. Auf anderen Plattformen hat sie keine Auswirkung.

Siehe auch ` printProgram()`.

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

Legt die Option für den Druckbereich auf „ range “ fest.

Siehe auch ` printRange()`.

void QPrinter::setPrinterName(const QString &name)

Legt den Druckernamen auf „ name “ fest.

Ist „ name “ leer, wird das Ausgabeformat auf „ PdfFormat “ gesetzt.

Ist „ name “ kein gültiger Drucker, wird keine Änderung vorgenommen.

Ist „ name “ ein gültiger Drucker, wird das Ausgabeformat auf „ NativeFormat “ gesetzt.

Siehe auch „ printerName()“, „ isValid()“ und „ setOutputFormat()“.

void QPrinter::setPrinterSelectionOption(const QString &option)

Legt fest, dass der Drucker zur Auswahl die Option „ option “ verwendet. „ option “ ist standardmäßig auf null gesetzt (was bedeutet, dass Qt intelligent genug sein sollte, um die richtige Auswahl zu treffen), kann jedoch auf andere Werte gesetzt werden, um eine bestimmte Option zur Druckerauswahl zu verwenden.

Wird die Druckerauswahloption geändert, während der Drucker aktiv ist, kann dies Auswirkungen auf den aktuellen Druckauftrag haben – muss aber nicht.

Diese Funktion hat unter Windows oder Mac keine Auswirkung.

Siehe auch printerSelectionOption() und setPrintProgram().

void QPrinter::setResolution(int dpi)

Legt fest, dass der Drucker unter dpi oder so nah wie möglich an dpi druckt.

Diese Einstellung wirkt sich auf das Koordinatensystem aus, wie es beispielsweise von QPainter::viewport() zurückgegeben wird.

Diese Funktion muss vor QPainter::begin() aufgerufen werden, um auf allen Plattformen wirksam zu sein.

Siehe auch resolution() und QPagedPaintDevice::setPageSize().

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

Gibt die von diesem Drucker unterstützten Papierformate zurück.

Die Werte entsprechen entweder einem Eintrag in der Enumeration „ QPrinter::PaperSource “ oder einem treiberspezifischen Wert. Die treiberspezifischen Werte sind größer als die in „wingdi.h“ deklarierte Konstante DMBIN_USER.

QList<int> QPrinter::supportedResolutions() const

Gibt eine Liste der Auflösungen (eine Liste von Ganzzahlen in Punkten pro Zoll) zurück, die der Drucker laut eigener Angabe unterstützt.

Bei X11, wo der gesamte Druck direkt in PDF erfolgt, gibt diese Funktion immer eine Liste mit einem Element zurück, die nur die PDF-Auflösung enthält, d. h. 72 (72 dpi – siehe jedoch PrinterMode).

bool QPrinter::supportsMultipleCopies() const

Gibt „ true “ zurück, wenn der Drucker das Drucken mehrerer Kopien desselben Dokuments in einem Druckauftrag unterstützt; andernfalls wird „false“ zurückgegeben.

Auf den meisten Systemen gibt diese Funktion „true“ zurück. Auf X11-Systemen, die CUPS nicht unterstützen, gibt diese Funktion jedoch „false“ zurück. Das bedeutet, dass die Anwendung die Anzahl der Kopien selbst handhaben muss, indem sie dasselbe Dokument so oft wie erforderlich druckt.

Siehe auch setCopyCount() und copyCount().

int QPrinter::toPage() const

Gibt die Nummer der letzten Seite in einem zu druckenden Seitenbereich zurück (die Einstellung „bis Seite“). Die Seiten in einem Dokument werden so nummeriert, dass die erste Seite die Seite 1 ist.

Standardmäßig gibt diese Funktion den Sonderwert 0 zurück, was bedeutet, dass die Einstellung „bis Seite“ nicht festgelegt ist.

Der Programmierer ist dafür verantwortlich, diese Einstellung auszulesen und den Druck entsprechend durchzuführen.

Siehe auch setFromTo(), fromPage() und pageRanges().