Struct cursive::views::Checkbox

pub struct Checkbox { /* fields omitted */ }

Checkable box.

Examples

use cursive_core::views::Checkbox;
use cursive_core::traits::Identifiable;

let checkbox = Checkbox::new().checked().with_name("check");

Implementations

impl Checkbox

pub fn disable(&mut self)

Disables this view.

A disabled view cannot be selected.

pub fn disabled(self) -> Checkbox

Disables this view.

Chainable variant.

pub fn enable(&mut self)

Re-enables this view.

pub fn set_enabled(&mut self, enabled: bool)

Enable or disable this view.

pub fn with_enabled(self, is_enabled: bool) -> Checkbox

Enable or disable this view.

Chainable variant.

pub fn is_enabled(&self) -> bool

Returns true if this view is enabled.

pub fn new() -> Checkbox

Creates a new, unchecked checkbox.

pub fn set_on_change<F>(&mut self, on_change: F) where
    F: 'static + Fn(&mut Cursive, bool), 

Sets a callback to be used when the state changes.

pub fn on_change<F>(self, on_change: F) -> Checkbox where
    F: 'static + Fn(&mut Cursive, bool), 

Sets a callback to be used when the state changes.

Chainable variant.

pub fn toggle(&mut self) -> EventResult

Toggles the checkbox state.

pub fn check(&mut self) -> EventResult

Check the checkbox.

pub fn checked(self) -> Checkbox

Check the checkbox.

Chainable variant.

pub fn is_checked(&self) -> bool

Returns true if the checkbox is checked.

Examples

use cursive_core::views::Checkbox;

let mut checkbox = Checkbox::new().checked();
assert!(checkbox.is_checked());

checkbox.uncheck();
assert!(!checkbox.is_checked());

pub fn uncheck(&mut self) -> EventResult

Uncheck the checkbox.

pub fn unchecked(self) -> Checkbox

Uncheck the checkbox.

Chainable variant.

pub fn set_checked(&mut self, checked: bool) -> EventResult

Sets the checkbox state.

pub fn with_checked(self, is_checked: bool) -> Checkbox

Set the checkbox state.

Chainable variant.

Trait Implementations

impl Default for Checkbox

pub fn default() -> Checkbox

Returns the "default value" for a type.

impl View for Checkbox

pub fn required_size(&mut self, XY<usize>) -> XY<usize>

Returns the minimum size the view requires with the given restrictions.

pub fn take_focus(&mut self, Direction) -> bool

This view is offered focus. Will it take it?

pub fn draw(&self, printer: &Printer<'_, '_>)

Draws the view with the given printer (includes bounds) and focus.

pub fn on_event(&mut self, event: Event) -> EventResult

Called when an event is received (key press, mouse event, ...).

pub fn layout(&mut self, XY<usize>)

Called once the size for this view has been decided.

pub fn needs_relayout(&self) -> bool

Should return true if the view content changed since the last call to layout().

pub fn call_on_any(
    &mut self,
    &Selector<'_>,
    &'a mut (dyn FnMut(&mut (dyn View + 'static)) + 'a)
)

Runs a closure on the view identified by the given selector.

pub fn focus_view(&mut self, &Selector<'_>) -> Result<(), ()>

Moves the focus to the view identified by the given selector.

pub fn important_area(&self, view_size: XY<usize>) -> Rect

What part of the view is important and should be visible?

pub fn type_name(&self) -> &'static str

Returns the type of this view.