Struct rat_widget::table::RTableState

pub struct RTableState<Selection> {
    pub widget: FTableState<Selection>,
    pub non_exhaustive: NonExhaustive,
}

Fields

widget: FTableState<Selection>

non_exhaustive: NonExhaustive

Implementations

impl<Selection> RTableState<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 column-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: rat_ftable::FTableState::scroll_to

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. Can go outside the area.

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

Row when dragging. Can go outside the area.

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

Column when dragging. Can go outside the area.

pub fn clear_offset(&mut self)

Sets both offsets to 0.

impl<Selection: TableSelection> RTableState<Selection>

pub fn scroll_to_selected(&mut self)

Scroll to selected.

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

Scroll to position.

impl RTableState<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 RTableState<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 RTableState<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)>)

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Selection: Debug> Debug for RTableState<Selection>

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

Formats the value using the given formatter.

impl<Selection: Default> Default for RTableState<Selection>

fn default() -> Self

Returns the “default value” for a type.

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

where FTableState<Selection>: HandleEvent<Event, DoubleClick, DoubleClickOutcome>,

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

Handle an event.

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

where FTableState<Selection>: HandleEvent<Event, MouseOnly, Outcome> + HandleEvent<Event, FocusKeys, Outcome> + HandleEvent<Event, EditKeys, EditOutcome>,

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

Handle an event.

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

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

Handle an event.

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

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

Handle an event.

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

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

Handle an event.

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

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

Handle an event.

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

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

Handle an event.

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

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

Handle an event.

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

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

Handle an event.

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

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

Handle an event.

impl<Selection> HasFocusFlag for RTableState<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: TableSelection> ScrollingState for RTableState<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 vertical_scroll(&self) -> usize

Suggested scroll per scroll-event.

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

Suggested scroll per scroll-event.

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 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<'a, Selection> ScrollingWidget<RTableState<Selection>> for RTable<'a, Selection>

fn need_scroll( &self, area: Rect, _state: &mut RTableState<Selection>, ) -> (bool, bool)

Widget wants a (horizontal, vertical) scrollbar. This gets combined with the ScrollbarPolicy.