Struct Toggle 

pub struct Toggle { /* private fields */ }

A button that stays in.

Whether it is in belongs to the caller: the toggle draws the state it was handed and reports the state pressing it asks for. A host that refuses the press simply does not apply it, and the button keeps showing what is true.

Implementations

impl Toggle

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

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

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

What assistive technology and a test call this toggle, when the words on it are not what it is called.

pub fn icon(self, glyph: Icon) -> Self

pub fn icon_only(self, glyph: Icon, name: impl Into<SharedString>) -> Self

Draws the toggle as a square carrying only its glyph, and names it.

The name is required for the same reason it is on IconButton: a glyph nobody can name is a control nobody can announce or address.

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

Whether the toggle is in. This is the caller’s answer, not the toggle’s.

pub fn variant(self, variant: ButtonVariant) -> Self

pub fn secondary(self) -> Self

pub fn ghost(self) -> Self

pub fn join(self, join: ButtonJoin) -> Self

Where the toggle sits in a joined run of them.

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

pub fn track_focus(self, handle: &FocusHandle) -> Self

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

Reports the state pressing asks for, which is the opposite of the one the toggle was handed.

Trait Implementations

impl Debug for Toggle

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

Formats the value using the given formatter.

impl Disableable for Toggle

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

impl IntoElement for Toggle

type Element = ViewElement<Toggle>

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 Toggle

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 Toggle

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

fn xs(self) -> Self

fn small(self) -> Self

fn medium(self) -> Self

fn large(self) -> Self