Struct Selection 

pub struct Selection {
    pub active: CellRef,
    pub anchor: CellRef,
    pub ranges: Vec<RangeRef>,
}

Fields

active: CellRef

The active (white) cell.

anchor: CellRef

Where a Shift-extension is anchored.

ranges: Vec<RangeRef>

Selected areas; the last one contains the active cell. Never empty.

Implementations

impl Selection

pub fn at(c: CellRef) -> Selection

pub fn range(r: RangeRef) -> Selection

pub fn current(&self) -> RangeRef

The current (last) area.

pub fn bounds(&self) -> RangeRef

Bounding range of all areas.

pub fn contains(&self, c: CellRef) -> bool

pub fn is_single_cell(&self) -> bool

pub fn moving_end(&self) -> CellRef

The corner of the current area opposite the anchor: the end that Shift+arrows move.

pub fn extend_to(&mut self, to: CellRef)

Extends the current area from the anchor to to (Shift+click / Shift+arrows).

pub fn a1(&self) -> String

The A1 text of all areas (A1:B2,D4).

pub fn expand_merges(&mut self, sheet: &Sheet)

Expands areas so merged cells are included whole. Whole columns and whole rows stay as they are: clicking column B’s header selects just B even when B1:C1 is merged, as in Excel.

pub fn cycle(&mut self, forward: bool, by_row: bool)

Moves the active cell within the selection (Enter/Tab inside a multi-cell selection).

impl Selection

pub fn next_corner(&mut self)

Ctrl+. (Next Corner of Selection): the active cell moves clockwise to the next corner of the current area (top-left, top-right, bottom-right, bottom-left) and becomes the anchor, so Shift+arrows then move the opposite corner. The area stays selected. From a cell that isn’t a corner the next corner is the top-left one; a single cell stays where it is.

pub fn next_corner_by(&mut self, stop: impl Fn(CellRef) -> Option<CellRef>)

Selection::next_corner where stop says where each corner takes the active cell: the top-left cell of a merged cell the corner is in, or None for a corner that can’t be selected (it is skipped). Corners that end up on the active cell are one stop with it.

Trait Implementations

impl Clone for Selection

fn clone(&self) -> Selection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Selection

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

Formats the value using the given formatter.

impl Default for Selection

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Selection

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Selection

impl PartialEq for Selection

fn eq(&self, other: &Selection) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Selection

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Selection