Struct masonry::LayoutCtx

pub struct LayoutCtx<'a> { /* private fields */ }

A context provided to layout handling methods of widgets.

As of now, the main service provided is access to a factory for creating text layout objects, which are likely to be useful during widget layout.

Implementations

impl LayoutCtx<'_>

pub fn widget_id(&self) -> WidgetId

get the WidgetId of the current widget.

pub fn skip_child(&self, child: &mut WidgetPod<impl Widget>)

Skip iterating over the given child.

Normally, container widgets are supposed to iterate over each of their child widgets in their methods. By default, the framework treats not doing so as a mistake, and panics if debug assertions are on.

This tells the framework that a child was deliberately skipped.

impl LayoutCtx<'_>

pub fn submit_action(&mut self, action: Action)

Submit an Action.

Note: Actions are still a WIP feature.

pub fn run_in_background( &mut self, _background_task: impl FnOnce(WorkerCtx<'_>) + Send + 'static )

Run the provided function in the background.

The function takes a [WorkerCtx] which it can use to communicate with the main thread.

pub fn compute_in_background<T: Any + Send>( &mut self, _background_task: impl FnOnce(WorkerCtx<'_>) -> T + Send + 'static ) -> PromiseToken<T>

Run the provided function in the background, and send its result once it’s done.

The function takes a [WorkerCtx] which it can use to communicate with the main thread.

Once the function returns, an Event::PromiseResult is emitted with the return value.

pub fn request_timer(&mut self, _deadline: Duration) -> TimerToken

Request a timer event.

The return value is a token, which can be used to associate the request with the event.

impl LayoutCtx<'_>

pub fn set_paint_insets(&mut self, insets: impl Into<Insets>)

Set explicit paint Insets for this widget.

You are not required to set explicit paint bounds unless you need to paint outside of your layout bounds. In this case, the argument should be an Insets struct that indicates where your widget needs to overpaint, relative to its bounds.

For more information, see WidgetPod::paint_insets.

pub fn set_baseline_offset(&mut self, baseline: f64)

Set an explicit baseline position for this widget.

The baseline position is used to align widgets that contain text, such as buttons, labels, and other controls. It may also be used by other widgets that are opinionated about how they are aligned relative to neighbouring text, such as switches or checkboxes.

The provided value should be the distance from the bottom of the widget to the baseline.

pub fn place_child(&mut self, child: &mut WidgetPod<impl Widget>, origin: Point)

Set the position of a child widget, in the paren’t coordinate space. This will also implicitly change “hot” status and affect the parent’s display rect.

Container widgets must call this method with each non-stashed child in their layout method, after calling child.layout(...).

impl LayoutCtx<'_>

pub fn font_ctx(&mut self) -> &mut FontContext