Struct TextFieldBuffer

Source

pub struct TextFieldBuffer { /* private fields */ }

Expand description

A mutable text buffer that can be edited.

This provides methods for changing text content:

replace - Replace a range with new text
append - Add text at the end
insert - Insert text at cursor position
delete - Delete a range of text

And for manipulating cursor/selection:

§Example

use cranpose_foundation::text::{TextFieldBuffer, TextRange};

let mut buffer = TextFieldBuffer::new("Hello");
buffer.place_cursor_at_end();
buffer.insert(", World!");
assert_eq!(buffer.text(), "Hello, World!");

Implementations§

Source §

impl TextFieldBuffer

Source

pub fn new(initial_text: impl Into<String>) -> Self

Creates a new buffer with the given initial text. Cursor is placed at the end of the text.

Source

pub fn with_selection(text: impl Into<String>, selection: TextRange) -> Self

Creates a buffer with text and specified selection.

Source

pub fn text(&self) -> &str

Returns the current text content.

Source

pub fn len(&self) -> usize

Returns the length of the text in bytes.

Source

pub fn is_empty(&self) -> bool

Returns true if the buffer is empty.

Source

pub fn selection(&self) -> TextRange

Returns the current selection range.

Source

pub fn composition(&self) -> Option<TextRange>

Returns the current composition (IME) range, if any.

Source

pub fn has_selection(&self) -> bool

Returns true if there’s a non-collapsed selection.

Source

pub fn has_changes(&self) -> bool

Returns true if any changes have been made.

Source

pub fn replace(&mut self, range: TextRange, replacement: &str)

Replaces text in the given range with new text.

The selection is adjusted based on the replacement:

If replacing before selection, selection shifts
If replacing within selection, cursor moves to end of replacement

Source

pub fn insert(&mut self, text: &str)

Inserts text at the current cursor position (or replaces selection).

Source

pub fn append(&mut self, text: &str)

Appends text at the end of the buffer.

Source

pub fn delete(&mut self, range: TextRange)

Deletes text in the given range.

Source

pub fn delete_before_cursor(&mut self)

Deletes the character before the cursor (backspace).

Source

pub fn delete_after_cursor(&mut self)

Deletes the character after the cursor (delete key).

Source

pub fn delete_surrounding(&mut self, before_bytes: usize, after_bytes: usize)

Deletes text surrounding the cursor or selection.

before_bytes and after_bytes are byte counts in UTF-8. The deletion respects character boundaries and preserves any IME composition range.

Source

pub fn clear(&mut self)

Clears all text.

Source

pub fn place_cursor_at_end(&mut self)

Places the cursor at the end of the text.

Source

pub fn place_cursor_at_start(&mut self)

Places the cursor at the start of the text.

Source

pub fn place_cursor_before_char(&mut self, index: usize)

Places the cursor before the character at the given index.

Source

pub fn select_all(&mut self)

Selects all text.

Source

pub fn extend_selection_left(&mut self)

Extends the selection one character to the left.

start is the anchor and end is the moving cursor, which is what makes this and Self::extend_selection_right inverses of each other: shift-left followed by shift-right returns to where it began. Moving whichever end happens to be smaller instead would leave the two growing from opposite ends, and shift-right after shift-left would grow the selection rather than shrink it.

A reverse range (start > end) is how an anchor to the right of the cursor is represented; see TextRange.

Source