Enum Element

Source

pub enum Element<Msg: Clone> {
Show 27 variants
    Button(Button<Msg>),
    Container(Container<Msg>),
    TextEdit(TextEdit<Msg>),
    Image(Image),
    Column(Column<Msg>),
    Row(Row<Msg>),
    Stack(Stack<Msg>),
    Text(Text),
    Spacer(Spacer),
    Scroll(Scroll<Msg>),
    Viewport(Viewport<Msg>),
    WrapGrid(WrapGrid<Msg>),
    Slider(Slider<Msg>),
    VSlider(VSlider<Msg>),
    Toggle(Toggle<Msg>),
    Separator(Separator),
    ProgressBar(ProgressBar),
    Checkbox(Checkbox<Msg>),
    Radio(Radio<Msg>),
    ListItem(ListItem<Msg>),
    WindowButton(WindowButton<Msg>),
    Pressable(Pressable<Msg>),
    Flex(Flex<Msg>),
    AnchoredOverlay(AnchoredOverlay<Msg>),
    Spinner(Spinner),
    External(External),
    Carousel(Carousel<Msg>),
}

Variants§

§

Carousel(Carousel<Msg>)

Implementations§

Source §

impl<Msg: Clone> Element<Msg>

Source

pub fn preferred_size(&self, max_width: f32, canvas: &Canvas) -> (f32, f32)

Source

pub fn draw( &self, canvas: &mut Canvas, rect: Rect, focused: bool, hovered: bool, pressed: bool, cursor_pos: usize, selection_anchor: usize, )

Source

pub fn hit_test(&self, rect: Rect, pos: Point) -> bool

Source

pub fn is_interactive(&self) -> bool

Whether the widget should be included in the per-surface widget_rects list — i.e. whether pointer / touch hit testing must be able to land on it. This is the predicate that gates the layout pass’s push to DrawCtx::widget_rects in the draw pass.

Defaults to Self::is_focusable for every widget that takes keyboard focus (those are interactive by definition). Widgets that are click/touch-only without taking keyboard focus — currently Element::WindowButton — opt in here without opting in to the Tab cycle.

Source

pub fn is_focusable(&self) -> bool

Whether the widget participates in the Tab / Shift+Tab focus cycle. Snapshotted onto super::LaidOutWidget::keyboard_focusable at layout time so next_focusable_index can iterate without the Element tree.

Hit-testable chrome that should not steal keyboard focus from window content (e.g. Element::WindowButton) returns false here while still returning true from Self::is_interactive.

Source

pub fn is_text_input(&self) -> bool

Source

pub fn cursor_shape(&self) -> CursorShape

Cursor shape to display while the pointer is over this widget. Per-widget defaults match desktop conventions:

Text inputs → Text (I-beam)
Clickables (Button, Pressable, Toggle, Checkbox, Radio, ListItem, WindowButton) → Pointer (hand)
Anything else → Default

Widgets that carry a per-instance override (set via the .cursor( shape ) builder) return the override; otherwise they return their type-based default. The runtime snapshots this onto super::LaidOutWidget::cursor at layout time and dispatches the shape via wp_cursor_shape_v1 on hover transitions.

Source

pub fn tooltip(&self) -> Option<&str>

Add an arm here to opt a widget kind into the auto-tooltip flow.

Source §

impl<Msg: Clone + 'static> Element<Msg>

Source

pub fn map<U, F>(self, f: F) -> Element
where U: Clone + 'static, F: Fn(Msg) -> U + 'static,

Re-tag every message a sub-view emits.

Walks the tree once and rewrites every per-leaf message store — Button::on_press, Slider::on_change, the children of Column/Row/Stack/WrapGrid, and so on — so the returned Element no longer references Msg. The standard Elm / iced shape: a sub-view defined as fn view( …) -> Element<SubMsg> can be embedded inside a parent that produces Element<AppMsg> by calling .map( AppMsg::Sub ).

Cost: O( leaves ) allocations for the closure-wrapping in the Arc<dyn Fn(...)> callbacks (text_edit, slider, vslider), and the closure itself runs an extra indirect call per emitted message — both per-map-layer. Trees built fresh every frame (the typical case) absorb this in the same allocator pressure view() already produces, so the overhead is in the noise.

sub_view().map( AppMsg::Sub )

Trait Implementations§

Source §