PdfElixide.Document.Annotation.Flags (pdf_elixide v0.9.0)

Copy Markdown View Source

Decoded /F annotation flags (ISO 32000-1 §12.5.3, Table 165).

These flags control how an annotation is displayed and printed. Each is exposed as a boolean; :raw carries the undecoded /F integer for callers that need the original bit value.

Fields

  • :invisible — do not display the annotation if it has no handler and no appearance stream.
  • :hidden — do not display or print the annotation.
  • :print — print the annotation when the page is printed.
  • :no_zoom — do not scale the annotation with the page zoom.
  • :no_rotate — do not rotate the annotation with the page.
  • :no_view — do not display the annotation on screen (it may still print).
  • :read_only — do not allow the user to interact with the annotation.
  • :locked — do not allow the annotation to be deleted or its properties changed.
  • :toggle_no_view — invert :no_view for certain events (e.g. mouse-over).
  • :locked_contents — do not allow the annotation's contents to be modified.
  • :raw — the raw /F integer.

Summary

Types

t()

Types

t()

@type t() :: %PdfElixide.Document.Annotation.Flags{
  hidden: boolean(),
  invisible: boolean(),
  locked: boolean(),
  locked_contents: boolean(),
  no_rotate: boolean(),
  no_view: boolean(),
  no_zoom: boolean(),
  print: boolean(),
  raw: non_neg_integer(),
  read_only: boolean(),
  toggle_no_view: boolean()
}