Trait iced_native::widget::Widget

pub trait Widget<Message, Renderer> where
    Renderer: Renderer, {
    fn width(&self) -> Length;
    fn height(&self) -> Length;
    fn layout(&self, renderer: &Renderer, limits: &Limits) -> Node;
    fn draw(
        &self, 
        renderer: &mut Renderer, 
        style: &Style, 
        layout: Layout<'_>, 
        cursor_position: Point, 
        viewport: &Rectangle
    );

    fn on_event(
        &mut self, 
        _event: Event, 
        _layout: Layout<'_>, 
        _cursor_position: Point, 
        _renderer: &Renderer, 
        _clipboard: &mut dyn Clipboard, 
        _shell: &mut Shell<'_, Message>
    ) -> Status { ... }
    fn mouse_interaction(
        &self, 
        _layout: Layout<'_>, 
        _cursor_position: Point, 
        _viewport: &Rectangle, 
        _renderer: &Renderer
    ) -> Interaction { ... }
    fn overlay(
        &mut self, 
        _layout: Layout<'_>, 
        _renderer: &Renderer
    ) -> Option<Element<'_, Message, Renderer>> { ... }
}

A component that displays information and allows interaction.

If you want to build your own widgets, you will need to implement this trait.

Examples

The repository has some examples showcasing how to implement a custom widget:

• bezier_tool, a Paint-like tool for drawing Bézier curves using lyon.
• custom_widget, a demonstration of how to build a custom widget that draws a circle.
• geometry, a custom widget showcasing how to draw geometry with the Mesh2D primitive in iced_wgpu.

Required Methods

fn width(&self) -> Length

Returns the width of the Widget.

fn height(&self) -> Length

Returns the height of the Widget.

fn layout(&self, renderer: &Renderer, limits: &Limits) -> Node

Returns the Node of the Widget.

This Node is used by the runtime to compute the Layout of the user interface.

fn draw(
    &self,
    renderer: &mut Renderer,
    style: &Style,
    layout: Layout<'_>,
    cursor_position: Point,
    viewport: &Rectangle
)

Draws the Widget using the associated Renderer.

Provided Methods

fn on_event(
    &mut self,
    _event: Event,
    _layout: Layout<'_>,
    _cursor_position: Point,
    _renderer: &Renderer,
    _clipboard: &mut dyn Clipboard,
    _shell: &mut Shell<'_, Message>
) -> Status

Processes a runtime Event.

It receives:

• an Event describing user interaction
• the computed Layout of the Widget
• the current cursor position
• a mutable Message list, allowing the Widget to produce new messages based on user interaction.
• the Renderer
• a Clipboard, if available

By default, it does nothing.

fn mouse_interaction(
    &self,
    _layout: Layout<'_>,
    _cursor_position: Point,
    _viewport: &Rectangle,
    _renderer: &Renderer
) -> Interaction

Returns the current mouse::Interaction of the Widget.

By default, it returns mouse::Interaction::Idle.

fn overlay(
    &mut self,
    _layout: Layout<'_>,
    _renderer: &Renderer
) -> Option<Element<'_, Message, Renderer>>

Returns the overlay of the Widget, if there is any.

Implementors

impl<'a, Message, Renderer> Widget<Message, Renderer> for Button<'a, Message, Renderer> where
    Message: Clone,
    Renderer: Renderer, 

impl<'a, Message, Renderer> Widget<Message, Renderer> for Checkbox<'a, Message, Renderer> where
    Renderer: Renderer, 

impl<'a, Message, Renderer> Widget<Message, Renderer> for Column<'a, Message, Renderer> where
    Renderer: Renderer, 

impl<'a, Message, Renderer> Widget<Message, Renderer> for Container<'a, Message, Renderer> where
    Renderer: Renderer, 

impl<'a, Message, Renderer> Widget<Message, Renderer> for PaneGrid<'a, Message, Renderer> where
    Renderer: Renderer, 

impl<'a, Message, Renderer> Widget<Message, Renderer> for ProgressBar<'a> where
    Renderer: Renderer, 

impl<'a, Message, Renderer> Widget<Message, Renderer> for Radio<'a, Message, Renderer> where
    Message: Clone,
    Renderer: Renderer, 

impl<'a, Message, Renderer> Widget<Message, Renderer> for Row<'a, Message, Renderer> where
    Renderer: Renderer, 

impl<'a, Message, Renderer> Widget<Message, Renderer> for Rule<'a> where
    Renderer: Renderer, 

impl<'a, Message, Renderer> Widget<Message, Renderer> for Scrollable<'a, Message, Renderer> where
    Renderer: Renderer, 

impl<'a, Message, Renderer> Widget<Message, Renderer> for TextInput<'a, Message, Renderer> where
    Message: Clone,
    Renderer: Renderer, 

impl<'a, Message, Renderer> Widget<Message, Renderer> for Toggler<'a, Message, Renderer> where
    Renderer: Renderer, 

impl<'a, Message, Renderer> Widget<Message, Renderer> for Tooltip<'a, Message, Renderer> where
    Renderer: Renderer, 

impl<'a, Message, Renderer, Handle> Widget<Message, Renderer> for Viewer<'a, Handle> where
    Renderer: Renderer<Handle = Handle>,
    Handle: Clone + Hash, 

impl<'a, T, Message, Renderer> Widget<Message, Renderer> for Slider<'a, T, Message> where
    T: Copy + Into<f64> + FromPrimitive,
    Message: Clone,
    Renderer: Renderer, 

impl<'a, T: 'a, Message, Renderer> Widget<Message, Renderer> for PickList<'a, T, Message, Renderer> where
    T: Clone + ToString + Eq,
    [T]: ToOwned<Owned = Vec<T>>,
    Message: 'static,
    Renderer: Renderer + 'a, 

impl<Message, Renderer> Widget<Message, Renderer> for Space where
    Renderer: Renderer, 

impl<Message, Renderer> Widget<Message, Renderer> for Svg where
    Renderer: Renderer, 

impl<Message, Renderer> Widget<Message, Renderer> for Text<Renderer> where
    Renderer: Renderer, 

impl<Message, Renderer, Handle> Widget<Message, Renderer> for Image<Handle> where
    Renderer: Renderer<Handle = Handle>,
    Handle: Clone + Hash,