<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <link rel="stylesheet" href="style.css" type="text/css"> <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"> <link rel="Start" href="index.html"> <link rel="previous" href="Pdfops.html"> <link rel="next" href="Pdfmarks.html"> <link rel="Up" href="index.html"> <link title="Index of types" rel=Appendix href="index_types.html"> <link title="Index of exceptions" rel=Appendix href="index_exceptions.html"> <link title="Index of values" rel=Appendix href="index_values.html"> <link title="Index of modules" rel=Appendix href="index_modules.html"> <link title="Pdfutil" rel="Chapter" href="Pdfutil.html"> <link title="Pdfio" rel="Chapter" href="Pdfio.html"> <link title="Pdftransform" rel="Chapter" href="Pdftransform.html"> <link title="Pdfunits" rel="Chapter" href="Pdfunits.html"> <link title="Pdfpaper" rel="Chapter" href="Pdfpaper.html"> <link title="Pdf" rel="Chapter" href="Pdf.html"> <link title="Pdfcrypt" rel="Chapter" href="Pdfcrypt.html"> <link title="Pdfflate" rel="Chapter" href="Pdfflate.html"> <link title="Pdfcodec" rel="Chapter" href="Pdfcodec.html"> <link title="Pdfwrite" rel="Chapter" href="Pdfwrite.html"> <link title="Pdfgenlex" rel="Chapter" href="Pdfgenlex.html"> <link title="Pdfread" rel="Chapter" href="Pdfread.html"> <link title="Pdfjpeg" rel="Chapter" href="Pdfjpeg.html"> <link title="Pdfops" rel="Chapter" href="Pdfops.html"> <link title="Pdfdest" rel="Chapter" href="Pdfdest.html"> <link title="Pdfmarks" rel="Chapter" href="Pdfmarks.html"> <link title="Pdfpagelabels" rel="Chapter" href="Pdfpagelabels.html"> <link title="Pdfpage" rel="Chapter" href="Pdfpage.html"> <link title="Pdfannot" rel="Chapter" href="Pdfannot.html"> <link title="Pdffun" rel="Chapter" href="Pdffun.html"> <link title="Pdfspace" rel="Chapter" href="Pdfspace.html"> <link title="Pdfimage" rel="Chapter" href="Pdfimage.html"> <link title="Pdfafm" rel="Chapter" href="Pdfafm.html"> <link title="Pdfafmdata" rel="Chapter" href="Pdfafmdata.html"> <link title="Pdfglyphlist" rel="Chapter" href="Pdfglyphlist.html"> <link title="Pdftext" rel="Chapter" href="Pdftext.html"> <link title="Pdfstandard14" rel="Chapter" href="Pdfstandard14.html"> <link title="Pdfgraphics" rel="Chapter" href="Pdfgraphics.html"> <link title="Pdfshapes" rel="Chapter" href="Pdfshapes.html"> <link title="Pdfdate" rel="Chapter" href="Pdfdate.html"> <link title="Pdfocg" rel="Chapter" href="Pdfocg.html"> <link title="Pdfcff" rel="Chapter" href="Pdfcff.html"> <link title="Pdftype1" rel="Chapter" href="Pdftype1.html"> <link title="Pdftruetype" rel="Chapter" href="Pdftruetype.html"> <link title="Pdftype0" rel="Chapter" href="Pdftype0.html"> <link title="Pdfmerge" rel="Chapter" href="Pdfmerge.html"><title>Pdfdest</title> </head> <body> <div class="navbar"><a class="pre" href="Pdfops.html" title="Pdfops">Previous</a> <a class="up" href="index.html" title="Index">Up</a> <a class="post" href="Pdfmarks.html" title="Pdfmarks">Next</a> </div> <h1>Module <a href="type_Pdfdest.html">Pdfdest</a></h1> <pre><span class="keyword">module</span> Pdfdest: <code class="code">sig</code> <a href="Pdfdest.html">..</a> <code class="code">end</code></pre><div class="info module top"> Destinations<br> </div> <hr width="100%"> <pre><code><span id="TYPEtargetpage"><span class="keyword">type</span> <code class="type"></code>targetpage</span> = </code></pre><table class="typetable"> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTtargetpage.PageObject"><span class="constructor">PageObject</span></span> <span class="keyword">of</span> <code class="type">int</code></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTtargetpage.OtherDocPageNumber"><span class="constructor">OtherDocPageNumber</span></span> <span class="keyword">of</span> <code class="type">int</code></code></td> </tr></table> <div class="info "> The target of a destination is either a page object in the same PDF (given by object number of page object), or a page number in an external file.<br> </div> <pre><code><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> = </code></pre><table class="typetable"> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTt.NullDestination"><span class="constructor">NullDestination</span></span></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTt.XYZ"><span class="constructor">XYZ</span></span> <span class="keyword">of</span> <code class="type"><a href="Pdfdest.html#TYPEtargetpage">targetpage</a> * float option * float option * float option</code></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTt.Fit"><span class="constructor">Fit</span></span> <span class="keyword">of</span> <code class="type"><a href="Pdfdest.html#TYPEtargetpage">targetpage</a></code></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTt.FitH"><span class="constructor">FitH</span></span> <span class="keyword">of</span> <code class="type"><a href="Pdfdest.html#TYPEtargetpage">targetpage</a> * float</code></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTt.FitV"><span class="constructor">FitV</span></span> <span class="keyword">of</span> <code class="type"><a href="Pdfdest.html#TYPEtargetpage">targetpage</a> * float</code></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTt.FitR"><span class="constructor">FitR</span></span> <span class="keyword">of</span> <code class="type"><a href="Pdfdest.html#TYPEtargetpage">targetpage</a> * float * float * float * float</code></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTt.FitB"><span class="constructor">FitB</span></span> <span class="keyword">of</span> <code class="type"><a href="Pdfdest.html#TYPEtargetpage">targetpage</a></code></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTt.FitBH"><span class="constructor">FitBH</span></span> <span class="keyword">of</span> <code class="type"><a href="Pdfdest.html#TYPEtargetpage">targetpage</a> * float</code></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTt.FitBV"><span class="constructor">FitBV</span></span> <span class="keyword">of</span> <code class="type"><a href="Pdfdest.html#TYPEtargetpage">targetpage</a> * float</code></code></td> </tr></table> <div class="info "> Destinations. See ISO-32000 for details.<br> </div> <pre><span id="VALread_destination"><span class="keyword">val</span> read_destination</span> : <code class="type"><a href="Pdf.html#TYPEt">Pdf.t</a> -> <a href="Pdf.html#TYPEpdfobject">Pdf.pdfobject</a> -> <a href="Pdfdest.html#TYPEt">t</a></code></pre><div class="info "> Read a destination given a PDF and destionation object.<br> </div> <pre><span id="VALpdfobject_of_destination"><span class="keyword">val</span> pdfobject_of_destination</span> : <code class="type"><a href="Pdfdest.html#TYPEt">t</a> -> <a href="Pdf.html#TYPEpdfobject">Pdf.pdfobject</a></code></pre><div class="info "> Write a destination to a <code class="code">Pdf.pdfobject</code>.<br> </div> </body></html>