Struct RootWidget

pub struct RootWidget { /* private fields */ }

A wrapper Widget which app drivers can wrap around the rest of the widget tree.

This is useful for a few things:

• Reporting a Role::Window to the accessibility API.
• Setting a default Background and Padding for the entire app using DefaultProperties.

Implementations

impl RootWidget

pub fn new(widget: impl Widget) -> Self

Create a new root widget.

pub fn from_pod(pod: WidgetPod<dyn Widget>) -> Self

Create a new root widget from a WidgetPod.

impl RootWidget

pub fn child_mut<'t>( this: &'t mut WidgetMut<'_, Self>, ) -> WidgetMut<'t, dyn Widget>

Get a mutable reference to the child widget.

Trait Implementations

impl Widget for RootWidget

fn on_pointer_event( &mut self, _ctx: &mut EventCtx<'_>, _props: &mut PropertiesMut<'_>, _event: &PointerEvent, )

Handle a pointer event.

fn on_text_event( &mut self, _ctx: &mut EventCtx<'_>, _props: &mut PropertiesMut<'_>, _event: &TextEvent, )

Handle a text event.

fn on_access_event( &mut self, _ctx: &mut EventCtx<'_>, _props: &mut PropertiesMut<'_>, _event: &AccessEvent, )

Handle an event from the platform’s accessibility API.

fn register_children(&mut self, ctx: &mut RegisterCtx<'_>)

Register child widgets with Masonry.

fn property_changed(&mut self, ctx: &mut UpdateCtx<'_>, property_type: TypeId)

Handle a property being added, changed, or removed.

fn layout( &mut self, ctx: &mut LayoutCtx<'_>, props: &mut PropertiesMut<'_>, bc: &BoxConstraints, ) -> Size

Compute layout and return the widget’s size.

fn paint( &mut self, ctx: &mut PaintCtx<'_>, props: &PropertiesRef<'_>, scene: &mut Scene, )

Paint the widget appearance.

fn accessibility_role(&self) -> Role

Return what kind of “thing” the widget fundamentally is.

fn accessibility( &mut self, _ctx: &mut AccessCtx<'_>, _props: &PropertiesRef<'_>, _node: &mut Node, )

Describe the widget’s contents for accessibility APIs.

fn children_ids(&self) -> SmallVec<[WidgetId; 16]>

Return ids of this widget’s children.

fn make_trace_span(&self, ctx: &QueryCtx<'_>) -> Span

Return a span for tracing.

fn on_anim_frame( &mut self, ctx: &mut UpdateCtx<'_>, _props: &mut PropertiesMut<'_>, interval: u64, )

Called at the beginning of a new animation frame.

fn update( &mut self, ctx: &mut UpdateCtx<'_>, _props: &mut PropertiesMut<'_>, event: &Update, )

Handle an update to the widget’s state.

fn compose(&mut self, ctx: &mut ComposeCtx<'_>)

Runs after the widget’s final transform has been computed.

fn accepts_pointer_interaction(&self) -> bool

Whether this widget gets pointer events and hovered status. True by default.

fn accepts_focus(&self) -> bool

Whether this widget gets text focus. False by default.

fn accepts_text_input(&self) -> bool

Whether this widget gets IME events. False by default.

fn get_debug_text(&self) -> Option<String>

Return a small string representing important info about this widget instance.

fn get_cursor(&self, ctx: &QueryCtx<'_>, pos: Point) -> CursorIcon

Return the cursor icon for this widget.

fn find_widget_under_pointer<'c>( &'c self, ctx: QueryCtx<'c>, pos: Point, ) -> Option<WidgetRef<'c, dyn Widget>>

Return the first innermost widget composed by this (including self), that contains/intersects with pos and accepts pointer interaction, if any.