Struct SelectionState 

pub struct SelectionState { /* private fields */ }

Cursor and scroll offset for a list of len items.

len is supplied per call rather than stored, so one state can outlive the collection it indexes: filters, reloads, and live updates all change len without invalidating the selection.

Scrolling the selection into view belongs to whoever draws the rows, because only it knows how many fit; ListView writes the window it settled on back through SelectionState::set_offset.

Implementations

impl SelectionState

pub fn new(len: usize) -> Self

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

pub fn offset(&self) -> usize

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

Records the window the rows were actually drawn from, so the next frame scrolls against it and a click hit-tests against the same rows.

pub fn select(&mut self, selected: Option<usize>, len: usize)

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

pub fn select_row(&mut self, visible_row: usize, len: usize)

pub fn set_rows_area(&mut self, area: Rect)

Records where the rows were drawn, so clicks can be mapped back to an index without every caller re-deriving the headers and borders above them. Called from rendering.

pub fn rows_area(&self) -> Rect

Where the rows were last drawn, for hit-testing a click against a pane.

pub fn select_at(&mut self, row: u16, len: usize) -> bool

Selects the row drawn at terminal row, reporting whether one was hit. Rows outside the last drawn area leave the selection alone.

pub fn step( &mut self, len: usize, direction: Direction, selectable: impl Fn(usize) -> bool, )

Wrapping move to the nearest index in direction for which selectable holds. Leaves the selection untouched when no index qualifies, so panes whose rows are a mix of headers and entries never land on a header.

pub fn step_clamped( &mut self, len: usize, direction: Direction, selectable: impl Fn(usize) -> bool, )

Like Self::step, but stops at the ends instead of wrapping. Suits long lists that are scanned rather than cycled.

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

Trait Implementations

impl Clone for SelectionState

fn clone(&self) -> SelectionState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SelectionState

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

Formats the value using the given formatter.

impl Default for SelectionState

fn default() -> SelectionState

Returns the “default value” for a type.

impl Eq for SelectionState

impl PartialEq for SelectionState

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SelectionState