Tabbed

Struct Tabbed 

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

A tabbed widget.

This widget draws the tabs and handles events.

Use TabbedState::selected and TabbedState::widget_area to render the actual content of the tab.

Implementations§

Source§

impl<'a> Tabbed<'a>

Source

pub fn new() -> Self

Source

pub fn tab_type(self, tab_type: TabType) -> Self

Tab type.

Source

pub fn placement(self, placement: TabPlacement) -> Self

Tab placement.

Source

pub fn tabs(self, tabs: impl IntoIterator<Item = impl Into<Line<'a>>>) -> Self

Tab-text.

Source

pub fn closeable(self, closeable: bool) -> Self

Closeable tabs?

Renders a close symbol and reacts with TabbedOutcome::Close.

Source

pub fn block(self, block: Block<'a>) -> Self

Block

Source

pub fn styles(self, styles: TabbedStyle) -> Self

Set combined styles.

Source

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

Base style. Mostly for any background.

Source

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

Style for the tab-text.

Source

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

Style for hover.

Source

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

Style for the selected tab.

Source

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

Style for a focused tab.

Source

pub fn into_widgets(self) -> (LayoutWidget<'a>, TabbedWidget<'a>)

Constructs the widgets for rendering.

Returns the LayoutWidget that must run first. It doesn’t actually render anything, it just calculates the layout for the tab regions.

Use TabbedState::widget_area to render the selected tab.

The TabbedWidget actually renders the tabs. Render it after you finished with the content.

Trait Implementations§

Source§

impl<'a> Clone for Tabbed<'a>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for Tabbed<'a>

Source§

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

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

impl<'a> Default for Tabbed<'a>

Source§

fn default() -> Tabbed<'a>

Returns the “default value” for a type. Read more
Source§

impl StatefulWidget for &Tabbed<'_>

Source§

type State = TabbedState

State associated with the stateful widget. Read more
Source§

fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.
Source§

impl StatefulWidget for Tabbed<'_>

Source§

type State = TabbedState

State associated with the stateful widget. Read more
Source§

fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.

Auto Trait Implementations§

§

impl<'a> Freeze for Tabbed<'a>

§

impl<'a> RefUnwindSafe for Tabbed<'a>

§

impl<'a> Send for Tabbed<'a>

§

impl<'a> Sync for Tabbed<'a>

§

impl<'a> Unpin for Tabbed<'a>

§

impl<'a> UnwindSafe for Tabbed<'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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.