Struct ScreenReader 

pub struct ScreenReader { /* private fields */ }

Implementations

impl ScreenReader

pub fn new() -> ScreenReader

Speaks through the current host’s crate::host::SpeechFactory. Never panics: with no speech available this is a [NullSpeaker] and narration is silently dropped.

pub fn with_speaker(speaker: Box<dyn Speaker>) -> ScreenReader

pub fn null() -> ScreenReader

pub fn speaker(&self) -> &dyn Speaker

pub fn set_rate(&mut self, rate: f32)

Set the speech rate (1.0 = engine default; 2.0 ≈ twice as fast).

pub fn set_voice(&mut self, voice: &str)

Select a backend voice (e.g. an espeak-ng voice id like "en-us").

pub fn configure(&mut self, settings: &ScreenReaderSettings)

Speak at the rate and in the voice the person chose in Settings.

pub fn announce_focus(&mut self, node: &AccessNode)

Speaks describe of the newly-focused node, interrupting any previous narration — rapid arrow navigation speaks only the control landed on, never a backlog (see focus_storm test). Resets the reading cursor so the next read_next/read_prev re-anchors here.

pub fn announce( &mut self, text: impl Into<String>, priority: Priority, interrupt: bool, )

The live-region entry point: errors/permission prompts use Priority::Important (survives a focus interrupt); polite toasts use Priority::Notification.

pub fn announce_value_change(&mut self, value: impl Into<String>)

Interrupting — dragging a slider should track the latest value, not queue every intermediate one.

pub fn echo_char(&mut self, ch: char)

Spoken at Priority::Text, interrupting, so a fast typist’s echoes coalesce.

pub fn echo_word(&mut self, word: &str)

pub fn echo_deletion(&mut self, deleted: &str)

A single deleted character is spoken as “X deleted”; otherwise just “deleted”.

pub fn stop(&mut self)

The “silence key” (Orca convention): stop all speech and discard anything pending.

pub fn is_speaking(&self) -> bool

pub fn cursor_item<'a>( &mut self, order: &'a [ReadingItem], ) -> Option<&'a ReadingItem>

The item the cursor is on in order, which a double tap activates.

pub fn read_all(&mut self, root: &dyn Widget)

A “say all”: speaks every node’s describe as bulk Priority::Text (so a later focus change interrupts it). Seeds the reading cursor at the start.

pub fn read_all_in(&mut self, order: &[ReadingItem])

Self::read_all over order.

pub fn seed_reading_order(&mut self, root: &dyn Widget) -> usize

Refreshes the reading order without moving the cursor.

pub fn read_next(&mut self, root: &dyn Widget) -> Option<AccessNode>

Returns None (speaking nothing) at the end of the document.

pub fn read_next_in(&mut self, order: &[ReadingItem]) -> Option<AccessNode>

Self::read_next over order.

pub fn read_prev(&mut self, root: &dyn Widget) -> Option<AccessNode>

Returns None at the start of the document.

pub fn read_prev_in(&mut self, order: &[ReadingItem]) -> Option<AccessNode>

Self::read_prev over order.

pub fn explore_in( &mut self, order: &[ReadingItem], point: Point, ) -> Option<AccessNode>

Explore by touch: speak the item of order under point and put the cursor on it, pressing nothing. Of nested items the innermost wins (a key, not the keyboard around it). The item the cursor is already on is not spoken again, so a finger dragged across one key says it once. Returns the item when the cursor moved to it.

pub fn cursor(&self) -> Option<usize>

pub fn read_next_matching( &mut self, root: &dyn Widget, pred: impl Fn(&AccessNode) -> bool, ) -> Option<AccessNode>

Speaks a short “no more” cue and returns None when nothing ahead matches pred. Shared engine behind read_next_heading/read_next_control.

pub fn read_next_matching_in( &mut self, order: &[ReadingItem], pred: impl Fn(&AccessNode) -> bool, ) -> Option<AccessNode>

Self::read_next_matching over order.

pub fn read_prev_matching( &mut self, root: &dyn Widget, pred: impl Fn(&AccessNode) -> bool, ) -> Option<AccessNode>

pub fn read_prev_matching_in( &mut self, order: &[ReadingItem], pred: impl Fn(&AccessNode) -> bool, ) -> Option<AccessNode>

Self::read_prev_matching over order.

pub fn read_next_heading(&mut self, root: &dyn Widget) -> Option<AccessNode>

Jump to the next heading and speak it (“Insert + H”).

pub fn read_prev_heading(&mut self, root: &dyn Widget) -> Option<AccessNode>

Jump to the previous heading and speak it (“Insert + Shift + H”).

pub fn read_next_control(&mut self, root: &dyn Widget) -> Option<AccessNode>

Jump to the next form field / interactive control and speak it (“Insert + F”).

pub fn read_prev_control(&mut self, root: &dyn Widget) -> Option<AccessNode>

Jump to the previous form field / interactive control and speak it (“Insert + Shift + F”).

Trait Implementations

impl Default for ScreenReader

fn default() -> ScreenReader

Returns the “default value” for a type.