Welcome to qpageview!

qpageview provides a page based document viewer widget for Qt5/PyQt5.

It has a flexible architecture potentionally supporting many formats. Currently, it supports SVG documents, images, and, using the Poppler-Qt5 binding, PDF documents.

import qpageview

from PyQt5.Qt import *
a = QApplication([])

v = qpageview.View()
v.show()
v.loadPdf("path/to/afile.pdf")

Homepage • Development • Download • Documentation • License

Features

• Versatile View widget with many optional mixin classes to cater for anything between basic or powerful functionality

• Rendering in a background thread, with smart priority control, so display of large PDF documents remains fast and smooth

• Almost infinite zooming thanks to tile-based rendering and caching

• Magnifier glass

• Printing functionality, directly to cups or via Qt/QPrinter

• Can display pages originating from different documents at the same time

• Can show the difference between pages that are almost the same via color composition

• And much more! And…all classes are extendable and heavily customizable, so it is easy to inherit and add any functionality you want.

Dependencies

• Python 3.6+

• Qt5

• PyQt5

• python-poppler-qt5 (needed for display of PDF documents)

• pycups (optionally, needed to print to a local CUPS server)

This manual documents qpageview version 0.6.2. Last update: Apr 09, 2022.

Contents

• Basic usage
  • Creating the View widget
  • Loading contents
  • Navigating in the View
  • Controlling the display
  • The Magnifier
  • The Rubberband
  • Controlling the behaviour
• Advanced usage
  • Document
  • Page and PageLayout
  • Controlling a view with ViewActions
  • Managing View settings
  • Using View Mixins
  • Specialized View subclasses
• Interacting with pages
  • Coordinate systems
  • Page position and Layout position
  • Links on a page
  • Getting text from a page
  • Getting image data from a page
• How rendering works
  • Available Page types
  • Implementing a new page type
• Overview of all modules
  • The main qpageview module
  • The backgroundjob module
  • The cache module
  • The constants module
  • The cupsprinter module
  • The diff module
  • The document module
  • The export module
  • The highlight module
  • The image module
  • The imageview module
  • The layout module
  • The link module
  • The locking module
  • The magnifier module
  • The multipage module
  • The page module
  • The pkginfo module
  • The poppler module
  • The printing module
  • The rectangles module
  • The render module
  • The rubberband module
  • The scrollarea module
  • The selector module
  • The shadow module
  • The sidebarview module
  • The svg module
  • The util module
  • The viewactions module
  • The view module
  • The widgetoverlay module

About

• Installing qpageview
• ChangeLog
• License

Indices and tables

• Index

• Module Index