Struct TabPanel

pub struct TabPanel { /* private fields */ }

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;
use cursive::view::Nameable;

let mut tabs = TabPanel::new()
      .with_tab(TextView::new("First").with_name("First"))
      .with_tab(TextView::new("Second").with_name("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.

Implementations

impl TabPanel

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<&str>

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

pub fn active_view(&self) -> Option<&dyn View>

Returns a reference to the underlying view.

pub fn active_view_mut(&mut self) -> Option<&mut dyn View>

Returns a mutable reference to the underlying view.

pub fn views(&self) -> Vec<&dyn View>

pub fn views_mut(&mut self) -> Vec<&mut dyn View>

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

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: &str) -> Result<Self, Self>

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

pub fn add_tab<T: View>(&mut self, view: NamedView<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, view: NamedView<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: &str, snd: &str)

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, view: NamedView<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, view: NamedView<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: &str) -> Result<(), IdNotFound>

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<String>

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

Trait Implementations

impl Default for TabPanel

fn default() -> Self

Returns the “default value” for a type.

impl View for TabPanel

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) -> Result<EventResult, CannotFocus>

Attempt to give this view the focus.

fn focus_view( &mut self, slt: &Selector<'_>, ) -> Result<EventResult, ViewNotFound>

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?

fn type_name(&self) -> &'static str

Returns the type of this view.