Trait webkit6::prelude::InputMethodContextExt

pub trait InputMethodContextExt: IsA<InputMethodContext> + Sealed + 'static {
    // Provided methods
    fn filter_key_event(&self, key_event: impl AsRef<Event>) -> bool { ... }
    fn input_hints(&self) -> InputHints { ... }
    fn input_purpose(&self) -> InputPurpose { ... }
    fn notify_cursor_area(&self, x: i32, y: i32, width: i32, height: i32) { ... }
    fn notify_focus_in(&self) { ... }
    fn notify_focus_out(&self) { ... }
    fn notify_surrounding(
        &self,
        text: &str,
        cursor_index: u32,
        selection_index: u32,
    ) { ... }
    fn reset(&self) { ... }
    fn set_enable_preedit(&self, enabled: bool) { ... }
    fn set_input_hints(&self, hints: InputHints) { ... }
    fn set_input_purpose(&self, purpose: InputPurpose) { ... }
    fn connect_committed<F: Fn(&Self, &str) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_delete_surrounding<F: Fn(&Self, i32, u32) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_preedit_changed<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_preedit_finished<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_preedit_started<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_input_hints_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_input_purpose_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
}

Trait containing all InputMethodContext methods.

Implementors

InputMethodContext

Provided Methods

fn filter_key_event(&self, key_event: impl AsRef<Event>) -> bool

Allow @key_event to be handled by the input method.

If true is returned, then no further processing should be done for the key event.

key_event

the key event to filter

Returns

true if the key event was handled, or false otherwise

fn input_hints(&self) -> InputHints

Get the value of the #WebKitInputMethodContext:input-hints property.

Returns

the #WebKitInputHints of the input associated with @self

fn input_purpose(&self) -> InputPurpose

Get the value of the #WebKitInputMethodContext:input-purpose property.

Returns

the #WebKitInputPurpose of the input associated with @self

fn notify_cursor_area(&self, x: i32, y: i32, width: i32, height: i32)

Notify @self that cursor area changed in input associated.

x

the x coordinate of cursor location

y

the y coordinate of cursor location

width

the width of cursor area

height

the height of cursor area

fn notify_focus_in(&self)

Notify @self that input associated has gained focus.

fn notify_focus_out(&self)

Notify @self that input associated has lost focus.

fn notify_surrounding( &self, text: &str, cursor_index: u32, selection_index: u32, )

Notify @self that the context surrounding the cursor has changed.

If there’s no selection @selection_index is the same as @cursor_index.

text

text surrounding the insertion point

length

the length of @text, or -1 if @text is nul-terminated

cursor_index

the byte index of the insertion cursor within @text.

selection_index

the byte index of the selection cursor within @text.

fn reset(&self)

Reset the @self.

This will typically cause the input to clear the preedit state.

fn set_enable_preedit(&self, enabled: bool)

Set whether @self should enable preedit to display feedback.

enabled

whether to enable preedit

fn set_input_hints(&self, hints: InputHints)

Set the value of the #WebKitInputMethodContext:input-hints property.

hints

a #WebKitInputHints

fn set_input_purpose(&self, purpose: InputPurpose)

Set the value of the #WebKitInputMethodContext:input-purpose property.

purpose

a #WebKitInputPurpose

fn connect_committed<F: Fn(&Self, &str) + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted when a complete input sequence has been entered by the user. This can be a single character immediately after a key press or the final result of preediting.

text

the string result

fn connect_delete_surrounding<F: Fn(&Self, i32, u32) + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted when the input method wants to delete the context surrounding the cursor. If @offset is a negative value, it means a position before the cursor.

offset

the character offset from the cursor position of the text to be deleted.

n_chars

the number of characters to be deleted

fn connect_preedit_changed<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted whenever the preedit sequence currently being entered has changed. It is also emitted at the end of a preedit sequence, in which case webkit_input_method_context_get_preedit() returns the empty string.

fn connect_preedit_finished<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted when a preediting sequence has been completed or canceled.

fn connect_preedit_started<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted when a new preediting sequence starts.

fn connect_input_hints_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

fn connect_input_purpose_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Object Safety

This trait is not object safe.

Implementors

impl<O: IsA<InputMethodContext>> InputMethodContextExt for O