[−][src]Trait wayland_protocols::unstable::input_method::v1::client::zwp_input_method_context_v1::RequestsTrait

pub trait RequestsTrait {
    fn destroy(&self);

    fn commit_string(&self, serial: u32, text: String);

    fn preedit_string(&self, serial: u32, text: String, commit: String);

    fn preedit_styling(&self, index: u32, length: u32, style: u32);

    fn preedit_cursor(&self, index: i32);

    fn delete_surrounding_text(&self, index: i32, length: u32);

    fn cursor_position(&self, index: i32, anchor: i32);

    fn modifiers_map(&self, map: Vec<u8>);

    fn keysym(
        &self, 
        serial: u32, 
        time: u32, 
        sym: u32, 
        state: u32, 
        modifiers: u32
    );

    fn grab_keyboard<F>(&self, implementor: F) -> Result<Proxy<WlKeyboard>, ()>
    where
        F: FnOnce(NewProxy<WlKeyboard>) -> Proxy<WlKeyboard>;

    fn key(&self, serial: u32, time: u32, key: u32, state: u32);

    fn modifiers(
        &self, 
        serial: u32, 
        mods_depressed: u32, 
        mods_latched: u32, 
        mods_locked: u32, 
        group: u32
    );

    fn language(&self, serial: u32, language: String);

    fn text_direction(&self, serial: u32, direction: u32);
}

Required methods

fn destroy(&self)

This is a destructor, you cannot send requests to this object any longer once this method is called.

fn commit_string(&self, serial: u32, text: String)

commit string

Send the commit string text for insertion to the application.

The text to commit could be either just a single character after a key press or the result of some composing (pre-edit). It could be also an empty text when some text should be removed (see delete_surrounding_text) or when the input cursor should be moved (see cursor_position).

Any previously set composing text will be removed.

fn preedit_string(&self, serial: u32, text: String, commit: String)

pre-edit string

Send the pre-edit string text to the application text input.

The commit text can be used to replace the pre-edit text on reset (for example on unfocus).

Previously sent preedit_style and preedit_cursor requests are also processed by the text_input.

fn preedit_styling(&self, index: u32, length: u32, style: u32)

pre-edit styling

Set the styling information on composing text. The style is applied for length in bytes from index relative to the beginning of the composing text (as byte offset). Multiple styles can be applied to a composing text.

This request should be sent before sending a preedit_string request.

fn preedit_cursor(&self, index: i32)

pre-edit cursor

Set the cursor position inside the composing text (as byte offset) relative to the start of the composing text.

When index is negative no cursor should be displayed.

This request should be sent before sending a preedit_string request.

fn delete_surrounding_text(&self, index: i32, length: u32)

delete text

Remove the surrounding text.

This request will be handled on the text_input side directly following a commit_string request.

fn cursor_position(&self, index: i32, anchor: i32)

set cursor to a new position

Set the cursor and anchor to a new position. Index is the new cursor position in bytes (when >= 0 this is relative to the end of the inserted text, otherwise it is relative to the beginning of the inserted text). Anchor is the new anchor position in bytes (when >= 0 this is relative to the end of the inserted text, otherwise it is relative to the beginning of the inserted text). When there should be no selected text, anchor should be the same as index.

This request will be handled on the text_input side directly following a commit_string request.

fn modifiers_map(&self, map: Vec<u8>)

fn keysym(&self, serial: u32, time: u32, sym: u32, state: u32, modifiers: u32)

keysym

Notify when a key event was sent. Key events should not be used for normal text input operations, which should be done with commit_string, delete_surrounding_text, etc. The key event follows the wl_keyboard key event convention. Sym is an XKB keysym, state is a wl_keyboard key_state.

fn grab_keyboard<F>(&self, implementor: F) -> Result<Proxy<WlKeyboard>, ()> where
    F: FnOnce(NewProxy<WlKeyboard>) -> Proxy<WlKeyboard>, 

grab hardware keyboard

Allow an input method to receive hardware keyboard input and process key events to generate text events (with pre-edit) over the wire. This allows input methods which compose multiple key events for inputting text like it is done for CJK languages.

fn key(&self, serial: u32, time: u32, key: u32, state: u32)

forward key event

Forward a wl_keyboard::key event to the client that was not processed by the input method itself. Should be used when filtering key events with grab_keyboard. The arguments should be the ones from the wl_keyboard::key event.

For generating custom key events use the keysym request instead.

fn modifiers(
    &self,
    serial: u32,
    mods_depressed: u32,
    mods_latched: u32,
    mods_locked: u32,
    group: u32
)

forward modifiers event

Forward a wl_keyboard::modifiers event to the client that was not processed by the input method itself. Should be used when filtering key events with grab_keyboard. The arguments should be the ones from the wl_keyboard::modifiers event.

fn language(&self, serial: u32, language: String)

fn text_direction(&self, serial: u32, direction: u32)

Loading content...

Implementations on Foreign Types

impl RequestsTrait for Proxy<ZwpInputMethodContextV1>[src]

Loading content...

Implementors

Loading content...