Struct TextBox 

pub struct TextBox { /* private fields */ }

The text box’s state: the text, wrapped, the page on screen and how much of it is revealed.

Implementations

impl TextBox

pub fn new( text: &str, width: usize, per_page: usize, widths: &CellWidths, ) -> Self

text wrapped at width cells (word_wrap, a wide character of widths two cells: Ctx::widths), per_page lines a page, on its first page with nothing revealed yet.

pub fn page_lines(&self) -> &[String]

The lines of the page on screen, in full.

pub fn progress(&self) -> f32

How many of the page’s characters are revealed, with the part of the next one typed so far.

pub fn shown(&self) -> usize

How many of the page’s characters are revealed.

pub fn is_revealed(&self) -> bool

Whether the whole page is revealed.

pub fn reveal(&mut self)

Reveals the whole page at once.

pub fn next_page(&mut self) -> bool

Turns to the next page, if there is one: returns whether it did.

pub fn confirm(&mut self) -> Step

What the key that goes on does: reveals the page being typed (Step::Revealed), else turns to the next page (Step::NextPage), else says the box is Step::Done and leaves it as it is (its owner moves on to the next line, or closes it).

pub fn to_last_page(&mut self)

Shows the last page, all of it revealed (the line a choice answers).

pub fn release(&mut self)

The key that goes on is no longer counted as held (the box waits on something else).

pub fn hold(&mut self, held: bool, dt: f32)

dt seconds on, with the key that goes on held or not.

pub fn type_on(&mut self, dt: f32, chars_per_s: Option<f32>)

dt seconds of typing at chars_per_s (None: the whole page at once), faster for the part of them past FAST_FORWARD_DELAY of holding; once the page is revealed, the time it has waited.

pub fn marker_lit(&self) -> bool

Whether the marker that says “press to go on” is lit: it blinks while the page waits.

Trait Implementations

impl Clone for TextBox

fn clone(&self) -> TextBox

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextBox

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

Formats the value using the given formatter.

impl PartialEq for TextBox

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TextBox