Struct zng::widget::WidgetBase

pub struct WidgetBase { /* private fields */ }

Base widget.

The base widget implements the id property, and uses node::include_intrinsics and node::widget to implement the minimum required intrinsics for a widget to be a part of the UI tree.

See also NonWidgetBase to declare types that are build like a widget but are never used in the UI tree.

Implementations

impl WidgetBase

pub fn widget_type() -> WidgetType

Gets the type of WidgetBase.

pub fn widget_new() -> WidgetBase

Starts building a new WidgetBase instance.

pub fn widget_builder(&mut self) -> &mut WidgetBuilder

Returns a mutable reference to the widget builder.

pub fn widget_when(&mut self) -> Option<&mut WhenInfo>

Returns a mutable reference to the when block if called inside a when block.

pub fn widget_take(&mut self) -> WidgetBuilder

Takes the widget builder, finishing the widget macro build.

After this call trying to set a property using self will panic, the returned builder can still be manipulated directly.

pub fn widget_build(&mut self) -> impl UiNode

Build the widget.

After this call trying to set a property will panic.

pub fn widget_importance(&mut self) -> &mut Importance

Returns a mutable reference to the importance of the next property assigns, unsets or when blocks.

Note that during the widget_intrinsic call this is Importance::WIDGET and after it is Importance::INSTANCE.

pub fn start_when_block( &mut self, inputs: Box<[WhenInput]>, state: Box<dyn VarBoxed<bool>>, expr: &'static str, location: SourceLocation, )

Start building a when block, all properties set after this call are pushed in the when block.

pub fn end_when_block(&mut self)

End the current when block, all properties set after this call are pushed in the widget.

impl WidgetBase

pub fn id(&self, id: impl IntoValue<WidgetId>)

c Unique ID of the widget instance.

Note that the id can convert from a &'static str unique name.

Trait Implementations

impl WidgetImpl for WidgetBase

fn inherit(widget: WidgetType) -> WidgetBase

The inherit function.

fn base(&mut self) -> &mut WidgetBase

Reference the parent WidgetBase.