Skip to main content

TextFieldValue

Struct TextFieldValue 

Source
pub struct TextFieldValue {
    pub annotated_string: AnnotatedString,
    pub selection: TextRange,
    pub composition: Option<TextRange>,
}
Expand description

Snapshot of a text field’s editing state including text, selection, and IME composition range. Corresponds to Compose’s TextFieldValue.

Fields§

§annotated_string: AnnotatedString

The annotated text. Plain text is accessible via text() or annotated_string.text.

§selection: TextRange

Selection range in byte offsets. Collapsed range (start == end) = cursor.

§composition: Option<TextRange>

Active IME composition range in byte offsets, or None.

Implementations§

Source§

impl TextFieldValue

Source

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

Create from plain text (no annotations).

Source

pub fn from_annotated(annotated: AnnotatedString) -> Self

Create from an AnnotatedString preserving all annotations.

Source

pub fn text(&self) -> &str

Convenience: plain text content (delegates to annotated_string.text).

Source

pub fn with_selection(self, start: usize, end: usize) -> Self

Source

pub fn get_text_before_selection(&self, max_chars: usize) -> AnnotatedString

Source

pub fn get_text_after_selection(&self, max_chars: usize) -> AnnotatedString

Source

pub fn get_selected_text(&self) -> AnnotatedString

Source

pub fn copy(&self, annotated_string: AnnotatedString) -> Self

Returns a copy with the given annotated string.

Source

pub fn copy_text(&self, text: String) -> Self

Returns a copy with the given plain text.

Trait Implementations§

Source§

impl Clone for TextFieldValue

Source§

fn clone(&self) -> TextFieldValue

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TextFieldValue

Source§

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

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

impl PartialEq for TextFieldValue

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for TextFieldValue

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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