A | |
| add_bookmarks [Cpdf] | add_bookmarks verify input pdf adds bookmarks from the bookmark file
give.
|
| add_page_labels [Cpdf] |
Add page labels.
|
| add_uchar [Xmlm.Buffer] |
Adds the given (guaranteed valid) unicode
code point to a
buffer.
|
| addtexts [Cpdf] |
Call
add_texts metrics linewidth outline fast fontname font bates batespad colour
position linespacing fontsize underneath text pages orientation
relative_to_cropbox midline_adjust topline filename pdf.
|
| append [Xmlm.String] |
Concatenates two strings.
|
| attach_file [Cpdf] | attach_file keepversion topage pdf filename attaches the file in filename to the pdf, optionally to a page (rather than document-level).
|
B | |
| blackfills [Cpdf] |
Make all fills on certain pages black.
|
| blacklines [Cpdf] |
Make all lines on certain pages black.
|
| blacktext [Cpdf] |
Make all text on certain pages black.
|
| blank_document [Cpdf] |
Make a blank document given x and y page dimensions in points and a number of pages
|
| blank_document_paper [Cpdf] |
The same, but give a Pdfpaper.t paper size.
|
C | |
| calculate_position [Cpdf] | calculate_position ignore_d w (xmin, ymin, xmax, ymax) orientation pos calculates
the absolute position of text given its width, bounding box, orientation and
position.
|
| clear [Xmlm.Buffer] |
Clears the buffer.
|
| combine_pages [Cpdf] | combine_pages fast under over scaletofit swap equalize combines the page
content of two PDFs, page-by-page.
|
| compare [Xmlm.String] |
String comparison.
|
| contents [Xmlm.Buffer] |
Returns the buffer contents.
|
| copy_annotations [Cpdf] |
Copy the annotations on a given set of pages from a to b.
|
| copy_id [Cpdf] | copy_id keepversion copyfrom copyto copies the ID, if any, from
copyfrom to copyto.
|
| create [Xmlm.Buffer] |
Creates a buffer of the given size.
|
| create_metadata [Cpdf] |
Create XMP metadata from scratch
|
| crop_pdf [Cpdf] | crop_pdf xywhlist pdf range sets the cropbox on the given pages.
|
D | |
| decompress_pdf [Cpdf] |
Decompresses all streams in a PDF document, assuming it isn't encrypted.
|
| draft [Cpdf] |
Remove images from a PDF, optionally adding crossed boxes.
|
E | |
| empty [Xmlm.String] |
The empty string.
|
| endpage_io [Cpdf] |
Like
Pdfpage.endpage, but from an input and possible password - does the
minimal work to find the number of pages.
|
| eoi [Xmlm.S] | |
| eoi [Xmlm] |
Returns
true if the end of input is reached.
|
| error_message [Xmlm.S] | |
| error_message [Xmlm] |
Converts the error to an english error message.
|
| expand_date [Cpdf] |
Expand the string "now" to a PDF date string, ignoring any other string
|
G | |
| get_annotations [Cpdf] |
Return the annotations as a (pagenumber, content) list
|
| get_info_utf8 [Cpdf] |
Given a PDF, returns a function which can lookup a given dictionary entry
from the /Info dictionary, returning it as a UTF8 string
|
| get_metadata [Cpdf] |
Extract metadata to a
Pdfio.bytes
|
| get_xmp_info [Cpdf] | |
| go [Cpdfcommand] |
Call the command line tools with the contents of
Sys.argv
|
| go_withargv [Cpdfcommand] |
Call the command line tools with a specialised
argv of our own
|
H | |
| hard_box [Cpdf] | |
| hasbox [Cpdf] |
True if a given page in a PDF has a given box
|
| hflip_pdf [Cpdf] |
Flip the given pages horizontally
|
I | |
| input [Xmlm.S] | |
| input [Xmlm] |
Inputs a signal.
|
| input_doc_tree [Xmlm.S] | |
| input_doc_tree [Xmlm] |
Same as
Xmlm.input_tree but reads a complete well-formed
sequence of signals.
|
| input_tree [Xmlm.S] | |
| input_tree [Xmlm] |
If the next signal is a :
`Data signal, inputs it and invokes data with the character data., `El_start signal, inputs the sequence of signals until its
matching `El_end and invokes el and data as follows
el, is called on each `El_end signals with the corresponding
`El_start tag and the result of the callback invocation for the
element's children., data, is called on each `Data signals with the character data.
This function won't be called twice consecutively or with the empty
string., Other signals, raises Invalid_argument.
|
| iter [Xmlm.String] |
Iterates over the unicode
code point
of the given string.
|
| iter_pages [Cpdf] |
Same as
process_pages, but iterate rather than map.
|
L | |
| length [Xmlm.Buffer] |
Returns the number of characters contained in the buffer.
|
| length [Xmlm.String] |
Returns the length of the string.
|
| list_annotations [Cpdf] |
List the annotations to standard output in a given encoding.
|
| list_annotations_more [Cpdf] |
The same, but giving more information.
|
| list_attached_files [Cpdf] |
List attached files.
|
| list_bookmarks [Cpdf] | list_bookmarks encoding range pdf output lists the bookmarks to the given
output in the format specified in cpdfmanual.pdf
|
| list_fonts [Cpdf] |
Return font list.
|
| lowercase [Xmlm.String] |
New string with uppercase letter translated
to lowercase (correctness is only needed for ASCII
code point).
|
M | |
| make_input [Xmlm.S] | |
| make_input [Xmlm] |
Returns a new input abstraction reading from the given source.
|
| make_output [Xmlm.S] | |
| make_output [Xmlm] |
Returns a new output abstraction writing to the given destination.
|
| map_pages [Cpdf] |
Same as
process_pages but return the list of outputs of the map function.
|
| metrics_baseline_adjustment [Cpdf] |
These functions returns some details about the text if
addtexts is called with metrics true.
|
| metrics_howmany [Cpdf] | |
| metrics_rot [Cpdf] | |
| metrics_text [Cpdf] | |
| metrics_x [Cpdf] | |
| metrics_y [Cpdf] | |
N | |
| ns_xml [Xmlm.S] | |
| ns_xml [Xmlm] |
Namespace name value bound to the
reserved
"xml" prefix.
|
| ns_xmlns [Xmlm.S] | |
| ns_xmlns [Xmlm] |
Namespace name value bound to the
reserved
"xmlns" prefix.
|
O | |
| of_string [Xmlm.String] |
String from an OCaml string.
|
| output [Xmlm.S] | |
| output [Xmlm] |
Outputs a signal.
|
| output_depth [Xmlm.S] | |
| output_depth [Xmlm] | output_depth o is o's current element nesting level (undefined
before the first `El_start and after the last `El_end).
|
| output_doc_tree [Xmlm.S] | |
| output_doc_tree [Xmlm] |
Same as
Xmlm.output_tree but outputs a complete well-formed
sequence of signals.
|
| output_info [Cpdf] |
Output to standard output general information about a PDF.
|
| output_page_info [Cpdf] |
Print page info (Mediabox etc) to standard output.
|
| output_tree [Xmlm.S] | |
| output_tree [Xmlm] |
Outputs signals corresponding to a value by recursively
applying the given value deconstructor.
|
| output_xmp_info [Cpdf] |
Output to standard output information from any XMP metadata stream in a PDF.
|
P | |
| padafter [Cpdf] |
Put blank pages after the given page numbers
|
| padbefore [Cpdf] |
Put blank pages before the given page numbers
|
| padmultiple [Cpdf] |
Pad to a multiple of n pages
|
| parse_bookmark_file [Cpdf] | parse_bookmark_file verify pdf input parses the bookmark file in input.
|
| parse_pagespec [Cpdf] |
Parse a (valid) page specification to a page range
|
| parse_pagespec_without_pdf [Cpdf] | |
| peek [Xmlm.S] | |
| peek [Xmlm] |
Same as
Xmlm.input but doesn't remove the signal from the sequence.
|
| pos [Xmlm.S] | |
| pos [Xmlm] |
Current position in the input abstraction.
|
| pp_attribute [Xmlm] | pp_attribute ppf att prints an unspecified representation of att on
ppf.
|
| pp_dtd [Xmlm] | pp_dtd ppf dtd prints an unspecified representation of dtd on ppf.
|
| pp_name [Xmlm] | pp_name ppf name prints an unspecified representation of name on
ppf.
|
| pp_signal [Xmlm] | pp_signal ppf s prints an unspecified representation of s on
ppf.
|
| pp_tag [Xmlm] | pp_tag ppf tag prints an unspecified representation of tag on
ppf.
|
| presentation [Cpdf] | presentation range t d horizontal inward direction effect_duration pdf
adds a presentation on the pages in range.
|
| print_fonts [Cpdf] |
Print font list to stdout
|
| print_metadata [Cpdf] |
Print metadate to stdout
|
| print_pdf_objs [Cpdf] |
Debug: Print out a PDF in readable form to the terminal
|
| process_pages [Cpdf] |
Given a function from page number and page to page, a document, and a list
of page numbers to apply it to, apply the function to all those pages.
|
R | |
| recompress_pdf [Cpdf] |
Compresses all streams in the PDF document which are uncompressed, using
/FlateDecode, leaving out metadata.
|
| remove_annotations [Cpdf] |
Remove the annotations on given pages.
|
| remove_art_pdf [Cpdf] |
Remove any art box from the given pages.
|
| remove_attached_files [Cpdf] |
Remove attached files.
|
| remove_bleed_pdf [Cpdf] |
Remove any bleed box from the given pages.
|
| remove_cropping_pdf [Cpdf] |
Remove any cropping from the given pages.
|
| remove_metadata [Cpdf] |
Remove the metadata from a file
|
| remove_trim_pdf [Cpdf] |
Remove any trim box from the given pages.
|
| removetext [Cpdf] |
Remove text from the given pages.
|
| rotate_contents [Cpdf] |
Rotate the contents by the given angle on the given pages.
|
| rotate_pdf [Cpdf] |
Change rotation to a given value 0, 90, 180, 270 on given pages.
|
| rotate_pdf_by [Cpdf] |
Rotate clockwise by 0, 90, 180, 270 on given pages.
|
S | |
| scale_contents [Cpdf] |
Scale the contents of a page by a given factor centred around a given point in a given range.
|
| scale_pdf [Cpdf] |
Scale a PDF in sx, sy in the given pages.
|
| scale_to_fit_pdf [Cpdf] | scale_to_fit_pdf fast position input_scale x y op pdf range scales a page to fit the
page size given by (x, y) and by the input_scale (e.g 1.0 = scale to fit, 0.9
= scale to fit leaving a border etc.).
|
| setBox [Cpdf] | setBox boxname x y w h pdf range sets the given box on the given pages.
|
| set_mediabox [Cpdf] | set_mediabox xywhlist pdf range sets the media box on the given pages.
|
| set_metadata [Cpdf] | set_metadata keepversion filename pdf sets the XML metadata of a PDF to the contents of filename.
|
| set_metadata_date [Cpdf] |
Set the metadata date
|
| set_metadata_from_bytes [Cpdf] |
The same, but the content comes from
bytes.
|
| set_open_action [Cpdf] |
Set the open action.
|
| set_page_layout [Cpdf] |
Set the page layout to the given name (sans slash) e.g SinglePage
|
| set_page_mode [Cpdf] |
Set the page layout to the given name (sans slash) e.g SinglePage
|
| set_pdf_info [Cpdf] | set_pdf_info (key, value, version) sets the entry key in the /Info directory, updating
the PDF minor version to version.
|
| set_version [Cpdf] |
Set the PDF version number
|
| set_viewer_preference [Cpdf] | set_pdf_info (key, value, version) sets the entry key in the
/ViewerPreferences directory, updating the PDF minor version to version.
|
| shift_pdf [Cpdf] |
Shift a PDF in x and y (in pts) in the given pages.
|
| split_on_bookmarks [Cpdf] |
Split a PDF on bookmarks of a given level or below.
|
| squeeze [Cpdf] |
Squeeze a PDF
|
| stamp [Cpdf] | stamp relative_to_cropbox position topline midline fast scale_to_fit isover range over pdf stamps the first page of
over over each page of the PDF.
|
| strftime [Cpdfstrftime] |
This supports the following format specifiers: %a %A %b %B %s %e %H %I %j %m %M %p %S %T %u %w %Y %%
|
| string_of_pagespec [Cpdf] |
Return a string for the given range.
|
| string_of_position [Cpdf] |
Produce a debug string of a
position
|
T | |
| thinlines [Cpdf] |
Make all lines in the PDF at least a certain thickness.
|
| to_utf_8 [Xmlm.String] | to_utf_8 f v s, is f (... (f (f v s1) s2) ...) sn.
|
| twoup [Cpdf] |
The twoup operation does the same, but scales the new sides down so that
the media box is unchanged.
|
| twoup_stack [Cpdf] |
The twoup_stack operation puts two logical pages on each physical page,
rotating them 90 degrees to do so.
|
U | |
| upright [Cpdf] |
Modify the rotation of the page and its contents to leave the rotation at 0 with the page effectively unaltered.
|
V | |
| validate_pagespec [Cpdf] |
Is a page specification, in theory, valid? This is the most we can find out
without supplying a PDF, and thus knowing how many pages there are in it.
|
| vflip_pdf [Cpdf] |
Flip the given pages vertically
|