Struct gui::Ui

pub struct Ui { /* private fields */ }

A Ui is a container for related widgets.

Implementations

impl Ui

pub fn new(
    new_root_widget: &'_ mut dyn FnMut(Id, &mut dyn Cap) -> Box<dyn Widget>
) -> (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<E>(&mut self, event: E) -> Option<UnhandledEvents>where
    E: Into<UiEvent>,

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 Cap for Ui

fn add_widget(
    &mut self,
    parent: Id,
    new_widget: &'_ mut dyn FnMut(Id, &mut dyn Cap) -> Box<dyn Widget>
) -> Id

Add a widget to the Ui.

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 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 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 focus(&mut self, widget: Id)

Focus a widget.

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

Check whether the given widget is focused.

fn hook_events(
    &mut self,
    widget: Id,
    hook_fn: Option<&'static dyn Fn(&mut dyn Widget, Event, &dyn Cap) -> Option<UiEvents>>
) -> Option<&'static dyn Fn(&mut dyn Widget, Event, &dyn Cap) -> Option<UiEvents>>

Install or remove an event hook handler.

impl Debug for Ui

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

Formats the value using the given formatter.

impl Default for Ui

fn default() -> Ui

Returns the “default value” for a type.