Add PdfLinkModel

Internal links and web links populate the QALM, which can then
be used to drive a Repeater to position highlight rectangles
with TapHandlers, which will handle a click by jumping to the
link destination.

Fixes: QTBUG-77511
Change-Id: I3b5b96d6e82bfd578f31f631f24279173036a080
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Michal Klocek <michal.klocek@qt.io>

11 files changed, 702 insertions, 0 deletions

diff --git a/src/pdf/api/qpdfdocument.h b/src/pdf/api/qpdfdocument.h
index 46d197f1d..9d3a4bb19 100644
--- a/src/pdf/api/qpdfdocument.h
+++ b/src/pdf/api/qpdfdocument.h
@@ -122,6 +122,7 @@ Q_SIGNALS:
 
 private:
     friend class QPdfBookmarkModelPrivate;
+    friend class QPdfLinkModelPrivate;
     friend class QPdfSearchModel;
 
     Q_PRIVATE_SLOT(d, void _q_tryLoadingWithSizeFromContentHeader())
diff --git a/src/pdf/api/qpdflinkmodel_p.h b/src/pdf/api/qpdflinkmodel_p.h
new file mode 100644
index 000000000..cf9c0aad4
--- /dev/null
+++ b/src/pdf/api/qpdflinkmodel_p.h
@@ -0,0 +1,106 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the QtPDF module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL3$
+** 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 http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/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 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPLv3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or later 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 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QPDFLINKMODEL_P_H
+#define QPDFLINKMODEL_P_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists purely as an
+// implementation detail.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#include "qtpdfglobal.h"
+#include "qpdfdocument.h"
+
+#include <QObject>
+#include <QAbstractListModel>
+
+QT_BEGIN_NAMESPACE
+
+class QPdfLinkModelPrivate;
+
+class Q_PDF_EXPORT QPdfLinkModel : public QAbstractListModel
+{
+    Q_OBJECT
+    Q_PROPERTY(QPdfDocument *document READ document WRITE setDocument NOTIFY documentChanged)
+    Q_PROPERTY(int page READ page WRITE setPage NOTIFY pageChanged)
+
+public:
+    enum class Role : int {
+        Rect = Qt::UserRole,
+        Url,
+        Page,
+        Location,
+        Zoom,
+        _Count
+    };
+    Q_ENUM(Role)
+    explicit QPdfLinkModel(QObject *parent = nullptr);
+    ~QPdfLinkModel();
+
+    QPdfDocument *document() const;
+
+    QHash<int, QByteArray> roleNames() const override;
+    int rowCount(const QModelIndex &parent) const override;
+    QVariant data(const QModelIndex &index, int role) const override;
+
+    int page() const;
+
+public Q_SLOTS:
+    void setDocument(QPdfDocument *document);
+    void setPage(int page);
+
+Q_SIGNALS:
+    void documentChanged();
+    void pageChanged(int page);
+
+private Q_SLOTS:
+    void onStatusChanged(QPdfDocument::Status status);
+
+private:
+    QHash<int, QByteArray> m_roleNames;
+    Q_DECLARE_PRIVATE(QPdfLinkModel)
+};
+
+QT_END_NAMESPACE
+
+#endif // QPDFLINKMODEL_P_H
diff --git a/src/pdf/api/qpdflinkmodel_p_p.h b/src/pdf/api/qpdflinkmodel_p_p.h
new file mode 100644
index 000000000..3e44f1651
--- /dev/null
+++ b/src/pdf/api/qpdflinkmodel_p_p.h
@@ -0,0 +1,91 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the QtPDF module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL3$
+** 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 http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/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 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPLv3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or later 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 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QPDFLINKMODEL_P_P_H
+#define QPDFLINKMODEL_P_P_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists purely as an
+// implementation detail.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#include "qpdflinkmodel_p.h"
+#include <private/qabstractitemmodel_p.h>
+
+#include "third_party/pdfium/public/fpdfview.h"
+
+#include <QUrl>
+
+QT_BEGIN_NAMESPACE
+
+class QPdfLinkModelPrivate: public QAbstractItemModelPrivate
+{
+    Q_DECLARE_PUBLIC(QPdfLinkModel)
+
+public:
+    QPdfLinkModelPrivate();
+
+    void update();
+
+    struct Link {
+        // where it is on the current page
+        QRectF rect;
+        int textStart = -1;
+        int textCharCount = 0;
+        // destination inside PDF
+        int page = -1; // -1 means look at the url instead
+        QPointF location;
+        qreal zoom = 1;
+        // web destination
+        QUrl url;
+
+        QString toString() const;
+    };
+
+    QPdfDocument *document = nullptr;
+    QVector<Link> links;
+    int page = 0;
+};
+
+QT_END_NAMESPACE
+
+#endif // QPDFLINKMODEL_P_P_H
diff --git a/src/pdf/pdfcore.pro b/src/pdf/pdfcore.pro
index f50c3aa06..ecb1d0cdb 100644
--- a/src/pdf/pdfcore.pro
+++ b/src/pdf/pdfcore.pro
@@ -61,6 +61,7 @@ ios: OBJECTS += $$NINJA_OBJECTS
 SOURCES += \
     qpdfbookmarkmodel.cpp \
     qpdfdocument.cpp \
+    qpdflinkmodel.cpp \
     qpdfpagenavigation.cpp \
     qpdfpagerenderer.cpp \
     qpdfsearchmodel.cpp \
@@ -75,6 +76,8 @@ HEADERS += \
     api/qpdfdocument_p.h \
     api/qpdfdocumentrenderoptions.h \
     api/qtpdfglobal.h \
+    api/qpdflinkmodel_p.h \
+    api/qpdflinkmodel_p_p.h \
     api/qpdfnamespace.h \
     api/qpdfpagenavigation.h \
     api/qpdfpagerenderer.h \
diff --git a/src/pdf/qpdflinkmodel.cpp b/src/pdf/qpdflinkmodel.cpp
new file mode 100644
index 000000000..8b49fec21
--- /dev/null
+++ b/src/pdf/qpdflinkmodel.cpp
@@ -0,0 +1,251 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the QtPDF module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL3$
+** 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 http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/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 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPLv3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or later 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 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qpdflinkmodel_p.h"
+#include "qpdflinkmodel_p_p.h"
+#include "qpdfdocument_p.h"
+
+#include "third_party/pdfium/public/fpdf_doc.h"
+#include "third_party/pdfium/public/fpdf_text.h"
+
+#include <QLoggingCategory>
+#include <QMetaEnum>
+
+QT_BEGIN_NAMESPACE
+
+Q_LOGGING_CATEGORY(qLcLink, "qt.pdf.links")
+
+QPdfLinkModel::QPdfLinkModel(QObject *parent)
+    : QAbstractListModel(*(new QPdfLinkModelPrivate()), parent)
+{
+    QMetaEnum rolesMetaEnum = metaObject()->enumerator(metaObject()->indexOfEnumerator("Role"));
+    for (int r = Qt::UserRole; r < int(Role::_Count); ++r)
+        m_roleNames.insert(r, QByteArray(rolesMetaEnum.valueToKey(r)).toLower());
+}
+
+QPdfLinkModel::~QPdfLinkModel() {}
+
+QHash<int, QByteArray> QPdfLinkModel::roleNames() const
+{
+    return m_roleNames;
+}
+
+int QPdfLinkModel::rowCount(const QModelIndex &parent) const
+{
+    Q_D(const QPdfLinkModel);
+    Q_UNUSED(parent)
+    return d->links.count();
+}
+
+QVariant QPdfLinkModel::data(const QModelIndex &index, int role) const
+{
+    Q_D(const QPdfLinkModel);
+    const QPdfLinkModelPrivate::Link &link = d->links.at(index.row());
+    switch (Role(role)) {
+    case Role::Rect:
+        return link.rect;
+    case Role::Url:
+        return link.url;
+    case Role::Page:
+        return link.page;
+    case Role::Location:
+        return link.location;
+    case Role::Zoom:
+        return link.zoom;
+    case Role::_Count:
+        break;
+    }
+    if (role == Qt::DisplayRole)
+        return link.toString();
+    return QVariant();
+}
+
+QPdfDocument *QPdfLinkModel::document() const
+{
+    Q_D(const QPdfLinkModel);
+    return d->document;
+}
+
+void QPdfLinkModel::setDocument(QPdfDocument *document)
+{
+    Q_D(QPdfLinkModel);
+    if (d->document == document)
+        return;
+    disconnect(d->document, &QPdfDocument::statusChanged, this, &QPdfLinkModel::onStatusChanged);
+    connect(document, &QPdfDocument::statusChanged, this, &QPdfLinkModel::onStatusChanged);
+    d->document = document;
+    emit documentChanged();
+    if (page())
+        setPage(0);
+    else
+        d->update();
+}
+
+int QPdfLinkModel::page() const
+{
+    Q_D(const QPdfLinkModel);
+    return d->page;
+}
+
+void QPdfLinkModel::setPage(int page)
+{
+    Q_D(QPdfLinkModel);
+    if (d->page == page)
+        return;
+
+    d->page = page;
+    emit pageChanged(page);
+    d->update();
+}
+
+QPdfLinkModelPrivate::QPdfLinkModelPrivate() : QAbstractItemModelPrivate()
+{
+}
+
+void QPdfLinkModelPrivate::update()
+{
+    Q_Q(QPdfLinkModel);
+    if (!document || !document->d->doc)
+        return;
+    auto doc = document->d->doc;
+    const QPdfMutexLocker lock;
+    FPDF_PAGE pdfPage = FPDF_LoadPage(doc, page);
+    if (!pdfPage) {
+        qWarning() << "failed to load page" << page;
+        return;
+    }
+    double pageHeight = FPDF_GetPageHeight(pdfPage);
+    q->beginResetModel();
+    links.clear();
+
+    // Iterate the ordinary links
+    int linkStart = 0;
+    bool ok = true;
+    while (ok) {
+        FPDF_LINK linkAnnot;
+        ok = FPDFLink_Enumerate(pdfPage, &linkStart, &linkAnnot);
+        if (!ok)
+            break;
+        FS_RECTF rect;
+        ok = FPDFLink_GetAnnotRect(linkAnnot, &rect);
+        if (!ok)
+            break;
+        Link linkData;
+        linkData.rect = QRectF(rect.left, pageHeight - rect.top,
+                               rect.right - rect.left, rect.top - rect.bottom);
+        FPDF_DEST dest = FPDFLink_GetDest(doc, linkAnnot);
+        FPDF_ACTION action = FPDFLink_GetAction(linkAnnot);
+        if (FPDFAction_GetType(action) != PDFACTION_GOTO) {
+            qWarning() << "link action type" << FPDFAction_GetType(action) << "is not yet supported";
+            continue;
+        }
+        linkData.page = FPDFDest_GetDestPageIndex(doc, dest);
+        FPDF_BOOL hasX, hasY, hasZoom;
+        FS_FLOAT x, y, zoom;
+        ok = FPDFDest_GetLocationInPage(dest, &hasX, &hasY, &hasZoom, &x, &y, &zoom);
+        if (!ok)
+            break;
+        if (hasX && hasY)
+            linkData.location = QPointF(x, y);
+        if (hasZoom)
+            linkData.zoom = zoom;
+        links << linkData;
+    }
+
+    // Iterate the web links
+    FPDF_TEXTPAGE textPage = FPDFText_LoadPage(pdfPage);
+    if (textPage) {
+        FPDF_PAGELINK webLinks = FPDFLink_LoadWebLinks(textPage);
+        if (webLinks) {
+            int count = FPDFLink_CountWebLinks(webLinks);
+            for (int i = 0; i < count; ++i) {
+                Link linkData;
+                int len = FPDFLink_GetURL(webLinks, i, nullptr, 0);
+                if (len < 1) {
+                    qWarning() << "URL" << i << "has length" << len;
+                } else {
+                    QVector<unsigned short> buf(len);
+                    int got = FPDFLink_GetURL(webLinks, i, buf.data(), len);
+                    Q_ASSERT(got == len);
+                    linkData.url = QString::fromUtf16(buf.data(), got - 1);
+                }
+                FPDFLink_GetTextRange(webLinks, i, &linkData.textStart, &linkData.textCharCount);
+                len = FPDFLink_CountRects(webLinks, i);
+                for (int r = 0; r < len; ++r) {
+                    double left, top, right, bottom;
+                    bool success = FPDFLink_GetRect(webLinks, i, r, &left, &top, &right, &bottom);
+                    if (success) {
+                        linkData.rect = QRectF(left, pageHeight - top, right - left, top - bottom);
+                        links << linkData;
+                    }
+                }
+            }
+            FPDFLink_CloseWebLinks(webLinks);
+        }
+        FPDFText_ClosePage(textPage);
+    }
+
+    // All done
+    FPDF_ClosePage(pdfPage);
+    if (Q_UNLIKELY(qLcLink().isDebugEnabled())) {
+        for (const Link &l : links)
+            qCDebug(qLcLink) << l.rect << l.toString();
+    }
+    q->endResetModel();
+}
+
+void QPdfLinkModel::onStatusChanged(QPdfDocument::Status status)
+{
+    Q_D(QPdfLinkModel);
+    qCDebug(qLcLink) << "sees document statusChanged" << status;
+    if (status == QPdfDocument::Ready)
+        d->update();
+}
+
+QString QPdfLinkModelPrivate::Link::toString() const
+{
+    QString ret;
+    if (page >= 0)
+        return QLatin1String("page ") + QString::number(page) +
+                QLatin1String(" location ") + QString::number(location.x()) + QLatin1Char(',') + QString::number(location.y()) +
+                QLatin1String(" zoom ") + QString::number(zoom);
+    else
+        return url.toString();
+}
+
+QT_END_NAMESPACE
+
+#include "moc_qpdflinkmodel_p.cpp"
diff --git a/src/pdf/quick/plugin.cpp b/src/pdf/quick/plugin.cpp
index 72aa12d6a..519ea43af 100644
--- a/src/pdf/quick/plugin.cpp
+++ b/src/pdf/quick/plugin.cpp
@@ -39,6 +39,7 @@
 #include <QtQml/qqmlengine.h>
 #include <QtQml/qqmlextensionplugin.h>
 #include "qquickpdfdocument_p.h"
+#include "qquickpdflinkmodel_p.h"
 #include "qquickpdfsearchmodel_p.h"
 #include "qquickpdfselection_p.h"
 
@@ -81,6 +82,7 @@ public:
         qmlRegisterModule(uri, 2, QT_VERSION_MINOR);
 
         qmlRegisterType<QQuickPdfDocument>(uri, 5, 15, "PdfDocument");
+        qmlRegisterType<QQuickPdfLinkModel>(uri, 5, 15, "PdfLinkModel");
         qmlRegisterType<QQuickPdfSearchModel>(uri, 5, 15, "PdfSearchModel");
         qmlRegisterType<QQuickPdfSelection>(uri, 5, 15, "PdfSelection");
 
diff --git a/src/pdf/quick/qml/PdfPageView.qml b/src/pdf/quick/qml/PdfPageView.qml
index 2f9c5ef99..556cf1b7a 100644
--- a/src/pdf/quick/qml/PdfPageView.qml
+++ b/src/pdf/quick/qml/PdfPageView.qml
@@ -118,6 +118,32 @@ Rectangle {
             }
         }
     }
+
+    Repeater {
+        model: PdfLinkModel {
+            id: linkModel
+            document: paper.document
+            page: image.currentFrame
+        }
+        delegate: Rectangle {
+            color: "transparent"
+            border.color: "lightgrey"
+            x: rect.x * paper.__pageScale
+            y: rect.y * paper.__pageScale
+            width: rect.width * paper.__pageScale
+            height: rect.height * paper.__pageScale
+            HoverHandler { cursorShape: Qt.PointingHandCursor } // 5.15 onward (QTBUG-68073)
+            TapHandler {
+                onTapped: {
+                    if (page >= 0)
+                        image.currentFrame = page
+                    else
+                        Qt.openUrlExternally(url)
+                }
+            }
+        }
+    }
+
     PinchHandler {
         id: pinch
         minimumScale: 0.1
diff --git a/src/pdf/quick/qquickpdfdocument_p.h b/src/pdf/quick/qquickpdfdocument_p.h
index 1ec7edb1a..9817b5eef 100644
--- a/src/pdf/quick/qquickpdfdocument_p.h
+++ b/src/pdf/quick/qquickpdfdocument_p.h
@@ -118,6 +118,7 @@ private:
     QUrl m_source;
     QPdfDocument m_doc;
 
+    friend class QQuickPdfLinkModel;
     friend class QQuickPdfSearchModel;
     friend class QQuickPdfSelection;
 
diff --git a/src/pdf/quick/qquickpdflinkmodel.cpp b/src/pdf/quick/qquickpdflinkmodel.cpp
new file mode 100644
index 000000000..a3f552d17
--- /dev/null
+++ b/src/pdf/quick/qquickpdflinkmodel.cpp
@@ -0,0 +1,132 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the QtPDF module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL3$
+** 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 http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/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 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPLv3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or later 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 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qquickpdflinkmodel_p.h"
+#include <QQuickItem>
+#include <QQmlEngine>
+#include <QStandardPaths>
+#include <private/qguiapplication_p.h>
+
+QT_BEGIN_NAMESPACE
+
+/*!
+    \qmltype PdfLinkModel
+    \instantiates QQuickPdfLinkModel
+    \inqmlmodule QtQuick.Pdf
+    \ingroup pdf
+    \brief A representation of links within a PDF document.
+    \since 5.15
+
+    PdfLinkModel provides the geometry and the destination for each link
+    that the specified \l page contains.
+
+    The available model roles are:
+
+    \value rect
+        Bounding rectangle around the link.
+    \value url
+        If the link is a web link, the URL for that; otherwise an empty URL.
+    \value page
+        If the link is an internal link, the page number to which the link should jump; otherwise \c {-1}.
+    \value location
+        If the link is an internal link, the location on the page to which the link should jump.
+    \value zoom
+        If the link is an internal link, the intended zoom level on the destination page.
+
+    Normally it will be used with \l {QtQuick::Repeater}{Repeater} to visualize
+    the links and provide the ability to click them:
+
+    \qml
+    Repeater {
+        model: PdfLinkModel {
+            document: root.document
+            page: image.currentFrame
+        }
+        delegate: Rectangle {
+            color: "transparent"
+            border.color: "lightgrey"
+            x: rect.x
+            y: rect.y
+            width: rect.width
+            height: rect.height
+            HoverHandler { cursorShape: Qt.PointingHandCursor }
+            TapHandler {
+                onTapped: {
+                    if (page >= 0)
+                        image.currentFrame = page
+                    else
+                        Qt.openUrlExternally(url)
+                }
+            }
+        }
+    }
+    \endqml
+
+    \note General-purpose PDF viewing capabilities are provided by
+    \l PdfPageView and \l PdfMultiPageView. PdfLinkModel is only needed
+    when building PDF view components from scratch.
+*/
+
+QQuickPdfLinkModel::QQuickPdfLinkModel(QObject *parent)
+    : QPdfLinkModel(parent)
+{
+}
+
+/*!
+    \qmlproperty PdfDocument PdfLinkModel::document
+
+    This property holds the PDF document in which links are to be found.
+*/
+QQuickPdfDocument *QQuickPdfLinkModel::document() const
+{
+    return m_quickDocument;
+}
+
+void QQuickPdfLinkModel::setDocument(QQuickPdfDocument *document)
+{
+    if (document == m_quickDocument)
+        return;
+    m_quickDocument = document;
+    QPdfLinkModel::setDocument(&document->m_doc);
+}
+
+/*!
+    \qmlproperty int PdfLinkModel::page
+
+    This property holds the page number on which links are to be found.
+*/
+
+QT_END_NAMESPACE
diff --git a/src/pdf/quick/qquickpdflinkmodel_p.h b/src/pdf/quick/qquickpdflinkmodel_p.h
new file mode 100644
index 000000000..23ad6c8c1
--- /dev/null
+++ b/src/pdf/quick/qquickpdflinkmodel_p.h
@@ -0,0 +1,87 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the QtPDF module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL3$
+** 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 http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/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 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPLv3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or later 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 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QQUICKPDFLINKMODEL_P_H
+#define QQUICKPDFLINKMODEL_P_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists purely as an
+// implementation detail.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#include "qquickpdfdocument_p.h"
+#include "../api/qpdflinkmodel_p.h"
+
+#include <QVariant>
+#include <QtQml/qqml.h>
+
+QT_BEGIN_NAMESPACE
+
+class QQuickPdfLinkModel : public QPdfLinkModel
+{
+    Q_OBJECT
+    Q_PROPERTY(QQuickPdfDocument *document READ document WRITE setDocument NOTIFY documentChanged)
+
+public:
+    explicit QQuickPdfLinkModel(QObject *parent = nullptr);
+
+    QQuickPdfDocument *document() const;
+    void setDocument(QQuickPdfDocument *document);
+
+signals:
+    void documentChanged();
+
+private:
+    void updateResults();
+
+private:
+    QQuickPdfDocument *m_quickDocument;
+    QVector<QPolygonF> m_linksGeometry;
+
+    Q_DISABLE_COPY(QQuickPdfLinkModel)
+};
+
+QT_END_NAMESPACE
+
+QML_DECLARE_TYPE(QQuickPdfLinkModel)
+
+#endif // QQUICKPDFLINKMODEL_P_H
diff --git a/src/pdf/quick/quick.pro b/src/pdf/quick/quick.pro
index d999ffb0b..7d65091aa 100644
--- a/src/pdf/quick/quick.pro
+++ b/src/pdf/quick/quick.pro
@@ -15,11 +15,13 @@ RESOURCES += resources.qrc
 SOURCES += \
     plugin.cpp \
     qquickpdfdocument.cpp \
+    qquickpdflinkmodel.cpp \
     qquickpdfsearchmodel.cpp \
     qquickpdfselection.cpp \
 
 HEADERS += \
     qquickpdfdocument_p.h \
+    qquickpdflinkmodel_p.h \
     qquickpdfsearchmodel_p.h \
     qquickpdfselection_p.h \