Struct conrod::Toggle
[−]
[src]
pub struct Toggle<'a, F> { pub maybe_react: Option<F>, 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
maybe_react: Option<F>
Set the reaction for the Toggle. It will be triggered upon release of the button.
enabled: bool
If true, will allow user inputs. If false, will disallow user inputs.
Methods
impl<'a, F> Toggle<'a, F>
[src]
fn new(value: bool) -> Toggle<'a, F>
Construct a new Toggle widget.
fn react(self, react: F) -> Self
Build the type's self.$($assignee).+ with the given $Type.
fn enabled(self, enabled: bool) -> Self
Build the type's self.$($assignee).+ with the given $Type.
Trait Implementations
impl<'a, F> Widget for Toggle<'a, F> where F: FnOnce(bool)
[src]
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
fn common(&self) -> &CommonBuilder
Return a reference to a CommonBuilder struct owned by the Widget. This method allows us to do a blanket impl of Positionable and Sizeable for T: Widget. Read more
fn common_mut(&mut self) -> &mut CommonBuilder
Return a mutable reference to a CommonBuilder struct owned by the Widget. This method allows us to do a blanket impl of Positionable and Sizeable for T: Widget. Read more
fn unique_kind(&self) -> &'static str
Return the kind of the widget as a &'static str. Read more
fn init_state(&self) -> State
Return the initial State of the Widget. Read more
fn style(&self) -> Style
Return the styling of the widget. Read more
fn update<C: CharacterCache>(self, args: UpdateArgs<Self, C>)
Update the state of the Toggle.
fn default_x_position<C: CharacterCache>(&self, ui: &Ui<C>) -> Position
The default Position for the widget along the x axis. Read more
fn default_y_position<C: CharacterCache>(&self, ui: &Ui<C>) -> Position
The default Position for the widget along the y axis. Read more
fn default_x_dimension<C: CharacterCache>(&self, ui: &Ui<C>) -> Dimension
The default width for the Widget. Read more
fn default_y_dimension<C: CharacterCache>(&self, ui: &Ui<C>) -> Dimension
The default height of the widget. Read more
fn drag_area(&self, _dim: Dimensions, _style: &Self::Style, _theme: &Theme) -> Option<Rect>
If the widget is draggable, implement this method and return the position an dimensions of the draggable space. The position should be relative to the center of the widget. Read more
fn kid_area<C: CharacterCache>(&self, args: KidAreaArgs<Self, C>) -> KidArea
The area on which child widgets will be placed when using the Place
Position
methods.
fn parent<I: Into<Index>>(self, parent_idx: I) -> Self
Set the parent widget for this Widget by passing the WidgetId of the parent. Read more
fn no_parent(self) -> Self
Specify that this widget has no parent widgets.
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<I: Into<Index>>(self, idx: I) -> 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
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 scroll_kids(self) -> Self
Set whether or not the widget's KidArea
is scrollable (the default is false). Read more
fn scroll_kids_vertically(self) -> Self
Set whether or not the widget's KidArea
is scrollable (the default is false). Read more
fn scroll_kids_horizontally(self) -> Self
Set whether or not the widget's KidArea
is scrollable (the default is false). Read more
fn set<I, U>(self, idx: I, ui: &mut U) where I: Into<Index>, U: UiRefMut
Note: There should be no need to override this method. Read more
impl<'a, F> Colorable for Toggle<'a, F>
[src]
fn color(self, color: Color) -> Self
Build the type's self.$($assignee).+ with the given $Type.
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
Set the color of the widget from rgb values.
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
Set the color of the widget from hsl values.
impl<'a, F> Frameable for Toggle<'a, F>
[src]
fn frame(self, frame: Scalar) -> Self
Build the type's self.$($assignee).+ with the given $Type.
fn frame_color(self, frame_color: Color) -> Self
Build the type's self.$($assignee).+ with the given $Type.
fn frame_rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self
Set the color of the widget's frame with rgba values.
fn frame_rgb(self, r: f32, g: f32, b: f32) -> Self
Set the color of the widget's frame with rgb values.
fn frame_hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self
Set the color of the widget's frame with hsla values.
fn frame_hsl(self, h: f32, s: f32, l: f32) -> Self
Set the color of the widget's frame with hsl values.
impl<'a, F> Labelable<'a> for Toggle<'a, F>
[src]
fn label(self, label: &'a str) -> Self
Build the type's self.$($assignee).+ with the given $Type.
fn label_color(self, label_color: Color) -> Self
Build the type's self.$($assignee).+ with the given $Type.
fn label_font_size(self, label_font_size: FontSize) -> Self
Build the type's self.$($assignee).+ with the given $Type.
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
Set the color of the widget's label from rgb values.
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
Set the color of the widget's label from hsl values.
fn small_font<C>(self, ui: &Ui<C>) -> Self
Set a "small" font size for the widget's label.
fn medium_font<C>(self, ui: &Ui<C>) -> Self
Set a "medium" font size for the widget's label.
fn large_font<C>(self, ui: &Ui<C>) -> Self
Set a "large" font size for the widget's label.