主页 / coding / 问题 / 79230983
Accepted
Dante
Asked: 2024-11-27 23:56:23 +0800 CST

QPdfView 中的可滚动覆盖

  • 772

我正在 QPdfView 中显示 pdf 文档，并且需要在几页上的某些区域上绘制覆盖层。

我已经设法绘制了覆盖层，但我需要一些帮助来调整滚动时其位置的调整方式。

代码如下：

from PySide6.QtCore import QRectF
from PySide6.QtGui import QPainter, QColor
from PySide6.QtPdfWidgets import QPdfView
from PySide6.QtCore import Qt
from PySide6.QtPdf import QPdfDocument

class CustomPdfView(QPdfView):  
    def __init__(self, parent=None):
        super().__init__(parent)
        
        # Placeholder areas
        self.highlights: dict[int, list[QRectF]] = {
            i : [QRectF(150.0, 150.0, 300.0, 300.0)] for i in range(200)
            }

    def paintEvent(self, event):
        super().paintEvent(event)

        if self.document().status() == QPdfDocument.Status.Ready:

            current_page_number = self.pageNavigator().currentPage()

            if current_page_number in self.highlights.keys():
                painter = QPainter(self.viewport())
                painter.setRenderHint(QPainter.RenderHint.Antialiasing)
                painter.setBrush(QColor(255, 255, 0, 100))
                painter.setPen(Qt.PenStyle.NoPen)

                total_pages = self.document().pageCount()
                current_page_size = self.document().pagePointSize(current_page_number)
                viewport_size = self.viewport().size()
                
                scroll_bar = self.verticalScrollBar()
                max_scroll = scroll_bar.maximum()
                
                scroll_per_page = max_scroll / total_pages
                scroll_calculated = scroll_per_page * current_page_number
                
                for rect in self.highlights[current_page_number]:

                    h_diff = scroll_bar.value() - scroll_calculated
                    
                    scaled_rect = QRectF(
                        (rect.x() / current_page_size.width()) * viewport_size.width(),
                        rect.y() - h_diff,
                        (rect.width() / current_page_size.width()) * viewport_size.width(),
                        rect.height()
                    )
                    painter.drawRect(scaled_rect)

                painter.end()

在最好的情况下，我想知道当前页面在视口中呈现了多少像素，因此 h_diff 变为 page_height - 可见像素

qt

1 个回答

  1. Best Answer

    您的方法存在多个问题，但以下是最重要的问题：

    • 它只占currentPage导航器的一部分，但在MultiPage模式下可以同时看到多个页面，“当前”只是与视图上半部分的一条假想线相交的页面（当前，是视口高度的 0.4 处的一条 2 像素的线）；
    • 它没有考虑基于自定义缩放或FitToWidth/FitInView模式的可能缩放；

    QtPdf 模块相对较新，目前仍基本实现，因此遗憾的是它缺少许多有用的方面（例如了解每个页面的可视边界矩形），这些方面可能需要进一步实现，因此这些方面必须手动处理。

    幸运的是，我们可以查看官方来源，我们可以看到它内部根据当前设置创建一个私有的“文档布局”，考虑到视口大小、实际比例、边距和页面间距。它本质上是一个基本映射，每个页面都有一个特定的 QRect 和基于视觉位置的比例。

    通过访问该布局，我们可以根据每页的实际坐标正确映射每个“亮点”。

    首先，我们需要创建一个计算所有文档布局的函数，并确保只要以下任何方面发生变化，它就会始终更新：

    • 文档（加载新的pdf时）；
    • 文件状态；
    • 视图边距（setDocumentMargins()）；
    • 自定义缩放系数；
    • 缩放模式；
    • 页面间距；
    • 当前页面，处于SinglePage模式；
    • 视图被调整大小（通过覆盖resizeEvent()）；

    布局使用形式为 的映射{page: (pageRect, scale)}，并通过循环遍历所有可见页面来计算：对于每个页面，它获取原始大小，缩放它（考虑缩放模式、屏幕 DPI 和可能的自定义缩放系数，或者可能考虑水平边距），然后使用0, 0具有新大小的默认 QRect 创建上述字典映射的值，并根据新大小和原始大小之间的比率进行缩放。在此过程中，还会考虑最小宽度，同时考虑边距和实际页面宽度。
    此后，再次循环页面以更新每个 QRect 的水平（基于视口大小和最小宽度居中）和垂直（基于每个页面高度和页面间距）位置。

    然后我们显然需要在 中绘制“亮点” paintEvent()，它会循环遍历所有布局的页面，检查页面当前是否在视口中，如果它包含亮点，则根据该页面的比例映射亮点矩形：x 和 y 被平移到页面原点，然后，与大小一起乘以页面比例。

    由于显而易见的原因，我仅尝试根据实际缩放来解决逻辑空间问题（例如：“基于区域”的突出显示）：如果您想显示仅考虑其位置缩放而不考虑其大小的“注释”，则需要进一步实施。

    以下代码是一个综合示例，它使用updateDocumentLayout基于上面链接的源的函数（calculateDocumentLayout()）：

    from collections import OrderedDict

from PySide6.QtCore import *
from PySide6.QtGui import *
from PySide6.QtWidgets import *
from PySide6.QtPdf import QPdfDocument
from PySide6.QtPdfWidgets import QPdfView

class CustomPdfView(QPdfView):
    def __init__(self, parent=None):
        super().__init__(parent)

        self._highlights = {}

        self.documentLayout = OrderedDict()
        self.documentChanged.connect(self.updateDocumentLayout)
        self.documentMarginsChanged.connect(self.updateDocumentLayout)
        self.zoomFactorChanged.connect(self.updateDocumentLayout)
        self.zoomModeChanged.connect(self.updateDocumentLayout)
        self.pageSpacingChanged.connect(self.updateDocumentLayout)
        self.pageNavigator().currentPageChanged.connect(
            self.currentPageChanged)

    def highlights(self):
        return self._highlights

    def setHighlights(self, highlights):
        self._highlights.clear()
        self._highlights.update(highlights)

    def currentPageChanged(self, currentPage):
        if self.pageMode() == self.PageMode.SinglePage:
            self.updateDocumentLayout()
            self.viewport().update()

    def documentStatusChanged(self, status):
        if status == QPdfDocument.Status.Ready:
            self.updateDocumentLayout()

    def updateDocumentLayout(self):
        self.documentLayout.clear()
        doc = self.document()
        if doc is None:
            return
        elif doc.status() != QPdfDocument.Status.Ready:
            # the document may have just been changed, so we need to 
            # connect its statusChanged signal, but only once
            try:
                doc.statusChanged.connect(
                    self.documentStatusChanged, 
                    Qt.ConnectionType.UniqueConnection
                )
            except TypeError:
                # older PyQt/PySide versions may raise a TypeError whenever a
                # UniqueConnection fails
                pass

            # if a new document has been set but the previous one still 
            # exists and has a status change, it may still trigger this 
            # function, therefore we will try to disconnect it
            sender = self.sender()
            if doc != sender and isinstance(sender, QPdfDocument):
                try:
                    sender.statusChanged.disconnect(
                        self.documentStatusChanged)
                except TypeError:
                    pass
            return

        screenRes = QApplication.primaryScreen().logicalDotsPerInch() / 72
        viewSize = self.viewport().size()
        viewWidth = viewSize.width()
        spacing = self.pageSpacing()

        margins = self.documentMargins()
        left = margins.left()
        right = margins.right()
        pageY = margins.top()

        totalWidth = 0

        if self.pageMode() == self.PageMode.SinglePage:
            pageRange = range(
                self.pageNavigator.currentPage(), 
                self.pageNavigator.currentPage() + 1
            )
        else:
            pageRange = range(
                0, doc.pageCount()
            )

        zoomMode = self.zoomMode()
        zoomFactor = self.zoomFactor()
        sizeFunc = doc.pagePointSize

        for page in pageRange:
            origSize = sizeFunc(page)
            pageScale = zoomFactor
            if zoomMode == self.ZoomMode.Custom:
                pageSize = QSizeF(origSize * screenRes * zoomFactor).toSize()
            elif zoomMode == self.ZoomMode.FitToWidth:
                pageSize = QSizeF(origSize * screenRes).toSize()
                pageScale = (viewWidth - left - right) / pageSize.width()
                pageSize *= pageScale
            else:
                vsize = QSize(viewSize - QSize(left + right, spacing))
                pageSize = QSizeF(origSize * screenRes).toSize()
                scaledSize = pageSize.scaled(
                    vsize, Qt.AspectRatioMode.KeepAspectRatio)
                pageScale = scaledSize.width() / pageSize.width()
                pageSize = scaledSize

            if pageSize.width() > totalWidth:
                totalWidth = pageSize.width()

            self.documentLayout[page] = (
                QRect(QPoint(0, pageY), pageSize), 
                pageScale
            )
            pageY += pageSize.height() + spacing

        totalWidth += left + right

        # horizontally center each page based on the totalWidth
        for pageRect, _ in self.documentLayout.values():
            pageRect.moveLeft(
                (max(totalWidth, viewWidth) - pageRect.width()) // 2)

    def resizeEvent(self, event):
        super().resizeEvent(event)
        self.updateDocumentLayout()

    def paintEvent(self, event):
        super().paintEvent(event)
        if not self.documentLayout:
            return

        viewRect = QRect(
            self.horizontalScrollBar().value(), 
            self.verticalScrollBar().value(), 
            self.viewport().width(), 
            self.viewport().height()
        )
        bottom = viewRect.bottom()

        qp = QPainter(self.viewport())
        qp.setBrush(QColor(255, 255, 0, 100))
        qp.setPen(Qt.PenStyle.NoPen)
        qp.translate(-viewRect.x(), -viewRect.y())

        for page, (pageRect, scale) in self.documentLayout.items():
            if not pageRect.intersects(viewRect):
                if pageRect.y() > bottom:
                    # the page is beyond the viewport bottom, there is no 
                    # need to go further
                    return
                continue

            if page in self._highlights:
                for rect in self._highlights[page]:
                    qp.drawRect(
                        pageRect.x() + rect.x() * scale,
                        pageRect.y() + rect.y() * scale,
                        rect.width() * scale,
                        rect.height() * scale
                    )


if __name__ == '__main__':
    import sys
    app = QApplication(sys.argv)
    view = CustomPdfView()
    view.setPageMode(view.PageMode.MultiPage)
    view.setPageSpacing(50)

    doc = QPdfDocument()
    view.setDocument(doc)
    doc.load('<path to pdf file>')

    view.setHighlights({
        i:[QRectF(150, 150, 300, 300)] for i in range(doc.pageCount())
    })

    view.show()
    sys.exit(app.exec())

    最后说明

    如上所述，QtPdf 模块处于相对早期的阶段（即使基本类至少可以追溯到 2018 年）并且肯定不是 Qt 开发的优先事项：我几个月前提交了一些相关报告，即使它们可能被认为非常相关，但尚未得到解决。

    这意味着上述代码所做的任何事情都是基于可能（并且希望）在未来的 Qt 版本中发生变化的实现，从而可能会破坏结果。

    • 1

相关问题