Struct Focus 

pub struct Focus {
    pub annot: usize,
    pub box_: FocusBox,
}

Which annotation on the page holds the keyboard focus, and what its focus rectangle is.

Both halves are needed and they are independent. The index alone decides the tint: a widget with a live control is never tinted, focused or not, and the focused one is the only widget a live control reaches in a single-focus session. The box decides whether anything is stroked in its place, which most field types answer with nothing.

use pdfrum_doc::{AnnotOverlay, Focus, FocusBox, geom};

let mut overlay = AnnotOverlay::with_capacity(2);
overlay.set_focus(Focus {
    annot: 1,
    box_: FocusBox::Rect(geom::rect(0.0, 0.0, 100.0, 20.0)),
});
assert_eq!(overlay.focus().map(|f| f.annot), Some(1));

Fields

annot: usize

The raw /Annots index of the focused annotation — the same key space AnnotOverlay::set uses.

box_: FocusBox

The rectangle to stroke, in page space.

Implementations

impl Focus

pub fn at(annot: usize) -> Focus

Focus on one annotation with no rectangle to stroke — the answer a text field and an editable combo box give.

use pdfrum_doc::{Focus, FocusBox};

let focus = Focus::at(2);
assert_eq!(focus.annot, 2);
// No rectangle to stroke, which is what a text field answers.
assert_eq!(focus.box_, FocusBox::None);

Trait Implementations

impl Clone for Focus

fn clone(&self) -> Focus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Focus

impl Debug for Focus

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

Formats the value using the given formatter.

impl PartialEq for Focus

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Focus