Struct gui::Ui

pub struct Ui<E> where
    E: 'static + Debug,  { /* fields omitted */ }

A Ui is a container for related widgets.

Methods

impl<E> Ui<E> where
    E: 'static + Debug, 

pub fn new(
    new_root_widget: &'f mut dyn FnMut(Id, &mut dyn MutCap<E>) -> Box<dyn Widget<E>>
) -> (Self, Id)

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

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

Render the Ui with the given Renderer.

pub fn handle<T>(&mut self, event: T) -> Option<UnhandledEvents<E>> where
    T: Into<UiEvent<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> Cap for Ui<E> where
    E: 'static + Debug, 

fn children(&self, widget: Id) -> Iter<'widget, 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> MutCap<E> for Ui<E> where
    E: 'static + Debug, 

fn add_widget(
    &mut self,
    parent: Id,
    new_widget: &'f mut dyn FnMut(Id, &mut dyn MutCap<E>) -> Box<dyn Widget<E>>
) -> 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 Fn(&mut dyn Widget<E>, &E, &dyn Cap) -> Option<UiEvents<E>>>
) -> Option<&'static dyn Fn(&mut dyn Widget<E>, &E, &dyn Cap) -> Option<UiEvents<E>>>

Install or remove an event hook handler.

impl<E: Default> Default for Ui<E> where
    E: 'static + Debug, 

fn default() -> Ui<E>

Returns the "default value" for a type.

impl<E: Debug> Debug for Ui<E> where
    E: 'static + Debug, 

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

Formats the value using the given formatter.