Struct titik::TabBox

pub struct TabBox<MSG> { /* fields omitted */ }

A Tab box contains multiple box which can only be shown one at a time

     ╭──────╮──────┬──────╮
     │ tab1 │ tab2 │ tab2 │
  ┌──┘      └──────┴──────┴────────┐
  │                                │
  │                                │
  │                                │
  │                                │
  │                                │
  └────────────────────────────────┘

Implementations

impl<MSG> TabBox<MSG>

pub fn new() -> Self

creates a new tab box

pub fn clear_children(&mut self)

remove all children of this flex_box

pub fn add_child_to_tab(
    &mut self,
    tab_index: usize,
    child: Box<dyn Widget<MSG>>
) -> bool

pub fn vertical(&mut self)

set to vertical column direction

pub fn horizontal(&mut self)

set to horizontal row direction

pub fn draw_labels(&self, buf: &mut Buffer, canvas: &mut Canvas)

╭──────╮──────┬──────╮ │ tab1 │ tab2 │ tab2 │ └──────┴──────┴──────┴

pub fn set_tab_labels(&mut self, labels: Vec<String>)

set the tab labels

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

set the active tab index

Trait Implementations

impl<MSG: Debug> Debug for TabBox<MSG>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<MSG> Widget<MSG> for TabBox<MSG> where
    MSG: Debug + 'static, 

fn layout(&self) -> Option<&Layout>

return the layout of thiswidget

fn set_layout(&mut self, layout: Layout)

fn get_offset(&self) -> (f32, f32)

the tab box has an offset of 2 from the top before drawing the child components

fn style(&self) -> Style

return the style of this widget

fn draw(&self, buf: &mut Buffer) -> Vec<Cmd>

this is called in the render loop in the renderer where the widget writes into the buffer. The result will then be written into the stdout terminal.

fn add_child(&mut self, child: Box<dyn Widget<MSG>>) -> bool

add a child widget to the current active tab

fn children(&self) -> Option<&[Box<dyn Widget<MSG>>]>

get a referemce tp the children of this widget

fn children_mut(&mut self) -> Option<&mut [Box<dyn Widget<MSG>>]>

get a mutable reference to the children of this widget

fn take_child(&mut self, index: usize) -> Option<Box<dyn Widget<MSG>>>

take the children at this index location

fn child_mut<'a>(
    &'a mut self,
    index: usize
) -> Option<&'a mut Box<dyn Widget<MSG>>>

return a mutable reference to a child at index location

fn as_any(&self) -> &dyn Any

get an Any reference

fn as_any_mut(&mut self) -> &mut dyn Any

get an Any mutable reference for casting purposed

fn set_size(&mut self, width: Option<f32>, height: Option<f32>)

set the size of the widget

fn set_id(&mut self, id: &str)

set the id of this widget

fn get_id(&self) -> &Option<String>

get the id of this widget

fn process_event(&mut self, event: Event) -> Vec<MSG>

this process the event and all callbacks attached to the widgets will be dispatched.

fn style_node(&self, stretch: &mut Stretch) -> Option<Node>

build a node with styles from this widget and its children The Layout tree is then calculated see layout::compute_layout

fn set_focused(&mut self, _focused: bool)

set the widget as focused

fn as_mut(&mut self) -> Option<&mut Self> where
    Self: Sized + 'static, 

get a mutable reference of this widget