Struct rat_widget::table::selection::RowSetSelection

pub struct RowSetSelection {
    pub anchor_row: Option<usize>,
    pub lead_row: Option<usize>,
    pub selected: HashSet<usize>,
}

Allows selection an active range of rows.

The current range can be retired to a set of selected rows, and a new range be started. This allows multiple interval selection and deselection of certain rows.

This one only supports row-selection.

Fields

anchor_row: Option<usize>

Start of the active selection.

lead_row: Option<usize>

Current end of the active selection.

selected: HashSet<usize>

Retired rows. This doesn’t contain the rows between anchor and lead.

You can call RowSetSelection::retire_selection to add the anchor-lead range. This resets anchor and lead though. Or iterate the complete range and call RowSetSelection::is_selected_row.

Implementations

impl RowSetSelection

pub fn new() -> RowSetSelection

New selection.

pub fn clear(&mut self)

Clear the selection.

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

Current lead.

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

Current anchor.

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

Set of all selected rows. Clones the retired set and adds the current anchor..lead range.

pub fn has_selection(&self) -> bool

Has some selection.

pub fn set_lead(&mut self, lead: Option<usize>, extend: bool) -> bool

Set a new lead. Maybe extend the range.

pub fn retire_selection(&mut self)

Transfers the range anchor to lead to the selection set and reset both.

pub fn add(&mut self, idx: usize)

Add to selection. Only works for retired selections, not for the active anchor-lead range.

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

Remove from selection. Only works for retired selections, not for the active anchor-lead range.

pub fn move_to(&mut self, lead: usize, max: usize, extend: bool) -> bool

Set a new lead, at the same time limit the lead to max.

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

Select next. Maybe extend the range.

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

Select next. Maybe extend the range.

Trait Implementations

impl Clone for RowSetSelection

fn clone(&self) -> RowSetSelection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RowSetSelection

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

Formats the value using the given formatter.

impl Default for RowSetSelection

fn default() -> RowSetSelection

Returns the “default value” for a type.

impl TableSelection for RowSetSelection

fn is_selected_row(&self, row: usize) -> bool

Row is selected. This can be separate from is_selected_cell.

fn is_selected_column(&self, _column: usize) -> bool

Column is selected. This can be separate from is_selected_cell.

fn is_selected_cell(&self, _column: usize, _row: usize) -> bool

Specific cell is selected.

fn lead_selection(&self) -> Option<(usize, usize)>

Selection lead.

fn scroll_selected(&self) -> bool

Should scroll be in terms of the selection or in terms of the offset.