Tabs

Struct Tabs 

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

A Tabs widget for showing a TabBar along with the tab’s content.

§Example

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

#[derive(Debug, Clone)]
enum TabId {
   One,
   Two,
   Three,
}

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

Implementations§

Source§

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

Source

pub fn new<F>(on_select: F) -> Self
where F: 'static + Fn(TabId) -> Message,

Creates a new Tabs widget 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.

Source

pub fn new_with_tabs<F>( tabs: impl IntoIterator<Item = (TabId, TabLabel, Element<'a, Message, Theme, Renderer>)>, on_select: F, ) -> Self
where F: 'static + Fn(TabId) -> Message,

Similar to new but with a given Vector of the TabLabel along with the tab’s content.

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

Source

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

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

Source

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

Sets the Tabs Icon render Position TabLabel of the TabBar.

Source

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

Sets the height of the Tabs.

Source

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

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

Source

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

Sets the icon size of the TabLabel of the TabBar.

Source

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.

Source

pub fn push<E>(self, id: TabId, tab_label: TabLabel, element: E) -> Self
where E: Into<Element<'a, Message, Theme, Renderer>>,

Pushes a TabLabel along with the tabs content to the Tabs.

Source

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

Sets the active tab of the Tabs using the TabId.

Source

pub fn tab_bar_height(self, height: Length) -> Self

Sets the height of the TabBar of the Tabs.

Source

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

Sets the maximum height of the TabBar of the Tabs.

Source

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

Sets the width of the TabBar of the Tabs.

Source

pub fn tab_bar_position(self, position: TabBarPosition) -> Self

Sets the TabBarPosition of the TabBar.

Source

pub fn tab_bar_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.

Source

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

Sets the padding of the tabs of the TabBar.

Source

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

Sets the spacing between the tabs of the TabBar.

Source

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

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

Source

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

Sets the text size of the TabLabel of the TabBar.

Source

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

Sets the width of the Tabs.

Trait Implementations§

Source§

impl<'a, Message, TabId, Theme, Renderer> From<Tabs<'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,

Source§

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

Converts to this type from the input type.
Source§

impl<Message, TabId, Theme, Renderer> Widget<Message, Theme, Renderer> for Tabs<'_, Message, TabId, Theme, Renderer>
where Renderer: Renderer + Renderer<Font = Font>, Theme: Catalog + Catalog, TabId: Eq + Clone,

Source§

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

Returns the state Tree of the children of the Widget.
Source§

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

Reconciles the Widget with the provided Tree.
Source§

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

Returns the Size of the Widget in lengths.
Source§

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

Returns the layout::Node of the Widget. Read more
Source§

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. Read more
Source§

fn mouse_interaction( &self, state: &Tree, layout: Layout<'_>, cursor: Cursor, viewport: &Rectangle, renderer: &Renderer, ) -> Interaction

Returns the current mouse::Interaction of the Widget. Read more
Source§

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.
Source§

fn overlay<'b>( &'b mut self, state: &'b mut Tree, layout: Layout<'b>, renderer: &Renderer, viewport: &Rectangle, translation: Vector, ) -> Option<Element<'b, Message, Theme, Renderer>>

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

fn operate( &mut self, tree: &mut Tree, layout: Layout<'_>, renderer: &Renderer, operation: &mut dyn Operation<()>, )

Applies an Operation to the Widget.
Source§

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

Returns a Size hint for laying out the Widget. Read more
Source§

fn tag(&self) -> Tag

Returns the Tag of the Widget.
Source§

fn state(&self) -> State

Returns the State of the Widget.

Auto Trait Implementations§

§

impl<'a, Message, TabId, Theme, Renderer> Freeze for Tabs<'a, Message, TabId, Theme, Renderer>
where <Theme as Catalog>::Class<'a>: Freeze,

§

impl<'a, Message, TabId, Theme = Theme, Renderer = Renderer<Renderer, Renderer>> !RefUnwindSafe for Tabs<'a, Message, TabId, Theme, Renderer>

§

impl<'a, Message, TabId, Theme = Theme, Renderer = Renderer<Renderer, Renderer>> !Send for Tabs<'a, Message, TabId, Theme, Renderer>

§

impl<'a, Message, TabId, Theme = Theme, Renderer = Renderer<Renderer, Renderer>> !Sync for Tabs<'a, Message, TabId, Theme, Renderer>

§

impl<'a, Message, TabId, Theme, Renderer> Unpin for Tabs<'a, Message, TabId, Theme, Renderer>
where <Theme as Catalog>::Class<'a>: Unpin, Renderer: Unpin, TabId: Unpin,

§

impl<'a, Message, TabId, Theme = Theme, Renderer = Renderer<Renderer, Renderer>> !UnwindSafe for Tabs<'a, Message, TabId, Theme, Renderer>

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

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more