Struct orbtk_widgets::TabWidgetState

pub struct TabWidgetState { /* fields omitted */ }

Through the TabWidgetState it is possible to control the behaviour of TabWidget. Nearly every called function on TabWidgetState will not be executed immediatly, but they are instead stored and executed during the update phase, in the same order they are submitted.

Implementations

impl TabWidgetState

pub fn select_by_index(&mut self, index: usize)

Switch the selected tab with one with the passed index. If the index is greater than the tab count, the last one will be selected.

pub fn select_by_body(&mut self, entity: Entity)

Switch the selected tab with one with the passed body. If the no such body is found among the present tabs, nothing happen.

pub fn remove_by_body(&mut self, entity: Entity)

Remove the tab with the passed body. If the no such body is found among the present tabs, nothing happen.

pub fn add_tab<T: Into<String>>(&mut self, header: T, body: Entity)

Add a new tab to the widget.

pub fn set_close_button_visibility(&mut self, value: bool)

Set the close button visibility of all the tabs.

pub fn get_close_button_visibility(&self) -> bool

Get the close button visibility status

pub fn get_index(&self, tab_body: Entity) -> Option<usize>

Get the tab index associated with the passed body. If it is not found, None is returned.

Trait Implementations

impl AsAny for TabWidgetState

fn as_any(&self) -> &dyn Any

fn as_any_mut(&mut self) -> &mut dyn Any

impl Default for TabWidgetState

fn default() -> TabWidgetState

Returns the "default value" for a type.

impl State for TabWidgetState

fn init(&mut self, registry: &mut Registry, ctx: &mut Context<'_>)

Init is used for setting up the initial state of a widget, setting up fields to starting values and registering service(s). It is called after the widget is created.

fn update(&mut self, _: &mut Registry, ctx: &mut Context<'_>)

Updates the state of a widget before layout is calculated for the given context when the widget becomes "dirty", (e.g.: a property of a widget is changed or an [event] is fired)

fn cleanup(&mut self, _registry: &mut Registry, _ctx: &mut Context<'_>)

Used to cleanup the state and is called after window close is requested. # Arguments * _registry: Provides access to the global Service Registry. * _ctx: Represents the context of the current widget.Allows manipulation of the widget tree.

fn update_post_layout(
    &mut self,
    _registry: &mut Registry,
    _ctx: &mut Context<'_>
)

Updates the state after layout is calculated and before rendering for the given context when the widget becomes "dirty", (e.g.: a property of a widget is changed, or an [event] is fired)