详解Qt Pdf之QPdfBookmarkModel 读取pdf标签页并显示

文章目录

前言
- [1. Qt 中的 `QPdfBookmarkModel` 简介](#1. Qt 中的 QPdfBookmarkModel 简介)
- - [1.1 主要成员类型和方法](#1.1 主要成员类型和方法)
- [2. 使用 `QPdfBookmarkModel` 显示 PDF 标签页](#2. 使用 QPdfBookmarkModel 显示 PDF 标签页)
- - [2.1 准备环境](#2.1 准备环境)
  - [2.2 创建界面和基本结构](#2.2 创建界面和基本结构)
  - [2.3 加载 PDF 文件并显示书签](#2.3 加载 PDF 文件并显示书签)
  - [2.4 显示书签](#2.4 显示书签)
总结

前言

Qt 是一个强大的跨平台应用程序开发框架，它提供了许多模块来帮助开发者实现各种功能。在处理 PDF 文件时，Qt 也提供了强大的支持，尤其是在 Qt 5.10 及之后的版本中，新增了 QPdfDocument 和 QPdfBookmarkModel 类，它们为我们提供了操作和显示 PDF 文件的能力。

在本文中，我们将详细探讨如何使用 QPdfBookmarkModel 来读取 PDF 文件中的标签页（书签），并将这些书签信息展示在 QTreeView 中。这样，用户就可以通过界面查看和跳转到 PDF 文档的不同章节。

1. Qt 中的 `QPdfBookmarkModel` 简介

QPdfBookmarkModel 是 Qt 5.10 引入的一个类，它继承自 QAbstractItemModel，用于表示和管理 PDF 文件中的书签信息。书签通常在 PDF 文档中用于标记不同的章节或页面，类似于目录或导航结构。

QPdfBookmarkModel 提供了一个树形结构的数据模型，每个书签作为模型的一个节点，节点之间可以有父子关系，形成一个层级结构。通过 QPdfBookmarkModel，我们可以获取每个书签的标题、级别、目标页码以及其他相关信息。

1.1 主要成员类型和方法

Role：用于获取书签的不同属性（如标题、级别、页码等）。
- Title：书签的标题。
- Level：书签的层级。
- Page：书签所在页面的页码。
- Location：书签目标位置的坐标。
- Zoom：书签的缩放级别。
关键方法：
- setDocument(QPdfDocument *document)：设置要加载的 PDF 文档。
- rowCount(const QModelIndex &parent)：获取当前节点的子节点数量。
- columnCount(const QModelIndex &parent)：获取列数（通常是 1）。
- data(const QModelIndex &index, int role)：获取指定书签节点的属性。
- index(int row, int column, const QModelIndex &parent)：获取指定位置的书签项。
- parent(const QModelIndex &index)：获取指定书签的父项。

2. 使用 `QPdfBookmarkModel` 显示 PDF 标签页

接下来，我们将实现一个简单的 PDF 查看器，能够读取 PDF 文件中的书签，并通过 QTreeView 来显示这些书签。下面是实现步骤。

2.1 准备环境

首先，我们需要确保安装了 Qt 的 PDF 模块（Qt PDF），该模块从 Qt 5.10 开始提供。可以在 .pro 文件中添加以下内容来启用 PDF 模块：

plaintext 复制代码

QT += pdf

2.2 创建界面和基本结构

在 QWidget 类中创建基本界面，包含一个按钮用于加载 PDF 文件，QTreeView 用于展示 PDF 中的书签信息。

cpp 复制代码

#include <QWidget>
#include <QPdfDocument>
#include <QPdfView>
#include <QVBoxLayout>
#include <QFileDialog>
#include <QPushButton>
#include <QLabel>
#include <QTreeView>
#include <QPdfBookmarkModel>

class PdfViewer : public QWidget {
    Q_OBJECT

public:
    PdfViewer(QWidget *parent = nullptr) : QWidget(parent) {
        // 设置布局
        QVBoxLayout *layout = new QVBoxLayout(this);

        // 创建控件
        QLabel *label = new QLabel("请选择 PDF 文件：", this);
        QPushButton *loadButton = new QPushButton("加载 PDF", this);
        pdfView = new QPdfView(this);

        // 添加控件到布局
        layout->addWidget(label);
        layout->addWidget(loadButton);
        layout->addWidget(pdfView);

        // 创建 PDF 文档对象
        pdfDocument = new QPdfDocument(this);

        // 创建书签模型
        bookmarkModel = new QPdfBookmarkModel(this);

        // 创建 QTreeView 显示书签
        QTreeView *bookmarkView = new QTreeView(this);
        bookmarkView->setModel(bookmarkModel);
        layout->addWidget(bookmarkView);

        // 连接加载按钮的点击事件
        connect(loadButton, &QPushButton::clicked, this, &PdfViewer::loadPdf);
    }

private slots:
    void loadPdf() {
        // 打开文件选择对话框
        QString fileName = QFileDialog::getOpenFileName(this, "打开 PDF 文件", "", "PDF Files (*.pdf)");
        if (fileName.isEmpty()) return;

        // 加载 PDF 文档
        if (pdfDocument->load(fileName) == QPdfDocument::Error::None) {
            pdfView->setDocument(pdfDocument);
            bookmarkModel->setDocument(pdfDocument); // 设置书签模型
        } else {
            qWarning() << "无法加载 PDF 文件：" << fileName;
        }
    }

private:
    QPdfDocument *pdfDocument;
    QPdfView *pdfView;
    QPdfBookmarkModel *bookmarkModel;  // 书签模型
};

2.3 加载 PDF 文件并显示书签

在 PdfViewer 类中，我们创建了 QPdfDocument 对象用来加载 PDF 文件，并将该对象传递给 QPdfBookmarkModel 以提取书签信息。通过 QTreeView，我们可以展示 PDF 文件中的书签。

loadPdf()：当用户点击"加载 PDF"按钮时，程序会弹出文件选择对话框，用户选择 PDF 文件后，调用 pdfDocument->load() 加载文件。如果文件加载成功，调用 bookmarkModel->setDocument(pdfDocument) 设置文档并加载书签数据。
bookmarkModel->setDocument(pdfDocument)：该方法会解析 PDF 文件中的书签，并填充 QPdfBookmarkModel，然后 QTreeView 会根据模型数据来显示书签。

2.4 显示书签

在 QTreeView 中，书签将以树形结构展示。每个节点对应一个书签，点击某个书签节点可以跳转到对应的页面。书签信息会包括书签的标题、层级（深度）和对应的页码。

总结

本文介绍了如何在 Qt 中使用 QPdfBookmarkModel 来读取和显示 PDF 文件中的书签。我们通过 QTreeView 展示了书签数据，并提供了一个简单的界面供用户选择和查看 PDF 文件。通过这些功能，用户能够更方便地浏览和导航 PDF 文档。

通过 QPdfBookmarkModel 和 QPdfView，我们可以更好地控制和展示 PDF 文件中的内容，为应用程序提供强大的 PDF 浏览和处理能力。