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.

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

Set the checked state.

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.