Trait TextInputMethodClient 

pub trait TextInputMethodClient {
    // Required methods
    fn events(&self) -> &TextInputMethodClientEvents;
    fn text_view_visual(&self) -> Option<Ref<Visual>>;
    fn supports_preedit(&self) -> bool;
    fn supports_surrounding_text(&self) -> bool;
    fn surrounding_text(&self) -> String;
    fn cursor_rectangle(&self) -> Rect;
    fn selection(&self) -> TextSelection;
    fn set_selection(&self, value: TextSelection);

    // Provided methods
    fn set_preedit_text(&self, _preedit_text: Option<&str>) { ... }
    fn execute_context_menu_action(&self, _action: ContextMenuAction) { ... }
    fn set_preedit_text_with_cursor(
        &self,
        preedit_text: Option<&str>,
        _cursor_pos: Option<i32>,
    ) { ... }
    fn text_view_visual_changed(
        &self,
        handler: Rc<dyn Fn()>,
    ) -> Rc<dyn IDisposable> { ... }
    fn cursor_rectangle_changed(
        &self,
        handler: Rc<dyn Fn()>,
    ) -> Rc<dyn IDisposable> { ... }
    fn surrounding_text_changed(
        &self,
        handler: Rc<dyn Fn()>,
    ) -> Rc<dyn IDisposable> { ... }
    fn selection_changed(&self, handler: Rc<dyn Fn()>) -> Rc<dyn IDisposable> { ... }
    fn reset_requested(&self, handler: Rc<dyn Fn()>) -> Rc<dyn IDisposable> { ... }
    fn input_pane_activation_requested(
        &self,
        handler: Rc<dyn Fn()>,
    ) -> Rc<dyn IDisposable> { ... }
    fn raise_text_view_visual_changed(&self) { ... }
    fn raise_cursor_rectangle_changed(&self) { ... }
    fn raise_surrounding_text_changed(&self) { ... }
    fn raise_selection_changed(&self) { ... }
    fn raise_input_pane_activation_requested(&self) { ... }
    fn request_reset(&self) { ... }
}

The text editing side of a text input method: what a text editing control gives the input method of the platform to work with.

Implementations embed a TextInputMethodClientEvents and provide the members describing the text; the events and the methods raising them are provided. Clients are compared by reference.

Required Methods

fn events(&self) -> &TextInputMethodClientEvents

The events of the client.

fn text_view_visual(&self) -> Option<Ref<Visual>>

The visual that’s showing the text, or None when the client has none (a text box without a template).

fn supports_preedit(&self) -> bool

Indicates if the text input method client is capable of displaying non-committed input on the cursor position.

fn supports_surrounding_text(&self) -> bool

Indicates if the text input method client supports sending surrounding text.

fn surrounding_text(&self) -> String

Returns the text around the cursor, usually the current paragraph.

fn cursor_rectangle(&self) -> Rect

Gets the cursor rectangle relative to the text view visual.

fn selection(&self) -> TextSelection

Gets the selection that is currently active.

fn set_selection(&self, value: TextSelection)

Sets the selection that is currently active.

Provided Methods

fn set_preedit_text(&self, _preedit_text: Option<&str>)

Sets the non-committed input string.

fn execute_context_menu_action(&self, _action: ContextMenuAction)

Executes a context menu action.

fn set_preedit_text_with_cursor( &self, preedit_text: Option<&str>, _cursor_pos: Option<i32>, )

Sets the non-committed input string and the cursor offset in that string.

fn text_view_visual_changed(&self, handler: Rc<dyn Fn()>) -> Rc<dyn IDisposable>

Fires when the text view visual has changed. Disposing the returned handle unsubscribes.

fn cursor_rectangle_changed(&self, handler: Rc<dyn Fn()>) -> Rc<dyn IDisposable>

Fires when the cursor rectangle has changed. Disposing the returned handle unsubscribes.

fn surrounding_text_changed(&self, handler: Rc<dyn Fn()>) -> Rc<dyn IDisposable>

Fires when the surrounding text has changed. Disposing the returned handle unsubscribes.

fn selection_changed(&self, handler: Rc<dyn Fn()>) -> Rc<dyn IDisposable>

Fires when the selection has changed. Disposing the returned handle unsubscribes.

fn reset_requested(&self, handler: Rc<dyn Fn()>) -> Rc<dyn IDisposable>

Fires when client wants to reset the input state. Disposing the returned handle unsubscribes.

fn input_pane_activation_requested( &self, handler: Rc<dyn Fn()>, ) -> Rc<dyn IDisposable>

Fires when the client requires the input pane (on-screen keyboard) to be shown. Disposing the returned handle unsubscribes.

fn raise_text_view_visual_changed(&self)

Raises the event telling that the text view visual has changed.

fn raise_cursor_rectangle_changed(&self)

Raises the event telling that the cursor rectangle has changed.

fn raise_surrounding_text_changed(&self)

Raises the event telling that the surrounding text has changed.

fn raise_selection_changed(&self)

Raises the event telling that the selection has changed.

fn raise_input_pane_activation_requested(&self)

Raises the event asking for the input pane to be shown.

fn request_reset(&self)

Asks for the input state to be reset.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors