Struct Toggler

pub struct Toggler<'a, Message, Theme = Theme, Renderer = Renderer>
where
    Theme: Catalog,
    Renderer: Renderer,
{ /* private fields */ }

A toggler widget.

Example

use iced::widget::toggler;

struct State {
   is_checked: bool,
}

enum Message {
    TogglerToggled(bool),
}

fn view(state: &State) -> Element<'_, Message> {
    toggler(state.is_checked)
        .label("Toggle me!")
        .on_toggle(Message::TogglerToggled)
        .into()
}

fn update(state: &mut State, message: Message) {
    match message {
        Message::TogglerToggled(is_checked) => {
            state.is_checked = is_checked;
        }
    }
}

Implementations

impl<'a, Message, Theme, Renderer> Toggler<'a, Message, Theme, Renderer>

where Theme: Catalog, Renderer: Renderer,

pub const DEFAULT_SIZE: f32 = 16f32

The default size of a Toggler.

pub fn new(is_toggled: bool) -> Self

Creates a new Toggler.

It expects:

• a boolean describing whether the Toggler is checked or not
• An optional label for the Toggler
• a function that will be called when the Toggler is toggled. It will receive the new state of the Toggler and must produce a Message.

pub fn label(self, label: impl IntoFragment<'a>) -> Self

Sets the label of the Toggler.

pub fn on_toggle(self, on_toggle: impl Fn(bool) -> Message + 'a) -> Self

Sets the message that should be produced when a user toggles the Toggler.

If this method is not called, the Toggler will be disabled.

pub fn on_toggle_maybe( self, on_toggle: Option<impl Fn(bool) -> Message + 'a>, ) -> Self

Sets the message that should be produced when a user toggles the Toggler, if Some.

If None, the Toggler will be disabled.

pub fn size(self, size: impl Into<Pixels>) -> Self

Sets the size of the Toggler.

pub fn width(self, width: impl Into<Length>) -> Self

Sets the width of the Toggler.

pub fn text_size(self, text_size: impl Into<Pixels>) -> Self

Sets the text size o the Toggler.

pub fn text_line_height(self, line_height: impl Into<LineHeight>) -> Self

Sets the text text::LineHeight of the Toggler.

pub fn text_alignment(self, alignment: impl Into<Alignment>) -> Self

Sets the horizontal alignment of the text of the Toggler

pub fn text_shaping(self, shaping: Shaping) -> Self

Sets the text::Shaping strategy of the Toggler.

pub fn text_wrapping(self, wrapping: Wrapping) -> Self

Sets the text::Wrapping strategy of the Toggler.

pub fn spacing(self, spacing: impl Into<Pixels>) -> Self

Sets the spacing between the Toggler and the text.

pub fn font(self, font: impl Into<Renderer::Font>) -> Self

Sets the Renderer::Font of the text of the Toggler

pub fn style(self, style: impl Fn(&Theme, Status) -> Style + 'a) -> Self

where Theme::Class<'a>: From<StyleFn<'a, Theme>>,

Sets the style of the Toggler.

pub fn class(self, class: impl Into<Theme::Class<'a>>) -> Self

Available on crate feature advanced only.

Sets the style class of the Toggler.

Trait Implementations

impl<'a, Message, Theme, Renderer> From<Toggler<'a, Message, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>

where Message: 'a, Theme: Catalog + 'a, Renderer: Renderer + 'a,

fn from( toggler: Toggler<'a, Message, Theme, Renderer>, ) -> Element<'a, Message, Theme, Renderer>

Converts to this type from the input type.

impl<Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Toggler<'_, Message, Theme, Renderer>

where Theme: Catalog, Renderer: Renderer,

fn tag(&self) -> Tag

Returns the Tag of the [Widget].

fn state(&self) -> State

Returns the State of the [Widget].

fn size(&self) -> Size<Length>

Returns the [Size] of the [Widget] in lengths.

fn layout(&self, tree: &mut Tree, renderer: &Renderer, limits: &Limits) -> Node

Returns the [layout::Node] of the [Widget].

fn update( &mut self, _state: &mut Tree, event: &Event, layout: Layout<'_>, cursor: Cursor, _renderer: &Renderer, _clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, _viewport: &Rectangle, )

Processes a runtime Event.

fn mouse_interaction( &self, _state: &Tree, layout: Layout<'_>, cursor: Cursor, _viewport: &Rectangle, _renderer: &Renderer, ) -> Interaction

Returns the current [mouse::Interaction] of the [Widget].

fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, style: &Style, layout: Layout<'_>, _cursor: Cursor, viewport: &Rectangle, )

Draws the [Widget] using the associated Renderer.

fn size_hint(&self) -> Size<Length>

Returns a [Size] hint for laying out the [Widget].

fn children(&self) -> Vec<Tree>

Returns the state [Tree] of the children of the [Widget].

fn diff(&self, tree: &mut Tree)

Reconciles the [Widget] with the provided [Tree].

fn operate( &self, _state: &mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _operation: &mut dyn Operation, )

Applies an [Operation] to the [Widget].

fn overlay<'a>( &'a mut self, _state: &'a mut Tree, _layout: Layout<'a>, _renderer: &Renderer, _viewport: &Rectangle, _translation: Vector, ) -> Option<Element<'a, Message, Theme, Renderer>>

Returns the overlay of the [Widget], if there is any.