PdfLinkModel QML Type | Qt PDF 6.8.0
Description: A representation of links within a PDF document.

- Qt 6.8
- Qt PDF
- QML Types
- PdfLinkModel
- Qt 6.8.0 Reference Documentation

# PdfLinkModel QML Type

A representation of links within a PDF document. More...

Import Statement: | import QtQuick.Pdf

- List of all members, including inherited members

## Properties

- document : PdfDocument
- page : int

## Detailed Description

PdfLinkModel provides the geometry and the destination for each link that the specified page contains.

The available model roles are:

Constant | Description
--- | ---
`rectangle` | Bounding rectangle around the link.
`url` | If the link is a web link, the URL for that; otherwise an empty URL.
`page` | If the link is an internal link, the page number to which the link should jump; otherwise `-1`.
`location` | If the link is an internal link, the location on the page to which the link should jump.
`zoom` | If the link is an internal link, the intended zoom level on the destination page.

Normally it will be used with Repeater to visualize the links and provide the ability to click them:

     Repeater {
         model: PdfLinkModel {
             document: root.document
             page: image.currentFrame
         }
         delegate: Rectangle {
             required property rect rectangle
             required property url url
             required property int page
             color: "transparent"
             border.color: "lightgrey"
             x: rectangle.x
             y: rectangle.y
             width: rectangle.width
             height: rectangle.height
             HoverHandler { cursorShape: Qt.PointingHandCursor }
             TapHandler {
                 onTapped: {
                     if (page >= 0)
                         image.currentFrame = page
                     else
                         Qt.openUrlExternally(url)
                 }
             }
         }
     }

Note: General-purpose PDF viewing capabilities are provided by `PdfScrollablePageView` and `PdfMultiPageView`. PdfLinkModel is only needed when building PDF view components from scratch.

## Property Documentation

document : PdfDocument

This property holds the PDF document in which links are to be found.

page : int

This property holds the page number on which links are to be found.