Struct CaretInfo 

#[non_exhaustive]
pub struct CaretInfo {
    pub opacity: Var<Factor>,
    pub index: Option<CaretIndex>,
    pub selection_index: Option<CaretIndex>,
    pub initial_selection: Option<(Range<CaretIndex>, bool)>,
    pub index_version: Wrapping<u8>,
    pub used_retained_x: bool,
    pub skip_next_scroll: bool,
}

Represents the caret position at the ResolvedText context.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

opacity: Var<Factor>

Caret opacity.

This variable is replaced often, the text resolver subscribes to it for UpdateOp::RenderUpdate automatically.

index: Option<CaretIndex>

Caret byte offset in the text string.

This is the insertion offset on the text, it can be the text length.

selection_index: Option<CaretIndex>

Second index that defines the start or end of a selection range.

initial_selection: Option<(Range<CaretIndex>, bool)>

Selection by word or line sets this value, selection extend by word or line grows from this central selection. The value is (selection, is_word).

index_version: Wrapping<u8>

Value incremented by one every time the index is set.

This is used to signal interaction with the index value by TextEditOp even if the interaction only sets-it to the index same value.

used_retained_x: bool

If the index was set by using the caret_retained_x.

skip_next_scroll: bool

Don’t scroll to new caret position on the next update.

If this is set to true the next time index or index_version changes auto-scroll is skipped once.

Implementations

impl CaretInfo

pub fn set_index(&mut self, index: CaretIndex)

Set the index and update the index version.

pub fn set_selection(&mut self, start: CaretIndex, end: CaretIndex)

Sets the selection start, end and update the index version.

The end is the caret position.

pub fn clear_selection(&mut self)

Clears selection.

pub fn set_char_index(&mut self, index: usize)

Set the char byte index and update the index version.

The caret line is always snapped when the caret changes, so the line value will be updated.

pub fn set_char_selection(&mut self, start: usize, end: usize)

Set the char byte index of the selection start, end and update the index version.

The end is the caret position.

The caret and selection lines are always snapped when the caret changes, so the line values will be updated.

pub fn selection_range(&self) -> Option<Range<CaretIndex>>

Gets the selection range if both index and selection_index are set.

pub fn selection_char_range(&self) -> Option<Range<usize>>

Gets the character range of the selection if both index and selection_index are set.

Trait Implementations

impl Clone for CaretInfo

fn clone(&self) -> CaretInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CaretInfo

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

Formats the value using the given formatter.