text_input_unstable_v2 protocol
zwp_text_input_v2 interface version 1
The zwp_text_input_v2 interface represents text input and input methods associated with a seat. It provides enter/leave events to follow the text input focus for a seat. Requests are used to enable/disable the text-input object and set state information like surrounding and selected text or the content type. The information about the entered text is sent to the text-input object via the pre-edit and commit events. Using this interface removes the need for applications to directly process hardware key events and compose text out of them. Text is valid UTF-8 encoded, indices and lengths are in bytes. Indices have to always point to the first byte of an UTF-8 encoded code point. Lengths are not allowed to contain just a part of an UTF-8 encoded code point. State is sent by the state requests (set_surrounding_text, set_content_type, set_cursor_rectangle and set_preferred_language) and an update_state request. After an enter or an input_method_change event all state information is invalidated and needs to be resent from the client. A reset or entering a new widget on client side also invalidates all current state information.
Requests
destroy (destructor) since version 0
~destroy()Destroy the wp_text_input object. Also disables all surfaces enabled through this wp_text_input object
enable since version 0
enable(surface object[wl_surface])Enable text input in a surface (usually when a text entry inside of it has focus). This can be called before or after a surface gets text (or keyboard) focus via the enter event. Text input to a surface is only active when it has the current text (or keyboard) focus and is enabled.
Arguments
| Name | Type | Description |
|---|---|---|
| surface | object[wl_surface] |
disable since version 0
disable(surface object[wl_surface])Disable text input in a surface (typically when there is no focus on any text entry inside the surface).
Arguments
| Name | Type | Description |
|---|---|---|
| surface | object[wl_surface] |
show_input_panel since version 0
show_input_panel()Requests input panels (virtual keyboard) to show. This should be used for example to show a virtual keyboard again (with a tap) after it was closed by pressing on a close button on the keyboard.
hide_input_panel since version 0
hide_input_panel()Requests input panels (virtual keyboard) to hide.
set_surrounding_text since version 0
set_surrounding_text(text string, cursor int, anchor int)Sets the plain surrounding text around the input position. Text is UTF-8 encoded. Cursor is the byte offset within the surrounding text. Anchor is the byte offset of the selection anchor within the surrounding text. If there is no selected text, anchor is the same as cursor. Make sure to always send some text before and after the cursor except when the cursor is at the beginning or end of text. When there was a configure_surrounding_text event take the before_cursor and after_cursor arguments into account for picking how much surrounding text to send. There is a maximum length of wayland messages so text can not be longer than 4000 bytes.
Arguments
| Name | Type | Description |
|---|---|---|
| text | string | |
| cursor | int | |
| anchor | int |
set_content_type since version 0
set_content_type(hint uint, purpose uint)Sets the content purpose and content hint. While the purpose is the basic purpose of an input field, the hint flags allow to modify some of the behavior. When no content type is explicitly set, a normal content purpose with none hint should be assumed.
Arguments
| Name | Type | Description |
|---|---|---|
| hint | uint | |
| purpose | uint |
set_cursor_rectangle since version 0
set_cursor_rectangle(x int, y int, width int, height int)Sets the cursor outline as a x, y, width, height rectangle in surface local coordinates. Allows the compositor to put a window with word suggestions near the cursor.
Arguments
| Name | Type | Description |
|---|---|---|
| x | int | |
| y | int | |
| width | int | |
| height | int |
set_preferred_language since version 0
set_preferred_language(language string)Sets a specific language. This allows for example a virtual keyboard to show a language specific layout. The "language" argument is a RFC-3066 format language tag. It could be used for example in a word processor to indicate language of currently edited document or in an instant message application which tracks languages of contacts.
Arguments
| Name | Type | Description |
|---|---|---|
| language | string |
update_state since version 0
update_state(serial uint, reason uint)Allows to atomically send state updates from client. This request should follow after a batch of state updating requests like set_surrounding_text, set_content_type, set_cursor_rectangle and set_preferred_language. The flags field indicates why an updated state is sent to the input method. Reset should be used by an editor widget after the text was changed outside of the normal input method flow. For "change" it is enough to send the changed state, else the full state should be send. Serial should be set to the serial from the last enter or input_method_changed event. To make sure to not receive outdated input method events after a reset or switching to a new widget wl_display_sync() should be used after update_state in these cases.
Arguments
| Name | Type | Description |
|---|---|---|
| serial | uint | serial of the enter or input_method_changed event |
| reason | uint |
Events
enter since version 0
enter(serial uint, surface object[wl_surface])Notification that this seat's text-input focus is on a certain surface. When the seat has the keyboard capability the text-input focus follows the keyboard focus.
Arguments
| Name | Type | Description |
|---|---|---|
| serial | uint | serial to be used by update_state |
| surface | object[wl_surface] |
leave since version 0
leave(serial uint, surface object[wl_surface])Notification that this seat's text-input focus is no longer on a certain surface. The leave notification is sent before the enter notification for the new focus. When the seat has the keyboard capability the text-input focus follows the keyboard focus.
Arguments
| Name | Type | Description |
|---|---|---|
| serial | uint | |
| surface | object[wl_surface] |
input_panel_state since version 0
input_panel_state(state uint, x int, y int, width int, height int)Notification that the visibility of the input panel (virtual keyboard) changed. The rectangle x, y, width, height defines the area overlapped by the input panel (virtual keyboard) on the surface having the text focus in surface local coordinates. That can be used to make sure widgets are visible and not covered by a virtual keyboard.
Arguments
| Name | Type | Description |
|---|---|---|
| state | uint | |
| x | int | |
| y | int | |
| width | int | |
| height | int |
preedit_string since version 0
preedit_string(text string, commit string)Notify when a new composing text (pre-edit) should be set around the current cursor position. Any previously set composing text should be removed. The commit text can be used to replace the composing text in some cases (for example when losing focus). The text input should also handle all preedit_style and preedit_cursor events occurring directly before preedit_string.
Arguments
| Name | Type | Description |
|---|---|---|
| text | string | |
| commit | string |
preedit_styling since version 0
preedit_styling(index uint, length uint, style uint)Sets styling information on composing text. The style is applied for length bytes from index relative to the beginning of the composing text (as byte offset). Multiple styles can be applied to a composing text by sending multiple preedit_styling events. This event is handled as part of a following preedit_string event.
Arguments
| Name | Type | Description |
|---|---|---|
| index | uint | |
| length | uint | |
| style | uint |
preedit_cursor since version 0
preedit_cursor(index int)Sets the cursor position inside the composing text (as byte offset) relative to the start of the composing text. When index is a negative number no cursor is shown. When no preedit_cursor event is sent the cursor will be at the end of the composing text by default. This event is handled as part of a following preedit_string event.
Arguments
| Name | Type | Description |
|---|---|---|
| index | int |
commit_string since version 0
commit_string(text string)Notify when text should be inserted into the editor widget. 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 should be removed.
Arguments
| Name | Type | Description |
|---|---|---|
| text | string |
cursor_position since version 0
cursor_position(index int, anchor int)Notify when the cursor or anchor position should be modified. This event should be handled as part of a following commit_string event. The text between anchor and index should be selected.
Arguments
| Name | Type | Description |
|---|---|---|
| index | int | position of cursor |
| anchor | int | position of selection anchor |
delete_surrounding_text since version 0
delete_surrounding_text(before_length uint, after_length uint)Notify when the text around the current cursor position should be deleted. BeforeLength and afterLength is the length (in bytes) of text before and after the current cursor position (excluding the selection) to delete. This event should be handled as part of a following commit_string or preedit_string event.
Arguments
| Name | Type | Description |
|---|---|---|
| before_length | uint | length of text before current cursor position |
| after_length | uint | length of text after current cursor position |
modifiers_map since version 0
modifiers_map(map array)Transfer an array of 0-terminated modifiers names. The position in the array is the index of the modifier as used in the modifiers bitmask in the keysym event.
Arguments
| Name | Type | Description |
|---|---|---|
| map | array |
keysym since version 0
keysym(time uint, sym uint, state uint, modifiers uint)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 a XKB keysym, state a wl_keyboard key_state. Modifiers are a mask for effective modifiers (where the modifier indices are set by the modifiers_map event)
Arguments
| Name | Type | Description |
|---|---|---|
| time | uint | |
| sym | uint | |
| state | uint | |
| modifiers | uint |
language since version 0
language(language string)Sets the language of the input text. The "language" argument is a RFC-3066 format language tag.
Arguments
| Name | Type | Description |
|---|---|---|
| language | string |
text_direction since version 0
text_direction(direction uint)Sets the text direction of input text. It is mainly needed for showing input cursor on correct side of the editor when there is no input yet done and making sure neutral direction text is laid out properly.
Arguments
| Name | Type | Description |
|---|---|---|
| direction | uint |
configure_surrounding_text since version 0
configure_surrounding_text(before_cursor int, after_cursor int)Configure what amount of surrounding text is expected by the input method. The surrounding text will be sent in the set_surrounding_text request on the following state information updates.
Arguments
| Name | Type | Description |
|---|---|---|
| before_cursor | int | |
| after_cursor | int |
input_method_changed since version 0
input_method_changed(serial uint, flags uint)The input method changed on compositor side, which invalidates all current state information. New state information should be sent from the client via state requests (set_surrounding_text, set_content_hint, ...) and update_state.
Arguments
| Name | Type | Description |
|---|---|---|
| serial | uint | serial to be used by update_state |
| flags | uint | currently unused |
Enums
Flagset content_hint since version 0
Content hint is a bitmask to allow to modify the behavior of the text input.
enum content_hint {
none = 0x0,
auto_completion = 0x1,
auto_correction = 0x2,
auto_capitalization = 0x4,
lowercase = 0x8,
uppercase = 0x10,
titlecase = 0x20,
hidden_text = 0x40,
sensitive_data = 0x80,
latin = 0x100,
multiline = 0x200,
}Entries
| Name | Value | Description |
|---|---|---|
| none | 0x0 | no special behaviour |
| auto_completion | 0x1 | suggest word completions |
| auto_correction | 0x2 | suggest word corrections |
| auto_capitalization | 0x4 | switch to uppercase letters at the start of a sentence |
| lowercase | 0x8 | prefer lowercase letters |
| uppercase | 0x10 | prefer uppercase letters |
| titlecase | 0x20 | prefer casing for titles and headings (can be language dependent) |
| hidden_text | 0x40 | characters should be hidden |
| sensitive_data | 0x80 | typed text should not be stored |
| latin | 0x100 | just latin characters should be entered |
| multiline | 0x200 | the text input is multiline |
content_purpose since version 0
The content purpose allows to specify the primary purpose of a text input. This allows an input method to show special purpose input panels with extra characters or to disallow some characters.
enum content_purpose {
normal = 0,
alpha = 1,
digits = 2,
number = 3,
phone = 4,
url = 5,
email = 6,
name = 7,
password = 8,
date = 9,
time = 10,
datetime = 11,
terminal = 12,
}Entries
| Name | Value | Description |
|---|---|---|
| normal | 0 | default input, allowing all characters |
| alpha | 1 | allow only alphabetic characters |
| digits | 2 | allow only digits |
| number | 3 | input a number (including decimal separator and sign) |
| phone | 4 | input a phone number |
| url | 5 | input an URL |
| 6 | input an email address | |
| name | 7 | input a name of a person |
| password | 8 | input a password (combine with password or sensitive_data hint) |
| date | 9 | input a date |
| time | 10 | input a time |
| datetime | 11 | input a date and time |
| terminal | 12 | input for a terminal |
update_state since version 0
Defines the reason for sending an updated state.
enum update_state {
change = 0,
full = 1,
reset = 2,
enter = 3,
}Entries
| Name | Value | Description |
|---|---|---|
| change | 0 | updated state because it changed |
| full | 1 | full state after enter or input_method_changed event |
| reset | 2 | full state after reset |
| enter | 3 | full state after switching focus to a different widget on client side |
input_panel_visibility since version 0
enum input_panel_visibility {
hidden = 0,
visible = 1,
}Entries
| Name | Value | Description |
|---|---|---|
| hidden | 0 | the input panel (virtual keyboard) is hidden |
| visible | 1 | the input panel (virtual keyboard) is visible |
preedit_style since version 0
enum preedit_style {
default = 0,
none = 1,
active = 2,
inactive = 3,
highlight = 4,
underline = 5,
selection = 6,
incorrect = 7,
}Entries
| Name | Value | Description |
|---|---|---|
| default | 0 | default style for composing text |
| none | 1 | composing text should be shown the same as non-composing text |
| active | 2 | composing text might be bold |
| inactive | 3 | composing text might be cursive |
| highlight | 4 | composing text might have a different background color |
| underline | 5 | composing text might be underlined |
| selection | 6 | composing text should be shown the same as selected text |
| incorrect | 7 | composing text might be underlined with a red wavy line |
text_direction since version 0
enum text_direction {
auto = 0,
ltr = 1,
rtl = 2,
}Entries
| Name | Value | Description |
|---|---|---|
| auto | 0 | automatic text direction based on text and language |
| ltr | 1 | left-to-right |
| rtl | 2 | right-to-left |
zwp_text_input_manager_v2 interface version 1
A factory for text-input objects. This object is a global singleton.
Requests
destroy (destructor) since version 0
~destroy()Destroy the wp_text_input_manager object.
get_text_input since version 0
get_text_input(id new_id[zwp_text_input_v2], seat object[wl_seat])Creates a new text-input object for a given seat.
Arguments
| Name | Type | Description |
|---|---|---|
| id | new_id[zwp_text_input_v2] | |
| seat | object[wl_seat] |
SPDX-FileCopyrightText: 2012, 2013 Intel Corporation SPDX-FileCopyrightText: 2015, 2016 Jan Arne Petersen SPDX-License-Identifier: MIT-CMU