Struct dialoguer::Checkboxes

pub struct Checkboxes<'a> { /* fields omitted */ }

Renders a multi select checkbox menu.

Methods

impl<'a> Checkboxes<'a>

pub fn new() -> Checkboxes<'static>

Creates a new checkbox object.

pub fn with_theme(theme: &'a dyn Theme) -> Checkboxes<'a>

Sets a theme other than the default one.

pub fn paged(&mut self, val: bool) -> &mut Checkboxes<'a>

Enables or disables paging

pub fn clear(&mut self, val: bool) -> &mut Checkboxes<'a>

Sets the clear behavior of the checkbox menu.

The default is to clear the checkbox menu.

pub fn defaults(&mut self, val: &[bool]) -> &mut Checkboxes<'a>

Sets a defaults for the menu

pub fn item(&mut self, item: &str) -> &mut Checkboxes<'a>

Add a single item to the selector.

pub fn item_checked(&mut self, item: &str, checked: bool) -> &mut Checkboxes<'a>

Add a single item to the selector with a default checked state.

pub fn items<T: ToString>(&mut self, items: &[T]) -> &mut Checkboxes<'a>

Adds multiple items to the selector.

pub fn items_checked<T: ToString>(
    &mut self,
    items: &[(T, bool)]
) -> &mut Checkboxes<'a>

Adds multiple items to the selector with checked state

pub fn with_prompt(&mut self, prompt: &str) -> &mut Checkboxes<'a>

Prefaces the menu with a prompt.

When a prompt is set the system also prints out a confirmation after the selection.

pub fn interact(&self) -> Result<Vec<usize>>

Enables user interaction and returns the result.

The user can select the items with the space bar and on enter the selected items will be returned.

pub fn interact_on(&self, term: &Term) -> Result<Vec<usize>>

Like interact but allows a specific terminal to be set.

Trait Implementations

impl<'a> Default for Checkboxes<'a>

fn default() -> Checkboxes<'a>

Returns the "default value" for a type.