Struct TextEditOp Copy item path

impl TextEditOp

pub fn new<D>( data: D, op: impl FnMut(&mut D, UndoFullOp<'_>) + Send + 'static, ) -> TextEditOp
where D: Send + Any + 'static,

New text edit operation.

The editable text widget that handles EDIT_CMD will call op during event handling in the node::resolve_text context meaning the TEXT.resolved and TEXT.resolve_caret service is available in op. The text is edited by modifying ResolvedText::txt. The text widget will detect changes to the caret and react s accordingly (updating caret position and animation), the caret index is also snapped to the nearest grapheme start.

The op arguments are a custom data D and what UndoFullOp to run, all text edit operations must be undoable, first UndoOp::Redo is called to “do”, then undo and redo again if the user requests undo & redo. The text variable is always read-write when op is called, more than one op can be called before the text variable updates, and ResolvedText::pending_edit is always false.

pub fn insert(insert: impl Into<Txt>) -> TextEditOp

Insert operation.

The insert text is inserted at the current caret index or at 0, or replaces the current selection, after insert the caret is positioned after the inserted text.

pub fn backspace() -> TextEditOp

Remove one backspace range ending at the caret index, or removes the selection.

See SegmentedText::backspace_range for more details about what is removed.

pub fn backspace_word() -> TextEditOp

Remove one backspace word range ending at the caret index, or removes the selection.

See SegmentedText::backspace_word_range for more details about what is removed.

pub fn delete() -> TextEditOp

Remove one delete range starting at the caret index, or removes the selection.

See SegmentedText::delete_range for more details about what is removed.

pub fn delete_word() -> TextEditOp

Remove one delete word range starting at the caret index, or removes the selection.

See SegmentedText::delete_word_range for more details about what is removed.

pub fn clear() -> TextEditOp

Remove all the text.

pub fn replace( select_before: Range<usize>, insert: impl Into<Txt>, select_after: Range<usize>, ) -> TextEditOp

Replace operation.

The select_before is removed, and insert inserted at the select_before.start, after insertion the select_after is applied, you can use an empty insert to just remove.

All indexes are snapped to the nearest grapheme, you can use empty ranges to just position the caret.

pub fn apply_transforms() -> TextEditOp

Applies TEXT_TRANSFORM_VAR and WHITE_SPACE_VAR to the text.

Trait Implementations§

impl Clone for TextEditOp

fn clone(&self) -> TextEditOp

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

impl Debug for TextEditOp

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl !UnwindSafe for TextEditOp

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> Downcast for T
where T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

impl<T> DowncastSync for T
where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FsChangeNote for T
where T: Debug + Any + Send + Sync,

fn as_any(&self) -> &(dyn Any + 'static)

Access any.

impl<T> Instrument for T

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

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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