GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PDF::API2::OUTLINE (3)

.ds Aq ’

NAME

PDF::API2::Outline - Manage PDF outlines (aka bookmarks)

CONTENTS

METHODS

$otl = PDF::API2::Outline->new $api,$parent,$prev Returns a new outline object (called from $otls->outline).
$otl->title $text Set the title of the outline.
$otl->closed Set the status of the outline to closed.
$otl->open Set the status of the outline to open.
$sotl=$otl->outline Returns a new sub-outline.
$otl->dest $pageobj [, %opts] Sets the destination page of the outline.
$otl->dest( $page, -fit => 1 ) Display the page designated by page, with its contents magnified just enough to fit the entire page within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension.
$otl->dest( $page, -fith => $top ) Display the page designated by page, with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of the page within the window.
$otl->dest( $page, -fitv => $left ) Display the page designated by page, with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of the page within the window.
$otl->dest( $page, -fitr => [ $left, $bottom, $right, $top ] ) Display the page designated by page, with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right, and top entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the rectangle within the window in the other dimension.
$otl->dest( $page, -fitb => 1 ) Display the page designated by page, with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the bounding box within the window in the other dimension.
$otl->dest( $page, -fitbh => $top ) Display the page designated by page, with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of its bounding box within the window.
$otl->dest( $page, -fitbv => $left ) Display the page designated by page, with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of its bounding box within the window.
$otl->dest( $page, -xyz => [ $left, $top, $zoom ] ) Display the page designated by page, with the coordinates (left, top) positioned at the top-left corner of the window and the contents of the page magnified by the factor zoom. A zero (0) value for any of the parameters left, top, or zoom specifies that the current value of that parameter is to be retained unchanged.
$otl->dest( $name ) (PDF 1.2) Connect the Outline to a Named Destination defined elswere.
$otl->url $url, %opts Defines the outline as launch-url with url $url.
$otl->file $file, %opts Defines the outline as launch-file with filepath $file.
$otl->pdfile $pdfile, $pagenum, %opts Defines the destination of the outline as pdf-file with filepath $pdfile, $pagenum and options %opts (same as dest).
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PDF::API2::OUTLINE (3) 2016-03-11

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.