Struct rat_widget::list::RListState

pub struct RListState<Selection> {
    pub len: usize,
    pub v_offset: usize,
    pub v_max_offset: usize,
    pub v_page_len: usize,
    pub area: Rect,
    pub inner: Rect,
    pub item_areas: Vec<Rect>,
    pub focus: FocusFlag,
    pub selection: Selection,
    pub mouse: MouseFlags,
}

Fields

len: usize

Length in items.

v_offset: usize

Offset

v_max_offset: usize

Max offset for full page.

v_page_len: usize

Page length

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 with_offset(self, offset: usize) -> Self

pub fn offset(&self) -> usize

pub fn offset_mut(&mut self) -> &mut usize

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

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

Row when dragging. Can go outside the area.

pub fn scroll_to_selected(&mut self)

Scroll to selected.

pub fn selection(&self) -> &Selection

pub fn selection_mut(&mut self) -> &mut Selection

impl RListState<RowSelection>

pub fn with_selected(self, selected: Option<usize>) -> Self

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

Returns the lead selection.

pub fn selected_mut(&mut self) -> &mut Option<usize>

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

impl RListState<RowSetSelection>

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

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

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 lead(&self) -> Option<usize>

Current lead.

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

Current anchor.

pub fn clear_selection(&mut self)

Clear the selection.

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.

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

fn vertical_max_offset(&self) -> usize

Maximum offset that is accessible with scrolling.

fn vertical_offset(&self) -> usize

Current vertical offset.

fn vertical_page(&self) -> usize

Vertical page-size at the current offset.

fn horizontal_max_offset(&self) -> usize

Maximum offset that is accessible with scrolling.

fn horizontal_offset(&self) -> usize

Current horizontal offset.

fn horizontal_page(&self) -> usize

Horizontal page-size at the current offset.

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

Change the vertical offset.

fn set_horizontal_offset(&mut self, _offset: usize) -> bool

Change the horizontal offset.

fn vertical_scroll(&self) -> usize

Suggested scroll per scroll-event.

fn horizontal_scroll(&self) -> usize

Suggested scroll per scroll-event.

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

Scroll up by n items. The widget returns true if the offset changed at all.

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

Scroll down by n items. The widget returns true if the offset changed at all.

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

Scroll up by n items. The widget returns true if the offset changed at all.

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

Scroll down by n items. The widget returns true if the offset changed at all.

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

impl<Selection> StructuralPartialEq for RListState<Selection>