Struct rat_widget::table::TableState

pub struct TableState<Selection> {

    pub focus: FocusFlag,
    pub area: Rect,
    pub inner: Rect,
    pub header_area: Rect,
    pub table_area: Rect,
    pub row_areas: Vec<Rect>,
    pub column_areas: Vec<Rect>,
    pub column_layout: Vec<Rect>,
    pub footer_area: Rect,
    pub rows: usize,
    pub _counted_rows: usize,
    pub columns: usize,
    pub vscroll: ScrollState,
    pub hscroll: ScrollState,
    pub selection: Selection,
    pub mouse: MouseFlags,
    pub non_exhaustive: NonExhaustive,
}

Table state.

Fields

focus: FocusFlag

Current focus state.

area: Rect

Total area.

inner: Rect

Area inside the border and scrollbars

header_area: Rect

Total header area.

table_area: Rect

Total table area.

row_areas: Vec<Rect>

Area per visible row. The first element is at row_offset.

column_areas: Vec<Rect>

Area for each column plus the following spacer if any. Invisible columns have width 0, height is the height of the table_area.

column_layout: Vec<Rect>

Layout areas for each column plus the following spacer if any. Positions are 0-based, y and height are 0.

footer_area: Rect

Total footer area.

rows: usize

Row count.

_counted_rows: usize

columns: usize

Column count.

vscroll: ScrollState

Row scrolling data.

hscroll: ScrollState

Column scrolling data.

selection: Selection

Selection data.

mouse: MouseFlags

Helper for mouse interactions.

non_exhaustive: NonExhaustive

Implementations

impl<Selection> TableState<Selection>

where Selection: Default,

pub fn new() -> TableState<Selection>

pub fn named(name: &str) -> TableState<Selection>

impl<Selection> TableState<Selection>

pub fn rows(&self) -> usize

Number of rows.

pub fn columns(&self) -> usize

Number of columns.

impl<Selection> TableState<Selection>

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.

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

Cell at given position.

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

Column at given position.

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

Row at given position.

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

Cell when dragging. Position can be outside the table area. See row_at_drag, col_at_drag

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

Row when dragging. Position can be outside the table area. If the position is above the table-area this returns offset - #rows. If the position is below the table-area this returns offset + page_len + #rows.

This doesn’t account for the row-height of the actual rows outside the table area, just assumes ‘1’.

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

Column when dragging. Position can be outside the table area. If the position is left of the table area this returns offset - 1. If the position is right of the table area this returns offset + page_width + 1.

impl<Selection> TableState<Selection>

where Selection: TableSelection,

pub fn clear_offset(&mut self)

Sets both offsets to 0.

pub fn row_max_offset(&self) -> usize

Maximum offset that is accessible with scrolling.

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

pub fn row_offset(&self) -> usize

Current vertical offset.

pub fn set_row_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 page_len(&self) -> usize

Vertical page-size at the current offset.

pub fn row_scroll_by(&self) -> usize

Suggested scroll per scroll-event.

pub fn x_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 x_offset(&self) -> usize

Current horizontal offset.

pub fn set_x_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 page_width(&self) -> usize

Horizontal page-size at the current offset.

pub fn x_scroll_by(&self) -> usize

Suggested scroll per scroll-event.

pub fn scroll_to_selected(&mut self) -> bool

Ensures that the selected item is visible. Caveat: This doesn’t work nicely if you have varying row-heights.

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

Ensures that the given row is visible. Caveat: This doesn’t work nicely if you have varying row-heights.

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

Ensures that the given column is completely visible.

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

Ensures that the given cell is visible.

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

Reduce the row-offset by n.

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

Increase the row-offset by n.

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

Reduce the col-offset by n.

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

Increase the col-offset by n.

impl TableState<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>

Selected row.

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

Select the row.

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 TableState<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>

Selected rows.

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 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. Only works for retired selections, not for the active anchor-lead range.

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.

impl TableState<CellSelection>

pub fn clear_selection(&mut self)

pub fn has_selection(&mut self) -> bool

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

Selected cell.

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

Select a cell.

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

Select a row. Column stays the same.

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

Select a column, row stays the same.

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

Select a cell, limit to maximum.

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

Select a row, limit to maximum.

pub fn move_to_col(&mut self, col: usize) -> bool

Select a cell, clamp between 0 and maximum.

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.

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

Move the selection left n columns. Ensures the row is visible afterwards.

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

Move the selection right n columns. Ensures the row is visible afterwards.

Trait Implementations

impl<Selection> Clone for TableState<Selection>

where Selection: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Selection> Debug for TableState<Selection>

where Selection: Debug,

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

Formats the value using the given formatter.

impl<Selection> Default for TableState<Selection>

where Selection: Default,

fn default() -> TableState<Selection>

Returns the “default value” for a type.

impl<Selection> HandleEvent<Event, DoubleClick, DoubleClickOutcome> for TableState<Selection>

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

Handles double-click events on the table.

impl<Selection> HandleEvent<Event, EditKeys, EditOutcome> for TableState<Selection>

where Selection: TableSelection, TableState<Selection>: HandleEvent<Event, Regular, Outcome>,

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

Handle an event.

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

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

Handle an event.

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

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

Handle an event.

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

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

Handle an event.

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

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

Handle an event.

impl HandleEvent<Event, Regular, Outcome> for TableState<CellSelection>

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

Handle an event.

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

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

Handle an event.

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

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

Handle an event.

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

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

Handle an event.

impl<Selection> HasFocusFlag for TableState<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) -> 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.