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>
impl<Msg> RadioGroup<Msg>
Sourcepub fn new(options: impl IntoIterator<Item = impl Into<String>>) -> Self
pub fn new(options: impl IntoIterator<Item = impl Into<String>>) -> Self
A vertical group of options with nothing chosen.
Sourcepub fn horizontal(self, horizontal: bool) -> Self
pub fn horizontal(self, horizontal: bool) -> Self
Lays the options out in one row instead of one per line.
Sourcepub fn style(self, style: RadioStyle) -> Self
pub fn style(self, style: RadioStyle) -> Self
Chooses how options are marked.
Trait Implementations§
Source§impl<Msg: 'static> Widget<Msg> for RadioGroup<Msg>
impl<Msg: 'static> Widget<Msg> for RadioGroup<Msg>
Source§fn measure(&self, _cx: &mut MeasureCx<'_>, available: Size) -> Size
fn measure(&self, _cx: &mut MeasureCx<'_>, available: Size) -> Size
available.Source§fn event(&self, cx: &mut EventCx<'_, Msg>, event: &Event) -> bool
fn event(&self, cx: &mut EventCx<'_, Msg>, event: &Event) -> bool
true when the event was used; unused key and scroll events
bubble to the parent widget.Source§fn paint_overlay(&self, _cx: &mut PaintCx<'_>, _anchor: Rect)
fn paint_overlay(&self, _cx: &mut PaintCx<'_>, _anchor: Rect)
PaintCx::request_overlay. anchor is the area the widget was painted in.Source§fn children_mut(&mut self) -> &mut [Node<Msg>]
fn children_mut(&mut self) -> &mut [Node<Msg>]
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>
impl<Msg> Unpin for RadioGroup<Msg>
impl<Msg> UnsafeUnpin for RadioGroup<Msg>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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