Struct masonry::widget::SizedBox

pub struct SizedBox { /* private fields */ }

A widget with predefined size.

If given a child, this widget forces its child to have a specific width and/or height (assuming values are permitted by this widget’s parent). If either the width or height is not set, this widget will size itself to match the child’s size in that dimension.

If not given a child, SizedBox will try to size itself as close to the specified height and width as possible given the parent’s constraints. If height or width is not set, it will be treated as zero.

Implementations

impl SizedBox

pub fn new(child: impl Widget) -> Self

Construct container with child, and both width and height not set.

pub fn new_with_id(child: impl Widget, id: WidgetId) -> Self

Construct container with child, and both width and height not set.

pub fn empty() -> Self

Construct container without child, and both width and height not set.

If the widget is unchanged, it will render nothing, which can be useful if you want to draw a widget some of the time.

pub fn width(self, width: f64) -> Self

Set container’s width.

pub fn height(self, height: f64) -> Self

Set container’s height.

pub fn expand(self) -> Self

Expand container to fit the parent.

Only call this method if you want your widget to occupy all available space. If you only care about expanding in one of width or height, use expand_width or expand_height instead.

pub fn expand_width(self) -> Self

Expand the container on the x-axis.

This will force the child to have maximum width.

pub fn expand_height(self) -> Self

Expand the container on the y-axis.

This will force the child to have maximum height.

pub fn background(self, brush: impl Into<BackgroundBrush>) -> Self

Builder-style method for setting the background for this widget.

This can be passed anything which can be represented by a BackgroundBrush; notably, it can be any Color, any gradient, or a fully custom painter FnMut.

pub fn border(self, color: impl Into<Color>, width: impl Into<f64>) -> Self

Builder-style method for painting a border around the widget with a color and width.

pub fn rounded(self, radius: impl Into<RoundedRectRadii>) -> Self

Builder style method for rounding off corners of this container by setting a corner radius

Trait Implementations

impl Widget for SizedBox

fn on_pointer_event(&mut self, ctx: &mut EventCtx<'_>, event: &PointerEvent)

Handle an event - usually user interaction.

fn on_text_event(&mut self, ctx: &mut EventCtx<'_>, event: &TextEvent)

fn on_access_event(&mut self, _ctx: &mut EventCtx<'_>, _event: &AccessEvent)

Handle an event from the platform’s accessibility API.

fn on_status_change( &mut self, _ctx: &mut LifeCycleCtx<'_>, _event: &StatusChange )

fn lifecycle(&mut self, ctx: &mut LifeCycleCtx<'_>, event: &LifeCycle)

Handle a lifecycle notification.

fn layout(&mut self, ctx: &mut LayoutCtx<'_>, bc: &BoxConstraints) -> Size

Compute layout.

fn paint(&mut self, ctx: &mut PaintCtx<'_>, scene: &mut Scene)

Paint the widget appearance.

fn accessibility_role(&self) -> Role

fn accessibility(&mut self, ctx: &mut AccessCtx<'_>)

fn children(&self) -> SmallVec<[WidgetRef<'_, dyn Widget>; 16]>

Return references to this widget’s children.

fn make_trace_span(&self) -> Span

Return a span for tracing.

fn get_debug_text(&self) -> Option<String>

Return a small string representing important info about this widget instance.

fn get_child_at_pos(&self, pos: Point) -> Option<WidgetRef<'_, dyn Widget>>

Return which child, if any, has the given pos in its layout rect.