Enum widgetry::app_state::Transition

pub enum Transition<A> {
    Keep,
    KeepWithMouseover,
    Pop,
    ModifyState(Box<dyn FnOnce(&mut Box<dyn State<A>>, &mut EventCtx<'_>, &mut A)>),
    ConsumeState(Box<dyn FnOnce(Box<dyn State<A>>, &mut EventCtx<'_>, &mut A) -> Vec<Box<dyn State<A>>>>),
    Push(Box<dyn State<A>>),
    Replace(Box<dyn State<A>>),
    Clear(Vec<Box<dyn State<A>>>),
    Multi(Vec<Transition<A>>),
}

When a state responds to an event, it can specify some way to manipulate the stack of states.

Variants

Keep

Don’t do anything, keep the current state as the active one

KeepWithMouseover

Keep the current state as the active one, but immediately call event again with a mouse moved event

Pop

Destroy the current state, and resume from the previous one

ModifyState(Box<dyn FnOnce(&mut Box<dyn State<A>>, &mut EventCtx<'_>, &mut A)>)

If a state needs to pass data back to its parent, use this. In the callback, you have to downcast the previous state to populate it with data.

Tuple Fields of ModifyState

0: Box<dyn FnOnce(&mut Box<dyn State<A>>, &mut EventCtx<'_>, &mut A)>

ConsumeState(Box<dyn FnOnce(Box<dyn State<A>>, &mut EventCtx<'_>, &mut A) -> Vec<Box<dyn State<A>>>>)

This destroys the current state, running the callback on it, and pushes new states onto the stack. The callback can consume the current state, thus salvaging fields from it without cloning.

Tuple Fields of ConsumeState

0: Box<dyn FnOnce(Box<dyn State<A>>, &mut EventCtx<'_>, &mut A) -> Vec<Box<dyn State<A>>>>

Push(Box<dyn State<A>>)

Push a new active state on the top of the stack.

Tuple Fields of Push

0: Box<dyn State<A>>

Replace(Box<dyn State<A>>)

Replace the current state with a new one. Equivalent to Pop, then Push.

Tuple Fields of Replace

0: Box<dyn State<A>>

Clear(Vec<Box<dyn State<A>>>)

Replace the entire stack of states with this stack.

Tuple Fields of Clear

0: Vec<Box<dyn State<A>>>

Multi(Vec<Transition<A>>)

Execute a sequence of transitions in order.

Tuple Fields of Multi

0: Vec<Transition<A>>