An object used for text input. More...
Data Structures | |
struct | zwp_text_input_v1_listener |
Functions | |
static int | zwp_text_input_v1_add_listener (struct zwp_text_input_v1 *zwp_text_input_v1, const struct zwp_text_input_v1_listener *listener, void *data) |
static void | zwp_text_input_v1_set_user_data (struct zwp_text_input_v1 *zwp_text_input_v1, void *user_data) |
static void * | zwp_text_input_v1_get_user_data (struct zwp_text_input_v1 *zwp_text_input_v1) |
static void | zwp_text_input_v1_destroy (struct zwp_text_input_v1 *zwp_text_input_v1) |
static void | zwp_text_input_v1_activate (struct zwp_text_input_v1 *zwp_text_input_v1, struct wl_seat *seat, struct wl_surface *surface) |
Requests the text_input object to be activated (typically when the text entry gets focus). More... | |
static void | zwp_text_input_v1_deactivate (struct zwp_text_input_v1 *zwp_text_input_v1, struct wl_seat *seat) |
Requests the text_input object to be deactivated (typically when the text entry lost focus). More... | |
static void | zwp_text_input_v1_show_input_panel (struct zwp_text_input_v1 *zwp_text_input_v1) |
Requests input panels (virtual keyboard) to show. | |
static void | zwp_text_input_v1_hide_input_panel (struct zwp_text_input_v1 *zwp_text_input_v1) |
Requests input panels (virtual keyboard) to hide. | |
static void | zwp_text_input_v1_reset (struct zwp_text_input_v1 *zwp_text_input_v1) |
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. | |
static void | zwp_text_input_v1_set_surrounding_text (struct zwp_text_input_v1 *zwp_text_input_v1, const char *text, uint32_t cursor, uint32_t anchor) |
Sets the plain surrounding text around the input position. More... | |
static void | zwp_text_input_v1_set_content_type (struct zwp_text_input_v1 *zwp_text_input_v1, uint32_t hint, uint32_t purpose) |
Sets the content purpose and content hint. More... | |
static void | zwp_text_input_v1_set_cursor_rectangle (struct zwp_text_input_v1 *zwp_text_input_v1, int32_t x, int32_t y, int32_t width, int32_t height) |
static void | zwp_text_input_v1_set_preferred_language (struct zwp_text_input_v1 *zwp_text_input_v1, const char *language) |
Sets a specific language. More... | |
static void | zwp_text_input_v1_commit_state (struct zwp_text_input_v1 *zwp_text_input_v1, uint32_t serial) |
static void | zwp_text_input_v1_invoke_action (struct zwp_text_input_v1 *zwp_text_input_v1, uint32_t button, uint32_t index) |
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.
content hint
Content hint is a bitmask to allow to modify the behavior of the text input.
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.
|
inlinestatic |
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.
|
inlinestatic |
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.
|
inlinestatic |
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.
|
inlinestatic |
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.
|
inlinestatic |
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.