Struct conrod::Toggle

pub struct Toggle<'a, F> {
    // 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 closure.

Methods

impl<'a, F> Toggle<'a, F>

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

Construct a new Toggle widget.

fn react(self, reaction: F) -> Self

Set the reaction for the Toggle. It will be triggered upon release of the button.

fn set<C>(self, ui_id: UiId, ui: &mut Ui<C>) where F: FnMut(bool)

After building the Toggle, use this method to set its current state into the given Ui. It will use this state for rendering the next time ui.draw(graphics) is called.

Trait Implementations

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

fn color(self, color: Color) -> Self

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

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

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

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

impl<'a, F> Frameable for Toggle<'a, F>

fn frame(self, width: f64) -> Self

fn frame_color(self, color: Color) -> Self

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

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

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

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

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

fn label(self, text: &'a str) -> Self

fn label_color(self, color: Color) -> Self

fn label_font_size(self, size: FontSize) -> Self

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

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

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

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

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

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

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

impl<'a, F> Positionable for Toggle<'a, F>

fn position(self, pos: Position) -> Self

fn horizontal_align(self, h_align: HorizontalAlign) -> Self

fn vertical_align(self, v_align: VerticalAlign) -> Self

fn point(self, point: Point) -> Self

fn xy(self, x: Scalar, y: Scalar) -> Self

fn relative(self, point: Point) -> Self

fn relative_xy(self, x: Scalar, y: Scalar) -> Self

fn relative_to(self, ui_id: UiId, point: Point) -> Self

fn relative_xy_to(self, ui_id: UiId, x: Scalar, y: Scalar) -> Self

fn down(self, pixels: Scalar) -> Self

fn up(self, pixels: Scalar) -> Self

fn left(self, pixels: Scalar) -> Self

fn right(self, pixels: Scalar) -> Self

fn down_from(self, ui_id: UiId, pixels: Scalar) -> Self

fn up_from(self, ui_id: UiId, pixels: Scalar) -> Self

fn left_from(self, ui_id: UiId, pixels: Scalar) -> Self

fn right_from(self, ui_id: UiId, pixels: Scalar) -> Self

fn align_left(self) -> Self

fn align_middle_x(self) -> Self

fn align_right(self) -> Self

fn align_top(self) -> Self

fn align_middle_y(self) -> Self

fn align_bottom(self) -> Self

fn place(self, place: Place, maybe_id: Option<CanvasId>) -> Self

fn middle_of(self, id: CanvasId) -> Self

fn top_left_of(self, id: CanvasId) -> Self

fn top_right_of(self, id: CanvasId) -> Self

fn bottom_left_of(self, id: CanvasId) -> Self

fn bottom_right_of(self, id: CanvasId) -> Self

fn mid_top_of(self, id: CanvasId) -> Self

fn mid_bottom_of(self, id: CanvasId) -> Self

fn mid_left_of(self, id: CanvasId) -> Self

fn mid_right_of(self, id: CanvasId) -> Self

fn middle(self) -> Self

fn top_left(self) -> Self

fn top_right(self) -> Self

fn bottom_left(self) -> Self

fn bottom_right(self) -> Self

fn mid_top(self) -> Self

fn mid_bottom(self) -> Self

fn mid_left(self) -> Self

fn mid_right(self) -> Self

impl<'a, F> Sizeable for Toggle<'a, F>

fn width(self, w: f64) -> Self

fn height(self, h: f64) -> Self

fn dim(self, dim: Dimensions) -> Self

fn dimensions(self, width: Scalar, height: Scalar) -> Self