src/gui/painting/qprintengine.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtGui module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QPRINTENGINE_H
  43 #define QPRINTENGINE_H
  44
  45 #include <QtCore/qvariant.h>
  46 #include <QtGui/qprinter.h>
  47
  48 QT_BEGIN_HEADER
  49
  50 QT_BEGIN_NAMESPACE
  51
  52 QT_MODULE(Gui)
  53
  54 #ifndef QT_NO_PRINTER
  55
  56 class Q_GUI_EXPORT QPrintEngine
  57 {
  58 public:
  59     virtual ~QPrintEngine() {}
  60     enum PrintEnginePropertyKey {
  61         PPK_CollateCopies,
  62         PPK_ColorMode,
  63         PPK_Creator,
  64         PPK_DocumentName,
  65         PPK_FullPage,
  66         PPK_NumberOfCopies,
  67         PPK_Orientation,
  68         PPK_OutputFileName,
  69         PPK_PageOrder,
  70         PPK_PageRect,
  71         PPK_PageSize,
  72         PPK_PaperRect,
  73         PPK_PaperSource,
  74         PPK_PrinterName,
  75         PPK_PrinterProgram,
  76         PPK_Resolution,
  77         PPK_SelectionOption,
  78         PPK_SupportedResolutions,
  79
  80         PPK_WindowsPageSize,
  81         PPK_FontEmbedding,
  82         PPK_SuppressSystemPrintStatus,
  83
  84         PPK_Duplex,
  85
  86         PPK_PaperSources,
  87         PPK_CustomPaperSize,
  88         PPK_PageMargins,
  89         PPK_CopyCount,
  90         PPK_SupportsMultipleCopies,
  91         PPK_PaperSize = PPK_PageSize,
  92
  93         PPK_CustomBase = 0xff00
  94     };
  95
  96     virtual void setProperty(PrintEnginePropertyKey key, const QVariant &value) = 0;
  97     virtual QVariant property(PrintEnginePropertyKey key) const = 0;
  98
  99     virtual bool newPage() = 0;
 100     virtual bool abort() = 0;
 101
 102     virtual int metric(QPaintDevice::PaintDeviceMetric) const = 0;
 103
 104     virtual QPrinter::PrinterState printerState() const = 0;
 105
 106 #ifdef Q_WS_WIN
 107     virtual HDC getPrinterDC() const { return 0; }
 108     virtual void releasePrinterDC(HDC) const { }
 109 #endif
 110
 111 };
 112
 113 #endif // QT_NO_PRINTER
 114
 115 QT_END_NAMESPACE
 116
 117 QT_END_HEADER
 118
 119 #endif // QPRINTENGINE_H