Skip to main content

TextEditState

Struct TextEditState 

Source
pub struct TextEditState {
    pub text: String,
    pub cursor_pos: usize,
    pub selection_anchor: Option<usize>,
    pub scroll_offset: f32,
    pub scroll_offset_y: f32,
    pub cursor_blink_timer: f64,
    pub last_click_time: f64,
    pub last_click_element: u32,
    pub preferred_col: Option<usize>,
    pub no_styles_movement: bool,
    pub undo_stack: Vec<UndoEntry>,
    pub redo_stack: Vec<UndoEntry>,
}
Expand description

Persistent text editing state per text input element. Keyed by element u32 ID in PlyContext::text_edit_states.

Fields§

§text: String

The current text content.

§cursor_pos: usize

Character index of the cursor (0 = before first char, text.chars().count() = after last).

§selection_anchor: Option<usize>

When Some, defines the anchor of a selection range (anchor..cursor_pos or cursor_pos..anchor).

§scroll_offset: f32

Horizontal scroll offset (pixels) when text overflows the bounding box.

§scroll_offset_y: f32

Vertical scroll offset (pixels) for multiline text inputs.

§cursor_blink_timer: f64

Timer for cursor blink animation (seconds).

§last_click_time: f64

Timestamp of last click (for double-click detection).

§last_click_element: u32

Element ID of last click (for double-click detection).

§preferred_col: Option<usize>

Saved visual column for vertical (up/down) navigation. When set, up/down arrows try to return to this column.

§no_styles_movement: bool

When true, cursor movement skips structural style positions (} and empty content markers). Set from TextInputConfig::no_styles_movement.

§undo_stack: Vec<UndoEntry>

Undo stack: previous states (newest at end).

§redo_stack: Vec<UndoEntry>

Redo stack: states undone (newest at end).

Implementations§

Source§

impl TextEditState

Source

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

Returns the ordered selection range (start, end) if a selection is active.

Source

pub fn selected_text(&self) -> &str

Returns the selected text, or empty string if no selection.

Source

pub fn delete_selection(&mut self) -> bool

Delete the current selection and place cursor at the start. Returns true if a selection was deleted.

Source

pub fn insert_text(&mut self, s: &str, max_length: Option<usize>)

Insert text at the current cursor position, replacing any selection. Respects max_length if provided.

Source

pub fn move_left(&mut self, shift: bool)

Move cursor left by one character.

Source

pub fn move_right(&mut self, shift: bool)

Move cursor right by one character.

Source

pub fn move_word_left(&mut self, shift: bool)

Move cursor to the start of the previous word.

Source

pub fn move_word_right(&mut self, shift: bool)

Move cursor to the end of the next word.

Source

pub fn move_home(&mut self, shift: bool)

Move cursor to start of line.

Source

pub fn move_end(&mut self, shift: bool)

Move cursor to end of line.

Source

pub fn select_all(&mut self)

Select all text.

Source

pub fn backspace(&mut self)

Delete character before cursor (Backspace).

Source

pub fn delete_forward(&mut self)

Delete character after cursor (Delete key).

Source

pub fn backspace_word(&mut self)

Delete the word before the cursor (Ctrl+Backspace).

Source

pub fn delete_word_forward(&mut self)

Delete the word after the cursor (Ctrl+Delete).

Source

pub fn click_to_cursor( &mut self, click_x: f32, char_x_positions: &[f32], shift: bool, )

Set cursor position from a click at pixel x within the element. char_x_positions should be a sorted list of x-positions for each character boundary (index 0 = left edge of first char, index n = right edge of last char).

Source

pub fn select_word_at(&mut self, char_pos: usize)

Select the word at the given character position (for double-click).

Reset blink timer so cursor is immediately visible.

Source

pub fn cursor_visible(&self) -> bool

Returns whether the cursor should be visible based on blink timer.

Source

pub fn ensure_cursor_visible(&mut self, cursor_x: f32, visible_width: f32)

Update scroll offset to ensure cursor is visible within visible_width. cursor_x is the pixel x-position of the cursor relative to text start.

Source

pub fn ensure_cursor_visible_vertical( &mut self, cursor_line: usize, line_height: f32, visible_height: f32, )

Update vertical scroll offset to keep cursor visible in multiline mode. cursor_line is the 0-based line index the cursor is on. line_height is pixel height per line. visible_height is the element height.

Source

pub fn push_undo(&mut self, kind: UndoActionKind)

Push the current state onto the undo stack before an edit. kind controls grouping: consecutive edits of the same kind are merged (only InsertChar, Backspace, and Delete are grouped).

Source

pub fn undo(&mut self) -> bool

Undo the last edit. Returns true if undo was performed.

Source

pub fn redo(&mut self) -> bool

Redo the last undone edit. Returns true if redo was performed.

Source

pub fn move_line_home(&mut self, shift: bool)

Move cursor to the start of the current line (Home in multiline mode).

Source

pub fn move_line_end(&mut self, shift: bool)

Move cursor to the end of the current line (End in multiline mode).

Source

pub fn move_up(&mut self, shift: bool)

Move cursor up one line (multiline only).

Source

pub fn move_down(&mut self, shift: bool)

Move cursor down one line (multiline only).

Source§

impl TextEditState

When the text-styling feature is enabled, these methods operate on TextEditState using visual (display) cursor positions. The internal text field contains raw markup, but cursor_pos and selection_anchor always represent visual positions.

Source

pub fn selected_text_styled(&self) -> String

Get the selected text in visual space, returning the visible chars.

Source

pub fn delete_selection_styled(&mut self) -> bool

Delete selection in styled mode. Returns true if a selection was deleted.

Source

pub fn insert_text_styled(&mut self, s: &str, max_length: Option<usize>)

Insert text at visual cursor position in styled mode, with escaping. The input s should already be escaped if needed.

Source

pub fn insert_char_styled(&mut self, ch: char, max_length: Option<usize>)

Insert a single typed character in styled mode (auto-escapes).

Source

pub fn backspace_styled(&mut self)

Backspace in styled mode: delete visual char before cursor.

Source

pub fn delete_forward_styled(&mut self)

Delete forward in styled mode: delete visual char after cursor.

Source

pub fn backspace_word_styled(&mut self)

Backspace word in styled mode.

Source

pub fn delete_word_forward_styled(&mut self)

Delete word forward in styled mode.

Source

pub fn move_left_styled(&mut self, shift: bool)

Move left in styled mode (visual space).

Source

pub fn move_right_styled(&mut self, shift: bool)

Move right in styled mode (visual space).

Source

pub fn move_word_left_styled(&mut self, shift: bool)

Move word left in styled mode.

Source

pub fn move_word_right_styled(&mut self, shift: bool)

Move word right in styled mode.

Source

pub fn move_home_styled(&mut self, shift: bool)

Move to start in styled mode.

Source

pub fn move_end_styled(&mut self, shift: bool)

Move to end in styled mode.

Source

pub fn move_up_styled( &mut self, shift: bool, visual_lines: Option<&[VisualLine]>, )

Move cursor up one visual line in styled mode. If visual_lines is provided (multiline with wrapping), uses them for navigation. Otherwise falls back to simple line-based movement.

Source

pub fn move_down_styled( &mut self, shift: bool, visual_lines: Option<&[VisualLine]>, )

Move cursor down one visual line in styled mode.

Source

pub fn select_all_styled(&mut self)

Select all in styled mode.

Source

pub fn click_to_cursor_styled(&mut self, click_visual_pos: usize, shift: bool)

Click to cursor in styled mode. click_visual_pos is the visual character position determined from click x.

Source

pub fn select_word_at_styled(&mut self, visual_pos: usize)

Select word at visual position in styled mode.

Source

pub fn cursor_pos_raw(&self) -> usize

Convert the visual cursor_pos to a raw position for rendering. Enters empty style tags at the cursor boundary.

Source

pub fn selection_anchor_raw(&self) -> Option<usize>

Convert the visual selection_anchor to a raw position for rendering.

Source

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

Get the selection range in raw positions for rendering.

Trait Implementations§

Source§

impl Clone for TextEditState

Source§

fn clone(&self) -> TextEditState

Returns a duplicate 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 TextEditState

Source§

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

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

impl Default for TextEditState

Source§

fn default() -> Self

Returns the “default value” for a type. 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> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

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> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

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

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> RoundFrom<T> for T

Source§

fn round_from(x: T) -> T

Performs the conversion.
Source§

impl<T, U> RoundInto<U> for T
where U: RoundFrom<T>,

Source§

fn round_into(self) -> U

Performs the conversion.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
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> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

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

Source§

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

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
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,