Struct MountedWidget

pub struct MountedWidget { /* private fields */ }

A Widget that has been attached to a widget hierarchy.

Because WidgetInstances can be reused, a mounted widget can be unmounted and eventually remounted. To ensure the widget is in a consistent state, all types that own MountedWidgets should call MountedWidget::remount_if_needed during their mount() functions.

Implementations

impl MountedWidget

pub fn remount_if_needed(&mut self, context: &mut EventContext<'_>)

Remounts this widget, if it was previously unmounted.

pub fn is_mounted(&self) -> bool

Returns true if this widget is still mounted in a window.

pub fn lock(&self) -> WidgetGuard<'_>

Locks the widget for exclusive access. Locking widgets should only be done for brief moments of time when you are certain no deadlocks can occur due to other widget locks being held.

pub fn invalidate(&self)

Invalidates this widget.

pub fn id(&self) -> WidgetId

Returns the unique id of this widget instance.

pub const fn instance(&self) -> &WidgetInstance

Returns the underlying widget instance

pub fn next_focus(&self) -> Option<MountedWidget>

Returns the next widget to focus after this widget.

This function returns the value set in MakeWidget::with_next_focus().

pub fn previous_focus(&self) -> Option<MountedWidget>

Returns the widget to focus before this widget.

There is no direct way to set this value. This relationship is created automatically using MakeWidget::with_next_focus().

pub fn explicit_focus_target(&self, advance: bool) -> Option<MountedWidget>

Returns the next or previous focus target, if one was set using MakeWidget::with_next_focus().

pub fn last_layout(&self) -> Option<Rect<Px>>

Returns the region that the widget was last rendered at.

pub fn effective_styles(&self) -> Styles

Returns the effective styles for the current tree.

pub fn active(&self) -> bool

Returns true if this widget is the currently active widget.

pub fn hovered(&self) -> bool

Returns true if this widget is currently the hovered widget.

pub fn primary_hover(&self) -> bool

Returns true if this widget that is directly beneath the cursor.

pub fn focused(&self) -> bool

Returns true if this widget is the currently focused widget.

pub fn parent(&self) -> Option<MountedWidget>

Returns the parent of this widget.

pub fn has_parent(&self) -> bool

Returns true if this node has a parent.

Trait Implementations

impl AsRef<WidgetId> for MountedWidget

fn as_ref(&self) -> &WidgetId

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for MountedWidget

fn clone(&self) -> MountedWidget

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MountedWidget

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

Formats the value using the given formatter.

impl ManageWidget for MountedWidget

type Managed = MountedWidget

The managed type, which can be Option<MountedWidget> or MountedWidget.

fn manage(&self, _context: &WidgetContext<'_>) -> Self::Managed

Resolve self into a MountedWidget.

impl<T> MapManagedWidget<T> for MountedWidget

type Result = T

The result of the mapping operation.

fn map(self, map: impl FnOnce(MountedWidget) -> T) -> Self::Result

Call map with a MountedWidget.

impl MountableChild for MountedWidget

fn mount( widget: MountedWidget, _into: &MountedChildren<Self>, _index: usize, ) -> Self

Returns the mounted representation of widget.

fn widget(&self) -> &MountedWidget

Returns a reference to the widget.

fn unmount(self) -> MountedWidget

Returns the widget and performs any other cleanup for this widget being unmounted.q

impl PartialEq<WidgetInstance> for MountedWidget

fn eq(&self, other: &WidgetInstance) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for MountedWidget

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.