<!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="Pdfpagelabels.html">
<link rel="next" href="Pdfannot.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"><link title="Page rotations" rel="Section" href="#2_Pagerotations">
<link title="Pages" rel="Section" href="#2_Pages">
<link title="Compound operations" rel="Section" href="#2_Compoundoperations">
<title>Pdfpage</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Pdfpagelabels.html" title="Pdfpagelabels">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="Pdfannot.html" title="Pdfannot">Next</a>
</div>
<h1>Module <a href="type_Pdfpage.html">Pdfpage</a></h1>
<pre><span class="keyword">module</span> Pdfpage: <code class="code">sig</code> <a href="Pdfpage.html">..</a> <code class="code">end</code></pre><div class="info module top">
Page-level functionality<br>
</div>
<hr width="100%">
<br>
<h2 id="2_Pagerotations">Page rotations</h2><br>
<pre><code><span id="TYPErotation"><span class="keyword">type</span> <code class="type"></code>rotation</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="TYPEELTrotation.Rotate0"><span class="constructor">Rotate0</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="TYPEELTrotation.Rotate90"><span class="constructor">Rotate90</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="TYPEELTrotation.Rotate180"><span class="constructor">Rotate180</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="TYPEELTrotation.Rotate270"><span class="constructor">Rotate270</span></span></code></td>
</tr></table>
<div class="info ">
The type of the four rotations of pages. This defines how a viewing
application (e.g Acrobat) displays the page.<br>
</div>
<pre><span id="VALint_of_rotation"><span class="keyword">val</span> int_of_rotation</span> : <code class="type"><a href="Pdfpage.html#TYPErotation">rotation</a> -> int</code></pre><div class="info ">
Utility function to convert from rotation to integers.<br>
</div>
<pre><span id="VALrotation_of_int"><span class="keyword">val</span> rotation_of_int</span> : <code class="type">int -> <a href="Pdfpage.html#TYPErotation">rotation</a></code></pre><div class="info ">
The reverse. raises <code class="code">Pdf.PDFError</code> if its input modulo 360 is not 0, 90, 180
or 270.<br>
</div>
<br>
<h2 id="2_Pages">Pages</h2><br>
<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> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.content">content</span> : <code class="type"><a href="Pdf.html#TYPEpdfobject">Pdf.pdfobject</a> list</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.mediabox">mediabox</span> : <code class="type"><a href="Pdf.html#TYPEpdfobject">Pdf.pdfobject</a></code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.resources">resources</span> : <code class="type"><a href="Pdf.html#TYPEpdfobject">Pdf.pdfobject</a></code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.rotate">rotate</span> : <code class="type"><a href="Pdfpage.html#TYPErotation">rotation</a></code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTt.rest">rest</span> : <code class="type"><a href="Pdf.html#TYPEpdfobject">Pdf.pdfobject</a></code>;</code></td>
</tr></table>
}
<div class="info ">
A type representing a page. <code class="code">content</code> is the list of objects containing the
graphical content stream (see the <code class="code">Pdfpages</code> module), <code class="code">mediabox</code> the page size,
<code class="code">resources</code> the page's resource dictionary, <code class="code">rotate</code> its rotation and <code class="code">rest</code> any
other entries to reside in the page dictionary.<br>
</div>
<pre><span id="VALblankpage"><span class="keyword">val</span> blankpage</span> : <code class="type"><a href="Pdfpaper.html#TYPEt">Pdfpaper.t</a> -> <a href="Pdfpage.html#TYPEt">t</a></code></pre><div class="info ">
Create a page with empty content, media box from the given paper size, empty
resources, zero rotation and no extra dictionary entries.<br>
</div>
<pre><span id="VALcustompage"><span class="keyword">val</span> custompage</span> : <code class="type"><a href="Pdf.html#TYPEpdfobject">Pdf.pdfobject</a> -> <a href="Pdfpage.html#TYPEt">t</a></code></pre><div class="info ">
The same, but given a page size rectangle.<br>
</div>
<pre><span id="VALpages_of_pagetree"><span class="keyword">val</span> pages_of_pagetree</span> : <code class="type"><a href="Pdf.html#TYPEt">Pdf.t</a> -> <a href="Pdfpage.html#TYPEt">t</a> list</code></pre><div class="info ">
Extract the page tree from a PDF document and parse it to a list of page
objects. Owing to the <code class="code">rest</code> entry in the <code class="code">page</code> type, no information is lost.<br>
</div>
<pre><span id="VALadd_pagetree"><span class="keyword">val</span> add_pagetree</span> : <code class="type"><a href="Pdfpage.html#TYPEt">t</a> list -> <a href="Pdf.html#TYPEt">Pdf.t</a> -> <a href="Pdf.html#TYPEt">Pdf.t</a> * int</code></pre><div class="info ">
Build a page tree from a list of pages and install it in the given PDF
document. The resultant document and the number of the new page root object are
returned. If the document already contains a page root, it is overwritten but is
not garbage collected.<br>
</div>
<pre><span id="VALadd_root"><span class="keyword">val</span> add_root</span> : <code class="type">int -> (string * <a href="Pdf.html#TYPEpdfobject">Pdf.pdfobject</a>) list -> <a href="Pdf.html#TYPEt">Pdf.t</a> -> <a href="Pdf.html#TYPEt">Pdf.t</a></code></pre><div class="info ">
Given the page root number (for instance that returned by <code class="code">add_pagetree</code>),
any specific extra dictionary entries and a PDF document, build a document root.
Returns the new document. If a root exists, it is overwritten but is not garbage
collected.<br>
</div>
<pre><span id="VALendpage"><span class="keyword">val</span> endpage</span> : <code class="type"><a href="Pdf.html#TYPEt">Pdf.t</a> -> int</code></pre><div class="info ">
Number of pages in a document, faster than reading the pages and counting.<br>
</div>
<br>
<h2 id="2_Compoundoperations">Compound operations</h2><br>
<pre><span id="VALrenumber_pages"><span class="keyword">val</span> renumber_pages</span> : <code class="type"><a href="Pdf.html#TYPEt">Pdf.t</a> -> <a href="Pdfpage.html#TYPEt">t</a> list -> <a href="Pdfpage.html#TYPEt">t</a> list</code></pre><div class="info ">
Rename the resources within a number of page resource dictionaries and
contents, so as to allow them to be merged without name clashes.<br>
</div>
<pre><span id="VALchange_pages"><span class="keyword">val</span> change_pages</span> : <code class="type">bool -> <a href="Pdf.html#TYPEt">Pdf.t</a> -> <a href="Pdfpage.html#TYPEt">t</a> list -> <a href="Pdf.html#TYPEt">Pdf.t</a></code></pre><div class="info ">
Change the pages in a document for some new ones. If the boolean is true
and the number of pages in the old and new documents are equal, references to
the old pages from outside the page tree (for instance in destinations or
bookmarks) are renumbered. This ensures bookmarks are preserved correctly.<br>
</div>
<pre><span id="VALpdf_of_pages"><span class="keyword">val</span> pdf_of_pages</span> : <code class="type">?retain_numbering:bool -> <a href="Pdf.html#TYPEt">Pdf.t</a> -> int list -> <a href="Pdf.html#TYPEt">Pdf.t</a></code></pre><div class="info ">
Return a pdf with a subset of pages, but nothing else changed - exactly the
same page object numbers, so bookmarks etc still work. Also sorts out bookmarks
so only those in the range are kept.<br>
</div>
</body></html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-release
>
by-pkgid
>
a94aa4b565ade94d0310c6e77aeea765
>
files
>
74
