Struct Toggler 

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

A toggler widget.

Example

pub enum Message {
    TogglerToggled(bool),
}

let is_toggled = true;

Toggler::new(String::from("Toggle me!"), is_toggled, |b| Message::TogglerToggled(b));

Implementations

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

where Renderer: Renderer, Renderer::Theme: StyleSheet,

pub const DEFAULT_SIZE: f32 = 20f32

The default size of a Toggler.

pub fn new<F>( id: Id, label: impl Into<Option<String>>, is_toggled: bool, f: F, ) -> Self

where F: 'a + Fn(Chain, bool) -> Message,

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 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_alignment(self, alignment: Horizontal) -> Self

Sets the horizontal alignment of the text 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: Renderer::Font) -> Self

Sets the Font of the text of the Toggler

pub fn style( self, style: impl Into<<Renderer::Theme as StyleSheet>::Style>, ) -> Self

Sets the style of the Toggler.

pub fn percent(self, percent: f32) -> Self

The percent completion of the toggler animation. This is indented to automated cosmic-time use, and shouldn’t need to be called manually.

pub fn anim_multiplier(self, multiplier: f32) -> Self

The default animation time is 100ms, to speed up the toggle animation use a value less than 1.0, and to slow down the animation use a value greater than 1.0.

Trait Implementations

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

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

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

Converts to this type from the input type.

impl<'a, Message, Renderer> Widget<Message, Renderer> for Toggler<'a, Message, Renderer>

where Renderer: Renderer, Renderer::Theme: StyleSheet + StyleSheet,

fn width(&self) -> Length

Returns the width of the Widget.

fn height(&self) -> Length

Returns the height of the Widget.

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

Returns the layout::Node of the Widget.

fn on_event( &mut self, _state: &mut Tree, event: Event, layout: Layout<'_>, cursor_position: Point, _renderer: &Renderer, _clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, ) -> Status

Processes a runtime Event.

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

Returns the current mouse::Interaction of the Widget.

fn draw( &self, _state: &Tree, renderer: &mut Renderer, theme: &Renderer::Theme, style: &Style, layout: Layout<'_>, cursor_position: Point, _viewport: &Rectangle, )

Draws the Widget using the associated Renderer.

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

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

Returns the state Tree of the children of the Widget.

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

Reconciliates the Widget with the provided Tree.

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

Applies an Operation to the Widget.

fn overlay<'a>( &'a mut self, _state: &'a mut Tree, _layout: Layout<'_>, _renderer: &Renderer, ) -> Option<Element<'a, Message, Renderer>>

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