Struct DialogStack 

pub struct DialogStack<Event, Context, Error> { /* private fields */ }

Hold a stack of widgets.

Renders the widgets and can handle events.

Hold the dialog-stack in your global state, call render() at the very end of rendering and handle() near the start of event-handling.

This will not handle modality, so make sure to consume all events you don’t want to propagate.

Implementations

impl<Event, Context, Error> DialogStack<Event, Context, Error>

pub fn render(self, area: Rect, buf: &mut Buffer, ctx: &mut Context)

Render all dialog-windows in stack-order.

impl<Event, Context, Error> DialogStack<Event, Context, Error>

pub fn new() -> Self

pub fn push( &self, render: impl Fn(Rect, &mut Buffer, &mut dyn Any, &mut Context) + 'static, event: impl Fn(&Event, &mut dyn Any, &mut Context) -> Result<DialogControl<Event>, Error> + 'static, state: impl Any, )

Push a dialog-window on the stack.

• render is called in reverse stack order, to render bottom to top.
• event is called in stack-order to handle events. if you don’t want events to propagate to dialog-windows in the background, you must consume them by returning StackControl::Unchanged.
• state as Any

pub fn pop(&self) -> Option<Box<dyn Any>>

Pop the top dialog-window from the stack.

It will return None if the stack is empty.

Panic

This function is partially reentrant. When called during rendering/event-handling it will panic when trying to pop your current dialog-window. Return StackControl::Pop instead of calling this function.

pub fn remove(&self, n: usize) -> Box<dyn Any>

Remove some dialog-window.

Panic

This function is not reentrant. It will panic when called during rendering or event-handling of any dialog-window. Panics when out-of-bounds.

pub fn to_front(&self, n: usize)

Move the given dialog-window to the top of the stack.

Panic

This function is not reentrant. It will panic when called during rendering or event-handling of any dialog-window. Use StackControl::ToFront for this.

Panics when out-of-bounds.

pub fn is_empty(&self) -> bool

No windows.

pub fn len(&self) -> usize

Number of dialog-windows.

pub fn state_is<S: 'static>(&self, n: usize) -> bool

Typecheck the state.

pub fn first<S: 'static>(&self) -> Option<usize>

Find first state with this type.

pub fn find<S: 'static>(&self) -> Vec<usize>

Find all states with this type.

pub fn apply<S: 'static, R>(&self, n: usize, f: impl Fn(&S) -> R) -> R

Run f for the given instance of S.

Panic

Panics when out-of-bounds. Panics when recursively accessing the same state. Accessing a different window-state is fine. Panics when the types don’t match.

pub fn apply_mut<S: 'static, R>( &mut self, n: usize, f: impl Fn(&mut S) -> R, ) -> R

Run f for the given instance of S with exclusive/mutabel access.

Panic

Panics when out-of-bounds. Panics when recursively accessing the same state. Accessing a different window-state is fine. Panics when the types don’t match.

Trait Implementations

impl<Event, Context, Error> Clone for DialogStack<Event, Context, Error>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Event, Context, Error> Debug for DialogStack<Event, Context, Error>

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

Formats the value using the given formatter.

impl<Event, Context, Error> Default for DialogStack<Event, Context, Error>

fn default() -> Self

Returns the “default value” for a type.

impl<Event, Context, Error> HandleEvent<Event, &mut Context, Result<Control<Event>, Error>> for DialogStack<Event, Context, Error>

where Context: SalsaContext<Event, Error>, Error: 'static, Event: 'static,

Handle events from top to bottom of the stack.

Panic

This function is not reentrant, it will panic when called from within it’s call-stack.

fn handle( &mut self, event: &Event, ctx: &mut Context, ) -> Result<Control<Event>, Error>

Handle an event.