Skip to main content

Switch

Struct Switch 

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

An on/off switch that applies at once, with an optional label.

The knob steps one cell every motion.step, and the track and knob colours blend with each step; the knob is always the brightest part. Enter, Space or a click toggles it. The application owns the state.

Style keys: switch (track, track-on, knob, knob-on) and switch-labeled (bg, fg, dot) with states hover, focus, checked, disabled; switch-label (fg). The labeled style reads its words from quvyta.switch.on and quvyta.switch.off.

Implementations§

Source§

impl<Msg> Switch<Msg>

Source

pub fn new(on: bool) -> Self

A capsule switch showing on.

Source

pub fn label(self, label: impl Into<String>) -> Self

Text after the switch; clicking it toggles too.

Source

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

Chooses how the switch looks.

Source

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

Greys the switch out; it cannot be focused or toggled.

Source

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

Message for the new state when the switch is toggled.

Trait Implementations§

Source§

impl<Msg: 'static> Widget<Msg> for Switch<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 Switch<Msg>

§

impl<Msg> !Send for Switch<Msg>

§

impl<Msg> !Sync for Switch<Msg>

§

impl<Msg> !UnwindSafe for Switch<Msg>

§

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

§

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

§

impl<Msg> UnsafeUnpin for Switch<Msg>
where Option<Box<dyn Fn(bool) -> 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.