zwp_text_input_v1¤
Text input
An object used for text input. Adds support for text input and input methods to applications. A text_input object is created from a wl_text_input_manager and corresponds typically to a text entry in an application.
Requests are used to activate/deactivate the text_input object and set state information like surrounding and selected text or the content type. The information about 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 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.
Methods:
-
activate–Request activation
-
deactivate–Request deactivation
-
show_input_panel–Show input panels
-
hide_input_panel–Hide input panels
-
reset–Reset
-
set_surrounding_text–Sets the surrounding text
-
set_content_type–Set content purpose and hint
-
set_cursor_rectangle– -
set_preferred_language–Sets preferred language
-
commit_state–Args:
-
invoke_action– -
on_enter–Enter event.
-
on_leave–Leave event.
-
on_modifiers_map–Modifiers map.
-
on_input_panel_state–State of the input panel.
-
on_preedit_string–Pre-edit.
-
on_preedit_styling–Pre-edit styling.
-
on_preedit_cursor–Pre-edit cursor.
-
on_commit_string–Commit.
-
on_cursor_position–Set cursor to new position.
-
on_delete_surrounding_text–Delete surrounding text.
-
on_keysym–Keysym.
-
on_language–Language.
-
on_text_direction–Text direction.
Content hint
Content hint is a bitmask to allow to modify the behavior of the text input.
-
none–No special behaviour -
default–Auto completion, correction and capitalization -
password–Hidden and sensitive text -
auto_completion–Suggest word completions -
auto_correction–Suggest word corrections -
auto_capitalization–Switch to uppercase letters at the start of a sentence -
lowercase–Prefer lowercase letters -
uppercase–Prefer uppercase letters -
titlecase–Prefer casing for titles and headings (can be language dependent) -
hidden_text–Characters should be hidden -
sensitive_data–Typed text should not be stored -
latin–Just latin characters should be entered -
multiline–The text input is multiline
Content purpose
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.
-
normal–Default input, allowing all characters -
alpha–Allow only alphabetic characters -
digits–Allow only digits -
number–Input a number (including decimal separator and sign) -
phone–Input a phone number -
url–Input an url -
email–Input an email address -
name–Input a name of a person -
password–Input a password (combine with password or `sensitive_data` hint) -
date–Input a date -
time–Input a time -
datetime–Input a date and time -
terminal–Input for a terminal
enter(surface: wl_surface) -> None
Enter event
Notify the text_input object when it received focus. Typically in response to an activate request.
leave() -> None
Leave event
Notify the text_input object when it lost focus. Either in response to a deactivate request or when the assigned surface lost focus or was destroyed.
modifiers_map(map: list) -> None
Modifiers map
Transfer an array of 0-terminated modifier names. The position in the array is the index of the modifier as used in the modifiers bitmask in the keysym event.
input_panel_state(state: int) -> None
State of the input panel
Notify when the visibility state of the input panel changed.
Pre-edit
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 preedit text on reset (for example on unfocus).
The text input should also handle all preedit_style and preedit_cursor events occurring directly before preedit_string.
Parameters:
preedit_styling(index: int, length: int, style: preedit_style) -> None
Pre-edit styling
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.
preedit_cursor(index: int) -> None
Pre-edit cursor
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.
This event is handled as part of a following preedit_string event.
Commit
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 also be 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.
Parameters:
Set cursor to new position
Notify when the cursor or anchor position should be modified.
This event should be handled as part of a following commit_string event.
Delete surrounding text
Notify when the text around the current cursor position should be deleted.
Index is relative to the current cursor (in bytes). Length is the length of deleted text (in bytes).
This event should be handled as part of a following commit_string event.
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 a wl_keyboard key_state. Modifiers are a mask for effective modifiers (where the modifier indices are set by the modifiers_map event)
Parameters:
text_direction(serial: int, direction: text_direction) -> None
Text direction
Sets the text direction of input text.
It is mainly needed for showing an input cursor on the correct side of the editor when there is no input done yet and making sure neutral direction text is laid out properly.
Parameters:
activate(seat: wl_seat, surface: wl_surface) -> None
Request activation
Requests the text_input object to be activated (typically when the text entry gets focus).
The seat argument is a wl_seat which maintains the focus for this activation. The surface argument is a wl_surface assigned to the text_input object and tracked for focus lost. The enter event is emitted on successful activation.
deactivate(seat: wl_seat) -> None
Request deactivation
Requests the text_input object to be deactivated (typically when the text entry lost focus). The seat argument is a wl_seat which was used for activation.
show_input_panel() -> None
Show input panels
Requests input panels (virtual keyboard) to show.
hide_input_panel() -> None
Hide input panels
Requests input panels (virtual keyboard) to hide.
reset() -> None
Reset
Should be called by an editor widget when the input state should be reset, for example after the text was changed outside of the normal input method flow.
Sets the surrounding text
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, then it is the same as cursor.
set_content_type(hint: content_hint, purpose: content_purpose) -> None
Set content purpose and hint
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 default hints (auto completion, auto correction, auto capitalization) should be assumed.
set_preferred_language(language: str) -> None
Sets preferred language
Sets a specific language. This allows for example a virtual keyboard to show a language specific layout. The "language" argument is an RFC-3066 format language tag.
It could be used for example in a word processor to indicate the language of the currently edited document or in an instant message application which tracks languages of contacts.
on_enter(surface: wl_surface) -> None
Enter event.
Override to handle wayland.zwp_text_input_v1.events.enter.
on_leave() -> None
Leave event.
Override to handle wayland.zwp_text_input_v1.events.leave.
on_modifiers_map(map: list) -> None
Modifiers map.
Override to handle wayland.zwp_text_input_v1.events.modifiers_map.
on_input_panel_state(state: int) -> None
State of the input panel.
Override to handle wayland.zwp_text_input_v1.events.input_panel_state.
Pre-edit.
Override to handle wayland.zwp_text_input_v1.events.preedit_string.
on_preedit_styling(index: int, length: int, style: preedit_style) -> None
Pre-edit styling.
Override to handle wayland.zwp_text_input_v1.events.preedit_styling.
on_preedit_cursor(index: int) -> None
Pre-edit cursor.
Override to handle wayland.zwp_text_input_v1.events.preedit_cursor.
Commit.
Override to handle wayland.zwp_text_input_v1.events.commit_string.
Set cursor to new position.
Override to handle wayland.zwp_text_input_v1.events.cursor_position.
Delete surrounding text.
Override to handle wayland.zwp_text_input_v1.events.delete_surrounding_text.
Keysym.
Override to handle wayland.zwp_text_input_v1.events.keysym.
Language.
Override to handle wayland.zwp_text_input_v1.events.language.
on_text_direction(serial: int, direction: text_direction) -> None
Text direction.
Override to handle wayland.zwp_text_input_v1.events.text_direction.