Skip to main content

TextSelectionHandle

Struct TextSelectionHandle 

Source
pub struct TextSelectionHandle(/* private fields */);
Expand description

A stable, participant-neutral handle for text that participates in window selection.

Implementations§

Source§

impl TextSelectionHandle

Source

pub fn new(fallback_copy_text: impl Into<String>, cx: &mut App) -> Self

Creates a selection participant handle with fallback text for copying.

Source

pub fn entity_id(&self) -> EntityId

Returns this participant’s stable identity.

Source

pub fn snapshot(&self, cx: &App) -> Option<TextSelectionSnapshot>

Returns the current geometry selection snapshot for this participant.

Source

pub fn set_fallback_copy_text(&self, text: impl Into<String>, cx: &mut App)

Sets the fallback text copied while this participant participates.

Source

pub fn set_local_selection(&self, active: bool, cx: &mut App)

Marks participant-local selection, such as select-all, as active.

Source

pub fn has_local_selection(&self, cx: &App) -> bool

Returns whether participant-local selection is active.

Source

pub fn register( &self, registration: TextSelectionRegistration, window: &mut Window, cx: &mut App, )

Registers this participant and its geometry for the current frame.

Source

pub fn update_runs( &self, runs: &[TextSelectionRun], cx: &mut App, ) -> TextSelectionProjection

Projects the current snapshot onto plain-text runs and caches their copy text.

Source

pub fn subscribe( &self, callback: impl FnMut(&TextSelectionEvent, &mut App) + 'static, cx: &mut App, ) -> Subscription

Subscribes to participant selection notifications.

Source

pub fn refresh_window_on_change( &self, window: &Window, cx: &mut App, ) -> Subscription

Subscribes window to refresh whenever this participant’s selection changes.

Source

pub fn focus_with( &self, callback: impl Fn(&mut Window, &mut App) + 'static, cx: &mut App, )

Sets the callback which focuses the participant when a drag begins in it.

Source

pub fn clear_with(&self, callback: impl Fn(&mut App) + 'static, cx: &mut App)

Sets the synchronous participant cleanup command used by window clear.

Source

pub fn copy_with( &self, callback: impl Fn(&mut App) -> String + 'static, cx: &mut App, )

Sets a participant-specific copy projection.

Source

pub fn resolve_content_key_with( &self, callback: impl Fn(Point<Pixels>, &App) -> Option<TextSelectionContentKey> + 'static, cx: &mut App, )

Sets a participant-specific lookup for stable virtualized content keys.

Trait Implementations§

Source§

impl Clone for TextSelectionHandle

Source§

fn clone(&self) -> TextSelectionHandle

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

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>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more