Struct Selection

pub struct Selection { /* private fields */ }

A cursor in the text file. This is an editing cursor, -(not a printing cursor.

Implementations

impl Selection

pub fn move_to(&mut self, p: Point, text: &Text)

Moves to specific, pre calculated Point.

pub fn move_hor(&mut self, by: i32, text: &Text) -> i32

Internal horizontal movement function.

Returns the number of distance moved through.

pub fn move_ver( &mut self, by: i32, text: &Text, area: &impl RawArea, cfg: PrintCfg, ) -> i32

Internal vertical movement function.

Returns the distance moved in lines.

pub fn move_ver_wrapped( &mut self, by: i32, text: &Text, area: &impl RawArea, cfg: PrintCfg, ) -> i32

Internal vertical movement function.

Returns the distance moved in wrapped lines.

pub fn set_anchor(&mut self)

Sets the position of the anchor to be the same as the current cursor position in the file

The anchor and current act as a range of text on the file.

pub fn unset_anchor(&mut self) -> Option<Point>

Unsets the anchor

This is done so the cursor no longer has a valid selection.

pub fn swap_ends(&mut self)

Switches the position of the anchor and caret

pub fn caret(&self) -> Point

Returns the cursor’s position on the screen

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

The anchor of this Selection, if it exists

pub fn byte(&self) -> usize

The byte (relative to the beginning of the file) of the caret. Indexed at 0

pub fn char(&self) -> usize

The char (relative to the beginning of the file) of the caret. Indexed at 0

pub fn line(&self) -> usize

The line of the caret. Indexed at 0.

pub fn range(&self, text: &Text) -> Range<usize>

Returns the range between caret and anchor.

If anchor isn’t set, returns an empty range on caret.

A Selection’s range will also never include the last character in a Text, which must be a newline.

Warning

This function will return the range that is supposed to be replaced, if self.is_inclusive(), this means that it will return one more byte at the end, i.e. start..=end.

pub fn start(&self) -> Point

The starting Point of this Selection

pub fn end(&self, text: &Text) -> Point

The ending Point of this Selection

pub fn point_range(&self, text: &Text) -> [Point; 2]

Returns the range between target and anchor.

like Selection::range, this function will not include beyond the last character’s Point.

If anchor isn’t set, returns an empty range on target.

pub fn set_desired_cols(&mut self, v: usize, w: usize)

Sets both the desired visual column, as well as the desired wrapped column

pub fn v_caret(&self, text: &Text, area: &impl RawArea, cfg: PrintCfg) -> VPoint

The visual caret of this Selection

VPoints include a lot more information than regular Points, like visual distance form the left edge, what the desired distance is, etc.

pub fn v_anchor( &self, text: &Text, area: &impl RawArea, cfg: PrintCfg, ) -> Option<VPoint>

The visual anchor of this Selection, if it exists

VPoints include a lot more information than regular Points, like visual distance form the left edge, what the desired distance is, etc.

pub fn v_range( &self, text: &Text, area: &impl RawArea, cfg: PrintCfg, ) -> [VPoint; 2]

The visual range between the caret and anchor of this Selection

VPoints include a lot more information than regular Points, like visual distance form the left edge, what the desired distance is, etc.

Trait Implementations

impl<'__de, __Context> BorrowDecode<'__de, __Context> for Selection

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

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<__Context> Decode<__Context> for Selection

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl Default for Selection

fn default() -> Selection

Returns the “default value” for a type.

impl Encode for Selection

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.