Struct ListState 

pub struct ListState { /* private fields */ }

A cursor over a list of rows, the first row shown, and a selection.

Rows are positions in what is listed (after filtering, say); the selection is kept by index, whatever the caller’s indices are (an item’s index before filtering), so marks survive a change of filter. Movement takes the page, the rows on screen, since that can change with every render.

Implementations

impl ListState

pub fn new() -> ListState

pub fn len(&self) -> usize

How many rows there are.

pub fn is_empty(&self) -> bool

pub fn set_len(&mut self, len: usize)

Set the number of rows. The cursor is left where it is: call reset or set_cursor to put it on a row that exists.

pub fn cursor(&self) -> usize

The row the cursor is on.

pub fn set_cursor(&mut self, row: usize)

Put the cursor on row, without scrolling (see follow).

pub fn offset(&self) -> usize

The first row shown.

pub fn set_offset(&mut self, offset: usize)

pub fn reset(&mut self, row: usize, page: usize)

Put the cursor on row and the first row shown back at the top, then scroll just enough to show the cursor: after the rows changed.

pub fn follow(&mut self, page: usize)

Scroll just enough that the cursor’s row is among the page shown.

pub fn step(&mut self, delta: isize, page: usize)

Move the cursor by delta rows (negative: up), stopping at the ends, and scroll to follow it. Nothing happens with no rows.

pub fn select_row(&mut self, row: usize, page: usize)

Move to row (clamped to the last) and scroll to show it.

pub fn visible(&self, page: usize) -> Range<usize>

The rows shown on a page of page rows.

pub fn clear_selection(&mut self, count: usize)

Make room to select count indices, all unselected.

pub fn is_selected(&self, index: usize) -> bool

pub fn set_selected(&mut self, index: usize, on: bool)

Select or unselect index; indices past the room made are grown to.

pub fn toggle(&mut self, index: usize)

Flip whether index is selected.

pub fn selected(&self) -> Vec<usize>

The selected indices, in order.

pub fn selected_count(&self) -> usize

How many indices are selected.

Trait Implementations

impl Clone for ListState

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListState

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

Formats the value using the given formatter.

impl Default for ListState

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ListState

impl PartialEq for ListState

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ListState