Struct TableState 

pub struct TableState {
    pub selected: Option<usize>,
    pub hovered: Option<usize>,
    pub offset: usize,
    /* private fields */
}

Mutable state for a Table widget.

Fields

selected: Option<usize>

Index of the currently selected row, if any.

hovered: Option<usize>

Index of the currently hovered row, if any.

offset: usize

Scroll offset (first visible row index).

Implementations

impl TableState

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

Set the selected row index, resetting offset on deselect.

pub fn with_persistence_id(self, id: impl Into<String>) -> Self

Create a new TableState with a persistence ID for state saving.

pub fn persistence_id(&self) -> Option<&str>

Get the persistence ID, if set.

impl TableState

pub fn undo_id(&self) -> UndoWidgetId

Get the undo widget ID.

This can be used to associate undo commands with this state instance.

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

Get the current sort column.

pub fn sort_ascending(&self) -> bool

Get whether the sort is ascending.

pub fn set_sort(&mut self, column: Option<usize>, ascending: bool)

Set the sort state.

pub fn filter(&self) -> &str

Get the filter text.

pub fn set_filter(&mut self, filter: impl Into<String>)

Set the filter text.

pub fn handle_mouse( &mut self, event: &MouseEvent, hit: Option<(HitId, HitRegion, u64)>, expected_id: HitId, row_count: usize, ) -> MouseResult

Handle a mouse event for this table.

Hit data convention

The hit data (u64) encodes the row index. When the table renders with a hit_id, each visible row registers HitRegion::Content with data = row_index as u64.

Arguments

• event — the mouse event from the terminal
• hit — result of frame.hit_test(event.x, event.y), if available
• expected_id — the HitId this table was rendered with
• row_count — total number of rows in the table

pub fn scroll_up(&mut self, lines: usize)

Scroll the table up by the given number of lines.

pub fn scroll_down(&mut self, lines: usize, row_count: usize)

Scroll the table down by the given number of lines.

Clamps so that the last row can still appear at the top of the viewport.

Trait Implementations

impl Clone for TableState

fn clone(&self) -> TableState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TableState

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

Formats the value using the given formatter.

impl Default for TableState

fn default() -> TableState

Returns the “default value” for a type.

impl Stateful for TableState

type State = TablePersistState

The state type that gets persisted.

fn state_key(&self) -> StateKey

Unique key identifying this widget instance.

fn save_state(&self) -> TablePersistState

Extract current state for persistence.

fn restore_state(&mut self, state: TablePersistState)

Restore state from persistence.

fn state_version() -> u32

State schema version for forward-compatible migrations.

impl TableUndoExt for TableState

fn sort_state(&self) -> (Option<usize>, bool)

Get the current sort state.

fn set_sort_state(&mut self, column: Option<usize>, ascending: bool)

Set the sort state.

fn filter_text(&self) -> &str

Get the current filter.

fn set_filter_text(&mut self, filter: &str)

Set the filter.

impl UndoSupport for TableState

fn undo_widget_id(&self) -> UndoWidgetId

Get the widget’s unique ID for undo tracking.

fn create_snapshot(&self) -> Box<dyn Any + Send>

Create a snapshot of the current state for undo purposes.

fn restore_snapshot(&mut self, snapshot: &dyn Any) -> bool

Restore state from a snapshot.