Struct SaveStatusSurface 

pub struct SaveStatusSurface { /* private fields */ }

A document’s save status, on the framework’s status surfaces (HIG §7c): “Saving…” and “Saved” are a change worth noticing once, so they show in the transient StatusBubble; a failed save is an error the person must act on, so it is an error toast (danger icon, the reason, a “Try again” action and a close button) that stays until the save succeeds or it is dismissed. An app reports the state and routes clicks; it never pins a bubble open or paints its own save pill.

Both float in the bottom-trailing corner of the area they report on, clear of its scroll bar gutter.

Implementations

impl SaveStatusSurface

pub fn new() -> SaveStatusSurface

pub fn set(&mut self, state: SaveState, now: Instant) -> bool

Report the save state. A change shows it; the same state again does nothing, so calling this every frame is fine. Returns whether what is shown changed.

pub fn set_detail(&mut self, detail: Option<String>)

Say something about the saved document after “Saved” (a note’s length). It reads current while the bubble shows and never reopens it on its own.

pub fn poke(&mut self, now: Instant) -> bool

Show the bubble again (another document opened under it). A showing failure needs no reminder.

pub fn hover_bubble( &mut self, area: Rect, p: Point, tr: &mut TextRenderer, theme: &Theme, now: Instant, ) -> bool

The pointer moved to p over area: resting on the bubble’s corner pins it open (see StatusBubble::pointer_moved). Returns whether visibility changed.

pub fn accessibility(&self, target: &str) -> Option<AccessNode>

The surface for assistive technology while a failure shows: the reason, announced, with “Try again” and “Dismiss” buttons whose action targets are {target}.retry and {target}.dismiss.

pub fn perform( &mut self, target: &str, action_target: &str, ) -> Option<SaveAction>

Assistive technology activated action_target (one of Self::accessibility’s buttons under target): the action it is.

pub fn failure(&self) -> Option<&str>

The reason of a failed save that is showing, if any.

pub fn is_visible(&self, now: Instant) -> bool

Whether anything is showing at now.

pub fn needs_frame(&self, now: Instant) -> bool

Frames are needed only while the bubble lingers or fades.

pub fn next_wake_deadline(&self) -> Option<Instant>

Wake once to remove a transient, including when reduced motion disables fades. Keep an overdue deadline until paint consumes it, so a parked host sees it.

pub fn pointer_moved(&mut self, p: Point) -> bool

The pointer moved to p; returns whether the hover changed.

pub fn click(&mut self, p: Point) -> Option<SaveAction>

A click at p: the action it hits on a showing failure. Dismissing hides the failure until the state changes again.

pub fn contains(&self, p: Point) -> bool

Whether p is on the failure card (so a host keeps the click).

pub fn paint( &mut self, scene: &mut Scene, transform: Affine, tr: &mut TextRenderer, theme: &Theme, area: Rect, now: Instant, ) -> Option<Rect>

Paint what is showing in area; returns the painted rect.

Trait Implementations

impl Clone for SaveStatusSurface

fn clone(&self) -> SaveStatusSurface

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SaveStatusSurface

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

Formats the value using the given formatter.

impl Default for SaveStatusSurface

fn default() -> SaveStatusSurface

Returns the “default value” for a type.