Struct Ui 

pub struct Ui<S: 'static, H: 'static> { /* private fields */ }

Used to construct a UI tree with the builder pattern.

Implementations

impl<S, H> Ui<S, H>

pub fn node(&mut self) -> &mut Self

Create a new node in the tree and make it the current node for subsequent builder calls to configure.

Panics: If called a second time at the root level (only one root node is allowed).

pub fn id(&mut self, id: NodeId) -> &mut Self

Assign an id to the current node, providing a stable identity between build phases.

Panics: If the ID has already been assigned to a different node.

pub fn classes<'a>(&mut self, classes: impl Into<Option<&'a str>>) -> &mut Self

Append a space-separated list of CSS classes to the current node.

You can pass in None to remove all classes from the current node.

pub fn text(&mut self, text: impl Into<UIString>) -> &mut Self

Sets the text to be rendered inside this node.

pub fn enabled(&mut self, enabled: impl Into<UIParam<bool>>) -> &mut Self

Sets whether the current node is enabled. Disabled nodes do not receive events and may be styled differently.

Accepts impl Into<UIParam> so you can pass a reactive Var or a constant bool directly.

pub fn offset(&mut self, offset: impl Into<UIParam<Vec2>>) -> &mut Self

Provide an offset value to change the position of child nodes. Useful for scroll areas.

Accepts impl Into<UIParam> so you can pass a reactive Var or a constant Vec2 directly.

pub fn style_sheet<'a>( &mut self, style_sheet: impl Into<Option<&'a Stylesheet>>, ) -> &mut Self

Apply a stylesheet to the current node and all of its children.

You can pass in None to remove a stylesheet from the current node. There can only be one stylesheet per node.

pub fn event( &mut self, event_type: On, callback: impl Fn(&mut S, &mut EventCtx<'_, H>) + 'static, ) -> &mut Self

Register an event callback.

pub fn on_style( &mut self, callback: impl Fn(&S, &mut Style) + 'static, ) -> &mut Self

Register a function to modify the current node’s style before the layout and draw phases. Useful for applying the results of an On::AnimationFrame event handler.

There can only be one on_style callback per node.

pub fn on_measure( &mut self, callback: impl Fn(&S, &MeasureCtx<'_>) -> Size + 'static, ) -> &mut Self

Register a function to calculate the node’s preferred size based on the provided constraints. This overrides the node’s built-in text layout measurement.

There can only be one on_measure callback per node.

pub fn on_canvas( &mut self, callback: impl Fn(&S, &mut CanvasCtx<'_>) + 'static, ) -> &mut Self

Register a function to draw arbitrary vector graphics inside the current node.

There can only be one on_canvas callback per node.

pub fn on_accessibility( &mut self, f: impl for<'a> Fn(&S, &mut AccessibilityCtx<'a>) + Send + Sync + 'static, ) -> &mut Self

Register a function to construct the accessability information for the current node if the platform requests it.

There can only be one on_accessability callback per node.

pub fn children(&mut self, func: impl FnOnce(&mut Ui<S, H>)) -> &mut Self

Add child nodes.

Trait Implementations

impl<S: 'static, H: 'static> Debug for Ui<S, H>

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

Formats the value using the given formatter.