Struct ListState 

pub struct ListState<Selection> {
    pub area: Rect,
    pub inner: Rect,
    pub row_areas: Vec<Rect>,
    pub rows: usize,
    pub scroll: ScrollState,
    pub focus: FocusFlag,
    pub selection: Selection,
    pub mouse: MouseFlags,
}

State & event handling.

Fields

area: Rect

Total area readonly. renewed for each render.

inner: Rect

Area inside the block. readonly. renewed for each render.

row_areas: Vec<Rect>

Areas for the rendered items. readonly. renewed for each render.

rows: usize

Length in items. mostly readonly. renewed for each render.

scroll: ScrollState

Offset etc. read+write

focus: FocusFlag

Focus read+write

selection: Selection

Selection model read+write

mouse: MouseFlags

Helper for mouse events. used for mouse interaction

Implementations

impl<Selection: ListSelection> ListState<Selection>

pub fn new() -> Self

where Selection: Default,

New initial state.

pub fn named(name: &str) -> Self

where Selection: Default,

New state with a focus name

pub fn rows(&self) -> usize

pub fn clear_offset(&mut self)

pub fn max_offset(&self) -> usize

pub fn set_max_offset(&mut self, max: usize)

pub fn offset(&self) -> usize

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

pub fn page_len(&self) -> usize

pub fn scroll_by(&self) -> usize

pub fn scroll_to_selected(&mut self) -> bool

Scroll to selected.

pub fn scroll_to(&mut self, pos: usize) -> bool

pub fn scroll_up(&mut self, n: usize) -> bool

pub fn scroll_down(&mut self, n: usize) -> bool

impl<Selection: ListSelection> ListState<Selection>

pub fn row_area(&self, row: usize) -> Option<Rect>

Returns the row-area for the given row, if it is visible.

pub fn row_at_clicked(&self, pos: (u16, u16)) -> Option<usize>

pub fn row_at_drag(&self, pos: (u16, u16)) -> usize

Row when dragging. Can go outside the area.

impl ListState<RowSelection>

pub fn items_added(&mut self, pos: usize, n: usize)

Update the state to match adding items.

This corrects the number of rows, offset and selection.

pub fn items_removed(&mut self, pos: usize, n: usize)

Update the state to match removing items.

This corrects the number of rows, offset and selection.

pub fn set_scroll_selection(&mut self, scroll: bool)

When scrolling the table, change the selection instead of the offset.

pub fn clear_selection(&mut self)

Clear the selection.

pub fn has_selection(&mut self) -> bool

Anything selected?

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

Returns the lead selection.

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

Returns the lead selection. Ensures the index is less than rows.

pub fn select(&mut self, row: Option<usize>) -> bool

pub fn move_to(&mut self, row: usize) -> bool

Move the selection to the given row. Limits the movement to the row-count. Ensures the row is visible afterwards.

pub fn move_up(&mut self, n: usize) -> bool

Move the selection up n rows. Ensures the row is visible afterwards.

pub fn move_down(&mut self, n: usize) -> bool

Move the selection down n rows. Ensures the row is visible afterwards.

impl ListState<RowSetSelection>

pub fn clear_selection(&mut self)

Clear the selection.

pub fn has_selection(&mut self) -> bool

Anything selected?

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

pub fn set_lead(&mut self, row: Option<usize>, extend: bool) -> bool

Change the lead-selection. Limits the value to the number of rows. If extend is false the current selection is cleared and both lead and anchor are set to the given value. If extend is true, the anchor is kept where it is and lead is changed. Everything in the range anchor..lead is selected. It doesn’t matter if anchor < lead.

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

Current lead.

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

Current anchor.

pub fn set_lead_clamped(&mut self, lead: usize, max: usize, extend: bool)

Set a new lead, at the same time limit the lead to max.

pub fn retire_selection(&mut self)

Retire the current anchor/lead selection to the set of selected rows. Resets lead and anchor and starts a new selection round.

pub fn add_selected(&mut self, idx: usize)

Add to selection.

pub fn remove_selected(&mut self, idx: usize)

Remove from selection. Only works for retired selections, not for the active anchor-lead range.

pub fn move_to(&mut self, row: usize, extend: bool) -> bool

Move the selection to the given row. Ensures the row is visible afterwards.

pub fn move_up(&mut self, n: usize, extend: bool) -> bool

Move the selection up n rows. Ensures the row is visible afterwards.

pub fn move_down(&mut self, n: usize, extend: bool) -> bool

Move the selection down n rows. Ensures the row is visible afterwards.

Trait Implementations

impl<Selection: Clone> Clone for ListState<Selection>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Selection: Debug> Debug for ListState<Selection>

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

Formats the value using the given formatter.

impl<Selection: Default> Default for ListState<Selection>

fn default() -> Self

Returns the “default value” for a type.

impl HandleEvent<Event, MouseOnly, Outcome> for ListState<NoSelection>

fn handle(&mut self, event: &Event, _keymap: MouseOnly) -> Outcome

Handle an event.

impl HandleEvent<Event, MouseOnly, Outcome> for ListState<RowSelection>

fn handle(&mut self, event: &Event, _keymap: MouseOnly) -> Outcome

Handle an event.

impl HandleEvent<Event, MouseOnly, Outcome> for ListState<RowSetSelection>

fn handle(&mut self, event: &Event, _: MouseOnly) -> Outcome

Handle an event.

impl HandleEvent<Event, Regular, Outcome> for ListState<NoSelection>

fn handle(&mut self, event: &Event, _keymap: Regular) -> Outcome

Handle an event.

impl HandleEvent<Event, Regular, Outcome> for ListState<RowSelection>

fn handle(&mut self, event: &Event, _keymap: Regular) -> Outcome

Handle an event.

impl HandleEvent<Event, Regular, Outcome> for ListState<RowSetSelection>

fn handle(&mut self, event: &Event, _: Regular) -> Outcome

Handle an event.

impl<Selection> HasFocus for ListState<Selection>

fn build(&self, builder: &mut FocusBuilder)

Build the focus-structure for the container.

fn focus(&self) -> FocusFlag

Access to the flag for the rest.

fn area(&self) -> Rect

Area for mouse focus.

fn id(&self) -> usize

Provide a unique id for the widget.

fn area_z(&self) -> u16

Z value for the area.

fn navigable(&self) -> Navigation

Declares how the widget interacts with focus.

fn is_focused(&self) -> bool

Focused?

fn lost_focus(&self) -> bool

Just lost focus.

fn gained_focus(&self) -> bool

Just gained focus.

impl<Selection: PartialEq> PartialEq for ListState<Selection>

fn eq(&self, other: &ListState<Selection>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Selection> RelocatableState for ListState<Selection>

fn relocate(&mut self, shift: (i16, i16), clip: Rect)

Relocate the areas in this widgets state.

fn relocate_hidden(&mut self)

Relocate all areas to a clip-rect (0,0+0x0).

impl<Selection: Eq> Eq for ListState<Selection>

impl<Selection> StructuralPartialEq for ListState<Selection>