Struct Radio

pub struct Radio<'a, Message, Renderer = Renderer>
where
    Renderer: Renderer,
{ /* private fields */ }

A circular button representing a choice.

Example

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Choice {
    A,
    B,
    C,
    All,
}

#[derive(Debug, Clone, Copy)]
pub enum Message {
    RadioSelected(Choice),
}

let selected_choice = Some(Choice::A);

let a = Radio::new(
    text::heading("A"),
    Choice::A,
    selected_choice,
    Message::RadioSelected,
);

let b = Radio::new(
    text::heading("B"),
    Choice::B,
    selected_choice,
    Message::RadioSelected,
);

let c = Radio::new(
    text::heading("C"),
    Choice::C,
    selected_choice,
    Message::RadioSelected,
);

let all = Radio::new(
    column![
        text::heading("All"),
        text::body("A, B and C"),
    ],
    Choice::All,
    selected_choice,
    Message::RadioSelected
);

let content = column![a, b, c, all];

Implementations

impl<'a, Message, Renderer> Radio<'a, Message, Renderer>

where Message: Clone, Renderer: Renderer,

pub const DEFAULT_SIZE: f32 = 16f32

The default size of a Radio button.

pub const DEFAULT_SPACING: f32 = 8f32

The default spacing of a Radio button.

pub fn new<T, F, V>(label: T, value: V, selected: Option<V>, f: F) -> Self

where V: Eq + Copy, F: FnOnce(V) -> Message, T: Into<Element<'a, Message, Theme, Renderer>>,

Creates a new Radio button.

It expects:

• the value related to the Radio button
• the label of the Radio button
• the current selected value
• a function that will be called when the Radio is selected. It receives the value of the radio and must produce a Message.

pub fn size(self, size: impl Into<Pixels>) -> Self

Sets the size of the Radio button.

pub fn width(self, width: impl Into<Length>) -> Self

Sets the width of the Radio button.

pub fn spacing(self, spacing: impl Into<Pixels>) -> Self

Sets the spacing between the Radio button and the text.

Trait Implementations

impl<'a, Message, Renderer> From<Radio<'a, Message, Renderer>> for Element<'a, Message, Theme, Renderer>

where Message: 'a + Clone, Renderer: 'a + Renderer,

fn from( radio: Radio<'a, Message, Renderer>, ) -> Element<'a, Message, Theme, Renderer>

Converts to this type from the input type.

impl<Message, Renderer> Widget<Message, Theme, Renderer> for Radio<'_, Message, Renderer>

where Message: Clone, Renderer: Renderer,

fn children(&self) -> Vec<Tree>

Returns the state Tree of the children of the Widget.

fn diff(&mut self, tree: &mut Tree)

Reconciliates the Widget with the provided Tree.

fn size(&self) -> Size<Length>

Returns the Size of the Widget in lengths.

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

Returns the layout::Node of the Widget.

fn operate( &self, tree: &mut Tree, layout: Layout<'_>, renderer: &Renderer, operation: &mut dyn Operation<()>, )

Applies an Operation to the Widget.

fn on_event( &mut self, tree: &mut Tree, event: Event, layout: Layout<'_>, cursor: Cursor, renderer: &Renderer, clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, viewport: &Rectangle, ) -> Status

Processes a runtime Event.

fn mouse_interaction( &self, tree: &Tree, layout: Layout<'_>, cursor: Cursor, viewport: &Rectangle, renderer: &Renderer, ) -> Interaction

Returns the current mouse::Interaction of the Widget.

fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, style: &Style, layout: Layout<'_>, cursor: Cursor, viewport: &Rectangle, )

Draws the Widget using the associated Renderer.

fn overlay<'b>( &'b mut self, tree: &'b mut Tree, layout: Layout<'_>, renderer: &Renderer, translation: Vector, ) -> Option<Element<'b, Message, Theme, Renderer>>

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

fn drag_destinations( &self, state: &Tree, layout: Layout<'_>, renderer: &Renderer, dnd_rectangles: &mut DndDestinationRectangles, )

Adds the drag destination rectangles of the widget. Runs after the layout phase for each widget in the tree.

fn size_hint(&self) -> Size<Length>

Returns a Size hint for laying out the Widget.

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

fn a11y_nodes( &self, _layout: Layout<'_>, _state: &Tree, _cursor: Cursor, ) -> A11yTree

get the a11y nodes for the widget and its children

fn id(&self) -> Option<Id>

Returns the id of the widget

fn set_id(&mut self, _id: Id)

Sets the id of the widget This may be called while diffing the widget tree