Struct DialogStack 

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

Hold a stack of dialog-widgets.

Renders them and integrates them into event-handling.

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

The event-handler will consume all crossterm events and block any widget interaction later in event-handling. It will pass through any application level events.

Implementations

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<WindowControl<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 WindowControl::Close 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. Return WindowControl::Close instead of calling this function.

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 top<S: 'static>(&self) -> Option<usize>

Find top state with this type.

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

Find all states with this type.

pub fn get_mut<'a, S: 'static>(&'a self, n: usize) -> Option<RefMut<'a, S>>

Get a mutable reference to the state at index n.

Panic

Panics when out-of-bounds.

Fails

Fails when recursively accessing the same state. Accessing a different window-state is fine. Fails when the types don’t match.

pub fn get<'a, S: 'static>(&'a self, n: usize) -> Option<Ref<'a, S>>

Get a reference to the state at index n.

Panic

Panics when out-of-bounds.

Fails

Fails when recursively accessing the same state. Accessing a different window-state is fine. Fails 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<WindowControl<Event>, Error>> for DialogStack<Event, Context, Error>

where Event: TryAsRef<Event> + 'static, Error: 'static,

Handle events from top to bottom of the stack.

crossterm events will only be passed on to the first dialog window. Other application events will go through all the windows on the stack until they are consumed.

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<WindowControl<Event>, Error>

Handle an event.

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

type State = Context

State associated with the stateful widget.

fn render(self, area: Rect, buf: &mut Buffer, ctx: &mut Self::State)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.