Struct TextEditingController 

pub struct TextEditingController { /* private fields */ }

Cloneable editing controller. It owns no platform resources; platform and widget layers can subscribe to value changes and decide when to repaint.

Implementations

impl TextEditingController

pub fn new() -> Self

pub fn with_text(text: impl Into<String>) -> Self

Creates a controller initialized with committed text.

pub fn restored(scope: RestorationScope, key: RestorationKey) -> Self

Creates an empty editor and restores its committed state, if present.

pub fn bind_restoration(&self, scope: RestorationScope, key: RestorationKey)

Binds committed text and selection to a stable restoration value.

pub fn unbind_restoration(&self)

Stops persisting subsequent editor mutations without deleting the saved value.

pub fn from_value(value: TextEditingValue) -> Self

pub fn value(&self) -> TextEditingValue

pub fn text(&self) -> String

pub fn selection(&self) -> TextSelection

pub fn composing(&self) -> Option<ComposingRange>

pub fn set_value(&self, value: TextEditingValue)

pub fn set_text(&self, text: impl Into<String>)

pub fn clear(&self)

pub fn set_selection(&self, selection: TextSelection)

pub fn set_selection_with_affinity( &self, selection: TextSelection, affinity: TextAffinity, )

Sets a selection while preserving which visual edge of a bidi run owns a collapsed caret. Native hit testing should use this overload.

pub fn set_composing(&self, composing: Option<ComposingRange>)

pub fn observe( &self, listener: impl Fn(&TextEditingValue) + 'static, ) -> TextEditingSubscription

Observes committed editing changes with automatic cleanup on drop.

pub fn add_listener( &self, listener: impl Fn(&TextEditingValue) + 'static, ) -> usize

Low-level manual registration for backend integrations. Prefer observe. Returns an opaque token accepted by Self::remove_listener.

pub fn remove_listener(&self, token: usize) -> bool

pub fn apply_delta(&self, delta: &TextEditingDelta)

pub fn replace_selection(&self, replacement: &str)

pub fn insert_text(&self, text: &str)

pub fn delete_backward(&self)

pub fn delete_forward(&self)

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

Alias used by the Widgets editor API.

pub fn backspace(&self)

Deletes one grapheme cluster behind the caret, or the active selection.

pub fn delete(&self)

Deletes one grapheme cluster ahead of the caret, or the active selection.

pub fn move_left(&self, extend: bool)

pub fn move_right(&self, extend: bool)

pub fn move_left_visual(&self, layout: &TextLayout, extend: bool)

Moves one grapheme in screen/visual order using the bidi caret stops emitted by TextLayout. The logical byte offset may move backwards while the caret moves right, which is required for right-to-left text.

pub fn move_right_visual(&self, layout: &TextLayout, extend: bool)

Moves one grapheme in screen/visual order using the bidi caret stops emitted by TextLayout.

pub fn move_home(&self, extend: bool)

pub fn move_end(&self, extend: bool)

pub fn select_all(&self)

pub fn selected_text(&self) -> String

pub fn set_preedit(&self, text: impl Into<String>, selection: Option<TextRange>)

Sets transient IME preedit text without changing committed content.

pub fn commit_preedit(&self, text: &str)

pub fn clear_preedit(&self)

pub fn preedit(&self) -> Option<String>

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

pub fn caret_affinity(&self) -> TextAffinity

Returns the visual affinity of the collapsed caret.

Trait Implementations

impl Clone for TextEditingController

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextEditingController

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

Formats the value using the given formatter.

impl Default for TextEditingController

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for TextEditingController

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.