Struct rat_ftable::FTableState

pub struct FTableState<Selection> {

    pub area: Rect,
    pub header_area: Rect,
    pub table_area: Rect,
    pub row_areas: Vec<Rect>,
    pub column_areas: Vec<Rect>,
    pub footer_area: Rect,
    pub rows: usize,
    pub columns: usize,
    pub row_offset: usize,
    pub col_offset: usize,
    pub row_page_len: usize,
    pub col_page_len: usize,
    pub max_row_offset: usize,
    pub max_col_offset: usize,
    pub selection: Selection,
    pub mouse: MouseFlags,
    pub non_exhaustive: NonExhaustive,
}

FTable state.

Fields

area: Rect

Total area.

header_area: Rect

Total header area.

table_area: Rect

Total table area.

row_areas: Vec<Rect>

Area per visible row.

column_areas: Vec<Rect>

Area per visible column, also contains the following spacer if any.

footer_area: Rect

Total footer area.

rows: usize

Row count.

columns: usize

Column count.

row_offset: usize

Current row offset. Automatically capped at rows-1.

col_offset: usize

Current column offset. Automatically capped at columns-1.

row_page_len: usize

Current page len as items.

col_page_len: usize

Current page width as columns.

max_row_offset: usize

Maximum offset for row-scrolling. Can be set higher, but this offset guarantees a full page display.

max_col_offset: usize

Maximum offset for column-scrolling. Can be set higher, but this offset guarantees a full page display.

selection: Selection

Selection data.

mouse: MouseFlags

Helper for mouse interactions.

non_exhaustive: NonExhaustive

Implementations

impl<Selection: TableSelection> FTableState<Selection>

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

Cell at given position.

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

Column at given position.

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

Row at given position.

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

Cell when dragging. Can go outside the area.

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

Row when dragging. Can go outside the area.

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

Column when dragging. Can go outside the area.

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

Change the vertical offset. Returns true, if there was some change to the offset, even if clipped.

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

Change the horizontal offset. Returns true, if there was some change to the offset, even if clipped.

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

Scroll up by n items.

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

Scroll down by n items.

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

Scroll up by n items.

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

Scroll down by n items.

pub fn scroll_to_selected(&mut self)

Scroll to selected.

impl FTableState<RowSelection>

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

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

pub fn select_clamped(&mut self, select: usize, maximum: usize)

Select a row, clamp between 0 and maximum.

impl FTableState<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.

impl FTableState<CellSelection>

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

Selected cell.

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

Select a cell.

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

Select a row. Column stays the same.

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

Select a column, row stays the same.

pub fn select_clamped( &mut self, select: (usize, usize), maximum: (usize, usize) )

Select a cell, clamp between 0 and maximum.

Trait Implementations

impl<Selection: Clone> Clone for FTableState<Selection>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Selection: Debug> Debug for FTableState<Selection>

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

Formats the value using the given formatter.

impl<Selection: Default> Default for FTableState<Selection>

fn default() -> Self

Returns the “default value” for a type.

impl HandleEvent<Event, FocusKeys, Outcome> for FTableState<CellSelection>

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

Handle an event.

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

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

Handle an event.

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

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

Handle an event.

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

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

Handle an event.

impl HandleEvent<Event, MouseOnly, Outcome> for FTableState<CellSelection>

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

Handle an event.

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

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

Handle an event.

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

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

Handle an event.

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

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

Handle an event.