Struct CodeEditorHandle 

pub struct CodeEditorHandle { /* private fields */ }

A handle onto a live editor, cloneable and detachable from the widget.

The EditorHandle pattern: an app keeps one to drive the editor from a toolbar, a shortcut, or a test without holding the widget itself.

Implementations

impl CodeEditorHandle

pub fn cursor_position(&self) -> usize

The caret’s document position.

pub fn cursor_position_signal(&self) -> Signal<usize>

The primary caret’s document position — a character offset into the whole document, not a line or column — as a reactive signal. Bind it in a status bar to show a caret position that tracks every caret move, not only edits.

pub fn caret_count(&self) -> Signal<usize>

Live caret count — 1 unless multi-caret editing is active.

pub fn bracket_match(&self) -> Signal<Option<(usize, usize)>>

The bracket next to the caret and its match, as document positions, or None. Populated only when the editor was configured with match_brackets and bracket pairs; a status surface can bind it, or an app can read it to drive its own overlay.

pub fn has_selection(&self) -> Signal<bool>

pub fn can_undo(&self) -> Signal<bool>

pub fn undo(&self)

Undo this editor’s last edit.

The handle could report can_undo long before it could act on it, which left a host able to light an Undo button here and unable to make it do anything. Ctrl+Z inside the widget always worked; this is the same command from outside.

pub fn redo(&self)

Redo this editor’s last undone edit.

pub fn copy(&self, ctx: &EventContext<'_>)

Copy the selection to the clipboard.

pub fn cut(&self, ctx: &EventContext<'_>)

Cut the selection to the clipboard.

pub fn paste(&self, ctx: &EventContext<'_>)

Paste over the selection.

pub fn select_all(&self)

Select the whole document.

pub fn is_read_only(&self) -> bool

Is this editor refusing edits?

pub fn can_redo(&self) -> Signal<bool>

pub fn document_version(&self) -> Signal<u64>

Bumps on every content or format change.

pub fn scroll_y(&self) -> Signal<f32>

Trait Implementations

impl Clone for CodeEditorHandle

fn clone(&self) -> CodeEditorHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodeEditorHandle

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

Formats the value using the given formatter.

impl TextSurface for CodeEditorHandle

fn paste_plain(&self, ctx: &EventContext<'_>)

Code has no rich formatting to strip; the plain paste is the paste.

fn can_undo(&self) -> bool

Is there anything in this surface’s own history to step back through?

fn can_redo(&self) -> bool

Is there anything to step forward into?

fn undo(&self)

fn redo(&self)

fn has_selection(&self) -> bool

Is any text selected right now?

fn is_read_only(&self) -> bool

Does this surface refuse edits? Cut and Paste are meaningless when it does.

fn allows_copy(&self) -> bool

May its contents be copied at all? A password field says no.

fn history_frozen(&self) -> bool

Is this surface refusing to step through its history at all?

fn cut(&self, ctx: &EventContext<'_>)

fn copy(&self, ctx: &EventContext<'_>)

fn paste(&self, ctx: &EventContext<'_>)

fn select_all(&self)