Help-Site Computer Manuals
Software
Hardware
Programming
Networking
  Algorithms & Data Structures   Programming Languages   Revision Control
  Protocols
  Cameras   Computers   Displays   Keyboards & Mice   Motherboards   Networking   Printers & Scanners   Storage
  Windows   Linux & Unix   Mac

/var/sites/help-site.com/auto/tmp/CPAN/9677/PDF-API2-0.68/lib/PDF/API2/Outline.pm

/var/sites/help-site.com/auto/tmp/CPAN/9677/PDF-API2-0.68/lib/PDF/API2/Outline.pm


$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).


AUTHOR

alfred reibenschuh


HISTORY


    $Log: Outline.pm,v $

    Revision 2.0  2005/11/16 02:16:00  areibens

    revision workaround for SF cvs import not to screw up CPAN

    Revision 1.2  2005/11/16 01:27:48  areibens

    genesis2

    Revision 1.1  2005/11/16 01:19:24  areibens

    genesis

    Revision 1.13  2005/06/17 19:43:47  fredo

    fixed CPAN modulefile versioning (again)

    Revision 1.12  2005/06/17 18:53:33  fredo

    fixed CPAN modulefile versioning (dislikes cvs)

    Revision 1.11  2005/03/14 22:01:05  fredo

    upd 2005

    Revision 1.10  2005/01/03 00:33:32  fredo

    added named destination support

    Revision 1.9  2004/12/16 00:30:51  fredo

    added no warn for recursion

    Revision 1.8  2004/07/29 10:47:39  fredo

    fixed "null vs. 0" bug of -xyz option

    Revision 1.7  2004/06/15 09:11:38  fredo

    removed cr+lf

    Revision 1.6  2004/06/07 19:44:12  fredo

    cleaned out cr+lf for lf

    Revision 1.5  2004/03/18 06:47:57  fredo

    fixed yank/paste error in dest method with -xyz parameter

    Revision 1.4  2003/12/08 13:05:19  Administrator

    corrected to proper licencing statement

    Revision 1.3  2003/11/30 17:13:39  Administrator

    merged into default

    Revision 1.2.2.1  2003/11/30 16:56:21  Administrator

    merged into default

    Revision 1.2  2003/11/30 11:32:40  Administrator

    added CVS id/log



=cut
Programminig
Wy
Wy
yW
Wy
Programming
Wy
Wy
Wy
Wy