Enum agui::widget::WidgetRef

pub enum WidgetRef {
    None,
    Owned(Rc<dyn Widget + 'static>),
    Borrowed(Weak<dyn Widget + 'static>),
    Keyed {
        owner_id: Option<WidgetId>,
        key: Key,
        widget: Box<WidgetRef, Global>,
    },
}

Holds a reference to a widget, or not.

This is generally used when a widget can accept children as a parameter. It can either be Owned, Borrowed, None, or Keyed. A Keyed widget is one that may retain its state across parental rebuilds.

Variants

None

No widget.

Owned(Rc<dyn Widget + 'static>)

Tuple Fields

0: Rc<dyn Widget + 'static>

An owned widget.

Borrowed(Weak<dyn Widget + 'static>)

Tuple Fields

0: Weak<dyn Widget + 'static>

A borrowed widget.

Keyed

Fields

owner_id: Option<WidgetId>

key: Key

widget: Box<WidgetRef, Global>

A keyed reference which may retain its state across parental rebuilds.

Implementations

impl WidgetRef

pub fn new<W>(widget: W) -> WidgetRef where
    W: Widget, 

pub fn is_valid(&self) -> bool

Returns true if the widget is still allocated in memory.

pub fn try_get(&self) -> Option<Rc<dyn Widget + 'static>>

pub fn get(&self) -> Rc<dyn Widget + 'static>

Panics

Will panic if the widget no longer exists, or the reference is empty.

pub fn get_type_id(&self) -> TypeId

Panics

Will panic if the widget no longer exists, or the reference is empty.

pub fn get_type_name(&self) -> &'static str

Panics

Will panic if the widget no longer exists, or the reference is empty.

pub fn try_downcast_ref<W>(&self) -> Option<Rc<W>> where
    W: Widget, 

Returns none of the widget is not the W type, or if it has been deallocated.

pub fn downcast_ref<W>(&self) -> Rc<W> where
    W: Widget, 

Panics

Will panic if the widget cannot be downcasted to the generic type.

Trait Implementations

impl Clone for WidgetRef

pub fn clone(&self) -> WidgetRef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WidgetRef

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

Formats the value using the given formatter.

impl Default for WidgetRef

pub fn default() -> WidgetRef

Returns the “default value” for a type.

impl<'_> From<&'_ WidgetRef> for BuildResult

pub fn from(widget: &WidgetRef) -> BuildResult

Performs the conversion.

impl<'_> From<&'_ WidgetRef> for WidgetRef

pub fn from(widget: &WidgetRef) -> WidgetRef

Performs the conversion.

impl From<App> for WidgetRef

pub fn from(widget: App) -> WidgetRef

Performs the conversion.

impl<F> From<Builder<F>> for WidgetRef where
    F: 'static + Fn(&WidgetContext<'_>) -> BuildResult, 

pub fn from(builder: Builder<F>) -> WidgetRef

Performs the conversion.

impl From<Button> for WidgetRef

pub fn from(widget: Button) -> WidgetRef

Performs the conversion.

impl From<Column> for WidgetRef

pub fn from(widget: Column) -> WidgetRef

Performs the conversion.

impl From<Drawable> for WidgetRef

pub fn from(widget: Drawable) -> WidgetRef

Performs the conversion.

impl From<Padding> for WidgetRef

pub fn from(widget: Padding) -> WidgetRef

Performs the conversion.

impl From<Row> for WidgetRef

pub fn from(widget: Row) -> WidgetRef

Performs the conversion.

impl From<Spacing> for WidgetRef

pub fn from(widget: Spacing) -> WidgetRef

Performs the conversion.

impl From<Text> for WidgetRef

pub fn from(widget: Text) -> WidgetRef

Performs the conversion.

impl From<WidgetRef> for BuildResult

pub fn from(widget: WidgetRef) -> BuildResult

Performs the conversion.

impl Into<Vec<WidgetRef, Global>> for WidgetRef

pub fn into(self) -> Vec<WidgetRef, Global>

Performs the conversion.