Add manual tests for PdfPageView

Before ff13e6532975b5372280c02061cb1b7227cf6699 the pdfviewer example
used PdfPageView; but from then until now, it was not used anywhere.
Now there's a manual test, slightly more refined than it was then.

PdfPageView no longer takes care of its own positioning (scrolling
or panning by whatever means): the user has the responsibility for that
(as in the pdfPageView manual test). But it still does its own pinch
zoom and text selection, so it's not completely devoid of event handlers.

This also makes it suitable for the the multipleDocuments manual
test, which creates a fullscreen transparent MDI window with fake
windows inside, one per document opened. Worked around some issues by
having PdfPageView as the top-level item in the Component.

Fixes: QTBUG-102295
Change-Id: Iedb9ed7d15fa3461c07bd5d6ea54a30c20f747da
Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io>

2 files changed, 582 insertions, 0 deletions

diff --git a/tests/manual/quick/pdf/multipleDocuments.qml b/tests/manual/quick/pdf/multipleDocuments.qml
new file mode 100644
index 000000000..3e5fab9b4
--- /dev/null
+++ b/tests/manual/quick/pdf/multipleDocuments.qml
@@ -0,0 +1,229 @@
+/****************************************************************************
+**
+** Copyright (C) 2022 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the examples of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:BSD$
+** 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 The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** BSD License Usage
+** Alternatively, you may use this file under the terms of the BSD license
+** as follows:
+**
+** "Redistribution and use in source and binary forms, with or without
+** modification, are permitted provided that the following conditions are
+** met:
+**   * Redistributions of source code must retain the above copyright
+**     notice, this list of conditions and the following disclaimer.
+**   * Redistributions in binary form must reproduce the above copyright
+**     notice, this list of conditions and the following disclaimer in
+**     the documentation and/or other materials provided with the
+**     distribution.
+**   * Neither the name of The Qt Company Ltd nor the names of its
+**     contributors may be used to endorse or promote products derived
+**     from this software without specific prior written permission.
+**
+**
+** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+import QtQuick
+import QtQuick.Controls
+import QtQuick.Dialogs
+import QtQuick.Layouts
+import QtQuick.Pdf
+import Qt.labs.animation
+
+ApplicationWindow {
+    id: root
+    width: 1280
+    height: 1024
+    color: "transparent"
+    flags: Qt.FramelessWindowHint
+    visibility: Window.FullScreen
+    property string source // for main.cpp
+    property real scaleStep: Math.sqrt(2)
+
+    Component {
+        id: pdfWindow
+
+        PdfPageView {
+            property alias source: document.source
+
+            Rectangle {
+                visible: parent.activeFocus
+                color: "transparent"
+                border.color: "cyan"
+                border.width: 3
+                anchors.fill: parent
+                anchors.margins: -border.width
+                anchors.topMargin: -toolbar.height - border.width
+            }
+
+            ToolBar {
+                id: toolbar
+                width: parent.width
+                y: -height
+                RowLayout {
+                    anchors.fill: parent
+                    anchors.rightMargin: 6
+                    ToolButton {
+                        action: Action {
+                            shortcut: StandardKey.ZoomIn
+                            enabled: pageView.sourceSize.width < 10000
+                            icon.source: "../../../../examples/pdf/pdfviewer/resources/zoom-in.svg"
+                            onTriggered: pageView.renderScale *= root.scaleStep
+                        }
+                    }
+                    ToolButton {
+                        action: Action {
+                            shortcut: StandardKey.ZoomOut
+                            enabled: pageView.sourceSize.width > 50
+                            icon.source: "../../../../examples/pdf/pdfviewer/resources/zoom-out.svg"
+                            onTriggered: pageView.renderScale /= root.scaleStep
+                        }
+                    }
+                    ToolButton {
+                        action: Action {
+                            shortcut: "Ctrl+0"
+                            icon.source: "../../../../examples/pdf/pdfviewer/resources/zoom-original.svg"
+                            onTriggered: pageView.resetScale()
+                        }
+                    }
+                    ToolButton {
+                        action: Action {
+                            icon.source: "../../../../examples/pdf/pdfviewer/resources/go-previous-view-page.svg"
+                            enabled: pageView.backEnabled
+                            onTriggered: pageView.back()
+                        }
+                        ToolTip.visible: enabled && hovered
+                        ToolTip.delay: 2000
+                        ToolTip.text: "go back"
+                    }
+                    SpinBox {
+                        id: currentPageSB
+                        from: 1
+                        to: document.pageCount
+                        editable: true
+                        value: pageView.currentPage + 1
+                        onValueModified: pageView.goToPage(value - 1)
+                        Layout.maximumWidth: 60
+                    }
+                    ToolButton {
+                        action: Action {
+                            icon.source: "../../../../examples/pdf/pdfviewer/resources/go-next-view-page.svg"
+                            enabled: pageView.forwardEnabled
+                            onTriggered: pageView.forward()
+                        }
+                        ToolTip.visible: enabled && hovered
+                        ToolTip.delay: 2000
+                        ToolTip.text: "go forward"
+                    }
+                    Text {
+                        text: document.title
+                        elide: Text.ElideRight
+                        Layout.fillWidth: true
+                    }
+                    DragHandler {
+                        target: pageView
+                    }
+                    TapHandler {
+                        onTapped: pageView.z++
+                    }
+                    ToolButton {
+                        action: Action {
+                            shortcut: StandardKey.Close
+                            text: "☒"
+                            onTriggered: pageView.destroy()
+                        }
+                    }
+                }
+            }
+
+            id: pageView
+            document: PdfDocument {
+                id: document
+                source: Qt.resolvedUrl(root.source)
+                onStatusChanged: (status) => { if (status === PdfDocument.Error) errorDialog.open() }
+            }
+
+            DragHandler {
+                acceptedButtons: Qt.MiddleButton
+            }
+            DragHandler {
+                acceptedDevices: PointerDevice.TouchScreen
+            }
+            HoverHandler {
+                onHoveredChanged: if (hovered) pageView.forceActiveFocus()
+            }
+
+            Dialog {
+                id: errorDialog
+                title: "Error loading " + document.source
+                standardButtons: Dialog.Ok
+                modal: true
+                closePolicy: Popup.CloseOnEscape
+                anchors.centerIn: parent
+                width: 300
+
+                Label {
+                    id: errorField
+                    text: document.error
+                }
+            }
+        }
+    }
+
+    Shortcut {
+        sequence: StandardKey.MoveToPreviousPage
+        onActivated: root.activeFocusItem.goToPage(root.activeFocusItem.currentPage - 1)
+    }
+    Shortcut {
+        sequence: StandardKey.MoveToNextPage
+        onActivated: root.activeFocusItem.goToPage(root.activeFocusItem.currentPage + 1)
+    }
+    Shortcut {
+        sequence: StandardKey.Open
+        onActivated: fileDialog.open()
+    }
+    Shortcut {
+        sequence: StandardKey.Quit
+        onActivated: Qt.quit()
+    }
+
+    function open(src) {
+        var win = pdfWindow.createObject(root, { source: src, y: 50 })
+    }
+
+    Component.onCompleted: {
+        if (Application.arguments.length > 2)
+            root.open(Application.arguments[Application.arguments.length - 1])
+    }
+
+    FileDialog {
+        id: fileDialog
+        title: "Open a PDF file"
+        nameFilters: [ "PDF files (*.pdf)" ]
+        onAccepted: root.open(selectedFile)
+    }
+}
diff --git a/tests/manual/quick/pdf/pdfPageView.qml b/tests/manual/quick/pdf/pdfPageView.qml
new file mode 100644
index 000000000..393d1f774
--- /dev/null
+++ b/tests/manual/quick/pdf/pdfPageView.qml
@@ -0,0 +1,353 @@
+/****************************************************************************
+**
+** Copyright (C) 2022 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the examples of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:BSD$
+** 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 The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** BSD License Usage
+** Alternatively, you may use this file under the terms of the BSD license
+** as follows:
+**
+** "Redistribution and use in source and binary forms, with or without
+** modification, are permitted provided that the following conditions are
+** met:
+**   * Redistributions of source code must retain the above copyright
+**     notice, this list of conditions and the following disclaimer.
+**   * Redistributions in binary form must reproduce the above copyright
+**     notice, this list of conditions and the following disclaimer in
+**     the documentation and/or other materials provided with the
+**     distribution.
+**   * Neither the name of The Qt Company Ltd nor the names of its
+**     contributors may be used to endorse or promote products derived
+**     from this software without specific prior written permission.
+**
+**
+** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+import QtQuick
+import QtQuick.Controls
+import QtQuick.Dialogs
+import QtQuick.Layouts
+import QtQuick.Pdf
+import Qt.labs.animation
+
+ApplicationWindow {
+    id: root
+    width: 800
+    height: 1024
+    color: "lightgrey"
+    title: document.title
+    visible: true
+    property string source // for main.cpp
+    property real scaleStep: Math.sqrt(2)
+
+    header: ToolBar {
+        RowLayout {
+            anchors.fill: parent
+            anchors.rightMargin: 6
+            ToolButton {
+                action: Action {
+                    shortcut: StandardKey.Open
+                    icon.source: "../../../../examples/pdf/pdfviewer/resources/document-open.svg"
+                    onTriggered: fileDialog.open()
+                }
+            }
+            ToolButton {
+                action: Action {
+                    shortcut: StandardKey.ZoomIn
+                    enabled: pageView.sourceSize.width < 10000
+                    icon.source: "../../../../examples/pdf/pdfviewer/resources/zoom-in.svg"
+                    onTriggered: pageView.renderScale *= root.scaleStep
+                }
+            }
+            ToolButton {
+                action: Action {
+                    shortcut: StandardKey.ZoomOut
+                    enabled: pageView.sourceSize.width > 50
+                    icon.source: "../../../../examples/pdf/pdfviewer/resources/zoom-out.svg"
+                    onTriggered: pageView.renderScale /= root.scaleStep
+                }
+            }
+            ToolButton {
+                action: Action {
+                    icon.source: "../../../../examples/pdf/pdfviewer/resources/zoom-fit-width.svg"
+                    onTriggered: pageView.scaleToWidth(root.contentItem.width, root.contentItem.height)
+                }
+            }
+            ToolButton {
+                action: Action {
+                    icon.source: "../../../../examples/pdf/pdfviewer/resources/zoom-fit-best.svg"
+                    onTriggered: pageView.scaleToPage(root.contentItem.width, root.contentItem.height)
+                }
+            }
+            ToolButton {
+                action: Action {
+                    shortcut: "Ctrl+0"
+                    icon.source: "../../../../examples/pdf/pdfviewer/resources/zoom-original.svg"
+                    onTriggered: pageView.resetScale()
+                }
+            }
+            ToolButton {
+                action: Action {
+                    shortcut: "Ctrl+L"
+                    icon.source: "../../../../examples/pdf/pdfviewer/resources/rotate-left.svg"
+                    onTriggered: pageView.rotation -= 90
+                }
+            }
+            ToolButton {
+                action: Action {
+                    shortcut: "Ctrl+R"
+                    icon.source: "../../../../examples/pdf/pdfviewer/resources/rotate-right.svg"
+                    onTriggered: pageView.rotation += 90
+                }
+            }
+            ToolButton {
+                action: Action {
+                    icon.source: "../../../../examples/pdf/pdfviewer/resources/go-previous-view-page.svg"
+                    enabled: pageView.backEnabled
+                    onTriggered: pageView.back()
+                }
+                ToolTip.visible: enabled && hovered
+                ToolTip.delay: 2000
+                ToolTip.text: "go back"
+            }
+            SpinBox {
+                id: currentPageSB
+                from: 1
+                to: document.pageCount
+                editable: true
+                value: pageView.currentPage + 1
+                onValueModified: pageView.goToPage(value - 1)
+                Shortcut {
+                    sequence: StandardKey.MoveToPreviousPage
+                    onActivated: pageView.goToPage(currentPageSB.value - 2)
+                }
+                Shortcut {
+                    sequence: StandardKey.MoveToNextPage
+                    onActivated: pageView.goToPage(currentPageSB.value)
+                }
+            }
+            ToolButton {
+                action: Action {
+                    icon.source: "../../../../examples/pdf/pdfviewer/resources/go-next-view-page.svg"
+                    enabled: pageView.forwardEnabled
+                    onTriggered: pageView.forward()
+                }
+                ToolTip.visible: enabled && hovered
+                ToolTip.delay: 2000
+                ToolTip.text: "go forward"
+            }
+            ToolButton {
+                action: Action {
+                    shortcut: StandardKey.Copy
+                    icon.source: "../../../../examples/pdf/pdfviewer/resources/edit-copy.svg"
+                    enabled: pageView.selectedText !== ""
+                    onTriggered: pageView.copySelectionToClipboard()
+                }
+            }
+            Shortcut {
+                sequence: StandardKey.Quit
+                onActivated: Qt.quit()
+            }
+        }
+    }
+
+    FileDialog {
+        id: fileDialog
+        title: "Open a PDF file"
+        nameFilters: [ "PDF files (*.pdf)" ]
+        onAccepted: document.source = selectedFile
+    }
+
+    Component.onCompleted: {
+        if (Application.arguments.length > 2)
+            document.source = Application.arguments[Application.arguments.length - 1]
+    }
+
+    Dialog {
+        id: errorDialog
+        title: "Error loading " + document.source
+        standardButtons: Dialog.Ok
+        modal: true
+        closePolicy: Popup.CloseOnEscape
+        anchors.centerIn: parent
+        width: 300
+
+        Label {
+            id: errorField
+            text: document.error
+        }
+    }
+
+    PdfPageView {
+        id: pageView
+        x: searchDrawer.position * searchDrawer.width // TODO binding gets broken during centering
+        document: PdfDocument {
+            id: document
+            source: Qt.resolvedUrl(root.source)
+            onStatusChanged: (status) => { if (status === PdfDocument.Error) errorDialog.open() }
+        }
+        searchString: searchField.text
+        onRenderScaleChanged: pageView.returnToBounds()
+
+        DragHandler {
+            acceptedButtons: Qt.MiddleButton
+            onActiveChanged: if (!active) pageView.returnToBounds()
+        }
+        DragHandler {
+            acceptedDevices: PointerDevice.TouchScreen
+            onActiveChanged: if (!active) pageView.returnToBounds()
+        }
+
+        BoundaryRule on x {
+            id: brx
+            minimumOvershoot: 100
+            maximumOvershoot: 100
+            minimum: Math.min(0, root.width - pageView.width)
+            maximum: 0
+        }
+
+        BoundaryRule on y {
+            id: bry
+            minimumOvershoot: 100
+            maximumOvershoot: 100
+            minimum: Math.min(0, root.height - pageView.height)
+            maximum: 0
+        }
+
+        function returnToBounds() {
+            bry.returnToBounds()
+            brx.returnToBounds()
+        }
+    }
+
+    WheelHandler {
+        target: pageView
+        property: "x"
+        orientation: Qt.Horizontal
+        acceptedDevices: PointerDevice.Mouse | PointerDevice.TouchPad
+        acceptedModifiers: Qt.NoModifier
+        onActiveChanged: if (!active) brx.returnToBounds()
+    }
+    WheelHandler {
+        target: pageView
+        property: "y"
+        orientation: Qt.Vertical
+        acceptedDevices: PointerDevice.Mouse | PointerDevice.TouchPad
+        acceptedModifiers: Qt.NoModifier
+        onActiveChanged: if (!active) bry.returnToBounds()
+    }
+
+    Drawer {
+        id: searchDrawer
+        edge: Qt.LeftEdge
+        modal: false
+        width: searchLayout.implicitWidth
+        y: root.header.height
+        height: root.contentItem.height
+        dim: false
+        Shortcut {
+            sequence: StandardKey.Find
+            onActivated: {
+                searchDrawer.open()
+                searchField.forceActiveFocus()
+            }
+        }
+        ColumnLayout {
+            id: searchLayout
+            anchors.fill: parent
+            anchors.margins: 2
+            RowLayout {
+                ToolButton {
+                    action: Action {
+                        icon.source: "../../../../examples/pdf/pdfviewer/resources/go-up-search.svg"
+                        shortcut: StandardKey.FindPrevious
+                        onTriggered: pageView.searchBack()
+                    }
+                    ToolTip.visible: enabled && hovered
+                    ToolTip.delay: 2000
+                    ToolTip.text: "find previous"
+                }
+                TextField {
+                    id: searchField
+                    placeholderText: "search"
+                    Layout.minimumWidth: 200
+                    Layout.fillWidth: true
+                    Image {
+                        visible: searchField.text !== ""
+                        source: "../../../../examples/pdf/pdfviewer/resources/edit-clear.svg"
+                        anchors {
+                            right: parent.right
+                            top: parent.top
+                            bottom: parent.bottom
+                            margins: 3
+                            rightMargin: 5
+                        }
+                        TapHandler {
+                            onTapped: searchField.clear()
+                        }
+                    }
+                }
+                ToolButton {
+                    action: Action {
+                        icon.source: "../../../../examples/pdf/pdfviewer/resources/go-down-search.svg"
+                        shortcut: StandardKey.FindNext
+                        onTriggered: pageView.searchForward()
+                    }
+                    ToolTip.visible: enabled && hovered
+                    ToolTip.delay: 2000
+                    ToolTip.text: "find next"
+                }
+            }
+            ListView {
+                id: searchResultsList
+                Layout.fillWidth: true
+                Layout.fillHeight: true
+                clip: true
+                model: pageView.searchModel
+                ScrollBar.vertical: ScrollBar { }
+                delegate: ItemDelegate {
+                    width: parent ? parent.width : 0
+                    text: "page " + (page + 1) + ": " + contextBefore + pageView.searchString + contextAfter
+                    highlighted: ListView.isCurrentItem
+                    onClicked: {
+                        searchResultsList.currentIndex = index
+                        pageView.goToLocation(page, location, 0)
+                        pageView.searchModel.currentResult = indexOnPage
+                    }
+                }
+            }
+        }
+    }
+
+    footer: Label {
+        property size implicitPointSize: document.pagePointSize(pageView.currentPage)
+        text: "page " + (pageView.currentPage + 1) + " of " + document.pageCount +
+              " scale " + pageView.renderScale.toFixed(2) +
+              " original " + implicitPointSize.width.toFixed(1) + "x" + implicitPointSize.height.toFixed(1) + "pts"
+        visible: document.status === PdfDocument.Ready
+    }
+}