Struct masonry::widget::WidgetRef

pub struct WidgetRef<'w, W: Widget + ?Sized> { /* private fields */ }

A rich reference to a Widget.

Widgets in Masonry are bundled with additional metadata called WidgetState.

A WidgetRef to a widget carries both a reference to the widget and to its WidgetState. It can Deref to the referenced widget.

This type is mostly used for debugging, to query a certain widget in the widget graph, get their layout, etc. It also implements std::fmt::Debug for convenience; printing it will display its widget subtree (as in, the referenced widget, and its children, and their children, etc).

This is only for shared access to widgets. For widget mutation, see WidgetMut.

Implementations

impl<'w, W: Widget + ?Sized> WidgetRef<'w, W>

pub fn state(self) -> &'w WidgetState

Get the WidgetState of the current widget.

pub fn deref(self) -> &'w W

Get the actual referenced Widget.

pub fn id(&self) -> WidgetId

Get the WidgetId of the current widget.

pub fn downcast<W2: Widget>(&self) -> Option<WidgetRef<'w, W2>>

Attempt to downcast to WidgetRef of concrete Widget type.

impl<'w, W: Widget> WidgetRef<'w, W>

pub fn as_dyn(&self) -> WidgetRef<'w, dyn Widget>

Return a type-erased WidgetRef.

impl<'w> WidgetRef<'w, dyn Widget>

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

Return widget’s children.

pub fn find_widget_by_id( &self, id: WidgetId ) -> Option<WidgetRef<'w, dyn Widget>>

Recursively find child widget with given id.

pub fn find_widget_at_pos( &self, pos: Point ) -> Option<WidgetRef<'w, dyn Widget>>

Recursively find innermost widget at given position.

pos - the position in local coordinates (zero being the top-left of the inner widget).

pub fn debug_validate(&self, after_layout: bool)

Recursively check that the Widget tree upholds various invariants.

Can only be called after on_event and lifecycle.

Trait Implementations

impl<'w, W: Widget + ?Sized> Clone for WidgetRef<'w, W>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'w, W: Widget + ?Sized> Debug for WidgetRef<'w, W>

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

Formats the value using the given formatter.

impl<'w, W: Widget + ?Sized> Deref for WidgetRef<'w, W>

type Target = W

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'w, W: Widget + ?Sized> Copy for WidgetRef<'w, W>