Struct cursive::views::SelectView

pub struct SelectView<T = String> {
    // some fields omitted
}

View to select an item among a list.

It contains a list of values of type T, with associated labels.

Examples

let mut time_select = SelectView::new().h_align(HAlign::Center);
time_select.add_item("Short", 1);
time_select.add_item("Medium", 5);
time_select.add_item("Long", 10);

time_select.set_on_submit(|s, time| {
    s.pop_layer();
    let text = format!("You will wait for {} minutes...", time);
    s.add_layer(Dialog::new(TextView::new(text))
                    .button("Quit", |s| s.quit()));
});

let mut siv = Cursive::new();
siv.add_layer(Dialog::new(time_select)
                .title("How long is your wait?"));

Methods

impl<T: 'static> SelectView<T>

fn new() -> Self

Creates a new empty SelectView.

fn popup(self) -> Self

Turns self into a popup select view.

Chainable variant.

fn set_popup(&mut self, popup: bool)

Turns self into a popup select view.

fn disable(&mut self)

Disables this view.

A disabled view cannot be selected.

fn disabled(self) -> Self

Disables this view.

Chainable variant.

fn enable(&mut self)

Re-enables this view.

fn set_enabled(&mut self, enabled: bool)

Enable or disable this view.

fn is_enabled(&self) -> bool

Returns true if this view is enabled.

fn set_on_select<F>(&mut self, cb: F) where F: Fn(&mut Cursive, &T) + 'static

Sets a callback to be used when an item is selected.

fn on_select<F>(self, cb: F) -> Self where F: Fn(&mut Cursive, &T) + 'static

Sets a callback to be used when an item is selected.

Chainable variant.

fn set_on_submit<F>(&mut self, cb: F) where F: Fn(&mut Cursive, &T) + 'static

Sets a callback to be used when <Enter> is pressed.

The item currently selected will be given to the callback.

fn on_submit<F>(self, cb: F) -> Self where F: Fn(&mut Cursive, &T) + 'static

Sets a callback to be used when <Enter> is pressed.

The item currently selected will be given to the callback.

Chainable variant.

fn align(self, align: Align) -> Self

Sets the alignment for this view.

fn v_align(self, v: VAlign) -> Self

Sets the vertical alignment for this view. (If the view is given too much space vertically.)

fn h_align(self, h: HAlign) -> Self

Sets the horizontal alignment for this view.

fn selection(&self) -> Rc<T>

Returns the value of the currently selected item.

Panics if the list is empty.

fn add_item<S: Into<String>>(&mut self, label: S, value: T)

Adds a item to the list, with given label and value.

fn remove_item(&mut self, id: usize)

Removes an item from the list.

fn item<S: Into<String>>(self, label: S, value: T) -> Self

Chainable variant of add_item

fn add_all<S, I>(&mut self, iter: I) where S: Into<String>, I: IntoIterator<Item=(S, T)>

Adds all items from from an iterator.

fn with_all<S, I>(self, iter: I) -> Self where S: Into<String>, I: IntoIterator<Item=(S, T)>

Adds all items from from an iterator.

Chainable variant.

fn selected_id(&self) -> Option<usize>

Returns the id of the item currently selected.

Returns None if the list is empty.

fn len(&self) -> usize

Returns the number of items in this list.

impl SelectView<String>

fn add_item_str<S: Into<String>>(&mut self, label: S)

Convenient method to use the label as value.

fn item_str<S: Into<String>>(self, label: S) -> Self

Chainable variant of add_item_str

fn add_all_str<S, I>(&mut self, iter: I) where S: Into<String>, I: IntoIterator<Item=S>

Adds all strings from an iterator.

Examples

let mut select_view = SelectView::new();
select_view.add_all_str(vec!["a", "b", "c"]);

fn with_all_str<S, I>(self, iter: I) -> Self where S: Into<String>, I: IntoIterator<Item=S>

Adds all strings from an iterator.

Chainable variant.

Trait Implementations

impl<T: 'static> View for SelectView<T>

fn draw(&self, printer: &Printer)

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

fn get_min_size(&mut self, req: Vec2) -> Vec2

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

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

Called when a key was pressed. Default implementation just ignores it.

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

This view is offered focus. Will it take it?

fn layout(&mut self, size: Vec2)

Called once the size for this view has been decided,

fn needs_relayout(&self) -> bool

Returns true if the view content changed since last layout phase.

fn find(&mut self, &Selector) -> Option<&mut Any>

Finds the view pointed to by the given path.