Struct egui::widgets::checkbox::Checkbox

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

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

impl<'a> Checkbox<'a>

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

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

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

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

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

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