QPlatformPrintDevice - New QPA base class

Add a new QPA class to abstract Print Devices.  Each platform instance
will encapsulate all required details about a print device instead of
the code being distributed throughout the print engine and print
plugin.

Change-Id: I7f6a537ad55a6e7f599d83f461b1e2ee62b15094
Reviewed-by: Lars Knoll <lars.knoll@digia.com>

1 files changed, 180 insertions, 0 deletions

diff --git a/src/printsupport/kernel/qplatformprintdevice.h b/src/printsupport/kernel/qplatformprintdevice.h
new file mode 100644
index 0000000000..04d614085f
--- /dev/null
+++ b/src/printsupport/kernel/qplatformprintdevice.h
@@ -0,0 +1,180 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 John Layt <jlayt@kde.org>
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtPrintSupport module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QPLATFORMPRINTDEVICE_H
+#define QPLATFORMPRINTDEVICE_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists for the convenience
+// of internal files.  This header file may change from version to version
+// without notice, or even be removed.
+//
+// We mean it.
+//
+
+#include "qplatformprintdevice.h"
+
+#include <private/qprint_p.h>
+
+#include <QtCore/qvector.h>
+#include <QtCore/qmimetype.h>
+#include <QtGui/qpagelayout.h>
+
+QT_BEGIN_NAMESPACE
+
+class Q_PRINTSUPPORT_EXPORT QPlatformPrintDevice : public QSharedData
+{
+public:
+    QPlatformPrintDevice();
+    explicit QPlatformPrintDevice(const QString &id);
+    virtual ~QPlatformPrintDevice();
+
+    QPlatformPrintDevice *clone();
+
+    bool operator==(const QPlatformPrintDevice &other) const;
+
+    virtual QString id() const;
+    virtual QString name() const;
+    virtual QString location() const;
+    virtual QString makeAndModel() const;
+
+    virtual bool isValid() const;
+    virtual bool isDefault() const;
+    virtual bool isRemote() const;
+
+    virtual QPrint::DeviceState state() const;
+
+    virtual bool isValidPageLayout(const QPageLayout &layout, int resolution) const;
+
+    virtual bool supportsMultipleCopies() const;
+    virtual bool supportsCollateCopies() const;
+
+    virtual QPageSize defaultPageSize() const;
+    virtual QList<QPageSize> supportedPageSizes() const;
+
+    virtual QPageSize supportedPageSize(const QPageSize &pageSize) const;
+    virtual QPageSize supportedPageSize(QPageSize::PageSizeId pageSizeId) const;
+    virtual QPageSize supportedPageSize(const QString &pageName) const;
+    virtual QPageSize supportedPageSize(const QSize &pointSize) const;
+    virtual QPageSize supportedPageSize(const QSizeF &size, QPageSize::Unit units) const;
+
+    virtual bool supportsCustomPageSizes() const;
+
+    virtual QSize minimumPhysicalPageSize() const;
+    virtual QSize maximumPhysicalPageSize() const;
+
+    virtual QMarginsF printableMargins(const QPageSize &pageSize, QPageLayout::Orientation orientation,
+                                       int resolution) const;
+
+    virtual int defaultResolution() const;
+    virtual QList<int> supportedResolutions() const;
+
+    virtual QPrint::InputSlot defaultInputSlot() const;
+    virtual QList<QPrint::InputSlot> supportedInputSlots() const;
+
+    virtual QPrint::OutputBin defaultOutputBin() const;
+    virtual QList<QPrint::OutputBin> supportedOutputBins() const;
+
+    virtual QPrint::DuplexMode defaultDuplexMode() const;
+    virtual QList<QPrint::DuplexMode> supportedDuplexModes() const;
+
+    virtual QPrint::ColorMode defaultColorMode() const;
+    virtual QList<QPrint::ColorMode> supportedColorModes() const;
+
+    virtual QList<QMimeType> supportedMimeTypes() const;
+
+    static QPageSize createPageSize(const QString &key, const QSize &size, const QString &localizedName);
+    static QPageSize createPageSize(int windowsId, const QSize &size, const QString &localizedName);
+
+protected:
+    virtual void loadPageSizes() const;
+    virtual void loadResolutions() const;
+    virtual void loadInputSlots() const;
+    virtual void loadOutputBins() const;
+    virtual void loadDuplexModes() const;
+    virtual void loadColorModes() const;
+    virtual void loadMimeTypes() const;
+
+    QPageSize supportedPageSizeMatch(const QPageSize &pageSize) const;
+
+    QString m_id;
+    QString m_name;
+    QString m_location;
+    QString m_makeAndModel;
+
+    bool m_isRemote;
+
+    bool m_supportsMultipleCopies;
+    bool m_supportsCollateCopies;
+
+    mutable bool m_havePageSizes;
+    mutable QVector<QPageSize> m_pageSizes;
+
+    bool m_supportsCustomPageSizes;
+
+    QSize m_minimumPhysicalPageSize;
+    QSize m_maximumPhysicalPageSize;
+
+    mutable bool m_haveResolutions;
+    mutable QVector<int> m_resolutions;
+
+    mutable bool m_haveInputSlots;
+    mutable QVector<QPrint::InputSlot> m_inputSlots;
+
+    mutable bool m_haveOutputBins;
+    mutable QVector<QPrint::OutputBin> m_outputBins;
+
+    mutable bool m_haveDuplexModes;
+    mutable QVector<QPrint::DuplexMode> m_duplexModes;
+
+    mutable bool m_haveColorModes;
+    mutable QVector<QPrint::ColorMode> m_colorModes;
+
+    mutable bool m_haveMimeTypes;
+    mutable QVector<QMimeType> m_mimeTypes;
+};
+
+QT_END_NAMESPACE
+
+#endif // QPLATFORMPRINTDEVICE_H