Struct gui::Ui

pub struct Ui<E, M>
where
    E: 'static,
    M: 'static,
{ /* private fields */ }

A Ui is a container for related widgets.

Implementations

impl<E, M> Ui<E, M>

pub fn new<D, W>(new_data: D, new_root_widget: W) -> (Self, Id)

where D: FnOnce() -> Box<dyn Any>, W: FnOnce(Id, &mut dyn MutCap<E, M>) -> Box<dyn Widget<E, M>>,

Create a new Ui instance containing one widget that acts as the root widget.

pub fn add_ui_widget<D, W>( &mut self, parent: Id, new_data: D, new_widget: W ) -> Id

where D: FnOnce() -> Box<dyn Any>, W: FnOnce(Id, &mut dyn MutCap<E, M>) -> Box<dyn Widget<E, M>>,

Add a widget to the Ui.

This method fulfills the exact same purpose as MutCap::add_widget, but it does not require boxing up the provided FnOnce.

pub fn render(&self, renderer: &dyn Renderer)

Render the Ui with the given Renderer.

pub async fn handle<T>(&mut self, event: T) -> Option<E>

where T: Into<E>,

Handle an event.

This function performs the initial determination of which widget is supposed to handle the given event and then passes it down to the actual event handler.

Trait Implementations

impl<E, M> Cap for Ui<E, M>

fn data(&self, widget: Id) -> &dyn Any

Retrieve a reference to a widget’s data.

fn children(&self, widget: Id) -> Iter<'_, Id>

Retrieve an iterator over the children. Iteration happens in z-order, from highest to lowest.

fn root_id(&self) -> Id

Retrieve the Id of the root widget.

fn parent_id(&self, widget: Id) -> Option<Id>

Retrieve the parent of the given widget.

fn is_visible(&self, widget: Id) -> bool

Check whether a widget has its visibility flag set.

fn is_displayed(&self, widget: Id) -> bool

Check whether a widget is actually being displayed.

fn focused(&self) -> Option<Id>

Retrieve the currently focused widget.

fn is_focused(&self, widget: Id) -> bool

Check whether the given widget is focused.

impl<E, M> Debug for Ui<E, M>

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

Formats the value using the given formatter.

impl<E, M> Deref for Ui<E, M>

type Target = dyn Cap

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<E, M> MutCap<E, M> for Ui<E, M>

fn data_mut(&mut self, widget: Id) -> &mut dyn Any

Retrieve a mutable reference to a widget’s data.

fn add_widget( &mut self, parent: Id, new_data: Box<dyn FnOnce() -> Box<dyn Any>>, new_widget: Box<dyn FnOnce(Id, &mut dyn MutCap<E, M>) -> Box<dyn Widget<E, M>>> ) -> Id

Add a widget to the Ui.

fn show(&mut self, widget: Id)

Show a widget, i.e., set its and its parents’ visibility flag.

fn hide(&mut self, widget: Id)

Hide a widget, i.e., unset its visibility flag.

fn focus(&mut self, widget: Id)

Focus a widget.

fn hook_events( &mut self, widget: Id, hook_fn: Option<&'static dyn for<'f> Fn(&'f dyn Widget<E, M>, &'f mut dyn MutCap<E, M>, Option<&'f E>) -> Pin<Box<dyn Future<Output = Option<E>> + 'f>>> ) -> Option<&'static dyn for<'f> Fn(&'f dyn Widget<E, M>, &'f mut dyn MutCap<E, M>, Option<&'f E>) -> Pin<Box<dyn Future<Output = Option<E>> + 'f>>>

where E: Mergeable,

Install or remove an event hook handler.

fn send<'life0, 'async_trait>( &'life0 mut self, widget: Id, message: M ) -> Pin<Box<dyn Future<Output = Option<M>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Send the provided message to the given widget.

fn call<'life0, 'life1, 'async_trait>( &'life0 mut self, widget: Id, message: &'life1 mut M ) -> Pin<Box<dyn Future<Output = Option<M>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Send the provided message to the given widget, without transferring ownership of the message.