Struct CheckBox 

pub struct CheckBox { /* private fields */ }

Available on crate feature winio only.

A simple check box.

Implementations

impl CheckBox

pub fn is_checked(&self) -> Result<bool, Error>

If the box is checked.

Examples found in repository

examples/options/options.rs (line 110)

    async fn update(
        &mut self,
        message: Self::Message,
        sender: &ComponentSender<Self>,
    ) -> Result<bool, Self::Error> {
        // futures_util::join!(self.window.update());
        Ok(match message {
            MainMessage::Noop => false,
            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::Redraw => true,
                    OptionsPageMessage::Close => {
                        sender.output(());
                        false
                    }
                    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 185)

    async fn update(
        &mut self,
        message: Self::Message,
        sender: &ComponentSender<Self>,
    ) -> Result<bool, Self::Error> {
        // futures_util::future::join(self.window.update(), self.canvas.update()).await;
        Ok(match message {
            MainMessage::Noop => false,
            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(self.radio_group[self.rindex].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)
                    // https://github.com/compio-rs/winio/issues/105
                    .show(unsafe { BorrowedWindow::win32(self.window.as_container().as_win32()) })
                    .await;
                false
            }
            MainMessage::OptionsPage(m) => {
                tracing::debug!(?m, "Options page message");
                match m {
                    OptionsPageMessage::Redraw => true,
                    OptionsPageMessage::Close => {
                        sender.output(());
                        false
                    }
                    OptionsPageMessage::Save(config, tx) => {
                        config.s = self.mltext.text()?;
                        tx.send(config).unwrap();
                        false
                    }
                }
            }
        })
    }

pub fn set_checked(&mut self, v: bool) -> Result<(), Error>

Set the checked state.

Examples found in repository

examples/options/options.rs (line 61)

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

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

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

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

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

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

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

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

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

        sender.post(MainMessage::EnabledClick);

        window.show();

        Ok(Self {
            window,
            enabled,
            b,
            s_label,
            s,
            e_label,
            e,
        })
    }

examples/test/widgets.rs (line 91)

    async fn init(
        mut init: Self::Init<'_>,
        sender: &ComponentSender<Self>,
    ) -> Result<Self, Self::Error> {
        // let mut window = Child::<Window>::init(init);
        let mut window = init.window(sender).await?;
        // window.set_text("Widgets example");
        window.set_size(Size::new(800.0, 600.0));

        let canvas = Child::<Canvas>::init(&window).await?;
        let mut ulabel = Child::<Label>::init(&window).await?;
        ulabel.set_text("Username:");
        ulabel.set_halign(HAlign::Right);
        let mut plabel = Child::<Label>::init(&window).await?;
        plabel.set_text("Password:");
        plabel.set_halign(HAlign::Right);
        let mut uentry = Child::<Edit>::init(&window).await?;
        uentry.set_text("AAA");
        let mut pentry = Child::<Edit>::init(&window).await?;
        pentry.set_text("123456");
        pentry.set_password(true);
        let mut pcheck = Child::<CheckBox>::init(&window).await?;
        pcheck.set_text("Show");
        pcheck.set_checked(false);
        let combo = Child::<ComboBox>::init(&window).await?;
        let mut list = Child::<ObservableVec<String>>::init(Vec::new())
            .await
            .unwrap();
        // https://www.zhihu.com/question/23600507/answer/140640887
        list.push("烫烫烫".to_string());
        list.push("昍昍昍".to_string());
        list.push("ﾌﾌﾌﾌﾌﾌ".to_string());
        list.push("쳌쳌쳌".to_string());
        let mut r1 = Child::<RadioButton>::init(&window).await?;
        r1.set_text("屯屯屯");
        r1.set_checked(true);
        let mut r2 = Child::<RadioButton>::init(&window).await?;
        r2.set_text("锟斤拷");
        let mut r3 = Child::<RadioButton>::init(&window).await?;
        r3.set_text("╠╠╠");
        // Initialize radio group with the radio buttons
        let radio_group = Child::<RadioButtonGroup>::init(vec![r1, r2, r3]).await?;

        let mut push_button = Child::<Button>::init(&window).await?;
        push_button.set_text("Push");
        let mut pop_button = Child::<Button>::init(&window).await?;
        pop_button.set_text("Pop");
        let mut show_button = Child::<Button>::init(&window).await?;
        show_button.set_text("Show");
        let mut progress = Child::<Progress>::init(&window).await?;
        progress.set_indeterminate(true);
        let mut mltext = Child::<TextBox>::init(&window).await?;
        HANDLER.with_app(|a| mltext.set_text(&a.config().s));

        window.show();

        Ok(Self {
            window,
            ulabel,
            plabel,
            uentry,
            pentry,
            pcheck,
            canvas,
            combo,
            list,
            index: None,
            radio_group,
            rindex: 0,
            push_button,
            pop_button,
            show_button,
            progress,
            mltext,
        })
    }

Trait Implementations

impl AsWidget for CheckBox

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

Get the widget handle.

impl Component for CheckBox

type Error = Error

The error type.

type Event = CheckBoxEvent

The output event type to the parent.

type Init<'a> = BorrowedContainer<'a>

Initial parameter type.

type Message = CheckBoxMessage

The input message type to update.

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

Create the initial component.

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

Start the event listening.

async fn update( &mut self, message: Self::Message, sender: &ComponentSender<Self>, ) -> Result<bool, Self::Error>

Respond to the message. Return true if need render.

fn render(&mut self, sender: &ComponentSender<Self>) -> Result<(), Self::Error>

Render the widgets.

async fn update_children(&mut self) -> Result<bool, Self::Error>

Update the children components. Return true if any child needs render.

fn render_children(&mut self) -> Result<(), Self::Error>

Render the children components. It will be called if any child or self needs render.

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) -> Result<bool, Error>

If the widget is enabled.

fn set_enabled(&mut self, v: bool) -> Result<(), Error>

Set if the widget is enabled.

fn enable(&mut self) -> Result<(), Self::Error>

Enable the widget.

fn disable(&mut self) -> Result<(), Self::Error>

Disable the widget.

impl Failable for CheckBox

type Error = Error

The error type associated.

impl Layoutable for CheckBox

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

The left top location.

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

Move the location.

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

The size.

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

Resize.

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

The preferred size.

fn rect(&self) -> Result<Rect<f64, LogicalSpace>, Self::Error>

The bounding rectangle.

fn set_rect(&mut self, r: Rect<f64, LogicalSpace>) -> Result<(), Self::Error>

Set the location and size.

fn min_size(&self) -> Result<Size2D<f64, LogicalSpace>, Self::Error>

Min acceptable size.

impl TextWidget for CheckBox

fn text(&self) -> Result<String, Error>

Get the text of the widget.

fn set_text(&mut self, s: impl AsRef<str>) -> Result<(), Error>

Set the text of the widget.

impl ToolTip for CheckBox

fn tooltip(&self) -> Result<String, Error>

Get the tooltip text of the widget.

fn set_tooltip(&mut self, s: impl AsRef<str>) -> Result<(), Error>

Set the tooltip text of the widget.

impl Visible for CheckBox

fn is_visible(&self) -> Result<bool, Error>

If the widget is visible.

fn set_visible(&mut self, v: bool) -> Result<(), Error>

Set the visibility.

fn show(&mut self) -> Result<(), Self::Error>

Show the widget.

fn hide(&mut self) -> Result<(), Self::Error>

Hide the widget.