Struct nannou::ui::prelude::widget::toggle::Toggle [−][src]
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.
Methods
impl<'a> Toggle<'a>
[src]
impl<'a> Toggle<'a>
pub fn new(value: bool) -> Toggle<'a>
[src]
pub fn new(value: bool) -> Toggle<'a>
Construct a new Toggle widget.
pub fn label_font_id(self, font_id: Id) -> Toggle<'a>
[src]
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>
[src]
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>
[src]
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>
[src]
pub fn enabled(self, enabled: bool) -> Toggle<'a>
Build the type's self.$($assignee).+ with the given $Type.
Trait Implementations
impl<'a> Widget for Toggle<'a>
[src]
impl<'a> Widget for Toggle<'a>
type State = State
State to be stored within the Ui
s widget cache. Read more
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. Read more
type Event = TimesClicked
The type of event yielded by the widget, returned via the Widget::set
function. Read more
fn init_state(&self, id_gen: Generator) -> <Toggle<'a> as Widget>::State
[src]
fn init_state(&self, id_gen: Generator) -> <Toggle<'a> as Widget>::State
Return the initial State of the Widget. Read more
fn style(&self) -> <Toggle<'a> as Widget>::Style
[src]
fn style(&self) -> <Toggle<'a> as Widget>::Style
Return the styling of the widget. Read more
fn update(self, args: UpdateArgs<Toggle<'a>>) -> <Toggle<'a> as Widget>::Event
[src]
fn update(self, args: UpdateArgs<Toggle<'a>>) -> <Toggle<'a> as Widget>::Event
Update the state of the Toggle.
fn default_x_position(&self, ui: &Ui) -> Position
[src]
fn default_x_position(&self, ui: &Ui) -> Position
The default Position for the widget along the x axis. Read more
fn default_y_position(&self, ui: &Ui) -> Position
[src]
fn default_y_position(&self, ui: &Ui) -> Position
The default Position for the widget along the y axis. Read more
fn default_x_dimension(&self, ui: &Ui) -> Dimension
[src]
fn default_x_dimension(&self, ui: &Ui) -> Dimension
The default width for the Widget. Read more
fn default_y_dimension(&self, ui: &Ui) -> Dimension
[src]
fn default_y_dimension(&self, ui: &Ui) -> Dimension
The default height of the widget. Read more
fn drag_area(
&self,
_dim: [f64; 2],
_style: &Self::Style,
_theme: &Theme
) -> Option<Rect>
[src]
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. Read more
fn kid_area(&self, args: KidAreaArgs<Self>) -> KidArea
[src]
fn kid_area(&self, args: KidAreaArgs<Self>) -> KidArea
The area on which child widgets will be placed when using the Place
Position
methods.
fn is_over(&self) -> fn(&Container, [f64; 2], &Theme) -> IsOver
[src]
fn is_over(&self) -> fn(&Container, [f64; 2], &Theme) -> IsOver
Returns either of the following: Read more
fn parent(self, parent_id: NodeIndex<u32>) -> Self
[src]
fn parent(self, parent_id: NodeIndex<u32>) -> Self
Set the parent widget for this Widget by passing the WidgetId of the parent. Read more
fn no_parent(self) -> Self
[src]
fn no_parent(self) -> Self
Specify that this widget has no parent widgets.
fn place_on_kid_area(self, b: bool) -> Self
[src]
fn place_on_kid_area(self, b: bool) -> Self
Set whether or not the Widget should be placed on the kid_area. Read more
fn graphics_for(self, id: NodeIndex<u32>) -> Self
[src]
fn graphics_for(self, id: NodeIndex<u32>) -> Self
Indicates that the Widget is used as a non-interactive graphical element for some other widget. Read more
fn floating(self, is_floating: bool) -> Self
[src]
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. Read more
fn crop_kids(self) -> Self
[src]
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. Read more
fn scroll_kids(self) -> Self
[src]
fn scroll_kids(self) -> Self
Makes the widget's KidArea
scrollable. Read more
fn scroll_kids_vertically(self) -> Self
[src]
fn scroll_kids_vertically(self) -> Self
Makes the widget's KidArea
scrollable. Read more
fn scroll_kids_horizontally(self) -> Self
[src]
fn scroll_kids_horizontally(self) -> Self
Set whether or not the widget's KidArea
is scrollable (the default is false). Read more
fn and<F>(self, build: F) -> Self where
F: FnOnce(Self) -> Self,
[src]
fn and<F>(self, build: F) -> Self where
F: FnOnce(Self) -> Self,
A builder method that "lifts" the Widget through the given build
function. Read more
fn and_mut<F>(self, mutate: F) -> Self where
F: FnOnce(&mut Self),
[src]
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. Read more
fn and_if<F>(self, cond: bool, build: F) -> Self where
F: FnOnce(Self) -> Self,
[src]
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. Read more
fn and_then<T, F>(self, maybe: Option<T>, build: F) -> Self where
F: FnOnce(Self, T) -> Self,
[src]
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. Read more
fn set(self, id: NodeIndex<u32>, ui_cell: &'a mut UiCell<'b>) -> Self::Event
[src]
fn set(self, id: NodeIndex<u32>, ui_cell: &'a mut UiCell<'b>) -> Self::Event
Note: There should be no need to override this method. Read more
impl<'a> Common for Toggle<'a>
[src]
impl<'a> Common for Toggle<'a>
fn common(&self) -> &CommonBuilder
[src]
fn common(&self) -> &CommonBuilder
Borrows the CommonBuilder
field.
fn common_mut(&mut self) -> &mut CommonBuilder
[src]
fn common_mut(&mut self) -> &mut CommonBuilder
Mutably borrows the CommonBuilder
field.
impl<'a> Clone for Toggle<'a>
[src]
impl<'a> Clone for Toggle<'a>
fn clone(&self) -> Toggle<'a>
[src]
fn clone(&self) -> Toggle<'a>
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl<'a> Colorable for Toggle<'a>
[src]
impl<'a> Colorable for Toggle<'a>
fn color(self, color: Color) -> Toggle<'a>
[src]
fn color(self, color: Color) -> Toggle<'a>
Build the type's self.$($assignee).+ with the given $Type.
fn rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self
[src]
fn rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self
Set the color of the widget from rgba values.
fn rgb(self, r: f32, g: f32, b: f32) -> Self
[src]
fn rgb(self, r: f32, g: f32, b: f32) -> Self
Set the color of the widget from rgb values.
fn hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self
[src]
fn hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self
Set the color of the widget from hsla values.
fn hsl(self, h: f32, s: f32, l: f32) -> Self
[src]
fn hsl(self, h: f32, s: f32, l: f32) -> Self
Set the color of the widget from hsl values.
impl<'a> Labelable<'a> for Toggle<'a>
[src]
impl<'a> Labelable<'a> for Toggle<'a>
fn label(self, label: &'a str) -> Toggle<'a>
[src]
fn label(self, label: &'a str) -> Toggle<'a>
Build the type's self.$($assignee).+ with the given $Type.
fn label_color(self, label_color: Color) -> Toggle<'a>
[src]
fn label_color(self, label_color: Color) -> Toggle<'a>
Build the type's self.$($assignee).+ with the given $Type.
fn label_font_size(self, label_font_size: u32) -> Toggle<'a>
[src]
fn label_font_size(self, label_font_size: u32) -> Toggle<'a>
Build the type's self.$($assignee).+ with the given $Type.
fn label_rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self
[src]
fn label_rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self
Set the color of the widget's label from rgba values.
fn label_rgb(self, r: f32, g: f32, b: f32) -> Self
[src]
fn label_rgb(self, r: f32, g: f32, b: f32) -> Self
Set the color of the widget's label from rgb values.
fn label_hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self
[src]
fn label_hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self
Set the color of the widget's label from hsla values.
fn label_hsl(self, h: f32, s: f32, l: f32) -> Self
[src]
fn label_hsl(self, h: f32, s: f32, l: f32) -> Self
Set the color of the widget's label from hsl values.
fn small_font(self, ui: &Ui) -> Self
[src]
fn small_font(self, ui: &Ui) -> Self
Set a "small" font size for the widget's label.
fn medium_font(self, ui: &Ui) -> Self
[src]
fn medium_font(self, ui: &Ui) -> Self
Set a "medium" font size for the widget's label.
fn large_font(self, ui: &Ui) -> Self
[src]
fn large_font(self, ui: &Ui) -> Self
Set a "large" font size for the widget's label.
impl<'a> Borderable for Toggle<'a>
[src]
impl<'a> Borderable for Toggle<'a>
fn border(self, border: f64) -> Toggle<'a>
[src]
fn border(self, border: f64) -> Toggle<'a>
Build the type's self.$($assignee).+ with the given $Type.
fn border_color(self, border_color: Color) -> Toggle<'a>
[src]
fn border_color(self, border_color: Color) -> Toggle<'a>
Build the type's self.$($assignee).+ with the given $Type.
fn border_rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self
[src]
fn border_rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self
Set the color of the widget's border with rgba values.
fn border_rgb(self, r: f32, g: f32, b: f32) -> Self
[src]
fn border_rgb(self, r: f32, g: f32, b: f32) -> Self
Set the color of the widget's border with rgb values.
fn border_hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self
[src]
fn border_hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self
Set the color of the widget's border with hsla values.
fn border_hsl(self, h: f32, s: f32, l: f32) -> Self
[src]
fn border_hsl(self, h: f32, s: f32, l: f32) -> Self
Set the color of the widget's border with hsl values.