Struct TableEditState 

pub struct TableEditState<T, E> {
    pub mode: Mode,
    pub table: TableState,
    pub editor: E,
    pub data: Vec<T>,
    pub mouse: MouseFlags,
    pub non_exhaustive: NonExhaustive,
}

State for TableEdit.

It has a mode-field for insert/edit/view.

Focus

When editing the widget blocks the Focus it is part of. You can’t leave the table as long as it’s editing.

It is intended that the editor-widget sets up a separate Focus for all the widgets and navigates independently of the main application Focus.

Fields

mode: Mode

Editing mode.

table: TableState

Backing table.

editor: E

Editor

data: Vec<T>

Data store

mouse: MouseFlags

non_exhaustive: NonExhaustive

Implementations

impl<T, E> TableEditState<T, E>

pub fn new(editor: E) -> TableEditState<T, E>

pub fn named(name: &str, editor: E) -> TableEditState<T, E>

pub fn with(self, data: impl IntoIterator<Item = T>) -> TableEditState<T, E>

Populate the table-data.

impl<T, E> TableEditState<T, E>

pub fn rows(&self) -> usize

Number of rows.

pub fn columns(&self) -> usize

Number of columns.

impl<T, E> TableEditState<T, E>

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<T, E> TableEditState<T, E>

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. The offset may be beyond the number of rows.

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. The offset may be beyond the table-width.

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. Caveat: Number of rows needs to be correct.

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. Caveat: Number of rows needs to be correct.

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 position 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<T, E> TableEditState<T, E>

pub fn clear_selection(&mut self)

Clear the selection.

impl<T, E> TableEditState<T, E>

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

When scrolling the table, change the selection instead of the offset.

pub fn has_selection(&mut self) -> bool

Anything selected?

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

Selected row. The selected row is not constrained by the row-count.

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

Return the selected row and ensure it is in the range 0..rows.

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

Select the row. The selection is not constrained by the row-count.

pub fn move_deselect(&mut self) -> bool

Set the selection to None and set the offset to 0

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

Move the selection to the given row. Ensures the row is visible afterward.

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

Move the selection up n rows. Ensures the row is visible afterward.

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

Move the selection down n rows. Ensures the row is visible afterward.

impl<T, E> TableEditState<T, E>

where E: TableEditorState<T>, T: Clone,

pub fn set_value(&mut self, data: Vec<T>)

Set the data.

pub fn value(&self) -> &Vec<T>

Get the data.

This will not contain the data of the currently editing row. Instead, it will contain the value before the edit started.

pub fn clear(&mut self)

Clear the widget.

pub fn is_editing(&self) -> bool

Editing is active?

pub fn is_insert(&self) -> bool

Is the current edit an insert?

pub fn remove(&mut self, row: usize)

Remove the item at the given row.

pub fn edit_new<'a>( &mut self, row: usize, ctx: &'a <E as TableEditorState<T>>::Context<'a>, ) -> Result<(), <E as TableEditorState<T>>::Err>

Edit a new item inserted at the selected row.

pub fn edit<'a>( &mut self, col: Option<usize>, row: usize, ctx: &'a <E as TableEditorState<T>>::Context<'a>, ) -> Result<(), <E as TableEditorState<T>>::Err>

Edit the item at the given row. A starting column can be provided too.

pub fn cancel<'a>( &mut self, ctx: &'a <E as TableEditorState<T>>::Context<'a>, ) -> Result<(), <E as TableEditorState<T>>::Err>

Cancel editing. When inserting a new row, the row will be removed.

pub fn commit<'a>( &mut self, ctx: &'a <E as TableEditorState<T>>::Context<'a>, ) -> Result<(), <E as TableEditorState<T>>::Err>

Commit the changes in the editor.

pub fn commit_and_append<'a>( &mut self, ctx: &'a <E as TableEditorState<T>>::Context<'a>, ) -> Result<(), <E as TableEditorState<T>>::Err>

Commit the current changes and start editing the next row. If the end of the table is reached a row will be appended.

pub fn commit_and_edit<'a>( &mut self, ctx: &'a <E as TableEditorState<T>>::Context<'a>, ) -> Result<(), <E as TableEditorState<T>>::Err>

Commit the current changes and start editing the next row. Does not append at the end of the table.

Trait Implementations

impl<T, E> Default for TableEditState<T, E>

where E: Default,

fn default() -> TableEditState<T, E>

Returns the “default value” for a type.

impl<'a, T, S> HandleEvent<Event, &'a <S as TableEditorState<T>>::Context<'a>, Result<Outcome, <S as TableEditorState<T>>::Err>> for TableEditState<T, S>

where S: HandleEvent<Event, &'a <S as TableEditorState<T>>::Context<'a>, Result<Outcome, <S as TableEditorState<T>>::Err>> + TableEditorState<T>, T: Clone,

fn handle( &mut self, event: &Event, ctx: &'a <S as TableEditorState<T>>::Context<'a>, ) -> Result<Outcome, <S as TableEditorState<T>>::Err>

Handle an event.

impl<T, E> HasFocus for TableEditState<T, E>

fn build(&self, builder: &mut FocusBuilder)

Build the focus-structure for the container/widget.

fn focus(&self) -> FocusFlag

Access to the focus flag.

fn area(&self) -> Rect

Area for mouse focus.

fn navigable(&self) -> Navigation

Declares how the widget interacts with focus.

fn build_nav(&self, navigable: Navigation, builder: &mut FocusBuilder)

Build the focus-structure for the container/widget.

fn id(&self) -> usize

Provide a unique id for the widget.

fn area_z(&self) -> u16

Z-value for the area.

fn is_focused(&self) -> bool

Does this widget have the focus or if the flag is used for a container, does any of widgets inside the container have the focus.

fn lost_focus(&self) -> bool

This widget just lost the focus.

fn gained_focus(&self) -> bool

This widget just gained the focus.

fn is_obscured(&self) -> bool

This widget is not beneath the mouse-cursor.

impl<T, E> HasScreenCursor for TableEditState<T, E>

where E: HasScreenCursor,

fn screen_cursor(&self) -> Option<(u16, u16)>

This returns the cursor position if

impl<T, E> RelocatableState for TableEditState<T, E>

where E: RelocatableState,

fn relocate(&mut self, shift: (i16, i16), clip: Rect)

Relocate the areas in this widgets state.

fn relocate_popup(&mut self, shift: (i16, i16), clip: Rect)

Relocate only popup areas. As rendering the popups is a separate render, this has to be separate too.

fn relocate_popup_hidden(&mut self)

Relocate all popup areas to a clip-rect (0,0+0x0).

fn relocate_hidden(&mut self)

Relocate all areas to a clip-rect (0,0+0x0).