Struct termimad::ListView

pub struct ListView<'t, T> {
    pub area: Area,
    pub skin: &'t MadSkin,
    // some fields omitted
}

A filterable list whose columns can be automatically resized.

Notes:

• another version will allow more than one style per cell (i.e. make the cells composites rather than compounds). Shout out if you need that now.
• this version doesn’t allow cell wrapping

Fields

area: Area

skin: &'t MadSkin

Implementations

impl<'t, T> ListView<'t, T>

pub fn new(
    area: Area,
    columns: Vec<ListViewColumn<'t, T>>,
    skin: &'t MadSkin
) -> Self

Create a new list view with the passed columns.

The columns can’t be changed afterwards but the area can be modified. When two columns have the same title, those titles are merged (but the columns below stay separated).

pub fn sort(&mut self, sort: Box<dyn Fn(&T, &T) -> Ordering>)

set a comparator for row sorting

pub fn tbody_height(&self) -> i32

return the height which is available for rows

pub fn scrollbar(&self) -> Option<(u16, u16)>

return an option which when filled contains a tupple with the top and bottom of the vertical scrollbar. Return none when the content fits the available space.

pub fn add_row(&mut self, data: T)

pub fn clear_rows(&mut self)

remove all rows (and selection).

Keep the columns and the sort function, if any.

pub fn row_counts(&self) -> (usize, usize)

return both the number of displayed rows and the total number

pub fn update_dimensions(&mut self)

recompute the widths of all columns. This should be called when the area size is modified

pub fn set_filter(&mut self, filter: Box<dyn Fn(&T) -> bool>)

pub fn remove_filter(&mut self)

pub fn write_on<W>(&self, w: &mut W) -> Result<()> where
    W: Write, 

write the list view on the given writer

pub fn write(&self) -> Result<()>

display the whole list in its area

pub fn do_scroll_show_bottom(&self) -> bool

return true if the last line of the list is visible

pub fn scroll_to_bottom(&mut self)

ensure the last line is visible

pub fn try_scroll_lines(&mut self, lines_count: i32)

set the scroll amount. lines_count can be negative

pub fn try_scroll_pages(&mut self, pages_count: i32)

set the scroll amount. pages_count can be negative

pub fn try_select_next(&mut self, up: bool)

try to select the next visible line

pub fn select_first_line(&mut self)

select the first visible line (unless there’s nothing).

pub fn select_last_line(&mut self)

select the last visible line (unless there’s nothing).

pub fn make_selection_visible(&mut self)

scroll to ensure the selected line (if any) is visible.

This is automatically called by try_scroll and try select functions

pub fn get_selection(&self) -> Option<&T>

pub fn has_selection(&self) -> bool

pub fn unselect(&mut self)