Struct Dom

pub struct Dom { /* private fields */ }

The DOM that contains the tree of active widgets.

Implementations

impl Dom

pub fn new() -> Self

Create a new, empty DOM.

pub fn start(&self)

Start the build phase for the DOM and bind it to the current thread.

pub fn finish(&self, input: &InputState)

End the DOM’s build phase.

pub fn len(&self) -> usize

Tells how many nodes are currently in the DOM.

pub fn is_empty(&self) -> bool

Tells whether the DOM is empty.

pub fn root(&self) -> WidgetId

Gives the root widget in the DOM. This widget will always exist.

pub fn request_focus(&self, id: WidgetId)

Request focus for the given widget id

pub fn current(&self) -> WidgetId

If the DOM is being built, tells which widget is currently being built.

This method only gives valid results when called from inside a Widget lifecycle method.

pub fn get_current(&self) -> Ref<'_, DomNode>

Returns a reference to the current DOM node. See Dom::current.

pub fn get(&self, id: WidgetId) -> Option<Ref<'_, DomNode>>

Get the node with the given widget ID.

pub fn get_mut(&self, id: WidgetId) -> Option<RefMut<'_, DomNode>>

Get a mutable reference to the node with the given widget ID.

pub fn get_global_or_init<T, F>(&self, init: F) -> T

where T: 'static + Clone, F: FnOnce() -> T,

Get a piece of DOM-global state or initialize it with the given function.

This is intended for any state that is global. It’s not a perfect fit for scoped state like themes.

pub fn do_widget<T: Widget>(&self, props: T::Props<'_>) -> Response<T::Response>

Convenience method for calling Dom::begin_widget immediately followed by Dom::end_widget.

pub fn begin_widget<T: Widget>( &self, props: T::Props<'_>, ) -> Response<T::Response>

Begin building a widget with the given type and props.

After calling this method, children can be added to this widget.

pub fn end_widget<T: Widget>(&self, id: WidgetId)

Finish building the widget with the given ID. Must be the top of the stack, with no other widgets pending.

Trait Implementations

impl Debug for Dom

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

Formats the value using the given formatter.