Struct ArrayView 

pub struct ArrayView<T, H> { /* private fields */ }

View to display a 2D array with row and column headers.

Implementations

impl<T, H> ArrayView<T, H>

where T: ArrayViewItem<H> + PartialEq, H: Eq + Hash + Copy + Clone + Send + Sync + 'static,

pub fn set_items_stable(&mut self, items: Vec<T>)

Sets the contained items of the array.

The current selection will be preserved when possible. (But this is only available for T: PartialEq.)

impl<T, H> ArrayView<T, H>

where T: ArrayViewItem<H>, H: Eq + Hash + Copy + Clone + Send + Sync + 'static,

pub fn new() -> Self

Creates a new empty ArrayView without any columns.

An ArrayView should be accompanied by an enum of type H representing the array columns.

pub fn row_header<C: FnOnce(ArrayRowHeader) -> ArrayRowHeader>( self, callback: C, ) -> Self

Configures the row header column.

Row header values are read from ArrayViewItem::to_row. The top-left corner text is set via ArrayView::array_name.

Chainable variant.

pub fn array_name<S: Into<String>>(self, name: S) -> Self

Sets the text shown in the top-left corner.

Chainable variant.

pub fn set_array_name<S: Into<String>>(&mut self, name: S)

Sets the text shown in the top-left corner.

pub fn set_row_header<C: FnOnce(ArrayRowHeader) -> ArrayRowHeader>( &mut self, callback: C, )

Configures the row header column.

Row header values are read from ArrayViewItem::to_row. The top-left corner text is set via ArrayView::array_name.

pub fn column<S: Into<String>, C: FnOnce(TableColumn<H>) -> TableColumn<H>>( self, column: H, title: S, callback: C, ) -> Self

Adds a column for the specified array column from type H along with a title for its visual display.

The provided callback can be used to further configure the created TableColumn.

pub fn add_column<S: Into<String>, C: FnOnce(TableColumn<H>) -> TableColumn<H>>( &mut self, column: H, title: S, callback: C, )

Adds a column for the specified array column from type H along with a title for its visual display.

The provided callback can be used to further configure the created TableColumn.

pub fn remove_column(&mut self, i: usize)

Remove a column.

pub fn insert_column<S: Into<String>, C: FnOnce(TableColumn<H>) -> TableColumn<H>>( &mut self, i: usize, column: H, title: S, callback: C, )

Adds a column for the specified array column from type H along with a title for its visual display.

The provided callback can be used to further configure the created TableColumn.

pub fn disable(&mut self)

Disables this view.

A disabled view cannot be selected.

pub fn enable(&mut self)

Re-enables this view.

pub fn set_enabled(&mut self, enabled: bool)

Enable or disable this view.

pub fn is_enabled(&self) -> bool

Returns true if this view is enabled.

pub fn set_on_submit<F>(&mut self, cb: F)

where F: Fn(&mut Cursive, usize, H) + Send + Sync + 'static,

Sets a callback to be used when <Enter> is pressed while a cell is selected.

Both the currently selected row and column will be given to the callback.

Example

array.set_on_submit(|_siv: &mut Cursive, _row: usize, _column: ArrayColumn| {
});

pub fn on_submit<F>(self, cb: F) -> Self

where F: Fn(&mut Cursive, usize, H) + Send + Sync + 'static,

Sets a callback to be used when <Enter> is pressed while a cell is selected.

Chainable variant.

Example

let _array = array.on_submit(|_siv: &mut Cursive, _row: usize, _column: ArrayColumn| {});

pub fn set_on_select<F>(&mut self, cb: F)

where F: Fn(&mut Cursive, usize, H) + Send + Sync + 'static,

Sets a callback to be used when a cell is selected.

Both the currently selected row and column will be given to the callback.

Example

array.set_on_select(|_siv: &mut Cursive, _row: usize, _column: ArrayColumn| {
});

pub fn on_select<F>(self, cb: F) -> Self

where F: Fn(&mut Cursive, usize, H) + Send + Sync + 'static,

Sets a callback to be used when a cell is selected.

Chainable variant.

Example

let _array = array.on_select(|_siv: &mut Cursive, _row: usize, _column: ArrayColumn| {});

pub fn clear(&mut self)

Removes all items from this view.

pub fn len(&self) -> usize

Returns the number of items in this array.

pub fn is_empty(&self) -> bool

Returns true if this array has no items.

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

Returns the index of the currently selected array row.

pub fn set_selected_row(&mut self, row_index: usize)

Selects the row at the specified index.

pub fn selected_row(self, row_index: usize) -> Self

Selects the row at the specified index.

Chainable variant.

pub fn set_items(&mut self, items: Vec<T>)

Sets the contained items of the array.

pub fn items(self, items: Vec<T>) -> Self

Sets the contained items of the array.

Chainable variant.

pub fn borrow_item(&self, index: usize) -> Option<&T>

Returns an immutable reference to the item at the specified index within the underlying storage vector.

pub fn borrow_item_mut(&mut self, index: usize) -> Option<&mut T>

Returns a mutable reference to the item at the specified index within the underlying storage vector.

pub fn borrow_items(&self) -> &[T]

Returns an immutable reference to the items contained within the array.

pub fn borrow_items_mut(&mut self) -> &mut [T]

Returns a mutable reference to the items contained within the array.

Can be used to modify the items in place.

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

Returns the index of the currently selected item within the underlying storage vector.

pub fn set_selected_item(&mut self, item_index: usize)

Selects the item at the specified index within the underlying storage vector.

pub fn selected_item(self, item_index: usize) -> Self

Selects the item at the specified index within the underlying storage vector.

Chainable variant.

pub fn insert_item(&mut self, item: T)

Inserts a new item into the array.

The item will be added to the end of the array.

pub fn insert_item_at(&mut self, index: usize, item: T)

Inserts a new item into the array.

The item will be inserted at the given index.

Panics

If index > self.len().

pub fn remove_item(&mut self, item_index: usize) -> Option<T>

Removes the item at the specified index within the underlying storage vector and returns it.

pub fn take_items(&mut self) -> Vec<T>

Removes all items from the underlying storage and returns them.

Trait Implementations

impl<T, H> Default for ArrayView<T, H>

where T: ArrayViewItem<H>, H: Eq + Hash + Copy + Clone + Send + Sync + 'static,

fn default() -> Self

Creates a new empty ArrayView without any columns.

See ArrayView::new().

impl<T, H> Scroller for ArrayView<T, H>

fn get_scroller_mut(&mut self) -> &mut Core

Returns a mutable access to the scroll core.

fn get_scroller(&self) -> &Core

Returns an immutable access to the scroll core.

impl<T, H> View for ArrayView<T, H>

where T: ArrayViewItem<H> + Send + Sync + 'static, H: Eq + Hash + Copy + Clone + Send + Sync + 'static,

fn required_size(&mut self, req: Vec2) -> Vec2

Returns the minimum size the view requires with the given restrictions.

fn draw(&self, printer: &Printer<'_, '_>)

Draws the view with the given printer (includes bounds) and focus.

fn layout(&mut self, size: Vec2)

Called once the size for this view has been decided.

fn take_focus(&mut self, _: Direction) -> Result<EventResult, CannotFocus>

Attempt to give this view the focus.

fn on_event(&mut self, event: Event) -> EventResult

Called when an event is received (key press, mouse event, …).

fn important_area(&self, size: Vec2) -> Rect

What part of the view is important and should be visible?

fn needs_relayout(&self) -> bool

Should return true if the view content changed since the last call to layout().

fn call_on_any( &mut self, _: &Selector<'_>, _: &mut dyn FnMut(&mut (dyn View + 'static)), )

Runs a closure on the view identified by the given selector.

fn focus_view(&mut self, _: &Selector<'_>) -> Result<EventResult, ViewNotFound>

Moves the focus to the view identified by the given selector.

fn type_name(&self) -> &'static str

Returns the type of this view.