unstable and server only.Expand description
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.
Structs§
- Content
Hint - content hint
- ZwpText
Input V1 - text input
Enums§
- Content
Purpose - content purpose
- Event
- Preedit
Style - Request
- Text
Direction
Constants§
- EVT_
COMMIT_ STRING_ OPCODE - The wire opcode for this event
- EVT_
COMMIT_ STRING_ SINCE - The minimal object version supporting this event
- EVT_
CURSOR_ POSITION_ OPCODE - The wire opcode for this event
- EVT_
CURSOR_ POSITION_ SINCE - The minimal object version supporting this event
- EVT_
DELETE_ SURROUNDING_ TEXT_ OPCODE - The wire opcode for this event
- EVT_
DELETE_ SURROUNDING_ TEXT_ SINCE - The minimal object version supporting this event
- EVT_
ENTER_ OPCODE - The wire opcode for this event
- EVT_
ENTER_ SINCE - The minimal object version supporting this event
- EVT_
INPUT_ PANEL_ STATE_ OPCODE - The wire opcode for this event
- EVT_
INPUT_ PANEL_ STATE_ SINCE - The minimal object version supporting this event
- EVT_
KEYSYM_ OPCODE - The wire opcode for this event
- EVT_
KEYSYM_ SINCE - The minimal object version supporting this event
- EVT_
LANGUAGE_ OPCODE - The wire opcode for this event
- EVT_
LANGUAGE_ SINCE - The minimal object version supporting this event
- EVT_
LEAVE_ OPCODE - The wire opcode for this event
- EVT_
LEAVE_ SINCE - The minimal object version supporting this event
- EVT_
MODIFIERS_ MAP_ OPCODE - The wire opcode for this event
- EVT_
MODIFIERS_ MAP_ SINCE - The minimal object version supporting this event
- EVT_
PREEDIT_ CURSOR_ OPCODE - The wire opcode for this event
- EVT_
PREEDIT_ CURSOR_ SINCE - The minimal object version supporting this event
- EVT_
PREEDIT_ STRING_ OPCODE - The wire opcode for this event
- EVT_
PREEDIT_ STRING_ SINCE - The minimal object version supporting this event
- EVT_
PREEDIT_ STYLING_ OPCODE - The wire opcode for this event
- EVT_
PREEDIT_ STYLING_ SINCE - The minimal object version supporting this event
- EVT_
TEXT_ DIRECTION_ OPCODE - The wire opcode for this event
- EVT_
TEXT_ DIRECTION_ SINCE - The minimal object version supporting this event
- REQ_
ACTIVATE_ OPCODE - The wire opcode for this request
- REQ_
ACTIVATE_ SINCE - The minimal object version supporting this request
- REQ_
COMMIT_ STATE_ OPCODE - The wire opcode for this request
- REQ_
COMMIT_ STATE_ SINCE - The minimal object version supporting this request
- REQ_
DEACTIVATE_ OPCODE - The wire opcode for this request
- REQ_
DEACTIVATE_ SINCE - The minimal object version supporting this request
- REQ_
HIDE_ INPUT_ PANEL_ OPCODE - The wire opcode for this request
- REQ_
HIDE_ INPUT_ PANEL_ SINCE - The minimal object version supporting this request
- REQ_
INVOKE_ ACTION_ OPCODE - The wire opcode for this request
- REQ_
INVOKE_ ACTION_ SINCE - The minimal object version supporting this request
- REQ_
RESET_ OPCODE - The wire opcode for this request
- REQ_
RESET_ SINCE - The minimal object version supporting this request
- REQ_
SET_ CONTENT_ TYPE_ OPCODE - The wire opcode for this request
- REQ_
SET_ CONTENT_ TYPE_ SINCE - The minimal object version supporting this request
- REQ_
SET_ CURSOR_ RECTANGLE_ OPCODE - The wire opcode for this request
- REQ_
SET_ CURSOR_ RECTANGLE_ SINCE - The minimal object version supporting this request
- REQ_
SET_ PREFERRED_ LANGUAGE_ OPCODE - The wire opcode for this request
- REQ_
SET_ PREFERRED_ LANGUAGE_ SINCE - The minimal object version supporting this request
- REQ_
SET_ SURROUNDING_ TEXT_ OPCODE - The wire opcode for this request
- REQ_
SET_ SURROUNDING_ TEXT_ SINCE - The minimal object version supporting this request
- REQ_
SHOW_ INPUT_ PANEL_ OPCODE - The wire opcode for this request
- REQ_
SHOW_ INPUT_ PANEL_ SINCE - The minimal object version supporting this request