Struct rat_widget::list::RListState

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

Fields

rows: usize

Length in items.

scroll: ScrollState

Offset

area: Rect

Total area

inner: Rect

Area inside the block.

item_areas: Vec<Rect>

Areas for the rendered items.

focus: FocusFlag

Focus

selection: Selection

Selection model

mouse: MouseFlags

Helper for mouse events.

Implementations

impl<Selection: ListSelection> RListState<Selection>

pub fn clear_offset(&mut self)

pub fn max_offset(&self) -> 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> RListState<Selection>

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 RListState<RowSelection>

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 select(&mut self, row: Option<usize>) -> bool

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

Move the selection to the given row. 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 RListState<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 RListState<Selection>

fn clone(&self) -> RListState<Selection>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Selection: Debug> Debug for RListState<Selection>

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

Formats the value using the given formatter.

impl<Selection: Default> Default for RListState<Selection>

fn default() -> RListState<Selection>

Returns the “default value” for a type.

impl HandleEvent<Event, FocusKeys, Outcome> for RListState<NoSelection>

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

Handle an event.

impl HandleEvent<Event, FocusKeys, Outcome> for RListState<RowSelection>

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

Handle an event.

impl HandleEvent<Event, FocusKeys, Outcome> for RListState<RowSetSelection>

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

Handle an event.

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

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

Handle an event.

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

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

Handle an event.

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

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

Handle an event.

impl<Selection> HasFocusFlag for RListState<Selection>

fn focus(&self) -> &FocusFlag

Access to the flag for the rest.

fn area(&self) -> Rect

Access the area for mouse focus.

fn z_areas(&self) -> &[ZRect]

The widget might have several disjointed areas. This is the case if it is showing a popup, but there might be other causes.

fn navigable(&self) -> bool

If the widget is focusable, but doesn’t want to partake in keyboard navigation it returns false here.

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 RListState<Selection>

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<Selection: Eq> Eq for RListState<Selection>

impl<Selection> StructuralPartialEq for RListState<Selection>