Struct ListView 

pub struct ListView { /* private fields */ }

The browser, independent of the terminal so it can be tested.

Implementations

impl ListView

pub fn new( badge: &'static str, title: &str, items: Vec<Item>, write_to: &str, ) -> Self

items in display order, a child right after its parent at one level deeper. badge names the view; write_to is where w offers to write.

pub fn names( badge: &'static str, title: &str, names: &[Box<str>], write_to: &str, ) -> Self

Flat names, one entry each.

pub fn with_notes(self, notes: Vec<String>) -> Self

Lines to show under the list.

Trait Implementations

impl Screen for ListView

fn render(&mut self, frame: &mut Frame<'_>)

fn handle_key(&mut self, key: KeyEvent)

A key press (Ctrl-C goes to Screen::interrupt instead).

fn interrupt(&mut self)

fn done(&self) -> bool

fn status(&self) -> Option<String>

What the view is doing, in one short line, for data-beans sessions and the session picker to show.

fn pending_work(&self) -> Option<String>

Blocking work the last key asked for, as a line to print while it runs; Screen::do_work then does it.

fn do_work(&mut self)

fn tick(&mut self) -> bool

Called about every TICK, keys or not: true redraws, for a view waiting on work in the background.

fn takes_mouse(&self) -> bool

Whether the view takes the mouse: only then is the terminal asked for it, since a view holding it keeps text from being selected.

fn mouse(&mut self, _event: MouseEvent) -> bool

A mouse event (a button pressed or let go, or a turn of the wheel) at a cell of the screen; whether the screen changed and is drawn again.

fn reports_chords(&self) -> bool

Whether the terminal is asked to report keys held with Shift, Alt or Ctrl apart (the kitty keyboard protocol; others ignore the request), so that Shift+Enter, say, is not taken for Enter.

fn take_notice(&mut self) -> Option<String>

Something to tell whoever is away, once: run_screen rings the terminal’s bell and asks it for a desktop notification saying it.