Struct ImeArgs 

pub struct ImeArgs {
    pub timestamp: DInstant,
    pub target: WidgetPath,
    pub txt: Txt,
    pub preview_caret: Option<(usize, usize)>,
    pub propagation: EventPropagationHandle,
}

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.

propagation: EventPropagationHandle

Propagation handle associated with this event instance.

Cloned arguments share the same handle, some arguments may also share the handle of another event if they share the same cause.

Implementations

impl ImeArgs

pub fn new( timestamp: impl Into<DInstant>, propagation: 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.

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

impl ImeArgs

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

impl AnyEventArgs for ImeArgs

fn is_in_target(&self, id: WidgetId) -> bool

Target.

fn timestamp(&self) -> DInstant

Instant this event update happened.

fn propagation(&self) -> &EventPropagationHandle

Propagation handle associated with this event instance.

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

Clone the args to a new box.

impl Clone for ImeArgs

fn clone(&self) -> ImeArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImeArgs

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

Formats the value using the given formatter.

impl PartialEq for ImeArgs

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl EventArgs for ImeArgs

impl StructuralPartialEq for ImeArgs