Struct TabBar 

pub struct TabBar<'a, Message, TabId, Theme = Theme, Renderer = Renderer>
where
    Renderer: Renderer + Renderer,
    Theme: Catalog,
    TabId: Eq + Clone,
{ /* private fields */ }

A tab bar to show tabs.

Example

#[derive(Debug, Clone)]
enum Message {
    TabSelected(TabId),
}

#[derive(PartialEq, Hash)]
enum TabId {
   One,
   Two,
   Three,
}

let tab_bar = TabBar::new(
    Message::TabSelected,
)
.push(TabId::One, TabLabel::Text(String::from("One")))
.push(TabId::Two, TabLabel::Text(String::from("Two")))
.push(TabId::Three, TabLabel::Text(String::from("Three")))
.set_active_tab(&TabId::One);

Implementations

impl<'a, Message, TabId, Theme, Renderer> TabBar<'a, Message, TabId, Theme, Renderer>

where Renderer: Renderer + Renderer<Font = Font>, Theme: Catalog, TabId: Eq + Clone,

pub fn new<F>(on_select: F) -> Self

where F: 'static + Fn(TabId) -> Message,

Creates a new TabBar with the index of the selected tab and a specified message which will be send when a tab is selected by the user.

It expects: * the index of the currently active tab. * the function that will be called if a tab is selected by the user. It takes the index of the selected tab.

pub fn with_tab_labels<F>( tab_labels: Vec<(TabId, TabLabel)>, on_select: F, ) -> Self

where F: 'static + Fn(TabId) -> Message,

Similar to new but with a given Vector of the TabLabels.

It expects: * the index of the currently active tab. * a vector containing the TabLabels of the TabBar. * the function that will be called if a tab is selected by the user. It takes the index of the selected tab.

pub fn close_size(self, close_size: f32) -> Self

Sets the size of the close icon of the TabLabels of the TabBar.

pub fn get_active_tab_id(&self) -> Option<&TabId>

Gets the id of the currently active tab on the TabBar.

pub fn get_active_tab_idx(&self) -> usize

Gets the index of the currently active tab on the TabBar.

pub fn get_height(&self) -> Length

Gets the width of the TabBar.

pub fn get_width(&self) -> Length

Gets the width of the TabBar.

pub fn height(self, height: impl Into<Length>) -> Self

Sets the height of the TabBar.

pub fn icon_font(self, font: Font) -> Self

Sets the font of the icons of the TabLabels of the TabBar.

pub fn icon_size(self, icon_size: f32) -> Self

Sets the icon size of the TabLabels of the TabBar.

pub fn max_height(self, max_height: f32) -> Self

Sets the maximum height of the TabBar.

pub fn on_close<F>(self, on_close: F) -> Self

where F: 'static + Fn(TabId) -> Message,

Sets the message that will be produced when the close icon of a tab on the TabBar is pressed.

Setting this enables the drawing of a close icon on the tabs.

pub fn padding(self, padding: impl Into<Padding>) -> Self

Sets the padding of the tabs of the TabBar.

pub fn push(self, id: TabId, tab_label: TabLabel) -> Self

Pushes a TabLabel to the TabBar.

pub fn size(&self) -> usize

Gets the amount of tabs on the TabBar.

pub fn spacing(self, spacing: impl Into<Pixels>) -> Self

Sets the spacing between the tabs of the TabBar.

pub fn text_font(self, text_font: Font) -> Self

Sets the font of the text of the TabLabels of the TabBar.

pub fn text_size(self, text_size: f32) -> Self

Sets the text size of the TabLabels of the TabBar.

pub fn tab_width(self, width: Length) -> Self

Sets the width of a tab on the TabBar.

pub fn set_active_tab(self, active_tab: &TabId) -> Self

Sets up the active tab on the TabBar.

pub fn set_position(self, position: Position) -> Self

Sets the Position of the Icon next to Text, Only used in TabLabel::IconText

pub fn style(self, style: impl Fn(&Theme, Status) -> Style + 'a) -> Self

where <Theme as Catalog>::Class<'a>: From<StyleFn<'a, Theme, Style>>,

Sets the style of the TabBar.

pub fn class(self, class: impl Into<<Theme as Catalog>::Class<'a>>) -> Self

Sets the class of the input of the TabBar.

pub fn width(self, width: impl Into<Length>) -> Self

Sets the width of the TabBar.

Trait Implementations

impl<'a, Message, TabId, Theme, Renderer> From<TabBar<'a, Message, TabId, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>

where Renderer: 'a + Renderer + Renderer<Font = Font>, Theme: 'a + Catalog + Catalog, Message: 'a, TabId: 'a + Eq + Clone,

fn from(tab_bar: TabBar<'a, Message, TabId, Theme, Renderer>) -> Self

Converts to this type from the input type.

impl<Message, TabId, Theme, Renderer> Widget<Message, Theme, Renderer> for TabBar<'_, Message, TabId, Theme, Renderer>

where Renderer: Renderer + Renderer<Font = Font>, Theme: Catalog + Catalog, TabId: Eq + Clone,

fn size(&self) -> Size<Length>

Returns the Size of the Widget in lengths.

fn layout( &mut self, tree: &mut Tree, renderer: &Renderer, limits: &Limits, ) -> Node

Returns the layout::Node of the Widget.

fn update( &mut self, _state: &mut Tree, event: &Event, layout: Layout<'_>, cursor: Cursor, _renderer: &Renderer, _clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, _viewport: &Rectangle, )

Processes a runtime Event.

fn mouse_interaction( &self, _state: &Tree, layout: Layout<'_>, cursor: Cursor, _viewport: &Rectangle, _renderer: &Renderer, ) -> Interaction

Returns the current mouse::Interaction of the Widget.

fn draw( &self, _state: &Tree, renderer: &mut Renderer, theme: &Theme, _style: &Style, layout: Layout<'_>, cursor: Cursor, viewport: &Rectangle, )

Draws the Widget using the associated Renderer.

fn size_hint(&self) -> Size<Length>

Returns a Size hint for laying out the Widget.

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

fn children(&self) -> Vec<Tree>

Returns the state Tree of the children of the Widget.

fn diff(&self, tree: &mut Tree)

Reconciles the Widget with the provided Tree.

fn operate( &mut self, _tree: &mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _operation: &mut dyn Operation, )

Applies an Operation to the Widget.

fn overlay<'a>( &'a mut self, _tree: &'a mut Tree, _layout: Layout<'a>, _renderer: &Renderer, _viewport: &Rectangle, _translation: Vector, ) -> Option<Element<'a, Message, Theme, Renderer>>

Returns the overlay of the Widget, if there is any.