Struct egui::widgets::Checkbox

source ·
pub struct Checkbox<'a> {
    checked: &'a mut bool,
    text: WidgetText,
    indeterminate: bool,
}
Expand description

Boolean on/off control with text label.

Usually you’d use Ui::checkbox instead.

// These are equivalent:
ui.checkbox(&mut my_bool, "Checked");
ui.add(egui::Checkbox::new(&mut my_bool, "Checked"));

Fields§

§checked: &'a mut bool§text: WidgetText§indeterminate: bool

Implementations§

source§

impl<'a> Checkbox<'a>

source

pub fn new(checked: &'a mut bool, text: impl Into<WidgetText>) -> Self

source

pub fn without_text(checked: &'a mut bool) -> Self

source

pub fn indeterminate(self, indeterminate: bool) -> Self

Display an indeterminate state (neither checked nor unchecked)

This only affects the checkbox’s appearance. It will still toggle its boolean value when clicked.

Trait Implementations§

source§

impl<'a> Widget for Checkbox<'a>

source§

fn ui(self, ui: &mut Ui) -> Response

Allocate space, interact, paint, and return a Response. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Checkbox<'a>

§

impl<'a> RefUnwindSafe for Checkbox<'a>

§

impl<'a> Send for Checkbox<'a>

§

impl<'a> Sync for Checkbox<'a>

§

impl<'a> Unpin for Checkbox<'a>

§

impl<'a> !UnwindSafe for Checkbox<'a>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.