Skip to main content

TextInputRegionProps

Struct TextInputRegionProps 

Source
pub struct TextInputRegionProps {
    pub layout: LayoutStyle,
    pub enabled: bool,
    pub text_boundary_mode_override: Option<TextBoundaryMode>,
    pub ime_cursor_area: Option<Rect>,
    pub a11y_label: Option<Arc<str>>,
    pub a11y_value: Option<Arc<str>>,
    pub a11y_required: bool,
    pub a11y_invalid: Option<SemanticsInvalid>,
    pub a11y_text_selection: Option<(u32, u32)>,
    pub a11y_text_composition: Option<(u32, u32)>,
    pub ime_surrounding_text: Option<WindowImeSurroundingText>,
}
Expand description

A focusable event region that participates in text input / IME routing.

Fields§

§layout: LayoutStyle§enabled: bool§text_boundary_mode_override: Option<TextBoundaryMode>§ime_cursor_area: Option<Rect>

Optional IME cursor area in window visual space.

When set, this is forwarded to WindowTextInputSnapshot.ime_cursor_area while the region is focused. This is a data-only escape hatch for editor ecosystems that own the geometry mapping (buffer ↔ rows ↔ caret rect) outside the mechanism layer.

§a11y_label: Option<Arc<str>>

Optional accessibility label for this text input region.

§a11y_value: Option<Arc<str>>

Optional accessibility value text for this text input region.

When present, selection and composition ranges are interpreted as UTF-8 byte offsets within this value (ADR 0071).

§a11y_required: bool§a11y_invalid: Option<SemanticsInvalid>§a11y_text_selection: Option<(u32, u32)>

Optional selection range (anchor, focus) in UTF-8 byte offsets within a11y_value.

§a11y_text_composition: Option<(u32, u32)>

Optional IME composition range (start, end) in UTF-8 byte offsets within a11y_value.

§ime_surrounding_text: Option<WindowImeSurroundingText>

Best-effort surrounding text excerpt for IME backends that support it.

This SHOULD exclude any active preedit/composing text and SHOULD be limited to WindowImeSurroundingText::MAX_TEXT_BYTES.

Trait Implementations§

Source§

impl Clone for TextInputRegionProps

Source§

fn clone(&self) -> TextInputRegionProps

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 TextInputRegionProps

Source§

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

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

impl Default for TextInputRegionProps

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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