zng_ext_window

Struct ImeArgs

source
pub struct ImeArgs {
    pub timestamp: DInstant,
    pub target: WidgetPath,
    pub txt: Txt,
    pub preview_caret: Option<(usize, usize)>,
    /* private fields */
}
Expand description

Arguments for IME_EVENT.

Fields§

§timestamp: DInstant

Instant the event happened.

§target: WidgetPath

The enabled text input widget.

§txt: Txt

The text, preview or actual insert.

§preview_caret: Option<(usize, usize)>

Caret/selection within the txt when it is preview.

The indexes are in char byte offsets and indicate where the caret or selection must be placed on the inserted or preview txt, if not set the position is at the end of the insert.

If this is None the text must commit.

Implementations§

source§

impl ImeArgs

source

pub fn new( timestamp: impl Into<DInstant>, propagation_handle: EventPropagationHandle, target: impl Into<WidgetPath>, txt: impl Into<Txt>, preview_caret: impl Into<Option<(usize, usize)>>, ) -> Self

New args from values that convert into the argument types.

source

pub fn now( target: impl Into<WidgetPath>, txt: impl Into<Txt>, preview_caret: impl Into<Option<(usize, usize)>>, ) -> Self

Arguments for event that happened now (INSTANT.now).

source§

impl ImeArgs

source

pub fn commit(&self) -> bool

If the text must be actually inserted.

If true the txt must be actually inserted at the last non-preview caret/selection, the caret then must be moved to after the inserted text.

If false the widget must visually adjust the text and caret to look as if the input has committed, but the actual text must not be altered, and if the txt is empty the previous caret/selection must be restored. Usually the preview text is rendered with an underline effect, otherwise it has the same appearance as the committed text.

Trait Implementations§

source§

impl AnyEventArgs for ImeArgs

source§

fn delivery_list(&self, list: &mut UpdateDeliveryList)

Target.

source§

fn clone_any(&self) -> Box<dyn AnyEventArgs>

Clone the event into a type erased box.
source§

fn as_any(&self) -> &dyn Any

Access to dyn Any methods.
source§

fn timestamp(&self) -> DInstant

Gets the instant this event happened.
source§

fn propagation(&self) -> &EventPropagationHandle

Propagation handle associated with this event instance. Read more
source§

impl Clone for ImeArgs

source§

fn clone(&self) -> ImeArgs

Returns a copy 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 ImeArgs

source§

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

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

impl EventArgs for ImeArgs

source§

fn handle<F, R>(&self, handler: F) -> Option<R>
where F: FnOnce(&Self) -> R,

Calls handler and stops propagation if propagation is still allowed. 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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
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
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T

source§

impl<T> StateValue for T
where T: Any + Send + Sync,