Skip to main content

Widget

Trait Widget 

Source
pub trait Widget {
Show 21 methods // Provided methods fn event(&mut self, _ctx: &mut EventCtx, _event: &Event) { ... } fn command(&mut self, _ctx: &mut EventCtx, _command: &Command<'_>) { ... } fn debug_name(&self) -> &'static str { ... } fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx) { ... } fn measure( &mut self, _ctx: &mut MeasureCtx, constraints: Constraints, ) -> Size { ... } fn measure_size( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, ) -> Size { ... } fn measure_axis( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, axis: Axis, ) -> f32 { ... } fn intrinsic_size( &mut self, ctx: &mut MeasureCtx, axis: Axis, available_cross: f32, ) -> IntrinsicSize { ... } fn arrange(&mut self, _ctx: &mut ArrangeCtx, _bounds: Rect) { ... } fn paint(&self, _ctx: &mut PaintCtx) { ... } fn supports_output_reuse(&self) -> bool { ... } fn layer_options(&self) -> LayerOptions { ... } fn layer_properties(&self) -> LayerProperties { ... } fn stack_host_options(&self) -> Option<StackHostOptions> { ... } fn stack_surface_options(&self) -> Option<StackSurfaceOptions> { ... } fn overlay_options(&self) -> Option<OverlayOptions> { ... } fn semantics(&self, _ctx: &mut SemanticsCtx) { ... } fn accepts_focus(&self) -> bool { ... } fn focus_changed(&mut self, _ctx: &mut EventCtx, _focused: bool) { ... } fn visit_children(&self, _visitor: &mut dyn WidgetPodVisitor) { ... } fn visit_children_mut(&mut self, _visitor: &mut dyn WidgetPodMutVisitor) { ... }
}

Provided Methods§

Source

fn event(&mut self, _ctx: &mut EventCtx, _event: &Event)

Source

fn command(&mut self, _ctx: &mut EventCtx, _command: &Command<'_>)

Receive a typed command addressed directly to this widget. Commands are target-only and do not capture or bubble through the widget tree.

Source

fn debug_name(&self) -> &'static str

Source

fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)

Publish widget-specific state for an inspector snapshot.

The runtime only calls this while explicitly capturing a snapshot, so normal event, layout, and paint passes pay no cost for this hook.

Source

fn measure(&mut self, _ctx: &mut MeasureCtx, constraints: Constraints) -> Size

Source

fn measure_size( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, ) -> Size

Compute a provisional size. Containers can override this to query child sizes without committing their final layouts. The default preserves existing custom widgets by delegating to measure; it may mutate state. Child measure calls still commit state. Use child size probes explicitly when only their scalar results are needed. Results must match measure for the same content and constraints. A final measure is still required before arrangement after a probe miss.

Source

fn measure_axis( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, axis: Axis, ) -> f32

Query one component of measure_size under exactly the same constraints. Overrides may avoid computing the other component, but must return the same extent. Like size probes, this does not replace final measurement.

Source

fn intrinsic_size( &mut self, ctx: &mut MeasureCtx, axis: Axis, available_cross: f32, ) -> IntrinsicSize

Report the smallest and preferred extent along one axis.

The conservative default treats the ordinary natural measurement as unbreakable. Text and other shrinkable widgets can override this to expose a smaller minimum without changing the normal measure contract.

Source

fn arrange(&mut self, _ctx: &mut ArrangeCtx, _bounds: Rect)

Source

fn paint(&self, _ctx: &mut PaintCtx)

Source

fn supports_output_reuse(&self) -> bool

Opt into retaining paint and semantics between targeted invalidations. Output must depend only on widget state, context, and observed sources; changes must invalidate the widget. Untracked readers and callbacks with side effects should keep the default. An opaque descendant also prevents caching its ancestors. Explicit subtree/window requests always rerun them. A source observed only in paint or semantics invalidates that callback, not its descendants. Mutating child state requires a child/subtree request.

Source

fn layer_options(&self) -> LayerOptions

Source

fn layer_properties(&self) -> LayerProperties

Source

fn stack_host_options(&self) -> Option<StackHostOptions>

Source

fn stack_surface_options(&self) -> Option<StackSurfaceOptions>

Source

fn overlay_options(&self) -> Option<OverlayOptions>

Describe this widget as the logical owner of a presented overlay.

The overlay’s rendered surfaces may be retained descendants. Returning options here lets the window runtime coordinate nesting, focus, dismissal, modality, and diagnostics independently of paint ownership.

Source

fn semantics(&self, _ctx: &mut SemanticsCtx)

Source

fn accepts_focus(&self) -> bool

Source

fn focus_changed(&mut self, _ctx: &mut EventCtx, _focused: bool)

Source

fn visit_children(&self, _visitor: &mut dyn WidgetPodVisitor)

Visit this widget’s logical children.

The children do not need to correspond to every piece of state or every visual element a widget owns internally. A widget may expose retained local children, generated/virtual children, remote children represented by local pods, or only the subset that should cooperate with the SUI runtime for this pass.

Source

fn visit_children_mut(&mut self, _visitor: &mut dyn WidgetPodMutVisitor)

Mutably visit this widget’s logical children.

This is the mutable counterpart to Widget::visit_children; SUI uses it as a cooperation point for the retained runtime, not as ownership of a widget’s complete internal model.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§