Struct cursive_tabs::TabPanel

pub struct TabPanel<K: Hash + Eq + Display + Copy + 'static> { /* fields omitted */ }

The TabPanel is an ease of use wrapper around a TabView and its TabBar. Additionally the TabBar in the Panel can be horizontally aligned, by default it is set to be left aligned.

Example

use cursive_tabs::{Align, TabPanel};
use cursive::views::TextView;

let mut tabs = TabPanel::new()
      .with_tab("First", TextView::new("First"))
      .with_tab("Second", TextView::new("Second"))
      .with_bar_alignment(Align::Center);

A TabView is also usable separately, so if you prefer the tabs without the TabBar and Panel around have a look at TabView.

Methods

impl<K: Hash + Eq + Copy + Display + 'static> TabPanel<K>

pub fn new() -> Self

Returns a new instance of a TabPanel. Alignment is set by default to left, to change this use set_bar_alignment to change to any other HAlign provided by cursive.

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

Returns the current active tab of the TabView. Note: Calls active_tab on the enclosed TabView.

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

Non-consuming variant to set the active tab in the TabView. Note: Calls set_active_tab on the enclosed TabView.

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

Consuming & Chainable variant to set the active tab in the TabView. Note: Calls set_active_tab on the enclosed TabView.

Be careful! Failure in this case means the panel get dropped this has to with some trait restrictions in cursive, at the moment just avoid using the chainable variant if you are unsure that the operation will succeed.

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

Non-consuming variant to add new tabs to the TabView. Note: Calls add_tab on the enclosed TabView.

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

Consuming & Chainable variant to add a new tab. Note: Calls add_tab on the enclosed TabView.

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

Swaps the given tab keys. If at least one of them cannot be found then no operation is performed

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

Non-consuming variant to add new tabs to the TabView at a certain position. It is fail-safe, if the postion is greater than the amount of tabs, it is appended to the end. Note: Calls add_tab_at on the enclosed TabView.

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

Consuming & Chainable variant to add a new tab at a certain position. It is fail-safe, if the postion is greater than the amount of tabs, it is appended to the end. Note: Calls add_tab_at on the enclosed TabView.

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

Remove a tab of the enclosed TabView.

pub fn next(&mut self)

Proceeds to the next view in order of addition.

pub fn prev(&mut self)

Go back to the previous view in order of addition.

pub fn with_bar_alignment(self, align: Align) -> Self

Consumable & Chainable variant to set the bar alignment.

pub fn set_bar_alignment(&mut self, align: Align)

Non-consuming variant to set the bar alignment.

pub fn with_bar_placement(self, placement: Placement) -> Self

pub fn set_bar_placement(&mut self, placement: Placement)

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

Returns the current order of tabs as an Vector with the keys of the views.

Trait Implementations

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

fn draw(&self, printer: &Printer)

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

fn layout(&mut self, vec: Vec2)

Called once the size for this view has been decided.

fn needs_relayout(&self) -> bool

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

fn required_size(&mut self, cst: 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, d: Direction) -> bool

This view is offered focus. Will it take it?

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

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

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

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

fn important_area(&self, view_size: XY<usize>) -> Rect

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