Struct DataView

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

W Dynamically presents a data variable.

Shorthand

The DataView! macro provides a shorthand init that sets view property directly.

DataView!(::<T>, data, update)

Note that the first argument is a turbo-fish that defines the data type and is required.

The shorthand is above expands to:

DataView! {
    view::<T> = { data: data, update: update };
}

Implementations

impl DataView

pub fn widget_new() -> DataView

Start building a new instance.

pub fn widget_type() -> WidgetType

Gets the widget type info.

impl DataView

pub fn padding(&self, padding: impl IntoVar<SideOffsets>)

P Spacing around content, inside the border.

pub fn child_align(&self, align: impl IntoVar<Align>)

P Content alignment.

pub fn clip_to_bounds(&self, clip: impl IntoVar<bool>)

P Content overflow clipping.

impl DataView

pub fn view<D>( &self, data: impl IntoVar<D>, update: impl WidgetHandler<DataViewArgs<D>>, )

where D: VarValue,

P The view generator.

The update widget handler is used to generate the view from the data, it is called on init and every time data or update are new. The view is set by calling DataViewArgs::set_view in the widget function args, note that the data variable is available in DataViewArgs::data, a good view will bind to the variable to support some changes, only replacing the view for major changes.

Methods from Deref<Target = WidgetBase>

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.

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 Deref for DataView

type Target = WidgetBase

The resulting type after dereferencing.

fn deref(&self) -> &<DataView as Deref>::Target

Dereferences the value.

impl DerefMut for DataView

fn deref_mut(&mut self) -> &mut <DataView as Deref>::Target

Mutably dereferences the value.