Skip to main content

DomBuilder

Struct DomBuilder 

Source
pub struct DomBuilder<'a> { /* private fields */ }
Expand description

A DOM tree (uzor::ui::dom) inside a kit panel. Start with dom.

Implementations§

Source§

impl<'a> DomBuilder<'a>

Source

pub fn scroll(self, y: f64) -> Self

Scroll the tree up by y (fixed elements do not move).

Source

pub fn viewport(self, r: Rect) -> Self

The viewport fixed elements are placed against (the panel rect by default).

Source

pub fn paint_slots( self, paint: &'a mut dyn FnMut(&mut dyn RenderContext, &SlotFrame<'_>), ) -> Self

Paint the tree’s embed slots with paint in paint order: each slot’s content is drawn right after its box, clipped to it and to its scroll containers, so a popover, a fixed sheet or a toast declared later stays on top. A paint slot (uzor::ui::dom::El::paint_slot) also gets the gestures it captured.

Source

pub fn slot_registry(self, reg: &'a mut SlotRegistry) -> Self

Paint slots by registered painters (uzor::ui::dom::SlotRegistry): a slot whose key has a painter is painted by it in paint order, gets its pointer, drag, wheel, click, gestures and (when focused) the DomBuilder::key as uzor::ui::dom::SlotEvents in slot-local coordinates, is a Tab stop when the painter is focusable, and takes the painter’s accessible name and role. What the painters return is DomResponse::slot_actions. Slots without a painter still go to DomBuilder::paint_slots, if given.

Source

pub fn number(self, id: impl Into<String>, spec: NumberSpec) -> Self

Make the text input id a number field (uzor::ui::domkit::number_input): only what spec accepts can be typed, {id}:inc / {id}:dec, ArrowUp / ArrowDown (with DomBuilder::key) and the wheel over the focused field step it, and leaving it tidies the text (NumberSpec::normalized). Every change comes back in DomResponse::edited; read the value with NumberSpec::parse.

Source

pub fn key(self, k: Option<&'a KeyInput>) -> Self

This frame’s key press, if any (the app forwards keys it did not use): the arrow keys step a focused number field (DomResponse::key_used).

Source

pub fn dom_scroll(self) -> Self

Let elements with an id and overflow: auto | scroll be framework-owned scroll containers (see dom). Off by default, so an app that already scrolls those boxes itself is unchanged.

Source

pub fn build<'c, C: ContentCx<'c>>(self, cx: &mut C) -> DomResponse

Paint the tree and register its hit targets and fields.

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for DomBuilder<'a>

§

impl<'a> !Send for DomBuilder<'a>

§

impl<'a> !Sync for DomBuilder<'a>

§

impl<'a> !UnwindSafe for DomBuilder<'a>

§

impl<'a> Forget for DomBuilder<'a>

§

impl<'a> Freeze for DomBuilder<'a>

§

impl<'a> Move for DomBuilder<'a>

§

impl<'a> Unpin for DomBuilder<'a>

§

impl<'a> UnsafeUnpin for DomBuilder<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.