diff --git a/cpdfpage.mli b/cpdfpage.mli index 438893c..80d5b71 100644 --- a/cpdfpage.mli +++ b/cpdfpage.mli @@ -79,8 +79,10 @@ 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.). [op] is unused. *) val scale_to_fit_pdf : ?fast:bool -> Cpdfposition.position -> float -> (float * float) list -> 'a -> Pdf.t -> int list -> Pdf.t +(** [stretch fast pagesizes pdf range] stretches content to fit the given page size without regard to aspect ratio. *) val stretch : ?fast:bool -> (float * float) list -> Pdf.t -> int list -> Pdf.t +(** [center_to_fit : pagesizes pdf range] moves content to the centre of the page without scaling it. *) val center_to_fit : (float * float) list -> Pdf.t -> int list -> Pdf.t (** {2 Stamping} *) @@ -133,6 +135,8 @@ val alluprightonly : int list -> Pdf.t -> bool (** When a page is transformed, its patterns must be too. *) val change_pattern_matrices_page : Pdf.t -> Pdftransform.transform_matrix -> Pdfpage.t -> Pdfpage.t +(** Very basic redaction - the removal of whole pages, optionally trimming the + structure tree to remove any content there. *) val redact : process_struct_tree:bool -> Pdf.t -> int list -> Pdf.t (** Remove a structure tree entirely from a file, including unmarking marked content. *) @@ -140,4 +144,3 @@ val remove_struct_tree : Pdf.t -> Pdf.t (** Mark a PDF as begin entirely artifacts (may be used after running [remove_struct_tree]. *) val mark_all_as_artifact : Pdf.t -> Pdf.t - diff --git a/cpdftweak.mli b/cpdftweak.mli index 5cf4548..9920cdd 100644 --- a/cpdftweak.mli +++ b/cpdftweak.mli @@ -24,8 +24,11 @@ val get_dict_entries : utf8:bool -> Pdf.t -> string -> Pdfio.bytes (** Remove clipping. *) val remove_clipping : Pdf.t -> int list -> Pdf.t +(** Find an object from an objspec. Raises and error if the chain is not found. *) val find_obj : Pdf.t -> string -> Pdf.pdfobject +(** [remove_stream pdf objspec filename] replaces the stream at [objspec] with the contents of [filename]. *) val replace_stream : Pdf.t -> string -> string -> unit +(** [replace_obj pdf objspec obj] replace the object at [objspec] (which must exist) with [obj]. *) val replace_obj : Pdf.t -> string -> Pdf.pdfobject -> unit diff --git a/cpdfutil.mli b/cpdfutil.mli index 629018c..c036b5b 100644 --- a/cpdfutil.mli +++ b/cpdfutil.mli @@ -1,6 +1,7 @@ +(** Utilities *) + (** Remove a dictionary entry. *) val remove_dict_entry : Pdf.t -> string -> Pdf.pdfobject option -> unit (** Replace a dictionary entry. *) val replace_dict_entry : Pdf.t -> string -> Pdf.pdfobject -> Pdf.pdfobject option -> unit -