Struct CCursorRange

pub struct CCursorRange {
    pub primary: CCursor,
    pub secondary: CCursor,
    pub h_pos: Option<f32>,
}

A selected text range (could be a range of length zero).

The selection is based on character count (NOT byte count!).

Fields

primary: CCursor

When selecting with a mouse, this is where the mouse was released. When moving with e.g. shift+arrows, this is what moves. Note that the two ends can come in any order, and also be equal (no selection).

secondary: CCursor

When selecting with a mouse, this is where the mouse was first pressed. This part of the cursor does not move when shift is down.

h_pos: Option<f32>

Saved horizontal position of the cursor.

Implementations

impl CCursorRange

pub fn one(ccursor: CCursor) -> Self

The empty range.

pub fn two(min: impl Into<CCursor>, max: impl Into<CCursor>) -> Self

pub fn select_all(galley: &Galley) -> Self

Select all the text in a galley

pub fn as_sorted_char_range(&self) -> Range<usize>

The range of selected character indices.

pub fn is_empty(&self) -> bool

True if the selected range contains no characters.

pub fn contains(&self, other: Self) -> bool

Is self a super-set of the other range?

pub fn single(&self) -> Option<CCursor>

If there is a selection, None is returned. If the two ends are the same, that is returned.

pub fn is_sorted(&self) -> bool

pub fn sorted_cursors(&self) -> [CCursor; 2]

returns the two ends ordered

pub fn sorted(&self) -> [CCursor; 2]

👎Deprecated: Use self.sorted_cursors instead.

pub fn slice_str<'s>(&self, text: &'s str) -> &'s str

pub fn on_key_press( &mut self, os: OperatingSystem, galley: &Galley, modifiers: &Modifiers, key: Key, ) -> bool

Check for key presses that are moving the cursor.

Returns true if we did mutate self.

pub fn on_event( &mut self, os: OperatingSystem, event: &Event, galley: &Galley, _widget_id: Id, ) -> bool

Check for events that modify the cursor range.

Returns true if such an event was found and handled.

Trait Implementations

impl Clone for CCursorRange

fn clone(&self) -> CCursorRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CCursorRange

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

Formats the value using the given formatter.

impl Default for CCursorRange

fn default() -> CCursorRange

Returns the “default value” for a type.

impl From<CCursorRange> for TextCursorState

fn from(ccursor_range: CCursorRange) -> Self

Converts to this type from the input type.

impl PartialEq for CCursorRange

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for CCursorRange

impl StructuralPartialEq for CCursorRange