PdfElixide.Form.Field.Choice (pdf_elixide v0.13.0)

A choice field (/FT /Ch) — list boxes and combo boxes.

:kind says which of the two it is, read from the /Ff bit :flags decodes as :combo.

The one kind whose value is expected to be a list, since only a list box can hold more than one selection at a time — and only one whose :flags carry :multi_select.

:value is a single selection as a string (whether the PDF spells it as a text string or a name), several selections as a list of strings, or nil. See PdfElixide.Form.Field.value/0 for what a malformed one can put here.

Summary

Types

kind()

Which kind of choice field it is.

t()

Types

kind()

@type kind() :: :combo_box | :list_box

Which kind of choice field it is.

:list_box is the default: this is what a field declaring no /Ff combo bit is.

t()

@type t() :: %PdfElixide.Form.Field.Choice{
  flags: PdfElixide.Form.Field.Choice.Flags.t(),
  kind: kind(),
  name: String.t(),
  value: PdfElixide.Form.Field.value()
}