Struct egui::text_selection::cursor_range::CursorRange

source ·
pub struct CursorRange {
    pub primary: Cursor,
    pub secondary: Cursor,
}
Expand description

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

Fields§

§primary: Cursor

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: Cursor

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.

Implementations§

source§

impl CursorRange

source

pub fn one(cursor: Cursor) -> Self

The empty range.

source

pub fn two(min: Cursor, max: Cursor) -> Self

source

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

Select all the text in a galley

source

pub fn as_ccursor_range(&self) -> CCursorRange

source

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

The range of selected character indices.

source

pub fn is_empty(&self) -> bool

True if the selected range contains no characters.

source

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

Is self a super-set of the other range?

source

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

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

source

pub fn is_sorted(&self) -> bool

source

pub fn sorted(self) -> Self

source

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

Returns the two ends ordered.

source

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

source

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.

source

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§

source§

impl Clone for CursorRange

source§

fn clone(&self) -> CursorRange

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for CursorRange

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for CursorRange

source§

fn default() -> CursorRange

Returns the “default value” for a type. Read more
source§

impl From<CursorRange> for TextCursorState

source§

fn from(cursor_range: CursorRange) -> Self

Converts to this type from the input type.
source§

impl PartialEq for CursorRange

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Copy for CursorRange

source§

impl StructuralPartialEq for CursorRange

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,