Struct TopEdgeReveal 

pub struct TopEdgeReveal { /* private fields */ }

Reveal state of one top-edge bar. See the module docs.

Implementations

impl TopEdgeReveal

pub fn shown(&self) -> bool

Whether the bar shows (and its controls take the pointer).

pub fn reset(&mut self)

Forget everything and hide at once (the window stopped being maximized, or the bar’s geometry is gone).

pub fn hide(&mut self) -> bool

Hide now, e.g. after one of the bar’s controls was used.

pub fn pin(&mut self) -> bool

Show the bar for keyboard use until Self::unpin.

pub fn unpin(&mut self)

Keyboard use ended; the pointer decides again on its next sample.

pub fn reveal_by_touch(&mut self) -> bool

A finger swiped down from the top edge, which the host read (a display’s edge, where the band is the bezel’s): show the bar. It stays until the pointer, or a tap, goes elsewhere. Returns whether that changed anything.

pub fn on_motion( &mut self, p: Point, geo: &EdgeGeometry<'_>, now: Instant, ) -> bool

A pointer sample. Returns whether shown changed.

pub fn on_press(&mut self, p: Point, geo: &EdgeGeometry<'_>)

A press. A press in the band while the bar hides goes to the app and cancels any reveal until the pointer leaves the band.

pub fn on_leave(&mut self) -> bool

The pointer left the surface: nothing to keep the bar for.

pub fn on_touch_start(&mut self, p: Point, geo: &EdgeGeometry<'_>)

A touch went down at p.

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

A touch moved to p. Returns whether shown changed.

pub fn on_touch_end(&mut self)

A touch lifted or was cancelled.

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

Advance timers to now without a sample. Returns whether shown changed.

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

When Self::settle next changes something with no further input, so the host can sleep until then instead of pumping frames.

pub fn force_shown(&mut self, shown: bool)

Test and shot fixture: as if the person had reached for the bar.

pub fn elapse(&mut self) -> bool

Test and shot clock control: settle as if the pending dwell or hold had run out. Returns whether the bar shows now.

Trait Implementations

impl Clone for TopEdgeReveal

fn clone(&self) -> TopEdgeReveal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TopEdgeReveal

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

Formats the value using the given formatter.

impl Default for TopEdgeReveal

fn default() -> TopEdgeReveal

Returns the “default value” for a type.