Skip to main content

ModeState

Struct ModeState 

Source
pub struct ModeState { /* private fields */ }
Expand description

Named mode system with independent screen stacks.

Each mode contains its own ScreenState. Switching modes preserves the previous mode’s screen stack, focus, and hook state.

§Example

let mut modes = slt::ModeState::new("app", "home");
modes.add_mode("settings", "general");

slt::run(|ui| {
    if ui.key('1') { modes.switch_mode("app"); }
    if ui.key('2') { modes.switch_mode("settings"); }
    let mode = modes.active_mode().to_string();
    ui.text(format!("Mode: {}", mode));
});

Implementations§

Source§

impl ModeState

Source

pub fn new(mode: impl Into<String>, screen: impl Into<String>) -> Self

Create a mode system with an initial mode and screen.

Source

pub fn add_mode(&mut self, mode: impl Into<String>, screen: impl Into<String>)

Add a new mode with an initial screen.

Source

pub fn switch_mode(&mut self, mode: impl Into<String>)

Switch to a different mode. The mode must have been added with Self::add_mode.

Panics if the mode does not exist. For a non-panicking variant that reports success, use Self::try_switch_mode.

Source

pub fn try_switch_mode(&mut self, mode: impl Into<String>) -> bool

Switch modes, returning true when the mode exists and the switch happened, or false when the mode has not been registered via Self::add_mode.

Prefer this over Self::switch_mode when the mode name comes from user input, key bindings, or anywhere the value could be unexpected at runtime — an unknown mode should not crash the host application.

Source

pub fn active_mode(&self) -> &str

Return the active mode name.

Source

pub fn screens(&self) -> &ScreenState

Get a reference to the active mode’s screen state.

Source

pub fn screens_mut(&mut self) -> &mut ScreenState

Get a mutable reference to the active mode’s screen state.

Trait Implementations§

Source§

impl Clone for ModeState

Source§

fn clone(&self) -> ModeState

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 Debug for ModeState

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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.