Struct TextSelectionHandle 

pub struct TextSelectionHandle(/* private fields */);

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

Implementations

impl TextSelectionHandle

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

Creates a selection participant handle with fallback text for copying.

pub fn entity_id(&self) -> EntityId

Returns this participant’s stable identity.

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

Returns the current geometry selection snapshot for this participant.

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

Sets the fallback text copied while this participant participates.

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

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

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

Returns whether participant-local selection is active.

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

Registers this participant and its geometry for the current frame.

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

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

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

Subscribes to participant selection notifications.

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

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

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.

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

Sets the synchronous participant cleanup command used by window clear.

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

Sets a participant-specific copy projection.

pub fn prepaint_touch_handles( &self, window: &mut Window, cx: &App, ) -> TouchHandleLayout

Lays out the touch handles at the ends of this participant’s selection, as they were painted last frame, and gives each a hitbox where the finger takes it. Call during the participant’s prepaint; hand the result to Self::paint_touch_handles.

pub fn paint_touch_handles( &self, layout: &TouchHandleLayout, color: Hsla, window: &mut Window, cx: &mut App, )

Paints the touch handles at the ends of this participant’s selection, in color, where the participant is in the paint order — so whatever is drawn over the text is drawn over its handles too. Call at the end of the participant’s paint, after Self::register for the frame.

The handles take the finger’s drag from there; Base moves the selection with it.

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

impl Clone for TextSelectionHandle

fn clone(&self) -> TextSelectionHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.