Struct TextState 

pub struct TextState {
    pub edit: TextEdit,
    pub config: TextConfig,
}

A text field’s interaction state.

The edit control is the state: the text, its layout, the caret, the selection, the scroll offset and the undo stack are one record with one invariant, rather than a string here and a stack there that a mutation has to remember to keep in step.

use pdfrum_doc::vt::{Config, Metrics};
use pdfrum_form::{TextConfig, TextState};

let metrics = Metrics { width: &|_| 1000, ascent: 800, descent: -200 };
let config = Config {
    plate: kurbo::Rect::new(0.0, 0.0, 1000.0, 20.0),
    font_size: 1.0,
    ..Default::default()
};
let state = TextState {
    edit: pdfrum_form::edit::TextEdit::new("hello", &config, &metrics, true),
    config: TextConfig::default(),
};
assert_eq!(state.text(), "hello");

Fields

edit: TextEdit

The live edit control: text, layout, caret, selection, undo.

config: TextConfig

How the field is configured.

Implementations

impl TextState

pub fn text(&self) -> &str

The text as the user has it, which may differ from the field’s stored value until the edit commits.

use pdfrum_doc::vt::{Config, Metrics};
use pdfrum_form::{TextConfig, TextState};

let metrics = Metrics { width: &|_| 1000, ascent: 800, descent: -200 };
let config = Config {
    plate: kurbo::Rect::new(0.0, 0.0, 1000.0, 20.0),
    font_size: 1.0,
    ..Default::default()
};
let mut state = TextState {
    edit: pdfrum_form::edit::TextEdit::new("old", &config, &metrics, true),
    config: TextConfig::default(),
};

// Typing moves the live text; the field's stored `/V` is untouched
// until the edit commits.
state.edit.set_caret_index(3);
pdfrum_form::edit::ops::insert_char(&mut state.edit, &config, &metrics, 'X', None);
assert_eq!(state.text(), "oldX");

Trait Implementations

impl Clone for TextState

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextState

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

Formats the value using the given formatter.

impl PartialEq for TextState

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TextState