Add rudimentary printing API and add it to example.

Change-Id: I48141d07e9744bb21d64a5c8724579cb469ba35c
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@theqtcompany.com>

4 files changed, 341 insertions, 0 deletions

diff --git a/src/webengine/api/qquickwebengineview.cpp b/src/webengine/api/qquickwebengineview.cpp
index 70a85f5f3..742cd6cf8 100644
--- a/src/webengine/api/qquickwebengineview.cpp
+++ b/src/webengine/api/qquickwebengineview.cpp
@@ -70,7 +70,10 @@
 #include <QClipboard>
 #include <QGuiApplication>
 #include <QLoggingCategory>
+#include <QMarginsF>
 #include <QMimeData>
+#include <QPageLayout>
+#include <QPageSize>
 #include <QQmlComponent>
 #include <QQmlContext>
 #include <QQmlEngine>
@@ -1179,6 +1182,15 @@ bool QQuickWebEngineView::wasRecentlyAudible()
     return d->adapter->wasRecentlyAudible();
 }
 
+void QQuickWebEngineView::printToPDF(const QString &filePath, PrintedPageSizeId pageSizeId, PrintedPageOrientation orientation)
+{
+    Q_D(QQuickWebEngineView);
+    QPageSize layoutSize(static_cast<QPageSize::PageSizeId>(pageSizeId));
+    QPageLayout::Orientation layoutOrientation = static_cast<QPageLayout::Orientation>(orientation);
+    QPageLayout pageLayout(layoutSize, layoutOrientation, QMarginsF(0.0, 0.0, 0.0, 0.0));
+    d->adapter->printToPDF(pageLayout, filePath);
+}
+
 bool QQuickWebEngineView::isFullScreen() const
 {
     Q_D(const QQuickWebEngineView);
diff --git a/src/webengine/api/qquickwebengineview_p.h b/src/webengine/api/qquickwebengineview_p.h
index 4c6cbbaff..9433a2150 100644
--- a/src/webengine/api/qquickwebengineview_p.h
+++ b/src/webengine/api/qquickwebengineview_p.h
@@ -273,6 +273,166 @@ public:
     };
     Q_DECLARE_FLAGS(FindFlags, FindFlag)
 
+    // must match QPageSize::PageSizeId
+    enum PrintedPageSizeId {
+        // Existing Qt sizes
+        A4,
+        B5,
+        Letter,
+        Legal,
+        Executive,
+        A0,
+        A1,
+        A2,
+        A3,
+        A5,
+        A6,
+        A7,
+        A8,
+        A9,
+        B0,
+        B1,
+        B10,
+        B2,
+        B3,
+        B4,
+        B6,
+        B7,
+        B8,
+        B9,
+        C5E,
+        Comm10E,
+        DLE,
+        Folio,
+        Ledger,
+        Tabloid,
+        Custom,
+
+        // New values derived from PPD standard
+        A10,
+        A3Extra,
+        A4Extra,
+        A4Plus,
+        A4Small,
+        A5Extra,
+        B5Extra,
+
+        JisB0,
+        JisB1,
+        JisB2,
+        JisB3,
+        JisB4,
+        JisB5,
+        JisB6,
+        JisB7,
+        JisB8,
+        JisB9,
+        JisB10,
+
+        // AnsiA = Letter,
+        // AnsiB = Ledger,
+        AnsiC,
+        AnsiD,
+        AnsiE,
+        LegalExtra,
+        LetterExtra,
+        LetterPlus,
+        LetterSmall,
+        TabloidExtra,
+
+        ArchA,
+        ArchB,
+        ArchC,
+        ArchD,
+        ArchE,
+
+        Imperial7x9,
+        Imperial8x10,
+        Imperial9x11,
+        Imperial9x12,
+        Imperial10x11,
+        Imperial10x13,
+        Imperial10x14,
+        Imperial12x11,
+        Imperial15x11,
+
+        ExecutiveStandard,
+        Note,
+        Quarto,
+        Statement,
+        SuperA,
+        SuperB,
+        Postcard,
+        DoublePostcard,
+        Prc16K,
+        Prc32K,
+        Prc32KBig,
+
+        FanFoldUS,
+        FanFoldGerman,
+        FanFoldGermanLegal,
+
+        EnvelopeB4,
+        EnvelopeB5,
+        EnvelopeB6,
+        EnvelopeC0,
+        EnvelopeC1,
+        EnvelopeC2,
+        EnvelopeC3,
+        EnvelopeC4,
+        // EnvelopeC5 = C5E,
+        EnvelopeC6,
+        EnvelopeC65,
+        EnvelopeC7,
+        // EnvelopeDL = DLE,
+
+        Envelope9,
+        // Envelope10 = Comm10E,
+        Envelope11,
+        Envelope12,
+        Envelope14,
+        EnvelopeMonarch,
+        EnvelopePersonal,
+
+        EnvelopeChou3,
+        EnvelopeChou4,
+        EnvelopeInvite,
+        EnvelopeItalian,
+        EnvelopeKaku2,
+        EnvelopeKaku3,
+        EnvelopePrc1,
+        EnvelopePrc2,
+        EnvelopePrc3,
+        EnvelopePrc4,
+        EnvelopePrc5,
+        EnvelopePrc6,
+        EnvelopePrc7,
+        EnvelopePrc8,
+        EnvelopePrc9,
+        EnvelopePrc10,
+        EnvelopeYou4,
+
+        // Last item, with commonly used synynoms from QPagedPrintEngine / QPrinter
+        LastPageSize = EnvelopeYou4,
+        NPageSize = LastPageSize,
+        NPaperSize = LastPageSize,
+
+        // Convenience overloads for naming consistency
+        AnsiA = Letter,
+        AnsiB = Ledger,
+        EnvelopeC5 = C5E,
+        EnvelopeDL = DLE,
+        Envelope10 = Comm10E
+    };
+    Q_ENUM(PrintedPageSizeId)
+
+    // must match QPageLayout::Orientation
+    enum PrintedPageOrientation {
+        Portrait,
+        Landscape
+    };
+    Q_ENUM(PrintedPageOrientation)
+
     // QmlParserStatus
     virtual void componentComplete() Q_DECL_OVERRIDE;
 
@@ -312,6 +472,7 @@ public Q_SLOTS:
     Q_REVISION(3) bool isAudioMuted() const;
     Q_REVISION(3) void setAudioMuted(bool muted);
     Q_REVISION(3) bool wasRecentlyAudible();
+    Q_REVISION(3) void printToPDF(const QString &filePath, PrintedPageSizeId pageSizeId = PrintedPageSizeId::A4, PrintedPageOrientation orientation = PrintedPageOrientation::Portrait);
 
 private Q_SLOTS:
     void lazyInitialize();
diff --git a/src/webengine/doc/qtwebengine.qdocconf b/src/webengine/doc/qtwebengine.qdocconf
index 2fbdef93e..d2b8980c4 100644
--- a/src/webengine/doc/qtwebengine.qdocconf
+++ b/src/webengine/doc/qtwebengine.qdocconf
@@ -43,6 +43,7 @@ tagfile                 = ../../../doc/qtwebengine/qtwebengine.tags
 depends += qtcore \
            qtgui \
            qtnetwork \
+           qtprintsupport \
            qtqml \
            qtquick \
            qtquickcontrols \
diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc
index 8e09d2b89..6a4e2ffef 100644
--- a/src/webengine/doc/src/webengineview.qdoc
+++ b/src/webengine/doc/src/webengineview.qdoc
@@ -717,6 +717,165 @@
 */
 
 /*!
+    \qmlproperty enumeration WebEngineView::PrintedPageSizeId
+    \since QtWebEngine 1.3
+
+    This enum type lists the available page sizes as defined in the Postscript
+    PPD standard.
+
+    The enumeration values are mapped from and must match QPageSize::PageSizeId. They are also
+    duplicated in QPagedPaintDevice and QPrinter.
+
+    The defined sizes are:
+
+    \value A0 841 x 1189 mm
+    \value A1 594 x 841 mm
+    \value A2 420 x 594 mm
+    \value A3 297 x 420 mm
+    \value A4 210 x 297 mm, 8.26 x 11.69 inches
+    \value A5 148 x 210 mm
+    \value A6 105 x 148 mm
+    \value A7 74 x 105 mm
+    \value A8 52 x 74 mm
+    \value A9 37 x 52 mm
+    \value B0 1000 x 1414 mm
+    \value B1 707 x 1000 mm
+    \value B2 500 x 707 mm
+    \value B3 353 x 500 mm
+    \value B4 250 x 353 mm
+    \value B5 176 x 250 mm, 6.93 x 9.84 inches
+    \value B6 125 x 176 mm
+    \value B7 88 x 125 mm
+    \value B8 62 x 88 mm
+    \value B9 44 x 62 mm
+    \value B10 31 x 44 mm
+    \value C5E 163 x 229 mm
+    \value Comm10E 105 x 241 mm, U.S. Common 10 Envelope
+    \value DLE 110 x 220 mm
+    \value Executive 7.5 x 10 inches, 190.5 x 254 mm
+    \value Folio 210 x 330 mm
+    \value Ledger 431.8 x 279.4 mm
+    \value Legal 8.5 x 14 inches, 215.9 x 355.6 mm
+    \value Letter 8.5 x 11 inches, 215.9 x 279.4 mm
+    \value Tabloid 279.4 x 431.8 mm
+    \value Custom Unknown, or a user defined size.
+    \value A10
+    \value A3Extra
+    \value A4Extra
+    \value A4Plus
+    \value A4Small
+    \value A5Extra
+    \value B5Extra
+    \value JisB0
+    \value JisB1
+    \value JisB2
+    \value JisB3
+    \value JisB4
+    \value JisB5
+    \value JisB6
+    \value JisB7
+    \value JisB8
+    \value JisB9
+    \value JisB10
+    \value AnsiA = \c Letter
+    \value AnsiB = \c Ledger
+    \value AnsiC
+    \value AnsiD
+    \value AnsiE
+    \value LegalExtra
+    \value LetterExtra
+    \value LetterPlus
+    \value LetterSmall
+    \value TabloidExtra
+    \value ArchA
+    \value ArchB
+    \value ArchC
+    \value ArchD
+    \value ArchE
+    \value Imperial7x9
+    \value Imperial8x10
+    \value Imperial9x11
+    \value Imperial9x12
+    \value Imperial10x11
+    \value Imperial10x13
+    \value Imperial10x14
+    \value Imperial12x11
+    \value Imperial15x11
+    \value ExecutiveStandard
+    \value Note
+    \value Quarto
+    \value Statement
+    \value SuperA
+    \value SuperB
+    \value Postcard
+    \value DoublePostcard
+    \value Prc16K
+    \value Prc32K
+    \value Prc32KBig
+    \value FanFoldUS
+    \value FanFoldGerman
+    \value FanFoldGermanLegal
+    \value EnvelopeB4
+    \value EnvelopeB5
+    \value EnvelopeB6
+    \value EnvelopeC0
+    \value EnvelopeC1
+    \value EnvelopeC2
+    \value EnvelopeC3
+    \value EnvelopeC4
+    \value EnvelopeC5 = \c C5E
+    \value EnvelopeC6
+    \value EnvelopeC65
+    \value EnvelopeC7
+    \value EnvelopeDL = \c DLE
+    \value Envelope9
+    \value Envelope10 = \c Comm10E
+    \value Envelope11
+    \value Envelope12
+    \value Envelope14
+    \value EnvelopeMonarch
+    \value EnvelopePersonal
+    \value EnvelopeChou3
+    \value EnvelopeChou4
+    \value EnvelopeInvite
+    \value EnvelopeItalian
+    \value EnvelopeKaku2
+    \value EnvelopeKaku3
+    \value EnvelopePrc1
+    \value EnvelopePrc2
+    \value EnvelopePrc3
+    \value EnvelopePrc4
+    \value EnvelopePrc5
+    \value EnvelopePrc6
+    \value EnvelopePrc7
+    \value EnvelopePrc8
+    \value EnvelopePrc9
+    \value EnvelopePrc10
+    \value EnvelopeYou4
+    \value LastPageSize = \c EnvelopeYou4
+    \omitvalue NPageSize
+    \omitvalue NPaperSize
+
+    \sa WebEngineView::printToPDF()
+*/
+
+/*!
+    \qmlproperty enumeration WebEngineView::PrintedPageOrientation
+    \since QtWebEngine 1.3
+
+    Describes the orientation of a PDF document that gets created from the WebEngineView's contents.
+    The enumeration values are mapped from and must match QPageLayout::Orientation.
+
+    \value Portrait
+    The document will be created using portrait orientation.
+
+    \value Landscape
+    The document will be created using landscape orientation.
+
+    \sa WebEngineView::printToPDF()
+*/
+
+/*!
     \qmltype WebEngineFullScreenRequest
     \instantiates QQuickWebEngineFullScreenRequest
     \inqmlmodule QtWebEngine
@@ -785,6 +944,14 @@
 */
 
 /*!
+    \qmlmethod void WebEngineView::printToPDF(const QString &filePath, PrintedPageSizeId pageSizeId, PrintedPageOrientation orientation)
+    \since QtWebEngine 1.3
+
+    Prints the WebEngineView's current contents to a PDF document and stores it under \a filePath. The document's size will be determined
+    by the value of \a pageSizeId and its orientation will be determined using \a orientation.
+*/
+
+/*!
     \qmlsignal void WebEngineView::wasRecentlyAudibleChanged(bool wasRecentlyAudible)
     \since QtWebEngine 1.3