Struct Cell

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

W Grid cell container.

This widget defines properties that position and size widgets in a Grid!.

See the Grid::cells property for more details.

Implementations

impl Cell

pub fn widget_new() -> Self

Start building a new instance.

pub fn widget_type() -> WidgetType

Gets the widget type info.

impl Cell

pub fn column(&self, col: impl IntoVar<usize>)

P Cell column index.

If set to usize::MAX the cell is positioned based on the logical index.

Is 0 by default.

This property sets the INFO_ID.

See also the at property to bind both indexes at the same time.

impl Cell

pub fn row(&self, row: impl IntoVar<usize>)

P Cell row index.

If set to usize::MAX the cell is positioned based on the logical index.

Is 0 by default.

This property sets the INFO_ID.

See also the at property to bind both indexes at the same time.

impl Cell

pub fn at(&self, column_row: impl IntoVar<(usize, usize)>)

P Cell column and row indexes.

If set to AT_AUTO the cell is positioned based on the logical index.

Is (0, 0) by default.

This property sets the INFO_ID.

See also the column or row properties to bind each index individually.

impl Cell

pub fn column_span(&self, span: impl IntoVar<usize>)

P Cell column span.

Number of cells this one spans over horizontally, starting from the column index and spanning to the right.

Is 1 by default, the index is clamped between 1..max where max is the maximum number of valid columns to the right of the cell column index.

Note that the cell will not influence the column width if it spans over multiple columns.

This property sets the INFO_ID.

See also the span property to bind both spans at the same time.

impl Cell

pub fn row_span(&self, span: impl IntoVar<usize>)

P Cell row span.

Number of cells this one spans over vertically, starting from the row index and spanning down.

Is 1 by default, the index is clamped between 1..max where max is the maximum number of valid rows down from the cell column index.

Note that the cell will not influence the row height if it spans over multiple rows.

This property sets the INFO_ID.

See also the span property to bind both spans at the same time.

impl Cell

pub fn span(&self, span: impl IntoVar<(usize, usize)>)

P Cell column and row span.

Is (1, 1) by default.

This property sets the INFO_ID.

See also the column_span or row_span properties to bind each index individually.

Methods from Deref<Target = Container>

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

P Content overflow clipping.

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

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.

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.

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.

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

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

This property disables inline layout for the widget.

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

P Insert node in the placement relative to the widget’s child, outside of the child layout.

This is still inside the parent widget, but outside of properties like padding.

This property disables inline layout for the widget.

pub fn child_left(&self, node: impl UiNode, spacing: impl IntoVar<Length>)

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.

pub fn child_right(&self, node: impl UiNode, spacing: impl IntoVar<Length>)

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.

pub fn child_top(&self, node: impl UiNode, spacing: impl IntoVar<Length>)

P Insert node above the widget’s child.

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

pub fn child_bottom(&self, node: impl UiNode, spacing: impl IntoVar<Length>)

P Insert node below the widget’s child.

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

pub fn child_start(&self, node: impl UiNode, spacing: impl IntoVar<Length>)

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.

pub fn child_end(&self, node: impl UiNode, spacing: impl IntoVar<Length>)

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.

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

P Insert node over the widget’s child.

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

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

P Insert node under the widget’s child.

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

pub fn child_out_left(&self, node: impl UiNode, spacing: impl IntoVar<Length>)

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.

pub fn child_out_right(&self, node: impl UiNode, spacing: impl IntoVar<Length>)

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.

pub fn child_out_top(&self, node: impl UiNode, spacing: impl IntoVar<Length>)

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.

pub fn child_out_bottom(&self, node: impl UiNode, spacing: impl IntoVar<Length>)

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.

pub fn child_out_start(&self, node: impl UiNode, spacing: impl IntoVar<Length>)

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.

pub fn child_out_end(&self, node: impl UiNode, spacing: impl IntoVar<Length>)

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.

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

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.

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

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) -> 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 Cell

type Target = Container

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Cell

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

Mutably dereferences the value.