[][src]Struct conrod_core::widget::toggle::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>[src]

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

Construct a new Toggle widget.

pub fn label_font_id(self, font_id: Id) -> Self[src]

Specify the font used for displaying the label.

pub fn label_x(self, x: Relative) -> Self[src]

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

pub fn label_y(self, y: Relative) -> Self[src]

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

pub fn enabled(self, enabled: bool) -> Self[src]

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

Trait Implementations

impl<'a> Borderable for Toggle<'a>[src]

fn border(self, border: Scalar) -> Self[src]

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

fn border_color(self, border_color: Color) -> Self[src]

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

impl<'a> Clone for Toggle<'a>[src]

impl<'a> Colorable for Toggle<'a>[src]

fn color(self, color: Color) -> Self[src]

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

impl<'a> Common for Toggle<'a>[src]

impl<'a> Labelable<'a> for Toggle<'a>[src]

fn label(self, label: &'a str) -> Self[src]

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

fn label_color(self, label_color: Color) -> Self[src]

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

fn label_font_size(self, label_font_size: FontSize) -> Self[src]

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

impl<'a> Widget for Toggle<'a>[src]

type State = State

State to be stored within the Uis 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 update(self, args: UpdateArgs<'_, '_, '_, '_, Self>) -> Self::Event[src]

Update the state of the Toggle.

Auto Trait Implementations

impl<'a> RefUnwindSafe for Toggle<'a>

impl<'a> Send for Toggle<'a>

impl<'a> Sync for Toggle<'a>

impl<'a> Unpin for Toggle<'a>

impl<'a> UnwindSafe for Toggle<'a>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<W> Positionable for W where
    W: Widget
[src]

impl<W> Sizeable for W where
    W: Widget
[src]

fn get_x_dimension(&Self, &Ui) -> Dimension[src]

We attempt to retrieve the x Dimension for the widget via the following:

  • Check for specified value at maybe_x_dimension
  • Otherwise, use the default returned by Widget::default_x_dimension.

fn get_y_dimension(&Self, &Ui) -> Dimension[src]

We attempt to retrieve the y Dimension for the widget via the following:

  • Check for specified value at maybe_y_dimension
  • Otherwise, use the default returned by Widget::default_y_dimension.

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.