Struct Tabs 

pub struct Tabs<'a, M> { /* private fields */ }

Children one at a time, under a bar of their titles (#478). Every tab keeps its state while another shows; hidden tabs still get ticks and resizes. Alt+Right or Ctrl+PageDown shows the next tab, Alt+Left or Ctrl+PageUp the previous, Alt+1 to Alt+9 a tab by number, and a click on a title that tab. These come before the tab’s own keys; Tab and Shift+Tab move focus inside the tab shown.

Implementations

impl<'a, M> Tabs<'a, M>

pub fn new() -> Tabs<'a, M>

pub fn tab( self, title: impl Into<String>, child: impl Component<Output = M> + 'a, ) -> Self

Add a tab.

pub fn push(&mut self, title: impl Into<String>, child: Child<'a, M>)

Add a tab to tabs already built.

pub fn styles(self, selected: Style, unselected: Style) -> Self

The styles of the shown tab’s title and the others’.

pub fn active(self, index: usize) -> Self

Show tab index first.

pub fn on( self, action: &str, keys: impl IntoIterator<Item = Key>, description: &str, handler: impl FnMut() -> Flow<M> + 'a, ) -> Self

Run handler when one of keys bubbles up unused by the focused child: an action of yours, listed in the keymap under this container’s context.

pub fn shortcut( self, action: &str, keys: impl IntoIterator<Item = Key>, description: &str, handler: impl FnMut() -> Flow<M> + 'a, ) -> Self

Run handler when one of keys is pressed, before the focused child sees it.

pub fn rebind(self, action: &str, keys: impl IntoIterator<Item = Key>) -> Self

Make keys do this container’s action (focus-next, and the container’s own); no keys unbinds it.

pub fn own_keymap(&self) -> &Keymap

This container’s own bindings, without its children’s.

pub fn with_mouse(self, on: bool) -> Self

Report the mouse even when no child asks for it: for a click to focus a child, or a border to drag.

pub fn select(&mut self, index: usize)

Show tab index.

pub fn selected(&self) -> usize

The tab shown.

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

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn get(&self, index: usize) -> Option<&(dyn Component<Output = M> + 'a)>

Tab index’s child.

pub fn get_mut( &mut self, index: usize, ) -> Option<&mut (dyn Component<Output = M> + 'a)>

pub fn content(&self, context: &Context<'_>) -> Rect

Where the shown tab’s child is.

Trait Implementations

impl<M> Component for Tabs<'_, M>

type Output = M

fn start(&mut self, context: &Context<'_>) -> Flow<M>

Called once, before the component is first painted, with the terminal’s size: for work that needs it, such as rendering content at the width. Returning Done or Cancel finishes the component without waiting for an event. The default does nothing.

fn handle(&mut self, event: &Event, context: &Context<'_>) -> Flow<M>

Handle one event. Ctrl+C never arrives here: the event loop ends the component with Outcome::Interrupted.

fn render(&self, context: &Context<'_>) -> View

Render the current state.

fn tick(&self) -> Option<Duration>

How often the component wants Event::Tick, for a spinner or a countdown. None (the default): never.

fn mouse(&self) -> bool

Whether the component wants mouse events (#476): clicks, drags and the wheel. Off by default, since reporting the mouse takes text selection away from the terminal; a component turns it on when its caller opts in, and run then enables mouse reporting for the session.

fn keymap(&self) -> Keymap

The bindings this component has right now, for a help overlay, a shortcut list or status-bar hints to read (see keymap). A container’s include its focused child’s, before its own. The default declares none.

fn focusable(&self) -> bool

Whether the component takes focus in a container: Tab stops on it and keys go to it. The default: yes. A label, or a component that has finished, says no.

fn focus_step(&mut self, forward: bool) -> bool

Move focus to the next (forward) or previous focus stop inside this component, for Tab and Shift+Tab. false when there is none after the current one, so the container moves on to its next child. The default, for a component that is one stop: false.

fn focus_enter(&mut self, forward: bool) -> bool

Take focus from outside: at the first stop inside when forward, at the last otherwise. false when nothing in it can take focus. The default: whether the component is focusable.

fn default_value(&self) -> Option<Self::Output>

The value to return when the terminal is not interactive and the policy asks for defaults. None: there is none.

fn prompt( &mut self, io: &mut dyn LineIo, ) -> Result<Option<Self::Output>, NotInteractive>

Ask for the value line by line, for when the terminal is not interactive and the policy asks for a prompt. The default says the component has no line-based form.

impl<'a, M> Default for Tabs<'a, M>

fn default() -> Self

Returns the “default value” for a type.