Struct zng_app::widget::WidgetCtx

pub struct WidgetCtx(/* private fields */);

Defines the backing data of WIDGET.

Each widget owns this data and calls WIDGET.with_context to delegate to it’s child node.

Implementations

impl WidgetCtx

pub fn new(id: WidgetId) -> Self

New widget context.

pub fn deinit(&mut self, retain_state: bool)

Drops all var and event handles, clears all state.

If retain_state is enabled the state will not be cleared and can still read.

pub fn is_pending_reinit(&self) -> bool

Returns true if reinit was requested for the widget.

Note that widget implementers must use take_reinit to fulfill the request.

pub fn take_reinit(&mut self) -> bool

Returns true if an WIDGET.reinit request was made.

Unlike other requests, the widget implement must re-init immediately.

pub fn id(&self) -> WidgetId

Gets the widget id.

pub fn bounds(&self) -> WidgetBoundsInfo

Gets the widget bounds.

pub fn border(&self) -> WidgetBorderInfo

Gets the widget borders.

pub fn with_state<R>( &mut self, f: impl FnOnce(&mut OwnedStateMap<WIDGET>) -> R, ) -> R

Call f with an exclusive lock to the widget state.

pub fn share(&mut self) -> Self

Clone a reference to the widget context.

This must be used only if the widget implementation is split.