Protocol input_method_unstable_v1

Interface zwp_input_method_context_v1 — input method context

Corresponds to a text input on the input method side. An input method context is created on text input activation on the input method side. It allows receiving information about the text input from the application via events. Input method contexts do not keep state after deactivation and should be destroyed after deactivation is handled.

Text is generally UTF-8 encoded, indices and lengths are in bytes.

Serials are used to synchronize the state between the text input and an input method. New serials are sent by the text input in the commit_state request and are used by the input method to indicate the known text input state in events like preedit_string, commit_string, and keysym. The text input can then ignore events from the input method which are based on an outdated state (for example after a reset).

Warning! The protocol described in this file is experimental and backward incompatible changes may be made. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes are done by bumping the version number in the protocol and interface names and resetting the interface version. Once the protocol is to be declared stable, the 'z' prefix and the version number in the protocol and interface names are removed and the interface version number is reset.

Request zwp_input_method_context_v1.destroy

Request zwp_input_method_context_v1.commit_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.

• serial uint: serial of the latest known text input state
• text string: None

Request zwp_input_method_context_v1.preedit_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.

• serial uint: serial of the latest known text input state
• text string: None
• commit string: None

Request zwp_input_method_context_v1.preedit_styling — 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.

• index uint: None
• length uint: None
• style uint: None

Request zwp_input_method_context_v1.preedit_cursor — 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.

• index int: None

Request zwp_input_method_context_v1.delete_surrounding_text — delete text

Remove the surrounding text.

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

• index int: None
• length uint: None

Request zwp_input_method_context_v1.cursor_position — 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.

• index int: None
• anchor int: None

Request zwp_input_method_context_v1.modifiers_map

• map array: None

Request zwp_input_method_context_v1.keysym — 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.

• serial uint: serial of the latest known text input state
• time uint: None
• sym uint: None
• state uint: None
• modifiers uint: None

Request zwp_input_method_context_v1.grab_keyboard — 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.

• keyboard new_id<wl_keyboard>: None

Request zwp_input_method_context_v1.key — 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.

• serial uint: serial from wl_keyboard::key
• time uint: time from wl_keyboard::key
• key uint: key from wl_keyboard::key
• state uint: state from wl_keyboard::key

Request zwp_input_method_context_v1.modifiers — 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.

• serial uint: serial from wl_keyboard::modifiers
• mods_depressed uint: mods_depressed from wl_keyboard::modifiers
• mods_latched uint: mods_latched from wl_keyboard::modifiers
• mods_locked uint: mods_locked from wl_keyboard::modifiers
• group uint: group from wl_keyboard::modifiers

Request zwp_input_method_context_v1.language

• serial uint: serial of the latest known text input state
• language string: None

Request zwp_input_method_context_v1.text_direction

• serial uint: serial of the latest known text input state
• direction uint: None

Event zwp_input_method_context_v1.surrounding_text — surrounding text event

The plain surrounding text around the input position. Cursor is the position in bytes within the surrounding text relative to the beginning of the text. Anchor is the position in bytes of the selection anchor within the surrounding text relative to the beginning of the text. If there is no selected text then anchor is the same as cursor.

• text string: None
• cursor uint: None
• anchor uint: None

Event zwp_input_method_context_v1.reset

Event zwp_input_method_context_v1.content_type

• hint uint: None
• purpose uint: None

Event zwp_input_method_context_v1.invoke_action

• button uint: None
• index uint: None

Event zwp_input_method_context_v1.commit_state

• serial uint: serial of text input state

Event zwp_input_method_context_v1.preferred_language

• language string: None