Struct WidgetInfo 

pub struct WidgetInfo {
    pub id: AnnotId,
    pub field: FieldId,
    pub field_index: Option<u32>,
    pub name: String,
    pub kind: Option<FieldKind>,
    pub flags: FieldFlags,
    pub rotation: Rotation,
    pub dict: Dict,
    pub valued: Dict,
    /* private fields */
}

One widget annotation, read far enough to build its field’s state.

Fields

id: AnnotId

Which annotation, by raw /Annots index.

field: FieldId

Which field it is a control of, on this page.

A page-local id. See WidgetInfo::field_index for the document-wide one, and the module documentation for why both exist.

field_index: Option<u32>

Where this widget’s field sits in the document’s flat terminal-field list — the /AcroForm /Fields walk pdfrum_doc::form::Form::fields performs, which is the space /CO, Doc.numFields and Doc.getNthFieldName all count in.

None for a widget whose field the form does not list: an unnamed widget, or one under an /AcroForm that does not reach it. Such a field exists for interaction and is invisible to a script, which is also what the oracle answers — GetFieldByDict returns null and CountFields never counted it.

name: String

The field’s fully qualified name, empty when it has none.

kind: Option<FieldKind>

What kind of field it is, when the classifier could name one.

flags: FieldFlags

The inherited /Ff.

rotation: Rotation

The widget’s /MK /R, as the quadrant the appearance stream is set into.

Folded by pdfrum_doc::geom::WidgetRotation::from_degrees, which is the same call ap::widget::rotated_rect makes — routing and the generator must agree about which box a click lands in, so there is one normalization and not two. An angle that is not a multiple of 90 names no quadrant and is upright.

dict: Dict

The widget’s dictionary, for the readers that want the long tail.

valued: Dict

The field dictionary the value is read from, when that is not the widget itself.

Implementations

impl WidgetInfo

pub fn value<R: Resolve>(&self, r: &R) -> String

The field’s stored value.

pub fn options<R: Resolve>(&self, r: &R) -> Vec<ChoiceOption>

The field’s options, for a choice field.

pub fn selected<R: Resolve>(&self, r: &R) -> Vec<usize>

Which options the file says are selected, as interaction reads it.

Deliberately not ap::field_body::selected_indices, and the two are both right — a list box’s selection has two readers that disagree on purpose:

• the appearance reader takes /V first and matches it as text. That is what draws a file with no /AP, and it is what ap::field_body::selected_indices reproduces.
• the interaction reader, this one, consults /I first as integer indices and falls back to /V only when /I is not usable. That is what a session’s state must be seeded from.

They agree except on one shape — /I present, /V absent — where the first selects nothing and the second selects the rows /I names.

pub fn text_config<R: Resolve>(&self, r: &R) -> TextConfig

The text configuration, read from the flags and /MaxLen.

pub fn choice_config(&self) -> ChoiceConfig

The choice configuration, read from the flags.

pub fn top_index<R: Resolve>(&self, r: &R) -> usize

The row a list box starts drawing at, from /TI.

Trait Implementations

impl Clone for WidgetInfo

fn clone(&self) -> WidgetInfo

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WidgetInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for WidgetInfo

fn eq(&self, other: &WidgetInfo) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for WidgetInfo