Struct ImeArgs

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

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

impl ImeArgs

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)>>, ) -> ImeArgs

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)>>, ) -> ImeArgs

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 delivery_list(&self, list: &mut UpdateDeliveryList)

Target.

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

Clone the event into a type erased box.

fn as_any(&self) -> &(dyn Any + 'static)

Access to dyn Any methods.

fn timestamp(&self) -> DInstant

Gets the instant this event happened.

fn propagation(&self) -> &EventPropagationHandle

Propagation handle associated with this event instance.

impl Clone for ImeArgs

fn clone(&self) -> ImeArgs

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl EventArgs for ImeArgs

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

where F: FnOnce(&Self) -> R,

Calls handler and stops propagation if propagation is still allowed.