<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qabstractprintdialog.cpp --> <title>QAbstractPrintDialog Class | Qt Print Support 5.12.6</title> <link rel="stylesheet" type="text/css" href="style/offline-simple.css" /> <script type="text/javascript"> document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css"); // loading style sheet breaks anchors that were jumped to before // so force jumping to anchor again setTimeout(function() { var anchor = location.hash; // need to jump to different anchor first (e.g. none) location.hash = "#"; setTimeout(function() { location.hash = anchor; }, 0); }, 0); </script> </head> <body> <div class="header" id="qtdocheader"> <div class="main"> <div class="main-rounded"> <div class="navigationbar"> <table><tr> <td >Qt 5.12</td><td ><a href="qtprintsupport-index.html">Qt Print Support</a></td><td ><a href="qtprintsupport-module.html">C++ Classes</a></td><td >QAbstractPrintDialog</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right"><a href="qtprintsupport-index.html">Qt 5.12.6 Reference Documentation</a></td> </tr></table> </div> </div> <div class="content"> <div class="line"> <div class="content mainContent"> <div class="sidebar"> <div class="toc"> <h3><a name="toc">Contents</a></h3> <ul> <li class="level1"><a href="#public-types">Public Types</a></li> <li class="level1"><a href="#public-functions">Public Functions</a></li> <li class="level1"><a href="#reimplemented-public-functions">Reimplemented Public Functions</a></li> <li class="level1"><a href="#static-public-members">Static Public Members</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> </div> <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">QAbstractPrintDialog Class</h1> <!-- $$$QAbstractPrintDialog-brief --> <p>The <a href="qabstractprintdialog.html">QAbstractPrintDialog</a> class provides a base implementation for print dialogs used to configure printers. <a href="#details">More...</a></p> <!-- @@@QAbstractPrintDialog --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QAbstractPrintDialog></span> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += printsupport</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="../qtwidgets/qdialog.html">QDialog</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qprintdialog.html">QPrintDialog</a></p> </td></tr></table></div><ul> <li><a href="qabstractprintdialog-members.html">List of all members, including inherited members</a></li> <li><a href="qabstractprintdialog-obsolete.html">Obsolete members</a></li> </ul> <a name="public-types"></a> <h2 id="public-types">Public Types</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qabstractprintdialog.html#PrintDialogOption-enum">PrintDialogOption</a></b> { None, PrintToFile, PrintSelection, PrintPageRange, ..., DontUseSheet }</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> flags </td><td class="memItemRight bottomAlign"><b><a href="qabstractprintdialog.html#PrintDialogOption-enum">PrintDialogOptions</a></b></td></tr> <tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qabstractprintdialog.html#PrintRange-enum">PrintRange</a></b> { AllPages, Selection, PageRange, CurrentPage }</td></tr> </table></div> <a name="public-functions"></a> <h2 id="public-functions">Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qabstractprintdialog.html#QAbstractPrintDialog">QAbstractPrintDialog</a></b>(QPrinter *<i>printer</i>, QWidget *<i>parent</i> = nullptr)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qabstractprintdialog.html#fromPage">fromPage</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qabstractprintdialog.html#maxPage">maxPage</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qabstractprintdialog.html#minPage">minPage</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QAbstractPrintDialog::PrintRange </td><td class="memItemRight bottomAlign"><b><a href="qabstractprintdialog.html#printRange">printRange</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QPrinter *</td><td class="memItemRight bottomAlign"><b><a href="qabstractprintdialog.html#printer">printer</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractprintdialog.html#setFromTo">setFromTo</a></b>(int <i>from</i>, int <i>to</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractprintdialog.html#setMinMax">setMinMax</a></b>(int <i>min</i>, int <i>max</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractprintdialog.html#setOptionTabs">setOptionTabs</a></b>(const QList<QWidget *> &<i>tabs</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qabstractprintdialog.html#setPrintRange">setPrintRange</a></b>(QAbstractPrintDialog::PrintRange <i>range</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qabstractprintdialog.html#toPage">toPage</a></b>() const</td></tr> </table></div> <a name="reimplemented-public-functions"></a> <h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qabstractprintdialog.html#exec">exec</a></b>() override = 0</td></tr> </table></div> <ul> <li class="fn">8 public functions inherited from <a href="../qtwidgets/qdialog.html#public-functions">QDialog</a></li> <li class="fn">216 public functions inherited from <a href="../qtwidgets/qwidget.html#public-functions">QWidget</a></li> <li class="fn">31 public functions inherited from <a href="../qtcore/qobject.html#public-functions">QObject</a></li> <li class="fn">14 public functions inherited from <a href="../qtgui/qpaintdevice.html#public-functions">QPaintDevice</a></li> </ul> <a name="static-public-members"></a> <h2 id="static-public-members">Static Public Members</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qabstractprintdialog.html#staticMetaObject-var">staticMetaObject</a></b></td></tr> </table></div> <ul> <li class="fn">5 static public members inherited from <a href="../qtwidgets/qwidget.html#static-public-members">QWidget</a></li> <li class="fn">9 static public members inherited from <a href="../qtcore/qobject.html#static-public-members">QObject</a></li> </ul> <h3>Additional Inherited Members</h3> <ul> <li class="fn">2 properties inherited from <a href="../qtwidgets/qdialog.html#properties">QDialog</a></li> <li class="fn">59 properties inherited from <a href="../qtwidgets/qwidget.html#properties">QWidget</a></li> <li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</a></li> <li class="fn">5 public slots inherited from <a href="../qtwidgets/qdialog.html#public-slots">QDialog</a></li> <li class="fn">19 public slots inherited from <a href="../qtwidgets/qwidget.html#public-slots">QWidget</a></li> <li class="fn">1 public slot inherited from <a href="../qtcore/qobject.html#public-slots">QObject</a></li> <li class="fn">3 signals inherited from <a href="../qtwidgets/qdialog.html#signals">QDialog</a></li> <li class="fn">3 signals inherited from <a href="../qtwidgets/qwidget.html#signals">QWidget</a></li> <li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li> <li class="fn">6 protected functions inherited from <a href="../qtwidgets/qdialog.html#protected-functions">QDialog</a></li> <li class="fn">35 protected functions inherited from <a href="../qtwidgets/qwidget.html#protected-functions">QWidget</a></li> <li class="fn">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</a></li> <li class="fn">1 protected function inherited from <a href="../qtgui/qpaintdevice.html#protected-functions">QPaintDevice</a></li> <li class="fn">1 protected slot inherited from <a href="../qtwidgets/qwidget.html#protected-slots">QWidget</a></li> </ul> <a name="details"></a> <!-- $$$QAbstractPrintDialog-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qabstractprintdialog.html">QAbstractPrintDialog</a> class provides a base implementation for print dialogs used to configure printers.</p> <p>This class implements getter and setter functions that are used to customize settings shown in print dialogs, but it is not used directly. Use <a href="qprintdialog.html">QPrintDialog</a> to display a print dialog in your application.</p> </div> <p><b>See also </b><a href="qprintdialog.html">QPrintDialog</a> and <a href="qprinter.html">QPrinter</a>.</p> <!-- @@@QAbstractPrintDialog --> <div class="types"> <h2>Member Type Documentation</h2> <!-- $$$PrintDialogOption$$$None$$$PrintToFile$$$PrintSelection$$$PrintPageRange$$$PrintShowPageSize$$$PrintCollateCopies$$$DontUseSheet$$$PrintCurrentPage --> <h3 class="flags" id="PrintDialogOption-enum"><a name="PrintDialogOption-enum"></a>enum QAbstractPrintDialog::<span class="name">PrintDialogOption</span><br/>flags QAbstractPrintDialog::<span class="name">PrintDialogOptions</span></h3> <p>Used to specify which parts of the print dialog should be visible.</p> <div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr> <tr><td class="topAlign"><code>QAbstractPrintDialog::None</code></td><td class="topAlign tblval"><code>0x0000</code></td><td class="topAlign">None of the options are enabled.</td></tr> <tr><td class="topAlign"><code>QAbstractPrintDialog::PrintToFile</code></td><td class="topAlign tblval"><code>0x0001</code></td><td class="topAlign">The print to file option is enabled.</td></tr> <tr><td class="topAlign"><code>QAbstractPrintDialog::PrintSelection</code></td><td class="topAlign tblval"><code>0x0002</code></td><td class="topAlign">The print selection option is enabled.</td></tr> <tr><td class="topAlign"><code>QAbstractPrintDialog::PrintPageRange</code></td><td class="topAlign tblval"><code>0x0004</code></td><td class="topAlign">The page range selection option is enabled.</td></tr> <tr><td class="topAlign"><code>QAbstractPrintDialog::PrintShowPageSize</code></td><td class="topAlign tblval"><code>0x0008</code></td><td class="topAlign">Show the page size + margins page only if this is enabled.</td></tr> <tr><td class="topAlign"><code>QAbstractPrintDialog::PrintCollateCopies</code></td><td class="topAlign tblval"><code>0x0010</code></td><td class="topAlign">The collate copies option is enabled</td></tr> <tr><td class="topAlign"><code>QAbstractPrintDialog::PrintCurrentPage</code></td><td class="topAlign tblval"><code>0x0040</code></td><td class="topAlign">The print current page option is enabled</td></tr> </table></div> <p>This value is obsolete and does nothing since Qt 4.5:</p> <div class="table"><table class="valuelist"><tr valign="top" class="even"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr> <tr><td class="topAlign"><code>QAbstractPrintDialog::DontUseSheet</code></td><td class="topAlign tblval"><code>0x0020</code></td><td class="topAlign">In previous versions of Qt, <a href="qabstractprintdialog.html#exec">exec</a>() the print dialog would create a sheet by default the dialog was given a parent. This is no longer supported in Qt 4.5. If you want to use sheets, use <a href="qprintdialog.html#open">QPrintDialog::open</a>() instead.</td></tr> </table></div> <p>The PrintDialogOptions type is a typedef for <a href="../qtcore/qflags.html">QFlags</a><PrintDialogOption>. It stores an OR combination of PrintDialogOption values.</p> <!-- @@@PrintDialogOption --> <!-- $$$PrintRange$$$AllPages$$$Selection$$$PageRange$$$CurrentPage --> <h3 class="fn" id="PrintRange-enum"><a name="PrintRange-enum"></a>enum QAbstractPrintDialog::<span class="name">PrintRange</span></h3> <p>Used to specify the print range selection option.</p> <div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr> <tr><td class="topAlign"><code>QAbstractPrintDialog::AllPages</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">All pages should be printed.</td></tr> <tr><td class="topAlign"><code>QAbstractPrintDialog::Selection</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">Only the selection should be printed.</td></tr> <tr><td class="topAlign"><code>QAbstractPrintDialog::PageRange</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">The specified page range should be printed.</td></tr> <tr><td class="topAlign"><code>QAbstractPrintDialog::CurrentPage</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">Only the currently visible page should be printed.</td></tr> </table></div> <p><b>See also </b><a href="qprinter.html#PrintRange-enum">QPrinter::PrintRange</a>.</p> <!-- @@@PrintRange --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QAbstractPrintDialog[overload1]$$$QAbstractPrintDialogQPrinter*QWidget* --> <h3 class="fn" id="QAbstractPrintDialog"><a name="QAbstractPrintDialog"></a>QAbstractPrintDialog::<span class="name">QAbstractPrintDialog</span>(<span class="type"><a href="qprinter.html">QPrinter</a></span> *<i>printer</i>, <span class="type"><a href="../qtwidgets/qwidget.html#QWidget">QWidget</a></span> *<i>parent</i> = nullptr)</h3> <p>Constructs an abstract print dialog for <i>printer</i> with <i>parent</i> as parent widget.</p> <!-- @@@QAbstractPrintDialog --> <!-- $$$exec[overload1]$$$exec --> <h3 class="fn" id="exec"><a name="exec"></a><code>[override pure virtual] </code><span class="type">int</span> QAbstractPrintDialog::<span class="name">exec</span>()</h3> <p>Reimplemented from <a href="../qtwidgets/qdialog.html#exec">QDialog::exec</a>().</p> <p>This virtual function is called to pop up the dialog. It must be reimplemented in subclasses.</p> <!-- @@@exec --> <!-- $$$fromPage[overload1]$$$fromPage --> <h3 class="fn" id="fromPage"><a name="fromPage"></a><span class="type">int</span> QAbstractPrintDialog::<span class="name">fromPage</span>() const</h3> <p>Returns the first page to be printed By default, this value is set to 0.</p> <!-- @@@fromPage --> <!-- $$$maxPage[overload1]$$$maxPage --> <h3 class="fn" id="maxPage"><a name="maxPage"></a><span class="type">int</span> QAbstractPrintDialog::<span class="name">maxPage</span>() const</h3> <p>Returns the maximum page in the page range. As of Qt 4.4, this function returns INT_MAX by default. Previous versions returned 1 by default.</p> <!-- @@@maxPage --> <!-- $$$minPage[overload1]$$$minPage --> <h3 class="fn" id="minPage"><a name="minPage"></a><span class="type">int</span> QAbstractPrintDialog::<span class="name">minPage</span>() const</h3> <p>Returns the minimum page in the page range. By default, this value is set to 1.</p> <!-- @@@minPage --> <!-- $$$printRange[overload1]$$$printRange --> <h3 class="fn" id="printRange"><a name="printRange"></a><span class="type"><a href="qabstractprintdialog.html#PrintRange-enum">QAbstractPrintDialog::PrintRange</a></span> QAbstractPrintDialog::<span class="name">printRange</span>() const</h3> <p>Returns the print range.</p> <p><b>See also </b><a href="qabstractprintdialog.html#setPrintRange">setPrintRange</a>().</p> <!-- @@@printRange --> <!-- $$$printer[overload1]$$$printer --> <h3 class="fn" id="printer"><a name="printer"></a><span class="type"><a href="qprinter.html">QPrinter</a></span> *QAbstractPrintDialog::<span class="name">printer</span>() const</h3> <p>Returns the printer that this printer dialog operates on.</p> <!-- @@@printer --> <!-- $$$setFromTo[overload1]$$$setFromTointint --> <h3 class="fn" id="setFromTo"><a name="setFromTo"></a><span class="type">void</span> QAbstractPrintDialog::<span class="name">setFromTo</span>(<span class="type">int</span> <i>from</i>, <span class="type">int</span> <i>to</i>)</h3> <p>Sets the range in the print dialog to be from <i>from</i> to <i>to</i>.</p> <!-- @@@setFromTo --> <!-- $$$setMinMax[overload1]$$$setMinMaxintint --> <h3 class="fn" id="setMinMax"><a name="setMinMax"></a><span class="type">void</span> QAbstractPrintDialog::<span class="name">setMinMax</span>(<span class="type">int</span> <i>min</i>, <span class="type">int</span> <i>max</i>)</h3> <p>Sets the page range in this dialog to be from <i>min</i> to <i>max</i>. This also enables the <a href="qabstractprintdialog.html#PrintDialogOption-enum">PrintPageRange</a> option.</p> <!-- @@@setMinMax --> <!-- $$$setOptionTabs[overload1]$$$setOptionTabsconstQList<QWidget*>& --> <h3 class="fn" id="setOptionTabs"><a name="setOptionTabs"></a><span class="type">void</span> QAbstractPrintDialog::<span class="name">setOptionTabs</span>(const <span class="type"><a href="../qtcore/qlist.html">QList</a></span><<span class="type"><a href="../qtwidgets/qwidget.html#QWidget">QWidget</a></span> *> &<i>tabs</i>)</h3> <p>Set a list of widgets as <i>tabs</i> to be shown on the print dialog, if supported.</p> <p>Currently this option is only supported on X11.</p> <p>Setting the option tabs will transfer their ownership to the print dialog.</p> <p>This function was introduced in Qt 4.4.</p> <!-- @@@setOptionTabs --> <!-- $$$setPrintRange[overload1]$$$setPrintRangeQAbstractPrintDialog::PrintRange --> <h3 class="fn" id="setPrintRange"><a name="setPrintRange"></a><span class="type">void</span> QAbstractPrintDialog::<span class="name">setPrintRange</span>(<span class="type"><a href="qabstractprintdialog.html#PrintRange-enum">QAbstractPrintDialog::PrintRange</a></span> <i>range</i>)</h3> <p>Sets the print range option in to be <i>range</i>.</p> <p><b>See also </b><a href="qabstractprintdialog.html#printRange">printRange</a>().</p> <!-- @@@setPrintRange --> <!-- $$$toPage[overload1]$$$toPage --> <h3 class="fn" id="toPage"><a name="toPage"></a><span class="type">int</span> QAbstractPrintDialog::<span class="name">toPage</span>() const</h3> <p>Returns the last page to be printed. By default, this value is set to 0.</p> <!-- @@@toPage --> </div> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2019 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners.<br/> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br/> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners. </p> </div> </body> </html>