Struct cursive_core::views::Checkbox

pub struct Checkbox { /* private fields */ }

Checkable box.

Examples

use cursive::traits::Nameable;
use cursive::views::Checkbox;

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) -> Self

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) -> Self

Enable or disable this view.

Chainable variant.

pub fn is_enabled(&self) -> bool

Returns true if this view is enabled.

pub fn new() -> Self

Creates a new, unchecked checkbox.

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

Sets a callback to be used when the state changes.

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

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) -> Self

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) -> Self

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) -> Self

Set the checkbox state.

Chainable variant.

Trait Implementations

impl Default for Checkbox

fn default() -> Self

Returns the “default value” for a type.

impl View for Checkbox

fn required_size(&mut self, _: Vec2) -> Vec2

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

fn take_focus(&mut self, _: Direction) -> Result<EventResult, CannotFocus>

Attempt to give this view the focus.

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

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

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

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

fn layout(&mut self, _: Vec2)

Called once the size for this view has been decided.

fn needs_relayout(&self) -> bool

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

fn call_on_any<'a>(&mut self, _: &Selector<'_>, _: AnyCb<'a>)

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

fn focus_view(&mut self, _: &Selector<'_>) -> Result<EventResult, ViewNotFound>

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

fn important_area(&self, view_size: Vec2) -> Rect

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

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

Returns the type of this view.