Struct AdoptiveNode

pub struct AdoptiveNode<U> { /* private fields */ }

Represents a node setup to dynamically swap child.

Any property node can be made adoptive by wrapping it with this node.

Implementations

impl<U> AdoptiveNode<U>

where U: UiNode,

pub fn new(create: impl FnOnce(AdoptiveChildNode) -> U) -> AdoptiveNode<U>

Create the adoptive node, the AdoptiveChildNode must be used as the child of the created node.

The created node is assumed to not be inited.

pub fn try_new<E>( create: impl FnOnce(AdoptiveChildNode) -> Result<U, E>, ) -> Result<AdoptiveNode<U>, E>

Create the adoptive node using a closure that can fail.

The created node is assumed to not be inited.

pub fn replace_child(&mut self, new_child: impl UiNode) -> Box<dyn UiNodeBoxed>

Replaces the child node.

Returns the previous child, the initial child is a NilUiNode.

Panics

Panics if is_inited.

pub fn is_inited(&self) -> bool

Returns true if this node is inited.

pub fn into_parts(self) -> (Arc<Mutex<RawMutex, Box<dyn UiNodeBoxed>>>, U)

Into child reference and node.

Panics

Panics if is_inited.

pub fn from_parts( child: Arc<Mutex<RawMutex, Box<dyn UiNodeBoxed>>>, node: U, ) -> AdoptiveNode<U>

From parts, assumes the nodes are not inited and that child is the actual child of node.

Trait Implementations

impl<U> UiNode for AdoptiveNode<U>

where U: UiNode,

fn init(&mut self)

Initializes the node in a new UI context.

fn deinit(&mut self)

Deinitializes the node in the current UI context.

fn info(&mut self, info: &mut WidgetInfoBuilder)

Builds widget info.

fn update(&mut self, updates: &WidgetUpdates)

Receives variable and other non-event updates.

fn event(&mut self, update: &EventUpdate)

Receives an event.

fn measure(&mut self, wm: &mut WidgetMeasure) -> Size2D<Px, Px>

Computes the widget size given the contextual layout metrics without actually updating the widget layout.

fn layout(&mut self, wl: &mut WidgetLayout) -> Size2D<Px, Px>

Computes the widget layout given the contextual layout metrics.

fn render(&mut self, frame: &mut FrameBuilder)

Generates render instructions and updates transforms and hit-test areas.

fn render_update(&mut self, update: &mut FrameUpdate)

Updates values in the last generated frame.

fn boxed(self) -> Box<dyn UiNodeBoxed>

where Self: Sized,

Box this node or just returns self if it is already a BoxedUiNode.

fn cfg_boxed(self) -> Box<dyn UiNodeBoxed>

where Self: Sized,

Helper for complying with the "dyn_node" feature, boxes the node or just returns it depending of the compile time feature.

fn is_widget(&self) -> bool

Gets if this node represents a full widget, that is, it is the outer-most widget node and defines a widget context.

fn is_nil(&self) -> bool

Gets if this node does nothing and is layout collapsed.

fn with_context<R, F>( &mut self, update_mode: WidgetUpdateMode, f: F, ) -> Option<R>

where F: FnOnce() -> R,

Calls f with the WIDGET context of the node if it is_widget.

fn into_widget(self) -> Box<dyn UiNodeBoxed>

where Self: Sized,

Gets a BoxedUiNode that is a full widget.

fn init_widget( self, ) -> (Box<dyn UiNodeBoxed>, ReadOnlyVar<Response<WidgetId>, ArcVar<Response<WidgetId>>>)

where Self: Sized,

Gets a BoxedUiNode that already is a full widget or will be after init and a response var that already is the widget ID or will update once after init with the ID.

fn downcast_unbox<T>(self) -> Result<T, Box<dyn UiNodeBoxed>>

where T: UiNode, Self: Sized,

Downcast to T, if self is T or self is a BoxedUiNode that is T.

fn actual_type_id(&self) -> TypeId

Returns the type_id of the unboxed node.

fn as_any(&self) -> &(dyn Any + 'static)

where Self: Sized,

Access to dyn Any methods.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

where Self: Sized,

Access to mut dyn Any methods.

fn trace<E, S>(self, enter_mtd: E) -> Box<dyn UiNodeBoxed>

where Self: Sized, E: FnMut(UiNodeOpMethod) -> S + Send + 'static,

Wraps the node in a node that, before delegating each method, calls a closure with the UiNodeOpMethod, the closure can return a span that is dropped after the method delegation.

fn op(&mut self, op: UiNodeOp<'_>)

Runs the UiNodeOp.