1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtGui module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QPRINTENGINE_H
41 #define QPRINTENGINE_H
42 
43 #include <QtPrintSupport/qtprintsupportglobal.h>
44 #include <QtCore/qvariant.h>
45 #include <QtPrintSupport/qprinter.h>
46 
Q_DECLARE_METATYPE(QMarginsF)47 Q_DECLARE_METATYPE(QMarginsF)
48 
49 QT_BEGIN_NAMESPACE
50 
51 
52 #ifndef QT_NO_PRINTER
53 
54 class Q_PRINTSUPPORT_EXPORT QPrintEngine
55 {
56 public:
57     virtual ~QPrintEngine() {}
58     enum PrintEnginePropertyKey {
59         PPK_CollateCopies,
60         PPK_ColorMode,
61         PPK_Creator,
62         PPK_DocumentName,
63         PPK_FullPage,
64         PPK_NumberOfCopies,
65         PPK_Orientation,
66         PPK_OutputFileName,
67         PPK_PageOrder,
68         PPK_PageRect,
69         PPK_PageSize,
70         PPK_PaperRect,
71         PPK_PaperSource,
72         PPK_PrinterName,
73         PPK_PrinterProgram,
74         PPK_Resolution,
75         PPK_SelectionOption,
76         PPK_SupportedResolutions,
77 
78         PPK_WindowsPageSize,
79         PPK_FontEmbedding,
80 
81         PPK_Duplex,
82 
83         PPK_PaperSources,
84         PPK_CustomPaperSize,
85         PPK_PageMargins,
86         PPK_CopyCount,
87         PPK_SupportsMultipleCopies,
88         PPK_PaperName,
89         PPK_QPageSize,
90         PPK_QPageMargins,
91         PPK_QPageLayout,
92         PPK_PaperSize = PPK_PageSize,
93 
94         PPK_CustomBase = 0xff00
95     };
96 
97     virtual void setProperty(PrintEnginePropertyKey key, const QVariant &value) = 0;
98     virtual QVariant property(PrintEnginePropertyKey key) const = 0;
99 
100     virtual bool newPage() = 0;
101     virtual bool abort() = 0;
102 
103     virtual int metric(QPaintDevice::PaintDeviceMetric) const = 0;
104 
105     virtual QPrinter::PrinterState printerState() const = 0;
106 };
107 
108 #endif // QT_NO_PRINTER
109 
110 QT_END_NAMESPACE
111 
112 #endif // QPRINTENGINE_H
113