Skip to main content

WidgetPlacement

Struct WidgetPlacement 

Source
#[non_exhaustive]
pub struct WidgetPlacement { pub id: WidgetId, pub origin: Point, pub size: Size, pub dormant: bool, }
Expand description

Placement of a child widget during layout.

#[non_exhaustive]: a parent reads and writes the fields of the slice it is handed, and never builds one — so the attribute costs a place_children implementation nothing, and it is what makes the next field addition a non-event rather than the breaking change dormant was. Use WidgetPlacement::new where one genuinely has to be constructed.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§id: WidgetId§origin: Point§size: Size§dormant: bool

Park this child dormant for as long as the flag stays set.

Only read for a parent whose Widget::culls_children returns true, and only such a parent is handed its dormant children here at all — every other widget still sees its active children and nothing else, so setting this without opting in does nothing.

A dormant child leaves paint, the layout recursion, the accessibility tree and the Tab ring, and keeps every piece of its state — focus, text, animations — for when it comes back. Clearing the flag wakes it in the same pass, so a container that culls by viewport shows no hole on the frame a camera jumps.

Arrives pre-set to the child’s current state, so a parent that ignores the field changes nothing.

This is a heavier decision than collapsing size to zero, and the two are worth layering rather than merging: zero size costs the child its geometry, dormancy costs it its existence. Parking what the user is interacting with clears focus and cancels pointers — see LayoutContext::for_each_interaction_ancestor.

Implementations§

Source§

impl WidgetPlacement

Source

pub fn new(id: WidgetId, origin: Point, size: Size) -> Self

A placement at origin sized size, awake.

The framework fills the slice a parent is handed; this is for the cases that stand outside a layout pass — a test driving place_children directly, or a widget assembling placements of its own.

Trait Implementations§

Source§

impl Clone for WidgetPlacement

Source§

fn clone(&self) -> WidgetPlacement

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for WidgetPlacement

Source§

impl Debug for WidgetPlacement

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.