Struct iced_pure::widget::Radio

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

A circular button representing a choice.

Example

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

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

let selected_choice = Some(Choice::A);

Radio::new(Choice::A, "This is A", selected_choice, Message::RadioSelected);

Radio::new(Choice::B, "This is B", selected_choice, Message::RadioSelected);

Implementations

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

pub const DEFAULT_SIZE: u16 = 28u16

The default size of a Radio button.

pub const DEFAULT_SPACING: u16 = 15u16

The default spacing of a Radio button.

pub fn new<F, V>(
    value: V,
    label: impl Into<String>,
    selected: Option<V>,
    f: F
) -> Radio<'a, Message, 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: u16) -> Radio<'a, Message, Renderer>

Sets the size of the Radio button.

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

Sets the width of the Radio button.

pub fn spacing(self, spacing: u16) -> Radio<'a, Message, Renderer>

Sets the spacing between the Radio button and the text.

pub fn text_size(self, text_size: u16) -> Radio<'a, Message, Renderer>

Sets the text size of the Radio button.

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

Sets the text font of the Radio button.

pub fn style(
    self,
    style_sheet: impl Into<Box<dyn StyleSheet + 'a, Global>>
) -> Radio<'a, Message, Renderer>

Sets the style of the Radio button.

Trait Implementations

impl<'a, Message, Renderer> Into<Element<'a, Message, Renderer>> for Radio<'a, Message, Renderer> where
    Message: 'a + Clone,
    Renderer: Renderer + 'a, 

fn into(self) -> Element<'a, Message, Renderer>

Converts this type into the (usually inferred) input type.

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

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.

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.

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

Returns the current [mouse::Interaction] of the Widget.

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

Draws the Widget using the associated Renderer.

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

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

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

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 layout::Node of the Widget.

fn on_event(
    &mut self,
    _state: &mut Tree,
    event: Event,
    layout: Layout<'_>,
    cursor_position: Point,
    renderer: &Renderer,
    clipboard: &mut dyn Clipboard,
    shell: &mut Shell<'_, Message>
) -> Status

Processes a runtime Event.

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

Draws the Widget using the associated Renderer.

fn mouse_interaction(
    &self,
    _state: &Tree,
    layout: Layout<'_>,
    cursor_position: Point,
    viewport: &Rectangle,
    renderer: &Renderer
) -> Interaction

Returns the current [mouse::Interaction] of the Widget.

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

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

Returns the state Tree of the children of the Widget.

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

Reconciliates the Widget with the provided Tree.

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

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