Module fpdf.prefs

Classes

class ViewerPreferences (hide_toolbar=False,
hide_menubar=False,
hide_window_u_i=False,
fit_window=False,
center_window=False,
display_doc_title=False,
non_full_screen_page_mode=PageMode.USE_NONE,
num_copies=None,
print_page_range=None,
direction=None,
duplex=None,
view_area=None,
view_clip=None,
print_area=None,
print_clip=None)

Expand source code Browse git

class ViewerPreferences:
    "Specifies the way the document shall be displayed on the screen"

    def __init__(
        self,
        hide_toolbar=False,
        hide_menubar=False,
        hide_window_u_i=False,
        fit_window=False,
        center_window=False,
        display_doc_title=False,
        non_full_screen_page_mode=PageMode.USE_NONE,
        num_copies=None,
        print_page_range=None,
        direction=None,
        duplex=None,
        view_area=None,
        view_clip=None,
        print_area=None,
        print_clip=None,
    ):
        self.hide_toolbar = hide_toolbar
        """
        (`bool`)
        A flag specifying whether to hide the conforming reader’s tool bars when the document is active
        """
        self.hide_menubar = hide_menubar
        """
        (`bool`)
        A flag specifying whether to hide the conforming reader’s menu bar when the document is active
        """
        self.hide_window_u_i = hide_window_u_i
        """
        (`bool`)
        A flag specifying whether to hide user interface elements in the document’s window
        (such as scroll bars and navigation controls), leaving only the document’s contents displayed
        """
        self.fit_window = fit_window
        """
        (`bool`)
        A flag specifying whether to resize the document’s window to fit the size of the first displayed page
        """
        self.center_window = center_window
        """
        (`bool`)
        A flag specifying whether to position the document’s window in the center of the screen
        """
        self.display_doc_title = display_doc_title
        """
        (`bool`)
        A flag specifying whether the window’s title bar should display the document title
        taken from the Title entry of the document information dictionary.
        If false, the title bar should instead display the name of the PDF file containing the document.
        """
        self.non_full_screen_page_mode = non_full_screen_page_mode
        """
        (`fpdf.enums.PageMode`)
        The document’s page mode, specifying how to display the document on exiting full-screen mode
        """
        if self.non_full_screen_page_mode in (
            PageMode.FULL_SCREEN,
            PageMode.USE_ATTACHMENTS,
        ):
            raise ValueError(
                f"{self.non_full_screen_page_mode} is not a supported value for NonFullScreenPageMode"
            )
        self.num_copies = num_copies
        """
        (`int`)
        The number of copies that shall be printed when the print dialog is opened for this file.
        Values outside this range shall be ignored. Default value: as defined by the conforming reader, but typically 1
        """
        self.print_page_range = print_page_range
        """
        (`list[int]`)
        The page numbers used to initialize the print dialog box when the file is printed.
        The array shall contain an even number of integers to be interpreted in pairs,
        with each pair specifying the first and last pages in a sub-range of pages to be printed.
        The first page of the PDF file shall be denoted by 1.
        """
        self.direction = direction
        """
        (`fpdf.enums.TextDirection`)
        The predominant reading order for text.
        """
        self.duplex = duplex
        """
        (`fpdf.enums.Duplex`)
        The paper handling option that shall be used when printing the file from the print dialog.
        """
        self.view_area = view_area
        """
        (`fpdf.enums.PageBoundaries`)
        The name of the page boundary representing the area of a page that shall be displayed when viewing the document on the screen.
        Default value: CropBox.
        """
        self.view_clip = view_clip
        """
        (`fpdf.enums.PageBoundaries`)
        The name of the page boundary to which the contents of a page shall be clipped when viewing the document on the screen.
        Default value: CropBox.
        """
        self.print_area = print_area
        """
        (`fpdf.enums.PageBoundaries`)
        The name of the page boundary representing the area of a page that shall be rendered when printing the document.
        Default value: CropBox.
        """
        self.print_clip = print_clip
        """
        (`fpdf.enums.PageBoundaries`)
        The name of the page boundary to which the contents of a page shall be clipped when printing the document.
        Default value: CropBox.
        """

    @property
    def non_full_screen_page_mode(self):
        return self._non_full_screen_page_mode

    @non_full_screen_page_mode.setter
    def non_full_screen_page_mode(self, page_mode):
        self._non_full_screen_page_mode = (
            None if page_mode is None else PageMode.coerce(page_mode)
        )

    @property
    def direction(self):
        return self._direction

    @direction.setter
    def direction(self, direction):
        self._direction = None if direction is None else TextDirection.coerce(direction)

    @property
    def duplex(self):
        return self._duplex

    @duplex.setter
    def duplex(self, duplex):
        self._duplex = None if duplex is None else Duplex.coerce(duplex)

    @property
    def view_area(self):
        return self._view_area

    @view_area.setter
    def view_area(self, view_area):
        self._view_area = (
            None if view_area is None else PageBoundaries.coerce(view_area)
        )

    @property
    def view_clip(self):
        return self._view_clip

    @view_clip.setter
    def view_clip(self, view_clip):
        self._view_clip = (
            None if view_clip is None else PageBoundaries.coerce(view_clip)
        )

    @property
    def print_area(self):
        return self._print_area

    @print_area.setter
    def print_area(self, print_area):
        self._print_area = (
            None if print_area is None else PageBoundaries.coerce(print_area)
        )

    @property
    def print_clip(self):
        return self._print_clip

    @print_clip.setter
    def print_clip(self, print_clip):
        self._print_clip = (
            None if print_clip is None else PageBoundaries.coerce(print_clip)
        )

    def serialize(self, _security_handler=None, _obj_id=None):
        obj_dict = build_obj_dict(
            {key: getattr(self, key) for key in dir(self)},
            _security_handler=_security_handler,
            _obj_id=_obj_id,
        )
        return create_dictionary_string(obj_dict)

Specifies the way the document shall be displayed on the screen

Instance variables

var center_window

(bool) A flag specifying whether to position the document’s window in the center of the screen

var direction

Expand source code Browse git

@property
def direction(self):
    return self._direction

(TextDirection) The predominant reading order for text.

var display_doc_title

(bool) A flag specifying whether the window’s title bar should display the document title taken from the Title entry of the document information dictionary. If false, the title bar should instead display the name of the PDF file containing the document.

var duplex

Expand source code Browse git

@property
def duplex(self):
    return self._duplex

(Duplex) The paper handling option that shall be used when printing the file from the print dialog.

var fit_window

(bool) A flag specifying whether to resize the document’s window to fit the size of the first displayed page

var hide_menubar

(bool) A flag specifying whether to hide the conforming reader’s menu bar when the document is active

var hide_toolbar

(bool) A flag specifying whether to hide the conforming reader’s tool bars when the document is active

var hide_window_u_i

(bool) A flag specifying whether to hide user interface elements in the document’s window (such as scroll bars and navigation controls), leaving only the document’s contents displayed

var non_full_screen_page_mode

Expand source code Browse git

@property
def non_full_screen_page_mode(self):
    return self._non_full_screen_page_mode

(PageMode) The document’s page mode, specifying how to display the document on exiting full-screen mode

var num_copies

(int) The number of copies that shall be printed when the print dialog is opened for this file. Values outside this range shall be ignored. Default value: as defined by the conforming reader, but typically 1

var print_area

Expand source code Browse git

@property
def print_area(self):
    return self._print_area

(PageBoundaries) The name of the page boundary representing the area of a page that shall be rendered when printing the document. Default value: CropBox.

var print_clip

Expand source code Browse git

@property
def print_clip(self):
    return self._print_clip

(PageBoundaries) The name of the page boundary to which the contents of a page shall be clipped when printing the document. Default value: CropBox.

var print_page_range

(list[int]) The page numbers used to initialize the print dialog box when the file is printed. The array shall contain an even number of integers to be interpreted in pairs, with each pair specifying the first and last pages in a sub-range of pages to be printed. The first page of the PDF file shall be denoted by 1.

var view_area

Expand source code Browse git

@property
def view_area(self):
    return self._view_area

(PageBoundaries) The name of the page boundary representing the area of a page that shall be displayed when viewing the document on the screen. Default value: CropBox.

var view_clip

Expand source code Browse git

@property
def view_clip(self):
    return self._view_clip

(PageBoundaries) The name of the page boundary to which the contents of a page shall be clipped when viewing the document on the screen. Default value: CropBox.

Methods

def serialize(self)

Expand source code Browse git

def serialize(self, _security_handler=None, _obj_id=None):
    obj_dict = build_obj_dict(
        {key: getattr(self, key) for key in dir(self)},
        _security_handler=_security_handler,
        _obj_id=_obj_id,
    )
    return create_dictionary_string(obj_dict)