Struct Radio

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

A circular button representing a choice.

Example

use iced::widget::{column, radio};

struct State {
   selection: Option<Choice>,
}

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

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

fn view(state: &State) -> Element<'_, Message> {
    let a = radio(
        "A",
        Choice::A,
        state.selection,
        Message::RadioSelected,
    );

    let b = radio(
        "B",
        Choice::B,
        state.selection,
        Message::RadioSelected,
    );

    let c = radio(
        "C",
        Choice::C,
        state.selection,
        Message::RadioSelected,
    );

    let all = radio(
        "All of the above",
        Choice::All,
        state.selection,
        Message::RadioSelected
    );

    column![a, b, c, all].into()
}

Implementations

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

where Message: Clone, Theme: Catalog, 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<F, V>( label: impl Into<String>, value: V, selected: Option<V>, f: F, ) -> Radio<'a, Message, Theme, Renderer>

where V: Eq + Copy, F: FnOnce(V) -> Message,

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>, ) -> Radio<'a, Message, Theme, Renderer>

Sets the size of the Radio button.

pub fn width( self, width: impl Into<Length>, ) -> Radio<'a, Message, Theme, Renderer>

Sets the width of the Radio button.

pub fn spacing( self, spacing: impl Into<Pixels>, ) -> Radio<'a, Message, Theme, Renderer>

Sets the spacing between the Radio button and the text.

pub fn text_size( self, text_size: impl Into<Pixels>, ) -> Radio<'a, Message, Theme, Renderer>

Sets the text size of the Radio button.

pub fn text_line_height( self, line_height: impl Into<LineHeight>, ) -> Radio<'a, Message, Theme, Renderer>

Sets the text text::LineHeight of the Radio button.

pub fn text_shaping( self, shaping: Shaping, ) -> Radio<'a, Message, Theme, Renderer>

Sets the text::Shaping strategy of the Radio button.

pub fn text_wrapping( self, wrapping: Wrapping, ) -> Radio<'a, Message, Theme, Renderer>

Sets the text::Wrapping strategy of the Radio button.

pub fn font( self, font: impl Into<<Renderer as Renderer>::Font>, ) -> Radio<'a, Message, Theme, Renderer>

Sets the text font of the Radio button.

pub fn style( self, style: impl Fn(&Theme, Status) -> Style + 'a, ) -> Radio<'a, Message, Theme, Renderer>

where <Theme as Catalog>::Class<'a>: From<Box<dyn Fn(&Theme, Status) -> Style + 'a>>,

Sets the style of the Radio button.

pub fn class( self, class: impl Into<<Theme as Catalog>::Class<'a>>, ) -> Radio<'a, Message, Theme, Renderer>

Sets the style class of the Radio button.

Trait Implementations

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

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

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

Converts to this type from the input type.

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

where Message: Clone, Theme: Catalog, Renderer: Renderer,

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

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 on_event( &mut self, _state: &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, _state: &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, defaults: &Style, layout: Layout<'_>, cursor: Cursor, viewport: &Rectangle, )

Draws the Widget using the associated Renderer.

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

Returns a Size hint for laying out the Widget.

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 operate( &self, _state: &mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _operation: &mut dyn Operation, )

Applies an Operation to the Widget.

fn overlay<'a>( &'a mut self, _state: &'a mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _translation: Vector, ) -> Option<Element<'a, Message, Theme, Renderer>>

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

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

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.