Skip to main content

LayoutCtx

Struct LayoutCtx 

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

Context passed to Widget::layout, carrying the text-shaping context and theme type-erased so frust-core depends on neither frust-text nor frust-theme.

Implementations§

Source§

impl<'a> LayoutCtx<'a>

Source

pub fn new() -> LayoutCtx<'static>

Create a layout context with no shared resources (leaf unit tests).

Source

pub fn with_text_context(text_ctx: &'a mut (dyn Any + 'static)) -> LayoutCtx<'a>

Create a layout context carrying the shared text-shaping context.

Source

pub fn with_resources( text_ctx: Option<&'a mut (dyn Any + 'static)>, theme: Option<&'a (dyn Any + 'static)>, ) -> LayoutCtx<'a>

Create a layout context carrying an optional text context and theme.

Source

pub fn with_theme(self, theme: &'a (dyn Any + 'static)) -> LayoutCtx<'a>

Attach the app’s active theme, type-erased.

Source

pub fn text_context<T>(&mut self) -> &mut T
where T: Any,

Recover the text-shaping context as &mut T; panics if absent or of another type (a wiring bug).

Source

pub fn theme_as<T>(&self) -> Option<&T>
where T: Any,

Recover the theme as &T, or None if absent or of another type.

Source

pub fn window_insets(&self) -> WindowInsets

The window insets for this pass, possibly narrowed by an ancestor.

Source

pub fn with_window_insets<R>( &mut self, insets: WindowInsets, f: impl FnOnce(&mut LayoutCtx<'a>) -> R, ) -> R

Run f with insets as the window insets, then restore them (how SafeArea removes consumed edges); a panic in f skips the restore.

Source

pub fn window_size(&self) -> Size

The window’s logical size (Size::ZERO before the first root layout); overlay pods are laid out against it, not their owner’s box.

Source

pub fn layout_epoch(&self) -> u64

The root’s global layout epoch for this pass; 0 outside a root.

Source

pub fn is_forced(&self) -> bool

Whether this pass ignores layout caches (true without a render root).

Trait Implementations§

Source§

impl Default for LayoutCtx<'static>

Source§

fn default() -> LayoutCtx<'static>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for LayoutCtx<'a>

§

impl<'a> !Send for LayoutCtx<'a>

§

impl<'a> !Sync for LayoutCtx<'a>

§

impl<'a> !UnwindSafe for LayoutCtx<'a>

§

impl<'a> Freeze for LayoutCtx<'a>

§

impl<'a> Unpin for LayoutCtx<'a>

§

impl<'a> UnsafeUnpin for LayoutCtx<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more