<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qprinter.cpp -->
<title>Qt 4.8: QPrintEngine Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtgui.html">QtGui</a></li>
<li>QPrintEngine</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<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="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QPrintEngine Class Reference</h1>
<!-- $$$QPrintEngine-brief -->
<p>The QPrintEngine class defines an interface for how <a href="qprinter.html">QPrinter</a> interacts with a given printing subsystem. <a href="#details">More...</a></p>
<!-- @@@QPrintEngine -->
<pre class="cpp"> <span class="preprocessor">#include <QPrintEngine></span></pre><p><b>Note:</b> All functions in this class are <a href="threads-reentrancy.html#reentrant">reentrant</a>.</p>
<ul>
<li><a href="qprintengine-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qprintengine.html#PrintEnginePropertyKey-enum">PrintEnginePropertyKey</a></b> { PPK_CollateCopies, PPK_ColorMode, PPK_Creator, PPK_Duplex, ..., PPK_CustomBase }</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qprintengine.html#dtor.QPrintEngine">~QPrintEngine</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qprintengine.html#abort">abort</a></b> () = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qprintengine.html#metric">metric</a></b> ( QPaintDevice::PaintDeviceMetric <i>id</i> ) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qprintengine.html#newPage">newPage</a></b> () = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QPrinter::PrinterState </td><td class="memItemRight bottomAlign"><b><a href="qprintengine.html#printerState">printerState</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QVariant </td><td class="memItemRight bottomAlign"><b><a href="qprintengine.html#property">property</a></b> ( PrintEnginePropertyKey <i>key</i> ) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qprintengine.html#setProperty">setProperty</a></b> ( PrintEnginePropertyKey <i>key</i>, const QVariant & <i>value</i> ) = 0</td></tr>
</table>
<a name="details"></a>
<!-- $$$QPrintEngine-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QPrintEngine class defines an interface for how <a href="qprinter.html">QPrinter</a> interacts with a given printing subsystem.</p>
<p>The common case when creating your own print engine is to derive from both <a href="qpaintengine.html">QPaintEngine</a> and QPrintEngine. Various properties of a print engine are given with <a href="qprintengine.html#property">property</a>() and set with <a href="qprintengine.html#setProperty">setProperty</a>().</p>
</div>
<p><b>See also </b><a href="qpaintengine.html">QPaintEngine</a>.</p>
<!-- @@@QPrintEngine -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$PrintEnginePropertyKey$$$PPK_CollateCopies$$$PPK_ColorMode$$$PPK_Creator$$$PPK_DocumentName$$$PPK_FullPage$$$PPK_NumberOfCopies$$$PPK_Orientation$$$PPK_OutputFileName$$$PPK_PageOrder$$$PPK_PageRect$$$PPK_PageSize$$$PPK_PaperRect$$$PPK_PaperSource$$$PPK_PrinterName$$$PPK_PrinterProgram$$$PPK_Resolution$$$PPK_SelectionOption$$$PPK_SupportedResolutions$$$PPK_WindowsPageSize$$$PPK_FontEmbedding$$$PPK_SuppressSystemPrintStatus$$$PPK_Duplex$$$PPK_PaperSources$$$PPK_CustomPaperSize$$$PPK_PageMargins$$$PPK_CopyCount$$$PPK_SupportsMultipleCopies$$$PPK_PaperSize$$$PPK_CustomBase -->
<h3 class="fn"><a name="PrintEnginePropertyKey-enum"></a>enum QPrintEngine::<span class="name">PrintEnginePropertyKey</span></h3>
<p>This enum is used to communicate properties between the print engine and <a href="qprinter.html">QPrinter</a>. A property may or may not be supported by a given print engine.</p>
<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"><tt>QPrintEngine::PPK_CollateCopies</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">A boolean value indicating whether the printout should be collated or not.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_ColorMode</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">Refers to <a href="qprinter.html#ColorMode-enum">QPrinter::ColorMode</a>, either color or monochrome.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_Creator</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">A string describing the document's creator.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_Duplex</tt></td><td class="topAlign"><tt>21</tt></td><td class="topAlign">A boolean value indicating whether both sides of the printer paper should be used for the printout.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_DocumentName</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">A string describing the document name in the spooler.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_FontEmbedding</tt></td><td class="topAlign"><tt>19</tt></td><td class="topAlign">A boolean value indicating whether data for the document's fonts should be embedded in the data sent to the printer.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_FullPage</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">A boolean describing if the printer should be full page or not.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_NumberOfCopies</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">Obsolete. An integer specifying the number of copies. Use PPK_CopyCount instead.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_Orientation</tt></td><td class="topAlign"><tt>6</tt></td><td class="topAlign">Specifies a <a href="qprinter.html#Orientation-enum">QPrinter::Orientation</a> value.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_OutputFileName</tt></td><td class="topAlign"><tt>7</tt></td><td class="topAlign">The output file name as a string. An empty file name indicates that the printer should not print to a file.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_PageOrder</tt></td><td class="topAlign"><tt>8</tt></td><td class="topAlign">Specifies a <a href="qprinter.html#PageOrder-enum">QPrinter::PageOrder</a> value.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_PageRect</tt></td><td class="topAlign"><tt>9</tt></td><td class="topAlign">A <a href="qrect.html">QRect</a> specifying the page rectangle</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_PageSize</tt></td><td class="topAlign"><tt>10</tt></td><td class="topAlign">Obsolete. Use PPK_PaperSize instead.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_PaperRect</tt></td><td class="topAlign"><tt>11</tt></td><td class="topAlign">A <a href="qrect.html">QRect</a> specifying the paper rectangle.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_PaperSource</tt></td><td class="topAlign"><tt>12</tt></td><td class="topAlign">Specifies a <a href="qprinter.html#PaperSource-enum">QPrinter::PaperSource</a> value.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_PaperSources</tt></td><td class="topAlign"><tt>22</tt></td><td class="topAlign">Specifies more than one <a href="qprinter.html#PaperSource-enum">QPrinter::PaperSource</a> value.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_PaperSize</tt></td><td class="topAlign"><tt>PPK_PageSize</tt></td><td class="topAlign">Specifies a <a href="qprinter.html#PaperSize-enum">QPrinter::PaperSize</a> value.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_PrinterName</tt></td><td class="topAlign"><tt>13</tt></td><td class="topAlign">A string specifying the name of the printer.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_PrinterProgram</tt></td><td class="topAlign"><tt>14</tt></td><td class="topAlign">A string specifying the name of the printer program used for printing,</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_Resolution</tt></td><td class="topAlign"><tt>15</tt></td><td class="topAlign">An integer describing the dots per inch for this printer.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_SelectionOption</tt></td><td class="topAlign"><tt>16</tt></td><td class="topAlign"> </td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_SupportedResolutions</tt></td><td class="topAlign"><tt>17</tt></td><td class="topAlign">A list of integer <a href="qtwebkit-bridge.html#qvariants">QVariants</a> describing the set of supported resolutions that the printer has.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_SuppressSystemPrintStatus</tt></td><td class="topAlign"><tt>20</tt></td><td class="topAlign">Suppress the built-in dialog for showing printing progress. As of 4.1 this only has effect on Mac OS X where, by default, a status dialog is shown.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_WindowsPageSize</tt></td><td class="topAlign"><tt>18</tt></td><td class="topAlign">An integer specifying a DM_PAPER entry on Windows.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_CustomPaperSize</tt></td><td class="topAlign"><tt>23</tt></td><td class="topAlign">A <a href="qsizef.html">QSizeF</a> specifying a custom paper size in the <a href="qprinter.html#Unit-enum">QPrinter::Point</a> unit.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_PageMargins</tt></td><td class="topAlign"><tt>24</tt></td><td class="topAlign">A <a href="qlist.html">QList</a><<a href="qvariant.html">QVariant</a>> containing the left, top, right and bottom margin values.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_CopyCount</tt></td><td class="topAlign"><tt>25</tt></td><td class="topAlign">An integer specifying the number of copies to print.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_SupportsMultipleCopies</tt></td><td class="topAlign"><tt>26</tt></td><td class="topAlign">A boolean value indicating whether or not the printer supports printing multiple copies in one job.</td></tr>
<tr><td class="topAlign"><tt>QPrintEngine::PPK_CustomBase</tt></td><td class="topAlign"><tt>0xff00</tt></td><td class="topAlign">Basis for extension.</td></tr>
</table>
<!-- @@@PrintEnginePropertyKey -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$~QPrintEngine[overload1]$$$~QPrintEngine -->
<h3 class="fn"><a name="dtor.QPrintEngine"></a>QPrintEngine::<span class="name">~QPrintEngine</span> ()<tt> [virtual]</tt></h3>
<p>Destroys the print engine.</p>
<!-- @@@~QPrintEngine -->
<!-- $$$abort[overload1]$$$abort -->
<h3 class="fn"><a name="abort"></a><span class="type">bool</span> QPrintEngine::<span class="name">abort</span> ()<tt> [pure virtual]</tt></h3>
<p>Instructs the print engine to abort the printing process. Returns true if successful; otherwise returns false.</p>
<!-- @@@abort -->
<!-- $$$metric[overload1]$$$metricQPaintDevice::PaintDeviceMetric -->
<h3 class="fn"><a name="metric"></a><span class="type">int</span> QPrintEngine::<span class="name">metric</span> ( <span class="type"><a href="qpaintdevice.html#PaintDeviceMetric-enum">QPaintDevice::PaintDeviceMetric</a></span> <i>id</i> ) const<tt> [pure virtual]</tt></h3>
<p>Returns the metric for the given <i>id</i>.</p>
<!-- @@@metric -->
<!-- $$$newPage[overload1]$$$newPage -->
<h3 class="fn"><a name="newPage"></a><span class="type">bool</span> QPrintEngine::<span class="name">newPage</span> ()<tt> [pure virtual]</tt></h3>
<p>Instructs the print engine to start a new page. Returns true if the printer was able to create the new page; otherwise returns false.</p>
<!-- @@@newPage -->
<!-- $$$printerState[overload1]$$$printerState -->
<h3 class="fn"><a name="printerState"></a><span class="type"><a href="qprinter.html#PrinterState-enum">QPrinter::PrinterState</a></span> QPrintEngine::<span class="name">printerState</span> () const<tt> [pure virtual]</tt></h3>
<p>Returns the current state of the printer being used by the print engine.</p>
<!-- @@@printerState -->
<!-- $$$property[overload1]$$$propertyPrintEnginePropertyKey -->
<h3 class="fn"><a name="property"></a><span class="type"><a href="qvariant.html">QVariant</a></span> QPrintEngine::<span class="name">property</span> ( <span class="type"><a href="qprintengine.html#PrintEnginePropertyKey-enum">PrintEnginePropertyKey</a></span> <i>key</i> ) const<tt> [pure virtual]</tt></h3>
<p>Returns the print engine's property specified by <i>key</i>.</p>
<p><b>See also </b><a href="qprintengine.html#setProperty">setProperty</a>().</p>
<!-- @@@property -->
<!-- $$$setProperty[overload1]$$$setPropertyPrintEnginePropertyKeyconstQVariant& -->
<h3 class="fn"><a name="setProperty"></a><span class="type">void</span> QPrintEngine::<span class="name">setProperty</span> ( <span class="type"><a href="qprintengine.html#PrintEnginePropertyKey-enum">PrintEnginePropertyKey</a></span> <i>key</i>, const <span class="type"><a href="qvariant.html">QVariant</a></span> & <i>value</i> )<tt> [pure virtual]</tt></h3>
<p>Sets the print engine's property specified by <i>key</i> to the given <i>value</i>.</p>
<p><b>See also </b><a href="qprintengine.html#property">property</a>().</p>
<!-- @@@setProperty -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
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.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Digia, Qt and their respective logos are trademarks of Digia Plc
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
