Struct Switch 

pub struct Switch { /* private fields */ }

A control that takes effect the moment it is flipped.

Use a switch for something that applies immediately, and a checkbox for something that applies when a form is submitted.

Implementations

impl Switch

pub fn new(ident: impl Into<Ident>) -> Self

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

pub fn description(self, description: impl Into<SharedString>) -> Self

pub fn named(self, name: impl Into<SharedString>) -> Self

Names the switch without drawing the name.

A switch at the right edge of a settings row is named by the row, and repeating those words beside the track would say everything twice. The name still has to reach the tree, because a control nobody can name is a control nobody can operate without looking at it.

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

pub fn on_change( self, handler: impl Fn(bool, &mut Window, &mut App) + 'static, ) -> Self

Trait Implementations

impl Debug for Switch

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Disableable for Switch

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

impl IntoElement for Switch

type Element = ViewElement<Switch>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for Switch

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.

impl Sizable for Switch

fn control_size(self, size: ControlSize) -> Self

fn xs(self) -> Self

fn small(self) -> Self

fn medium(self) -> Self

fn large(self) -> Self