Struct WidgetManager

pub struct WidgetManager<'ui> { /* private fields */ }

Handles the entirety of the widget lifecycle.

Implementations

impl<'ui> WidgetManager<'ui>

pub fn new() -> WidgetManager<'ui>

Create a new WidgetManager.

pub fn get_tree(&self) -> &Tree<WidgetId>

Returns the widget tree.

pub fn contains(&self, widget_id: &WidgetId) -> bool

Check if a widget exists in the tree.

pub fn try_get_node(&self, widget_id: WidgetId) -> Option<&WidgetNode>

Fetch the tree representation of a widget. Will be None if it doesn’t exist.

pub fn get_node(&self, widget_id: &WidgetId) -> &WidgetNode

Fetch the tree representation of a widget.

Panics

Will panic if the widget is not found.

pub fn try_get(&self, widget_id: &WidgetId) -> Option<WidgetRef>

Fetch a widget from the tree. Will be None if it doesn’t exist.

pub fn get(&self, widget_id: &WidgetId) -> WidgetRef

Fetch a widget from the tree.

Panics

This will panic if the widget is not found.

pub fn try_get_as<W>(&self, widget_id: &WidgetId) -> Option<Rc<W>>

where W: Widget,

Fetch a widget as the specified type. If it doesn’t exist, or it is not the requested type, this will return None.

pub fn get_as<W>(&self, widget_id: &WidgetId) -> Rc<W>

where W: Widget,

Fetch a widget as the specified type.

Panics

If the widget is not the requested type, it will panic.

pub fn get_rect(&self, widget_id: &WidgetId) -> Option<&Rect>

Get the visual Rect of a widget.

pub fn get_clipping(&self, widget_id: &WidgetId) -> Ref<Shape>

Get the visual clipping Path for a widget.

pub const fn get_context(&self) -> &WidgetContext<'ui>

Get the widget build context.

pub fn add(&mut self, parent_id: Option<WidgetId>, widget: WidgetRef)

Queues the widget for addition into the tree

pub fn remove(&mut self, widget_id: WidgetId)

Queues the widget_id for removal on the next update()

pub fn update(&mut self, events: &mut Vec<WidgetEvent>)

Update the UI tree.

This processes any pending additions, removals, and updates. The events parameter is a list of all changes that occured during the process, in order.

pub fn print_tree(&self)

pub fn print_tree_modifications(&self)

Trait Implementations

impl<'ui> Default for WidgetManager<'ui>

fn default() -> WidgetManager<'ui>

Returns the “default value” for a type.