Struct cursive_tabs::TabView

pub struct TabView<K: Hash> { /* fields omitted */ }

Main struct which manages views

Methods

impl<K: Hash + Eq + Copy + 'static> TabView<K>

pub fn new() -> Self

Returns a new TabView

Example

let mut tabs = TabView::new();

pub fn active_tab(&self) -> Option<K>

Returns the currently active tab Id.

pub fn set_active_tab(&mut self, id: K) -> Result<(), ()>

Set the currently active (visible) tab. If the tab id is not known, an error is returned and no action is performed.

pub fn with_active_tab(self, id: K) -> Result<Self, ()>

Set the currently active (visible) tab. If the tab id is not known, an error is returned and no action is performed.

This is the consumable variant.

pub fn add_tab<T: View>(&mut self, id: K, view: T)

Add a new tab to the tab view. The new tab will be set active and will be the visible tab for this tab view.

pub fn with_tab<T: View>(self, id: K, view: T) -> Self

Add a new tab to the tab view. The new tab will be set active and will be the visible tab for this tab view.

This is the consumable variant.

pub fn add_tab_at<T: View>(&mut self, id: K, view: T, pos: usize)

Add a new tab at a given position. The new tab will be set active and will be the visible tab for this tab view.

This is designed to not fail, if the given position is greater than the number of current tabs, it simply will be appended.

pub fn with_tab_at<T: View>(self, id: K, view: T, pos: usize) -> Self

Add a new tab at a given position. The new tab will be set active and will be the visible tab for this tab view.

It is designed to be fail-safe, if the given position is greater than the number of current tabs, it simply will be appended.

This is the consumable variant.

pub fn swap_tabs(&mut self, fst: K, snd: K)

Swap the tabs position. If one of the given key cannot be found, then no operation is performed.

pub fn remove_tab(&mut self, id: K) -> Result<(), ()>

Removes a tab with the given id from the TabView. If the removed tab is active at the moment, the TabView will unfocus it and the focus needs to be set manually afterwards, or a new view has to be inserted.

pub fn tab_order(&self) -> Vec<K>

Returns the current order of keys in a vector. When you're implementing your own tab bar, be aware that this is the current tab bar and is only a copy of the original order, modification will not be transferred and future updates in the original not displayed.

pub fn next(&mut self)

Set the active tab to the next tab in order.

pub fn prev(&mut self)

Set the active tab to the previous tab in order.

pub fn set_bar_rx(&mut self, rx: Receiver<K>)

Set the receiver for keys to be changed to

pub fn set_active_key_tx(&mut self, tx: Sender<K>)

Set the sender for the key switched to

Trait Implementations

impl<K: Hash + Eq + Copy + 'static> View for TabView<K>

fn draw(&self, printer: &Printer)

Draws the view with the given printer (includes bounds) and focus.

fn layout(&mut self, size: Vec2)

Called once the size for this view has been decided.

fn required_size(&mut self, req: Vec2) -> Vec2

Returns the minimum size the view requires with the given restrictions.

fn on_event(&mut self, evt: Event) -> EventResult

Called when an event is received (key press, mouse event, ...).

fn take_focus(&mut self, src: Direction) -> bool

This view is offered focus. Will it take it?

fn call_on_any<'a>(&mut self, slt: &Selector, cb: AnyCb<'a>)

Runs a closure on the view identified by the given selector.

fn focus_view(&mut self, slt: &Selector) -> Result<(), ()>

Moves the focus to the view identified by the given selector.

fn needs_relayout(&self) -> bool

Should return true if the view content changed since the last call to layout().

fn important_area(&self, size: Vec2) -> Rect

What part of the view is important and should be visible?