Skip to main content

RadioGroup

Struct RadioGroup 

Source
pub struct RadioGroup<Msg> { /* private fields */ }
Expand description

A set of options of which exactly one is chosen, for a few choices that should all stay visible. For many choices use a Select.

The group takes focus as one control: arrow keys choose the previous or next option, Home and End the first and last, and a click anywhere on an option, mark or label, chooses it. By default (RadioStyle::Square) every option shows a small square centred in two cells and the chosen one differs by colour: choosing blends the new square towards the chosen tone over two motion.steps while the old one blends back. RadioStyle::Mark also grows the chosen square into a full two-cell box, swapping shape halfway through the same blend. With reduced motion the change is immediate. RadioStyle::Box gives every option the checkbox’s box and RadioStyle::Dot a dot or a ring. Nothing is bracketed, and every style keeps two cells (one for dots) in every state, so labels never move. The application owns the choice.

The box style looks exactly like a checkbox: what differs is the meaning. A radio group chooses one option and a checkbox turns each option on or off by itself.

Style keys: radio.mark (fg, also the colour of the full box) for marks, whose blank icons take their tones from radio.box (bg); radio.box (bg) for boxes; radio (fg) for dots; radio-label (fg, bold); all with states hover, focus, checked, disabled. Icons: radio-mark-small for marks, dot and dot-outline for dots.

Implementations§

Source§

impl<Msg> RadioGroup<Msg>

Source

pub fn new(options: impl IntoIterator<Item = impl Into<String>>) -> Self

A vertical group of options with nothing chosen.

Source

pub fn selected(self, index: Option<usize>) -> Self

The chosen option.

Source

pub fn horizontal(self, horizontal: bool) -> Self

Lays the options out in one row instead of one per line.

Source

pub fn style(self, style: RadioStyle) -> Self

Chooses how options are marked.

Source

pub fn disabled(self, disabled: bool) -> Self

Greys the group out; it cannot be focused or changed.

Source

pub fn on_select(self, message: impl Fn(usize) -> Msg + 'static) -> Self

Message for choosing option index.

Trait Implementations§

Source§

impl<Msg: 'static> Widget<Msg> for RadioGroup<Msg>

Source§

fn measure(&self, _cx: &mut MeasureCx<'_>, available: Size) -> Size

The size the widget wants when it may use up to available.
Source§

fn paint(&self, cx: &mut PaintCx<'_>, area: Rect)

Draws the widget into area.
Source§

fn event(&self, cx: &mut EventCx<'_, Msg>, event: &Event) -> bool

Handles input. Returns true when the event was used; unused key and scroll events bubble to the parent widget.
Source§

fn focusable(&self) -> bool

Whether the widget can take keyboard focus.
Source§

fn paint_overlay(&self, _cx: &mut PaintCx<'_>, _anchor: Rect)

Draws the widget’s overlay after the whole view was painted, when it asked for one with PaintCx::request_overlay. anchor is the area the widget was painted in.
Source§

fn children(&self) -> &[Node<Msg>]

Child nodes, for widgets that contain other widgets.
Source§

fn children_mut(&mut self) -> &mut [Node<Msg>]

Mutable child nodes, used to assign ids.

Auto Trait Implementations§

§

impl<Msg> !RefUnwindSafe for RadioGroup<Msg>

§

impl<Msg> !Send for RadioGroup<Msg>

§

impl<Msg> !Sync for RadioGroup<Msg>

§

impl<Msg> !UnwindSafe for RadioGroup<Msg>

§

impl<Msg> Freeze for RadioGroup<Msg>
where Option<Box<dyn Fn(usize) -> Msg>>: Freeze,

§

impl<Msg> Unpin for RadioGroup<Msg>
where Option<Box<dyn Fn(usize) -> Msg>>: Unpin,

§

impl<Msg> UnsafeUnpin for RadioGroup<Msg>
where Option<Box<dyn Fn(usize) -> Msg>>: UnsafeUnpin,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.