Struct Container 

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

W Base container.

Implementations

impl Container

pub fn widget_new() -> Self

Start building a new instance.

pub fn widget_type() -> WidgetType

Gets the widget type info.

impl Container

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

P Content overflow clipping.

impl Container

pub fn child(&self, child: impl IntoUiNode)

P The widget’s child.

Can be any type that implements UiNode, any widget.

In Container! derived widgets or similar this property is captured and used as the actual child, in other widgets this property is an alias for child_under.

impl Container

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

P Margin space around the content of a widget.

This property is margin with nest group CHILD_LAYOUT.

impl Container

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

P Aligns the widget content within the available space.

This property is align with nest group CHILD_LAYOUT.

impl Container

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

P Spacing between child and one of the child_insert properties.

The spacing is only applied if the child insert property in the direction is set.

impl Container

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

P Spacing between child and child layout nodes and one of the child_out_insert properties.

The spacing is only applied if the child insert property in the direction is set.

impl Container

pub fn child_insert( &self, placement: impl IntoVar<ChildInsert>, node: impl IntoUiNode, )

P Insert node in the placement relative to the widget’s child.

The node is inserted inside the CHILD_LAYOUT scope, meaning inside padding, just like the child. See also child_out_insert for inserting a node outside the child layout.

Spacing between the widget’s child and node can be configured using child_spacing.

A property for each direction is also provided, see child_start, child_end, child_left, child_right, child_top, child_bottom, child_over and child_under.

This property disables inline layout for the widget.

impl Container

pub fn child_out_insert( &self, placement: impl IntoVar<ChildInsert>, node: impl IntoUiNode, )

P Insert node in the placement relative to the widget’s child, outside of the CHILD_LAYOUT scope, meaning outside padding, but still inside the widget.

Spacing between the widget’s child layout nodes and the node can be configured using child_out_spacing.

A property for each direction is also provided, see child_out_start, child_out_end, child_out_left, child_out_right, child_out_top, child_out_bottom, child_out_over and child_out_under.

This property disables inline layout for the widget.

impl Container

pub fn child_left(&self, node: impl IntoUiNode)

P Insert node to the left of the widget’s child.

This property disables inline layout for the widget. See child_insert for more details.

impl Container

pub fn child_right(&self, node: impl IntoUiNode)

P Insert node to the right of the widget’s child.

This property disables inline layout for the widget. See child_insert for more details.

impl Container

pub fn child_top(&self, node: impl IntoUiNode)

P Insert node above the widget’s child.

This property disables inline layout for the widget. See child_insert for more details.

impl Container

pub fn child_bottom(&self, node: impl IntoUiNode)

P Insert node below the widget’s child.

This property disables inline layout for the widget. See child_insert for more details.

impl Container

pub fn child_start(&self, node: impl IntoUiNode)

P Insert node to the left of the widget’s child in LTR contexts or to the right in RTL contexts.

This property disables inline layout for the widget. See child_insert for more details.

impl Container

pub fn child_end(&self, node: impl IntoUiNode)

P Insert node to the right of the widget’s child in LTR contexts or to the right of the widget’s child in RTL contexts.

This property disables inline layout for the widget. See child_insert for more details.

impl Container

pub fn child_over(&self, node: impl IntoUiNode)

P Insert node over the widget’s child.

This property disables inline layout for the widget. See child_insert for more details.

impl Container

pub fn child_under(&self, node: impl IntoUiNode)

P Insert node under the widget’s child.

This property disables inline layout for the widget. See child_insert for more details.

impl Container

pub fn child_out_left(&self, node: impl IntoUiNode)

P Insert node to the left of the widget’s child, outside of the child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

impl Container

pub fn child_out_right(&self, node: impl IntoUiNode)

P Insert node to the right of the widget’s child, outside of the child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

impl Container

pub fn child_out_top(&self, node: impl IntoUiNode)

P Insert node above the widget’s child, outside of the child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

impl Container

pub fn child_out_bottom(&self, node: impl IntoUiNode)

P Insert node below the widget’s child, outside of the child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

impl Container

pub fn child_out_start(&self, node: impl IntoUiNode)

P Insert node to the left of the widget’s child in LTR contexts or to the right in RTL contexts, outside of the child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

impl Container

pub fn child_out_end(&self, node: impl IntoUiNode)

P Insert node to the right of the widget’s child in LTR contexts or to the right of the widget’s child in RTL contexts, outside of the child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

impl Container

pub fn child_out_over(&self, node: impl IntoUiNode)

P Insert node over the widget’s child, not affected by child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

impl Container

pub fn child_out_under(&self, node: impl IntoUiNode)

P Insert node under the widget’s child, not affected by child layout.

This property disables inline layout for the widget. See child_out_insert for more details.

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) -> 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: Var<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>)

B Unique ID of the widget instance.

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

Trait Implementations

impl Deref for Container

type Target = WidgetBase

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Container

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.