Skip to content

PdfView

Qt Base Class: QPdfView

Signature: QPdfView(self) -> None QPdfView(self, parent: PySide6.QtWidgets.QWidget) -> None

Base classes

Name Children Inherits
AbstractScrollAreaMixin
prettyqt.widgets.abstractscrollarea
QPdfView
PySide6.QtPdfWidgets
QPdfView(self) -> None

⋔ Inheritance diagram

graph TD
  1473572237888["pdfwidgets.PdfView"]
  1473293679456["widgets.AbstractScrollAreaMixin"]
  1473293662864["widgets.FrameMixin"]
  1473293688240["widgets.WidgetMixin"]
  1473299815024["core.ObjectMixin"]
  140713234304496["builtins.object"]
  1473245548480["gui.PaintDeviceMixin"]
  1473572186160["QtPdfWidgets.QPdfView"]
  1473290616416["QtWidgets.QAbstractScrollArea"]
  1473290626176["QtWidgets.QFrame"]
  1473290849680["QtWidgets.QWidget"]
  1473288842240["QtCore.QObject"]
  1473291690208["Shiboken.Object"]
  1473300082368["QtGui.QPaintDevice"]
  1473293679456 --> 1473572237888
  1473293662864 --> 1473293679456
  1473293688240 --> 1473293662864
  1473299815024 --> 1473293688240
  140713234304496 --> 1473299815024
  1473245548480 --> 1473293688240
  140713234304496 --> 1473245548480
  1473572186160 --> 1473572237888
  1473290616416 --> 1473572186160
  1473290626176 --> 1473290616416
  1473290849680 --> 1473290626176
  1473288842240 --> 1473290849680
  1473291690208 --> 1473288842240
  140713234304496 --> 1473291690208
  1473300082368 --> 1473290849680
  1473291690208 --> 1473300082368

🛈 DocStrings

Bases: AbstractScrollAreaMixin, QPdfView

PDF viewer widget .

Source code in prettyqt\pdfwidgets\pdfview.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
class PdfView(widgets.AbstractScrollAreaMixin, QtPdfWidgets.QPdfView):
    """PDF viewer widget ."""

    def __init__(self, parent: widgets.QWidget | None = None, **kwargs):
        super().__init__(parent, **kwargs)
        self.setDocument(pdf.PdfDocument(self))

    def get_document_margins(self) -> core.Margins:
        return core.Margins(self.documentMargins())

    def set_file(self, path: datatypes.PathType):
        doc = pdf.PdfDocument(self)
        doc.load(os.fspath(path))
        self.setDocument(doc)

    def set_page_mode(self, mode: PageModeStr | QtPdfWidgets.QPdfView.PageMode):
        """Set the page mode.

        Args:
            mode: page mode
        """
        self.setPageMode(PAGE_MODE.get_enum_value(mode))

    def get_page_mode(self) -> PageModeStr:
        """Return current page mode.

        Returns:
            page mode
        """
        return PAGE_MODE.inverse[self.pageMode()]

    def set_zoom_mode(self, mode: ZoomModeStr | QtPdfWidgets.QPdfView.ZoomMode):
        """Set the zoom mode.

        Args:
            mode: zoom mode
        """
        self.setZoomMode(ZOOM_MODE.get_enum_value(mode))

    def get_zoom_mode(self) -> ZoomModeStr:
        """Return current zoom mode.

        Returns:
            zoom mode
        """
        return ZOOM_MODE.inverse[self.zoomMode()]

get_page_mode() -> PageModeStr

Return current page mode.

Source code in prettyqt\pdfwidgets\pdfview.py 
58
59
60
61
62
63
64
def get_page_mode(self) -> PageModeStr:
    """Return current page mode.

    Returns:
        page mode
    """
    return PAGE_MODE.inverse[self.pageMode()]

get_zoom_mode() -> ZoomModeStr

Return current zoom mode.

Source code in prettyqt\pdfwidgets\pdfview.py 
74
75
76
77
78
79
80
def get_zoom_mode(self) -> ZoomModeStr:
    """Return current zoom mode.

    Returns:
        zoom mode
    """
    return ZOOM_MODE.inverse[self.zoomMode()]

set_page_mode(mode: PageModeStr | QtPdfWidgets.QPdfView.PageMode)

Set the page mode.

Parameters:

Name Type Description Default
mode PageModeStr | PageMode

page mode

 required
Source code in prettyqt\pdfwidgets\pdfview.py 
50
51
52
53
54
55
56
def set_page_mode(self, mode: PageModeStr | QtPdfWidgets.QPdfView.PageMode):
    """Set the page mode.

    Args:
        mode: page mode
    """
    self.setPageMode(PAGE_MODE.get_enum_value(mode))

set_zoom_mode(mode: ZoomModeStr | QtPdfWidgets.QPdfView.ZoomMode)

Set the zoom mode.

Parameters:

Name Type Description Default
mode ZoomModeStr | ZoomMode

zoom mode

 required
Source code in prettyqt\pdfwidgets\pdfview.py 
66
67
68
69
70
71
72
def set_zoom_mode(self, mode: ZoomModeStr | QtPdfWidgets.QPdfView.ZoomMode):
    """Set the zoom mode.

    Args:
        mode: zoom mode
    """
    self.setZoomMode(ZOOM_MODE.get_enum_value(mode))

⌗ Property table

Qt Property Type Doc
objectName QString
modal bool
windowModality Qt::WindowModality
enabled bool
geometry QRect
frameGeometry QRect
normalGeometry QRect
x int
y int
pos QPoint
frameSize QSize
size QSize
width int
height int
rect QRect
childrenRect QRect
childrenRegion QRegion
sizePolicy QSizePolicy
minimumSize QSize
maximumSize QSize
minimumWidth int
minimumHeight int
maximumWidth int
maximumHeight int
sizeIncrement QSize
baseSize QSize
palette QPalette
font QFont
cursor QCursor
mouseTracking bool
tabletTracking bool
isActiveWindow bool
focusPolicy Qt::FocusPolicy
focus bool
contextMenuPolicy Qt::ContextMenuPolicy
updatesEnabled bool
visible bool
minimized bool
maximized bool
fullScreen bool
sizeHint QSize
minimumSizeHint QSize
acceptDrops bool
windowTitle QString
windowIcon QIcon
windowIconText QString
windowOpacity double
windowModified bool
toolTip QString
toolTipDuration int
statusTip QString
whatsThis QString
accessibleName QString
accessibleDescription QString
layoutDirection Qt::LayoutDirection
autoFillBackground bool
styleSheet QString
locale QLocale
windowFilePath QString
inputMethodHints QFlags
frameShape QFrame::Shape
frameShadow QFrame::Shadow
lineWidth int
midLineWidth int
frameWidth int
frameRect QRect
verticalScrollBarPolicy Qt::ScrollBarPolicy
horizontalScrollBarPolicy Qt::ScrollBarPolicy
sizeAdjustPolicy QAbstractScrollArea::SizeAdjustPolicy
document QPdfDocument
pageMode QPdfView::PageMode
zoomMode QPdfView::ZoomMode
zoomFactor double
pageSpacing int
documentMargins QMargins