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 base_column_areas: Vec<Rect>,
    pub footer_area: Rect,
    pub rows: usize,
    pub _counted_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. Good for click-hit checks.

base_column_areas: Vec<Rect>

Area for each defined column without the spacer. Columns not visible will have width 0.

footer_area: Rect

Total footer area.

rows: usize

Row count.

_counted_rows: usize

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

pub fn rows(&self) -> usize

Number of rows.

pub fn columns(&self) -> usize

Number of columns.

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

Returns the whole row-area and the cell-areas for the given row, if it is visible.

Attention: These areas might be 0-length if the column is scrolled beyond the table-area.

See: FTableState::scroll_to

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 clear_offset(&mut self)

Sets both offsets to 0.

impl<Selection: TableSelection> FTableState<Selection>

pub fn scroll_to_selected(&mut self)

Scroll to selected.

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

Scroll to position.

impl<Selection: TableSelection> FTableState<Selection>

pub fn vertical_max_offset(&self) -> usize

Maximum offset that is accessible with scrolling.

This is shorter than the length of the content by whatever fills the last page. This is the base for the scrollbar content_length.

pub fn vertical_offset(&self) -> usize

Current vertical offset.

pub fn vertical_page(&self) -> usize

Vertical page-size at the current offset.

pub fn vertical_scroll(&self) -> usize

Suggested scroll per scroll-event.

pub fn horizontal_max_offset(&self) -> usize

Maximum offset that is accessible with scrolling.

This is shorter than the length of the content by whatever fills the last page. This is the base for the scrollbar content_length.

pub fn horizontal_offset(&self) -> usize

Current horizontal offset.

pub fn horizontal_page(&self) -> usize

Horizontal page-size at the current offset.

pub fn horizontal_scroll(&self) -> usize

Suggested scroll per scroll-event.

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

Change the vertical offset.

Due to overscroll it’s possible that this is an invalid offset for the widget. The widget must deal with this situation.

The widget returns true if the offset changed at all.

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

Change the horizontal offset.

Due to overscroll it’s possible that this is an invalid offset for the widget. The widget must deal with this situation.

The widget returns true if the offset changed at all.

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

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

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

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

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

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

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

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

impl FTableState<RowSelection>

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

Scroll selection instead of offset.

pub fn scroll_selection(&self) -> bool

Scroll selection instead of offset.

pub fn clear(&mut self)

Clear offsets and selection.

pub fn clear_selection(&mut self)

pub fn has_selection(&mut self) -> bool

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 clear(&mut self)

Clear offsets and selection.

pub fn clear_selection(&mut self)

Clear the selection.

pub fn has_selection(&mut self) -> bool

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 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 clear(&mut self)

Clear offsets and selection.

pub fn clear_selection(&mut self)

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

Selected cell.

pub fn has_selection(&mut self) -> bool

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

Select a cell.

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

Select a row. Column stays the same.

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

Select a column, row stays the same.

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

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<Selection> HandleEvent<Event, DoubleClick, DoubleClickOutcome> for FTableState<Selection>

fn handle(&mut self, event: &Event, _keymap: DoubleClick) -> DoubleClickOutcome

Handles double-click events on the table.

impl<Selection: TableSelection> HandleEvent<Event, EditKeys, EditOutcome> for FTableState<Selection>

where Self: HandleEvent<Event, FocusKeys, Outcome>,

fn handle(&mut self, event: &Event, _keymap: EditKeys) -> EditOutcome

Handle an event.

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.