Struct LAYOUT

pub struct LAYOUT;

Current layout context.

Only available in measure and layout methods.

Implementations

impl LAYOUT

pub fn pass_id(&self) -> LayoutPassId

Gets the current window layout pass.

Widgets can be layout more then once per window layout pass, you can use this ID to identify such cases.

pub fn with_root_context<R>( &self, pass_id: LayoutPassId, metrics: LayoutMetrics, f: impl FnOnce() -> R, ) -> R

Calls f in a new layout pass.

pub fn with_context<R>( &self, metrics: LayoutMetrics, f: impl FnOnce() -> R, ) -> R

Calls f in a new layout context.

pub fn with_no_context<R>(&self, f: impl FnOnce() -> R) -> R

Calls f without a layout context.

pub fn metrics(&self) -> LayoutMetrics

Gets the context metrics.

pub fn capture_metrics_use<R>(&self, f: impl FnOnce() -> R) -> (LayoutMask, R)

Capture all layout metrics used in f.

Note that the captured mask is not propagated to the current context, you can use register_metrics_use to propagate the returned mask.

pub fn register_metrics_use(&self, uses: LayoutMask)

Register that the node layout depends on these contextual values.

Note that the value methods already register by the LayoutMetrics getter methods.

pub fn constraints(&self) -> PxConstraints2d

Current size constraints.

pub fn z_constraints(&self) -> PxConstraints

Current perspective constraints.

pub fn constraints_for(&self, axis: LayoutAxis) -> PxConstraints

Current length constraints for the given axis.

pub fn with_constraints<R>( &self, constraints: PxConstraints2d, f: impl FnOnce() -> R, ) -> R

Calls f with the constraints in context.

pub fn with_z_constraints<R>( &self, constraints: PxConstraints, f: impl FnOnce() -> R, ) -> R

Calls f with the constraints for perspective in context.

pub fn with_constraints_for<R>( &self, axis: LayoutAxis, constraints: PxConstraints, f: impl FnOnce() -> R, ) -> R

Calls f with the constraints in context.

pub fn with_sub_size( &self, removed: PxSize, f: impl FnOnce() -> PxSize, ) -> PxSize

Runs a function f in a context that has its max size subtracted by removed and its final size added by removed.

pub fn with_add_size(&self, added: PxSize, f: impl FnOnce() -> PxSize) -> PxSize

Runs a function f in a layout context that has its max size added by added and its final size subtracted by added.

pub fn inline_constraints(&self) -> Option<InlineConstraints>

Current inline constraints.

pub fn with_no_inline<R>(&self, f: impl FnOnce() -> R) -> R

Calls f with no inline constraints.

pub fn root_font_size(&self) -> Px

Root font size.

pub fn font_size(&self) -> Px

Current font size.

pub fn with_font_size<R>(&self, font_size: Px, f: impl FnOnce() -> R) -> R

Calls f with font_size in the context.

pub fn viewport(&self) -> PxSize

Current viewport size.

pub fn viewport_min(&self) -> Px

Current smallest dimension of the viewport.

pub fn viewport_max(&self) -> Px

Current largest dimension of the viewport.

pub fn viewport_for(&self, axis: LayoutAxis) -> Px

Current viewport length for the given axis.

pub fn with_viewport<R>(&self, viewport: PxSize, f: impl FnOnce() -> R) -> R

Calls f with viewport in the context.

pub fn scale_factor(&self) -> Factor

Current scale factor.

pub fn with_scale_factor<R>( &self, scale_factor: Factor, f: impl FnOnce() -> R, ) -> R

Calls f with scale_factor in the context.

pub fn screen_ppi(&self) -> Ppi

Current screen PPI.

pub fn with_screen_ppi<R>(&self, screen_ppi: Ppi, f: impl FnOnce() -> R) -> R

Calls f with screen_ppi in the context.

pub fn direction(&self) -> LayoutDirection

Current layout direction.

pub fn with_direction<R>( &self, direction: LayoutDirection, f: impl FnOnce() -> R, ) -> R

Calls f with direction in the context.

pub fn leftover(&self) -> Size2D<Option<Px>, ()>

Context leftover length for the widget, given the Length::Leftover value it communicated to the parent.

pub fn leftover_for(&self, axis: LayoutAxis) -> Option<Px>

Context leftover length for the given axis.

pub fn with_leftover<R>( &self, width: Option<Px>, height: Option<Px>, f: impl FnOnce() -> R, ) -> R

Calls f with leftover set to with and height.