Struct TabView 

pub struct TabView { /* private fields */ }

The currently selected tab will have a highlighted background. All others will have the same background (which is usually darker).

Design:

[1] Tab│[2] Tab│[3] Tab│...

        -------------
        Tab 1 content
        -------------

Implementations

impl TabView

pub const TAB_SEPERATOR: Grapheme

pub const BRACKET_OPEN: Grapheme

pub const BRACKET_CLOSE: Grapheme

pub const ANGLES_RIGHT: Grapheme

pub const ANGLES_LEFT: Grapheme

pub const MIN_TAB_WIDTH: TSize = 4

pub fn default_callback(&mut self)

pub fn default_key_handler(&mut self, event: &mut WindowEvent)

pub fn set_selection_changed_callback<F: Fn(&mut Self) + 'static>( &mut self, callback: F, )

pub fn set_key_handler(&mut self, f: TabViewKeyHandler)

pub fn select_tab(&mut self, tab: &Tab)

Forcibly selects the given tab item

pub fn enable_tab_enumeration(&mut self)

This will enumerate each tab depending on the order they are in Enumerated Tabs will start with (n), n ∈ ℕ

Examples found in repository

examples/tabview.rs (line 44)

	fn default() -> Self {
		let label = WindowFactory::create::<Label>();
		label.borrow_mut().set_text("Lorem ipsum");
		let label2 = WindowFactory::create::<Label>();
		label2.borrow_mut().set_text("Bibsum loram");
		let label3 = WindowFactory::create::<Label>();
		label3.borrow_mut().set_text("Epsum larel");
		let label4 = WindowFactory::create::<Label>();
		label4.borrow_mut().set_text("Ipsel Aarel");

		let tabview = WindowFactory::create::<TabView>();
		{
			let mut brw = tabview.borrow_mut();
			brw.enable_tab_enumeration();
			brw.set_highlight_fg_color(Some(Color::Grey));
			brw.set_highlight_bg_color(Some(Color::Blue));
			brw.add_item(Tab::new("WIP Tab Number. 1", label));
			brw.add_item(Tab::new("WIP Tab Number. 2", label2));
			brw.add_item(Tab::new("WIP Tab Number. 3", label3));
			brw.add_item(Tab::new("WIP Tab Number. 4", label4));
		}

		Self {
			uid: WindowUID::new(),
			tabview,
			running: true,
		}
	}

pub fn disable_tab_enumeration(&mut self)

Disables the tab enumeration of all tabs

pub fn get_selection(&self) -> Option<&Tab>

Returns the selected Tab

pub fn set_highlight_fg_color(&mut self, color: Option<Color>)

Sets the foreground for the highlighted tab

Examples found in repository

examples/tabview.rs (line 45)

	fn default() -> Self {
		let label = WindowFactory::create::<Label>();
		label.borrow_mut().set_text("Lorem ipsum");
		let label2 = WindowFactory::create::<Label>();
		label2.borrow_mut().set_text("Bibsum loram");
		let label3 = WindowFactory::create::<Label>();
		label3.borrow_mut().set_text("Epsum larel");
		let label4 = WindowFactory::create::<Label>();
		label4.borrow_mut().set_text("Ipsel Aarel");

		let tabview = WindowFactory::create::<TabView>();
		{
			let mut brw = tabview.borrow_mut();
			brw.enable_tab_enumeration();
			brw.set_highlight_fg_color(Some(Color::Grey));
			brw.set_highlight_bg_color(Some(Color::Blue));
			brw.add_item(Tab::new("WIP Tab Number. 1", label));
			brw.add_item(Tab::new("WIP Tab Number. 2", label2));
			brw.add_item(Tab::new("WIP Tab Number. 3", label3));
			brw.add_item(Tab::new("WIP Tab Number. 4", label4));
		}

		Self {
			uid: WindowUID::new(),
			tabview,
			running: true,
		}
	}

pub fn set_highlight_bg_color(&mut self, color: Option<Color>)

Sets the background for the highlighted tab

Examples found in repository

examples/tabview.rs (line 46)

	fn default() -> Self {
		let label = WindowFactory::create::<Label>();
		label.borrow_mut().set_text("Lorem ipsum");
		let label2 = WindowFactory::create::<Label>();
		label2.borrow_mut().set_text("Bibsum loram");
		let label3 = WindowFactory::create::<Label>();
		label3.borrow_mut().set_text("Epsum larel");
		let label4 = WindowFactory::create::<Label>();
		label4.borrow_mut().set_text("Ipsel Aarel");

		let tabview = WindowFactory::create::<TabView>();
		{
			let mut brw = tabview.borrow_mut();
			brw.enable_tab_enumeration();
			brw.set_highlight_fg_color(Some(Color::Grey));
			brw.set_highlight_bg_color(Some(Color::Blue));
			brw.add_item(Tab::new("WIP Tab Number. 1", label));
			brw.add_item(Tab::new("WIP Tab Number. 2", label2));
			brw.add_item(Tab::new("WIP Tab Number. 3", label3));
			brw.add_item(Tab::new("WIP Tab Number. 4", label4));
		}

		Self {
			uid: WindowUID::new(),
			tabview,
			running: true,
		}
	}

pub fn select_next(&mut self)

pub fn select_previous(&mut self)

Trait Implementations

impl Default for TabView

fn default() -> Self

Returns the “default value” for a type.

impl HasWindowUID for TabView

fn uid(&self) -> WindowUID

Must be static and unique for each object implementing Window. Generate once per instance using WindowUID::new.

impl ItemCollection<Tab> for TabView

type Index = usize

Type used to index the underlying collection

fn add_item(&mut self, item: Tab)

Adds an item to the underlying collection

fn remove_item(&mut self, item: &Tab)

Removes an item from the underlying collection

fn remove_at(&mut self, index: Self::Index) -> Tab

Removes an item at the given index from the underlying collection Might panic if index is invalid

fn get_item(&mut self, index: Self::Index) -> Option<&Tab>

Returns an item from the collection by its index

fn clear_items(&mut self)

Clears all items in the underlying collection

fn items(&self) -> Self::Index

Returns the number of items in the underlying collection

impl Widget for TabView

fn set_alignment( &mut self, horizontal: HorizontalAlignment, vertical: VerticalAlignment, )

fn set_visibility(&mut self, visibility: bool)

fn set_width(&mut self, width: Size)

fn set_height(&mut self, height: Size)

fn set_margin(&mut self, margin: Thickness)

fn set_border(&mut self, border: BorderStyle)

fn set_enabled_state(&mut self, is_enabled: bool)

Changing the IsEnabled state usually changes the highlight color

fn set_width_constraint(&mut self, width: SizeConstraint)

fn set_height_constraint(&mut self, height: SizeConstraint)

impl WidgetColors for TabView

fn set_disabled_color(&mut self, color: Option<Color>)

fn set_base_fg_color(&mut self, color: Option<Color>)

fn set_base_bg_color(&mut self, color: Option<Color>)

impl Window for TabView

fn children(&mut self, builder: SubWindowBuilder) -> SubWindows

Returns all children windows (and layouting Rects) Note: When changing the children make sure to also adjust the focus

fn render(&self, canvas: &mut Canvas)

Allows self to draw into its own Canvas The canvas size depends on other properties set and the terminal size itself It is guarenteed that the size of the Canvas is atleast 1x1

fn handle_event(&mut self, event: &mut WindowEvent)

The events are forwarded from crossterm with the only exception of Resize which will have the same dimensions as the resulting canvas If a event’s handled attributed is set to true it will stop bubbling otherwise it will keep bubbling until another Window marks it as handled Except for:

fn focus(&self) -> Option<WindowRef>

Which child of the window has focus Is there is None, then ´self´ has focus

fn is_enabled(&self) -> bool

Is self enabled? Indicated whether or not to handle input and if its focusable When false, Window is still eligible to receive events

impl WindowLayout for TabView

fn border(&self) -> BorderStyle

fn alignment(&self) -> (HorizontalAlignment, VerticalAlignment)

Aligns self within its parent Window

fn is_visible(&self) -> bool

fn margin(&self) -> Thickness

fn desired_size_pre_hook(&mut self, available_size: TPoint)

This is similar to desired_size but will not return anything and can mutably change self This is executed before WindowLayout::desired_size Only implement if actually necessary

fn desired_size(&self, available_size: TPoint) -> TPoint

Parents call this to get the desired size of the child This must not exceed available_size on any axis When the result’s product is equal to 0, this window wont be drawn