Skip to main content

Tabs

Struct Tabs 

Source
pub struct Tabs<'a> { /* private fields */ }
Expand description

A horizontal strip of titles with the tab at selected highlighted.

Unlike Table/List, Tabs is a plain Widget, not a StatefulWidget: there is no scroll offset for a tab strip, only a selected index, so it takes selected: Option<usize> directly (set via Tabs::select) rather than a ListState: the app is free to drive that index however it likes (a plain usize it owns, a FocusRing, whatever fits), the same “app- or interaction-machinery-driven, widget just reads it” division of labor as every other widget here.

Titles render left to right, column_spacing blank columns apart (default 1, matching Table::column_spacing), with an optional single-character divider (default None, i.e. no divider) centered in that spacing: set with Tabs::divider. Drawing stops once a title would start past the area’s right edge; there is no horizontal scrolling.

style and selected_style default to Theme::DARK (as if Tabs::theme had been called); set them with Tabs::style/Tabs::selected_style.

As an InteractiveWidget, type State = usize (the same index a caller already threads into Tabs::select for the plain Widget path): a single id covers the whole strip, and a click selects the tab whose column range contains Response::pointer_pos, resolved against the very same per-tab column layout the drawing routine uses, so the two can’t diverge.

§Examples

use retroglyph_core::grid::{Grid, Rect};
use retroglyph_ui::{Surface, Tabs, Widget};

let titles = ["Overview", "Details", "Settings"];
let area = Rect::new(0, 0, 30, 1);
let mut grid = Grid::new(30, 1);
Tabs::new(&titles)
    .select(Some(0))
    .render(&mut Surface::new(&mut grid, area, 0));

Implementations§

Source§

impl<'a> Tabs<'a>

Source

pub fn new(titles: &'a [&'a str]) -> Self

A tab strip over titles, with nothing selected, styled from Theme::DARK (as if Tabs::theme had been called).

Source

pub const fn select(self, index: Option<usize>) -> Self

Select tab index (or clear the selection with None).

Source

pub const fn style(self, style: Style) -> Self

Set the style of unselected tabs.

Source

pub const fn selected_style(self, style: Style) -> Self

Set the style of the selected tab, including its background fill.

Source

pub const fn column_spacing(self, spacing: u16) -> Self

Set the number of blank columns between tabs.

Source

pub const fn divider(self, divider: Option<char>) -> Self

Set a divider character drawn within the spacing between tabs. None (the default) draws no divider: just column_spacing blank columns.

Source

pub fn theme(self, theme: Theme) -> Self

Applies theme’s named roles to this tab strip: style becomes theme.dim (unselected tabs read as de-emphasized) on theme.panel_bg, and selected_style becomes theme.bg on theme.accent: the same bright-on-accent highlight super::List::theme and super::Table::theme give their own selected state.

style sets an explicit background rather than leaving it at Style::new()’s default: an unset background isn’t “transparent” once a real backend draws it (a bare Color::Default cell paints as solid black behind the glyph; see retroglyph-software’s DEFAULT_BG), so this widget assumes it’s drawn on theme.panel_bg, true when composed with a themed super::Panel/super::Modal. Drawing this tab strip directly on the raw screen background instead needs a manual .style(...) override afterwards.

Call before any manual Tabs::style/Tabs::selected_style override you want to keep.

Source

pub fn theme_on(self, theme: Theme, bg: Color) -> Self

Same as Tabs::theme, but style is drawn on bg instead of theme.panel_bg: for a tab strip drawn directly on a backdrop other than a themed super::Panel/ super::Modal’s fill. selected_style still uses theme.accent as its background, unaffected by bg. Tabs::theme is exactly theme_on(theme, theme.panel_bg).

Trait Implementations§

Source§

impl<'a> Clone for Tabs<'a>

Source§

fn clone(&self) -> Tabs<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for Tabs<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<Id> InteractiveWidget<Id> for Tabs<'_>

Source§

fn sense(&self) -> Sense

A single id covers the whole strip: clicking resolves which tab via Response::pointer_pos and this strip’s own column layout, rather than each tab registering its own id.

Source§

type State = usize

State that outlives one render call, e.g. a selection index or scroll offset. () for widgets that have none.
Source§

fn render( &self, surface: &mut Surface<'_>, state: &mut Self::State, response: Response<Id>, )

Draw into surface, styled by response, which the caller already resolved (via Interaction::interact) for surface.area() and sense.
Source§

impl Widget for Tabs<'_>

Source§

fn render(&self, surface: &mut Surface<'_>)

Draw this widget into surface, filling surface.area(). Read more
Source§

impl<'a> Copy for Tabs<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for Tabs<'a>

§

impl<'a> RefUnwindSafe for Tabs<'a>

§

impl<'a> Send for Tabs<'a>

§

impl<'a> Sync for Tabs<'a>

§

impl<'a> Unpin for Tabs<'a>

§

impl<'a> UnsafeUnpin for Tabs<'a>

§

impl<'a> UnwindSafe for Tabs<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<C> WithAlpha for C
where C: Copy,

§

fn with_alpha_first<A>(self, alpha: A) -> AlphaFirst<A, Self>

Wraps self with alpha, storing alpha before the color in memory (see [AlphaFirst]).
§

fn with_alpha_last<A>(self, alpha: A) -> AlphaLast<A, Self>

Wraps self with alpha, storing alpha after the color in memory (see [AlphaLast]).