Struct TabsState 

pub struct TabsState { /* private fields */ }

The tabs, which one is selected, and the scroll position of the strip.

Edit it through its methods so the strip observes the change. Every method leaves the state whole before it emits, so a subscriber reads the tabs and the selection as they will render.

Implementations

impl TabsState

pub fn new(tabs: impl IntoIterator<Item = Tab>) -> Self

The tabs, with the first one selected. Ids must be unique.

pub fn tabs(&self) -> &[Tab]

The tabs, in strip order.

pub fn selected(&self) -> Option<&SharedString>

The id of the selected tab.

pub fn select( &mut self, id: impl Into<SharedString>, cx: &mut Context<'_, Self>, )

Selects the tab with id and scrolls it into view. A no-op for an unknown id or the tab already selected.

pub fn select_neighbor(&mut self, step: isize, cx: &mut Context<'_, Self>)

Selects the tab step places from the selected one, wrapping at the ends: -1 for the previous tab, 1 for the next.

pub fn select_edge(&mut self, last: bool, cx: &mut Context<'_, Self>)

Selects the first tab, or the last one when last is set.

pub fn push(&mut self, tab: Tab, cx: &mut Context<'_, Self>)

Appends a tab and selects it. Its id must be new to the strip.

pub fn insert(&mut self, index: usize, tab: Tab, cx: &mut Context<'_, Self>)

Inserts a tab at index, clamped to the end, without selecting it, so a host that keeps its own order can put a tab where it belongs. Its id must be new to the strip.

pub fn remove( &mut self, id: impl Into<SharedString>, cx: &mut Context<'_, Self>, )

Removes the tab with id. If it was selected, the tab after it is selected, or the one before it when it was last. Emits Closed, then Selected when the selection moved.

pub fn set_icon( &mut self, id: impl Into<SharedString>, icon: Option<impl Into<Icon>>, cx: &mut Context<'_, Self>, )

Sets or clears the icon of the tab with id, such as to mark a state the tab is in. A no-op for an unknown id.

pub fn request_add(&mut self, cx: &mut Context<'_, Self>)

Asks the application for a new tab.

pub fn rename( &mut self, id: impl Into<SharedString>, label: impl Into<SharedString>, cx: &mut Context<'_, Self>, )

Sets the label of the tab with id and emits Renamed. A no-op for an unknown id or an unchanged label.

pub fn start_rename( &mut self, id: impl Into<SharedString>, window: &mut Window, cx: &mut Context<'_, Self>, )

Turns the label of the tab with id into a text field holding the label, selected and focused. Enter or leaving the field commits a non-empty name; Escape cancels. A strip that is renamable starts one on a double click.

pub fn commit_rename(&mut self, cx: &mut Context<'_, Self>)

Ends an inline rename and keeps the typed name, unless it is blank.

pub fn cancel_rename(&mut self, cx: &mut Context<'_, Self>)

Ends an inline rename and keeps the old label.

pub fn renaming(&self) -> Option<&SharedString>

The id of the tab being renamed inline, if any.

Trait Implementations

impl EventEmitter<TabsEvent> for TabsState