Struct Select

pub struct Select<L> {
    pub list: L,
    /* private fields */
}

A widget to select a single item from a list.

The list must implement the List trait.

Fields

list: L

The underlying list

Implementations

impl<L: List> Select<L>

pub fn new(list: L) -> Self

Creates a new Select.

Panics

Panics if there are no selectable items, or if list.page_size() is less than 5.

pub fn get_at(&self) -> usize

The index of the element that is currently being hovered.

pub fn set_at(&mut self, at: usize)

Set the index of the element that is currently being hovered.

at can be any number (even beyond list.len()), but the caller is responsible for making sure that it is a selectable element.

pub fn into_inner(self) -> L

Consumes the Select returning the original list.

impl<L: Index<usize>> Select<L>

pub fn selected(&self) -> &L::Output

Returns a reference to the currently hovered item.

impl<L: IndexMut<usize>> Select<L>

pub fn selected_mut(&mut self) -> &mut L::Output

Returns a mutable reference to the currently hovered item.

Trait Implementations

impl<L: Clone> Clone for Select<L>

fn clone(&self) -> Select<L>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<L: Debug> Debug for Select<L>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<L: List> Widget for Select<L>

fn cursor_pos(&mut self, layout: Layout) -> (u16, u16)

Returns the starting location of the layout. It should not be relied upon for a sensible cursor position.

fn handle_key(&mut self, key: KeyEvent) -> bool

Handle a key input. It should return whether key was handled.

fn render<B: Backend>(&mut self, layout: &mut Layout, b: &mut B) -> Result<()>

Render to a given backend.

fn height(&mut self, layout: &mut Layout) -> u16

The number of rows of the terminal the widget will take when rendered.