fenix/cpdf-source
1
0
Fork 0
mirror of https://github.com/johnwhitington/cpdf-source.git synced 2025-04-25 23:38:45 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docstrings

Browse Source
This commit is contained in:
John Whitington 2025-03-25 16:37:36 +00:00
parent 8b73790abe
commit 1181e25c62
3 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
cpdfpage.mli
View File

@ -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. *) = 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 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 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 val center_to_fit : (float * float) list -> Pdf.t -> int list -> Pdf.t
(** {2 Stamping} *) (** {2 Stamping} *)
@ -133,6 +135,8 @@ val alluprightonly : int list -> Pdf.t -> bool
(** When a page is transformed, its patterns must be too. *) (** When a page is transformed, its patterns must be too. *)
val change_pattern_matrices_page : Pdf.t -> Pdftransform.transform_matrix -> Pdfpage.t -> Pdfpage.t 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 val redact : process_struct_tree:bool -> Pdf.t -> int list -> Pdf.t
(** Remove a structure tree entirely from a file, including unmarking marked content. *) (** 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]. *) (** Mark a PDF as begin entirely artifacts (may be used after running [remove_struct_tree]. *)
val mark_all_as_artifact : Pdf.t -> Pdf.t val mark_all_as_artifact : Pdf.t -> Pdf.t

3
cpdftweak.mli
View File

@ -24,8 +24,11 @@ val get_dict_entries : utf8:bool -> Pdf.t -> string -> Pdfio.bytes
(** Remove clipping. *) (** Remove clipping. *)
val remove_clipping : Pdf.t -> int list -> Pdf.t 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 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 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 val replace_obj : Pdf.t -> string -> Pdf.pdfobject -> unit

3
cpdfutil.mli
View File

@ -1,6 +1,7 @@
(** Utilities *)
(** Remove a dictionary entry. *) (** Remove a dictionary entry. *)
val remove_dict_entry : Pdf.t -> string -> Pdf.pdfobject option -> unit val remove_dict_entry : Pdf.t -> string -> Pdf.pdfobject option -> unit
(** Replace a dictionary entry. *) (** Replace a dictionary entry. *)
val replace_dict_entry : Pdf.t -> string -> Pdf.pdfobject -> Pdf.pdfobject option -> unit val replace_dict_entry : Pdf.t -> string -> Pdf.pdfobject -> Pdf.pdfobject option -> unit