Struct WindowList 

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

A list of Windows.

Implementations

impl<Event, Context, Error> WindowList<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> WindowList<Event, Context, Error>

pub fn new() -> Self

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

Show a window.

This shows the window on top of any other.

pub fn close(&self, n: usize) -> Box<dyn Window>

Remove the window from the list.

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 to_front(&self, n: usize)

Move the given window to the top.

Panic

This function is not reentrant. It will panic when called during rendering or event-handling of any window. It is not necessary to call this during event handling as this happens automatically.

Panics when out-of-bounds.

pub fn to_back(&self, n: usize)

Move the given window to the bottom.

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 is_empty(&self) -> bool

No windows.

pub fn len(&self) -> usize

Number of windows.

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

Typecheck the window.

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

Find top window with this type.

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

Find all windows with this type.

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

Get a reference to the window at index n.

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 get_mut<'a, S: 'static>(&'a self, n: usize) -> RefMut<'a, S>

Get a mutable reference to the window at index n.

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 try_get_mut<'a, S: 'static>(&'a self, n: usize) -> Option<RefMut<'a, S>>

Get a mutable reference to the window 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 try_get<'a, S: 'static>(&'a self, n: usize) -> Option<Ref<'a, S>>

Get a reference to the window 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 WindowList<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 WindowList<Event, Context, Error>

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

Formats the value using the given formatter.

impl<Event, Context, Error> Default for WindowList<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 WindowList<Event, Context, Error>

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

Handle events from top to bottom.

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.