.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "PDF::API2::ViewerPreferences 3"
.TH PDF::API2::ViewerPreferences 3 "2021-12-08" "perl v5.26.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
PDF::API2::ViewerPreferences \- How the PDF should be displayed or printed
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "$self = $class\->new($pdf)" 4
.el .IP "\f(CW$self\fR = \f(CW$class\fR\->new($pdf)" 4
.IX Item "$self = $class->new($pdf)"
Creates a new ViewerPreferences object from a \s-1PDF::API2\s0 object.
.ie n .IP "%preferences = $self\->\fBget_preferences()\fR" 4
.el .IP "\f(CW%preferences\fR = \f(CW$self\fR\->\fBget_preferences()\fR" 4
.IX Item "%preferences = $self->get_preferences()"
Returns a hash containing all of the viewer preferences that are defined in the
\&\s-1PDF.\s0
.ie n .IP "$value = $self\->get_preference($name)" 4
.el .IP "\f(CW$value\fR = \f(CW$self\fR\->get_preference($name)" 4
.IX Item "$value = $self->get_preference($name)"
Returns the value of the specified viewer preference if present, or \f(CW\*(C`undef\*(C'\fR if
not.
.ie n .IP "$self\->set_preferences(%values)" 4
.el .IP "\f(CW$self\fR\->set_preferences(%values)" 4
.IX Item "$self->set_preferences(%values)"
Sets one or more viewer preferences, as described in the preferences section
below.
.SH "PREFERENCES"
.IX Header "PREFERENCES"
Viewer Preferences describe how the document should be presented on screen or in
print.  Not all \s-1PDF\s0 viewers will respect these preferences.
.PP
Boolean preferences default to false and take (or return) 0 or 1 as arguments.
.PP
Bounding Box preferences take (or return) one of \f(CW\*(C`media_box\*(C'\fR, \f(CW\*(C`crop_box\*(C'\fR,
\&\f(CW\*(C`bleed_box\*(C'\fR, \f(CW\*(C`trim_box\*(C'\fR, or \f(CW\*(C`art_box\*(C'\fR.
.IP "hide_toolbar (boolean)" 4
.IX Item "hide_toolbar (boolean)"
A flag specifying whether to hide the tool bars when the document is active.
.IP "hide_menubar (boolean)" 4
.IX Item "hide_menubar (boolean)"
A flag specifying whether to hide the menu bar when the document is active.
.IP "hide_window_ui (boolean)" 4
.IX Item "hide_window_ui (boolean)"
A flag specifying whether to hide the user interface elements in the document's
window (such as scroll bars and navigation controls), leaving only the
document's contents displayed.
.IP "fit_window (boolean)" 4
.IX Item "fit_window (boolean)"
A flag specifying whether to resize the document's window to fit the size of the
first displayed page.
.IP "center_window (boolean)" 4
.IX Item "center_window (boolean)"
A flag specifying whether to position the document's window in the center of the
screen.
.IP "display_doc_title (boolean)" 4
.IX Item "display_doc_title (boolean)"
A flag specifying whether the window's title bar should display the document
title taken from the Title entry of the document information directory.  If
false, the title bar should instead display the name of the \s-1PDF\s0 file containing
the document.
.IP "non_full_screen_page_mode (name)" 4
.IX Item "non_full_screen_page_mode (name)"
The document's page mode, specifying how to display the document on exiting
full-screen mode.  Options are the same as \f(CW\*(C`page_mode\*(C'\fR in \s-1PDF::API2\s0.
.IP "direction ('l2r' or 'r2l')" 4
.IX Item "direction ('l2r' or 'r2l')"
The predominant reading order for text (left-to-right or right-to-left).
.Sp
This entry has no direct effect on the document's contents or page numbering but
may be used to determine the relative positioning of pages when displayed
side-by-side or printed n\-up.
.IP "view_area (bounding box)" 4
.IX Item "view_area (bounding box)"
The name of the page boundary representing the area of a page that shall be
displayed when viewing the document on the screen.
.IP "view_clip (bounding box)" 4
.IX Item "view_clip (bounding box)"
The name of the page boundary to which the contents of a page shall be clipped
when viewing the document on the screen.
.IP "print_area (bounding box)" 4
.IX Item "print_area (bounding box)"
The name of the page boundary representing the area of a page that shall be
rendered when printing the document.
.IP "print_clip (bounding box)" 4
.IX Item "print_clip (bounding box)"
The name of the page boundary to which the contents of a page shall be clipped
when printing the document.
.IP "print_scaling ('none' or 'app_default')" 4
.IX Item "print_scaling ('none' or 'app_default')"
The page scaling option that shall be selected when a print dialog is displayed
for this document.  \f(CW\*(C`none\*(C'\fR represents no page scaling, and \f(CW\*(C`app_default\*(C'\fR
represents the reader's default print scaling.
.IP "duplex ('simplex', 'duplex_short', or 'duplex_long')" 4
.IX Item "duplex ('simplex', 'duplex_short', or 'duplex_long')"
The paper handling option that shall be used when printing the file from the
print dialog.  The duplex values represent whether the page should be flipped on
its short edge or long edge, respectively.
.IP "pick_tray_by_pdf_size (boolean)" 4
.IX Item "pick_tray_by_pdf_size (boolean)"
A flag specifying whether the \s-1PDF\s0 page size shall be used to select the input
paper tray.  This setting influences only the preset values used to populate the
print dialog presented by the reader.
.IP "print_page_rage (an array of integer pairs)" 4
.IX Item "print_page_rage (an array of integer pairs)"
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 \s-1PDF\s0 file shall be denoted by 1.
.IP "num_copies (integer)" 4
.IX Item "num_copies (integer)"
The number of copies that shall be printed when the print dialog is opened for
this file.