Struct nannou::ui::prelude::widget::Toggle

pub struct Toggle<'a> {
    pub enabled: bool,
    // some fields omitted
}

A pressable widget for toggling the state of a bool.

Like the Button widget, it’s reaction is triggered upon release and will return the new bool state.

Note that the Toggle will not mutate the bool for you, you should do this yourself within the react function.

Fields

enabled: bool

If true, will allow user inputs. If false, will disallow user inputs.

Implementations

impl<'a> Toggle<'a>

pub fn new(value: bool) -> Toggle<'a>

Construct a new Toggle widget.

pub fn label_font_id(self, font_id: Id) -> Toggle<'a>

Specify the font used for displaying the label.

pub fn label_x(self, x: Relative) -> Toggle<'a>

Specify the label’s position relatively to Toggle along the x axis.

pub fn label_y(self, y: Relative) -> Toggle<'a>

Specify the label’s position relatively to Toggle along the y axis.

pub fn enabled(self, enabled: bool) -> Toggle<'a>

Build the type’s self.$($assignee).+ with the given $Type.

Trait Implementations

impl<'a> Borderable for Toggle<'a>

pub fn border(self, border: f64) -> Toggle<'a>

Build the type’s self.$($assignee).+ with the given $Type.

pub fn border_color(self, border_color: Color) -> Toggle<'a>

Build the type’s self.$($assignee).+ with the given $Type.

pub fn border_rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self

Set the color of the widget’s border with rgba values.

pub fn border_rgb(self, r: f32, g: f32, b: f32) -> Self

Set the color of the widget’s border with rgb values.

pub fn border_hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self

Set the color of the widget’s border with hsla values.

pub fn border_hsl(self, h: f32, s: f32, l: f32) -> Self

Set the color of the widget’s border with hsl values.

impl<'a> Clone for Toggle<'a>

pub fn clone(&self) -> Toggle<'a>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Colorable for Toggle<'a>

pub fn color(self, color: Color) -> Toggle<'a>

Build the type’s self.$($assignee).+ with the given $Type.

pub fn rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self

Set the color of the widget from rgba values.

pub fn rgb(self, r: f32, g: f32, b: f32) -> Self

Set the color of the widget from rgb values.

pub fn hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self

Set the color of the widget from hsla values.

pub fn hsl(self, h: f32, s: f32, l: f32) -> Self

Set the color of the widget from hsl values.

impl<'a> Common for Toggle<'a>

pub fn common(&self) -> &CommonBuilder

Borrows the CommonBuilder field.

pub fn common_mut(&mut self) -> &mut CommonBuilder

Mutably borrows the CommonBuilder field.

impl<'a> Labelable<'a> for Toggle<'a>

pub fn label(self, label: &'a str) -> Toggle<'a>

Build the type’s self.$($assignee).+ with the given $Type.

pub fn label_color(self, label_color: Color) -> Toggle<'a>

Build the type’s self.$($assignee).+ with the given $Type.

pub fn label_font_size(self, label_font_size: u32) -> Toggle<'a>

Build the type’s self.$($assignee).+ with the given $Type.

pub fn label_rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self

Set the color of the widget’s label from rgba values.

pub fn label_rgb(self, r: f32, g: f32, b: f32) -> Self

Set the color of the widget’s label from rgb values.

pub fn label_hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self

Set the color of the widget’s label from hsla values.

pub fn label_hsl(self, h: f32, s: f32, l: f32) -> Self

Set the color of the widget’s label from hsl values.

pub fn small_font(self, ui: &Ui) -> Self

Set a “small” font size for the widget’s label.

pub fn medium_font(self, ui: &Ui) -> Self

Set a “medium” font size for the widget’s label.

pub fn large_font(self, ui: &Ui) -> Self

Set a “large” font size for the widget’s label.

impl<'a> Widget for Toggle<'a>

type State = State

State to be stored within the Uis widget cache.

type Style = Style

Every widget is required to have its own associated Style type. This type is intended to contain high-level styling information for the widget that can be optionally specified by a user of the widget.

type Event = TimesClicked

The type of event yielded by the widget, returned via the Widget::set function.

pub fn init_state(&self, id_gen: Generator<'_>) -> <Toggle<'a> as Widget>::State

Return the initial State of the Widget.

pub fn style(&self) -> <Toggle<'a> as Widget>::Style

Return the styling of the widget.

pub fn update(
    self,
    args: UpdateArgs<'_, '_, '_, '_, Toggle<'a>>
) -> <Toggle<'a> as Widget>::Event

Update the state of the Toggle.

pub fn default_x_position(&self, ui: &Ui) -> Position

The default Position for the widget along the x axis.

pub fn default_y_position(&self, ui: &Ui) -> Position

The default Position for the widget along the y axis.

pub fn default_x_dimension(&self, ui: &Ui) -> Dimension

The default width for the Widget.

pub fn default_y_dimension(&self, ui: &Ui) -> Dimension

The default height of the widget.

pub fn drag_area(
    &self,
    _dim: [f64; 2],
    _style: &Self::Style,
    _theme: &Theme
) -> Option<Rect>

If the widget is draggable, implement this method and return the position and dimensions of the draggable space. The position should be relative to the center of the widget.

pub fn kid_area(&self, args: KidAreaArgs<'_, Self>) -> KidArea

The area on which child widgets will be placed when using the Place Position methods.

pub fn is_over(&self) -> fn(&Container, [f64; 2], &Theme) -> IsOver

Returns either of the following:

pub fn parent(self, parent_id: NodeIndex<u32>) -> Self

Set the parent widget for this Widget by passing the WidgetId of the parent.

pub fn no_parent(self) -> Self

Specify that this widget has no parent widgets.

pub fn place_on_kid_area(self, b: bool) -> Self

Set whether or not the Widget should be placed on the kid_area.

pub fn graphics_for(self, id: NodeIndex<u32>) -> Self

Indicates that the Widget is used as a non-interactive graphical element for some other widget.

pub fn floating(self, is_floating: bool) -> Self

Set whether or not the widget is floating (the default is false). A typical example of a floating widget would be a pop-up or alert window.

pub fn crop_kids(self) -> Self

Indicates that all widgets who are children of this widget should be cropped to the kid_area of this widget.

pub fn scroll_kids(self) -> Self

Makes the widget’s KidArea scrollable.

pub fn scroll_kids_vertically(self) -> Self

Makes the widget’s KidArea scrollable.

pub fn scroll_kids_horizontally(self) -> Self

Set whether or not the widget’s KidArea is scrollable (the default is false).

pub fn and<F>(self, build: F) -> Self where
    F: FnOnce(Self) -> Self, 

A builder method that “lifts” the Widget through the given build function.

pub fn and_mut<F>(self, mutate: F) -> Self where
    F: FnOnce(&mut Self), 

A builder method that mutates the Widget with the given mutate function.

pub fn and_if<F>(self, cond: bool, build: F) -> Self where
    F: FnOnce(Self) -> Self, 

A method that conditionally builds the Widget with the given build function.

pub fn and_then<T, F>(self, maybe: Option<T>, build: F) -> Self where
    F: FnOnce(Self, T) -> Self, 

A method that optionally builds the Widget with the given build function.

pub fn set(self, id: NodeIndex<u32>, ui_cell: &'a mut UiCell<'b>) -> Self::Event

Note: There should be no need to override this method.