Struct CheckBox 

pub struct CheckBox { /* private fields */ }

Available on crate feature winio only.

A simple check box.

Implementations

impl CheckBox

pub fn text(&self) -> String

The text.

pub fn set_text(&mut self, s: impl AsRef<str>)

Set the text.

Examples found in repository

examples/options/options.rs (line 40)

    fn init(mut init: Self::Init<'_>, sender: &ComponentSender<Self>) -> Self {
        let mut window = init.window(sender);
        // window.set_size(Size::new(800.0, 600.0));

        let mut enabled = Child::<CheckBox>::init(&window);
        enabled.set_text("Enable");

        let mut b = Child::<CheckBox>::init(&window);
        b.set_text("Switch");

        let mut e_label = Child::<Label>::init(&window);
        e_label.set_text("Mode:");
        let mut e = Child::<ComboBox>::init(&window);
        e.insert(0, "A");
        e.insert(1, "B");

        let mut s_label = Child::<Label>::init(&window);
        s_label.set_text("Message:");
        let mut s = Child::<Edit>::init(&window);

        HANDLER.with_app(|a| {
            let config = a.config();

            enabled.set_checked(config.enabled);
            b.set_checked(config.b);

            e.set_selection(Some(match config.e {
                Mode::A => 0,
                Mode::B => 1,
            }));

            s.set_text(&config.s);
        });

        sender.post(MainMessage::EnabledClick);

        window.show();

        Self {
            window,
            enabled,
            b,
            s_label,
            s,
            e_label,
            e,
        }
    }

pub fn is_checked(&self) -> bool

If the box is checked.

Examples found in repository

examples/options/options.rs (line 107)

    async fn update(&mut self, message: Self::Message, sender: &ComponentSender<Self>) -> bool {
        futures_util::join!(self.window.update());
        match message {
            MainMessage::Noop => false,
            MainMessage::Close => {
                sender.output(());
                false
            }
            MainMessage::Redraw => true,
            MainMessage::EnabledClick => {
                let enabled = self.enabled.is_checked();
                self.b.set_enabled(enabled);
                self.e.set_enabled(enabled);
                self.s.set_enabled(enabled);
                false
            }
            MainMessage::OptionsPage(m) => {
                tracing::debug!(?m, "Options page message");
                match m {
                    OptionsPageMessage::Save(config, tx) => {
                        config.enabled = self.enabled.is_checked();
                        config.b = self.b.is_checked();
                        config.e = match self.e.selection() {
                            Some(0) => Mode::A,
                            Some(1) => Mode::B,
                            _ => Default::default(),
                        };
                        config.s = self.s.text();
                        tx.send(config).unwrap()
                    }
                }
                false
            }
        }
    }

examples/test/widgets.rs (line 197)

    async fn update(&mut self, message: Self::Message, sender: &ComponentSender<Self>) -> bool {
        futures_util::future::join(self.window.update(), self.canvas.update()).await;
        match message {
            MainMessage::Noop => false,
            MainMessage::Close => {
                sender.output(());
                false
            }
            MainMessage::Redraw => true,
            MainMessage::PasswordCheck => {
                self.pentry.set_password(!self.pcheck.is_checked());
                true
            }
            MainMessage::List(e) => {
                self.pop_button.set_enabled(!self.list.is_empty());
                self.combo
                    .emit(ComboBoxMessage::from_observable_vec_event(e))
                    .await
            }
            MainMessage::Select => {
                self.index = self.combo.selection();
                false
            }
            MainMessage::Push => {
                self.list.push(
                    match self.rindex {
                        0 => &self.r1,
                        1 => &self.r2,
                        2 => &self.r3,
                        _ => unreachable!(),
                    }
                    .text(),
                );
                false
            }
            MainMessage::Pop => {
                self.list.pop();
                false
            }
            MainMessage::RSelect(i) => {
                self.rindex = i;
                false
            }
            MainMessage::Show => {
                MessageBox::new()
                    .title("Show selected item")
                    .message(
                        self.index
                            .and_then(|index| self.list.get(index))
                            .map(|s| s.as_str())
                            .unwrap_or("No selection."),
                    )
                    .buttons(MessageBoxButton::Ok)
                    .show(&self.window)
                    .await;
                false
            }
            MainMessage::OptionsPage(m) => {
                tracing::debug!(?m, "Options page message");
                match m {
                    OptionsPageMessage::Save(config, tx) => {
                        config.s = self.mltext.text();
                        tx.send(config).unwrap()
                    }
                }
                false
            }
        }
    }

pub fn set_checked(&mut self, v: bool)

Set the checked state.

Examples found in repository

examples/options/options.rs (line 58)

    fn init(mut init: Self::Init<'_>, sender: &ComponentSender<Self>) -> Self {
        let mut window = init.window(sender);
        // window.set_size(Size::new(800.0, 600.0));

        let mut enabled = Child::<CheckBox>::init(&window);
        enabled.set_text("Enable");

        let mut b = Child::<CheckBox>::init(&window);
        b.set_text("Switch");

        let mut e_label = Child::<Label>::init(&window);
        e_label.set_text("Mode:");
        let mut e = Child::<ComboBox>::init(&window);
        e.insert(0, "A");
        e.insert(1, "B");

        let mut s_label = Child::<Label>::init(&window);
        s_label.set_text("Message:");
        let mut s = Child::<Edit>::init(&window);

        HANDLER.with_app(|a| {
            let config = a.config();

            enabled.set_checked(config.enabled);
            b.set_checked(config.b);

            e.set_selection(Some(match config.e {
                Mode::A => 0,
                Mode::B => 1,
            }));

            s.set_text(&config.s);
        });

        sender.post(MainMessage::EnabledClick);

        window.show();

        Self {
            window,
            enabled,
            b,
            s_label,
            s,
            e_label,
            e,
        }
    }

Trait Implementations

impl AsRawWidget for CheckBox

fn as_raw_widget(&self) -> RawWidget

Get the raw window handle.

impl AsWidget for CheckBox

fn as_widget(&self) -> BorrowedWidget<'_>

Get the window handle.

impl Component for CheckBox

type Event = CheckBoxEvent

The output event type to the parent.

type Init<'a> = BorrowedWindow<'a>

Initial parameter type.

type Message = ()

The input message type to update.

fn init( init: <CheckBox as Component>::Init<'_>, _sender: &ComponentSender<CheckBox>, ) -> CheckBox

Create the initial component.

async fn start(&mut self, sender: &ComponentSender<CheckBox>) -> !

Start the event listening.

async fn update( &mut self, _message: <CheckBox as Component>::Message, _sender: &ComponentSender<CheckBox>, ) -> bool

Respond to the message.

fn render(&mut self, _sender: &ComponentSender<CheckBox>)

Render the widgets.

impl Debug for CheckBox

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Enable for CheckBox

fn is_enabled(&self) -> bool

If the widget is enabled.

fn set_enabled(&mut self, v: bool)

Set if the widget is enabled.

fn enable(&mut self)

Enable the widget.

fn disable(&mut self)

Disable the widget.

impl Layoutable for CheckBox

fn loc(&self) -> Point2D<f64, LogicalSpace>

The left top location.

fn set_loc(&mut self, p: Point2D<f64, LogicalSpace>)

Move the location.

fn size(&self) -> Size2D<f64, LogicalSpace>

The size.

fn set_size(&mut self, v: Size2D<f64, LogicalSpace>)

Resize.

fn preferred_size(&self) -> Size2D<f64, LogicalSpace>

The preferred size.

fn rect(&self) -> Rect<f64, LogicalSpace>

The bounding rectangle.

fn set_rect(&mut self, r: Rect<f64, LogicalSpace>)

Set the location and size.

fn min_size(&self) -> Size2D<f64, LogicalSpace>

Min acceptable size.

impl Visible for CheckBox

fn is_visible(&self) -> bool

If the widget is visible.

fn set_visible(&mut self, v: bool)

Set the visibility.

fn show(&mut self)

Show the widget.

fn hide(&mut self)

Hide the widget.