Module wayland_protocols::unstable::text_input::v3::server::zwp_text_input_v3

text input

The zwp_text_input_v3 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 preedit_string and commit_string events.

Text is valid UTF-8 encoded, indices and lengths are in bytes. Indices must not point to middle bytes inside a code point: they must either point to the first byte of a code point or to the end of the buffer. Lengths must be measured between two valid indices.

Focus moving throughout surfaces will result in the emission of zwp_text_input_v3.enter and zwp_text_input_v3.leave events. The focused surface must commit zwp_text_input_v3.enable and zwp_text_input_v3.disable requests as the keyboard focus moves across editable and non-editable elements of the UI. Those two requests are not expected to be paired with each other, the compositor must be able to handle consecutive series of the same request.

State is sent by the state requests (set_surrounding_text, set_content_type and set_cursor_rectangle) and a commit request. After an enter event or disable request all state information is invalidated and needs to be resent by the client.

Structs

ContentHint	content hint
ZwpTextInputV3

Enums

ChangeCause	text change reason
ContentPurpose	content purpose
Event
Request

Constants

EVT_COMMIT_STRING_SINCE	The minimal object version supporting this event
EVT_DELETE_SURROUNDING_TEXT_SINCE	The minimal object version supporting this event
EVT_DONE_SINCE	The minimal object version supporting this event
EVT_ENTER_SINCE	The minimal object version supporting this event
EVT_LEAVE_SINCE	The minimal object version supporting this event
EVT_PREEDIT_STRING_SINCE	The minimal object version supporting this event
REQ_COMMIT_SINCE	The minimal object version supporting this request
REQ_DESTROY_SINCE	The minimal object version supporting this request
REQ_DISABLE_SINCE	The minimal object version supporting this request
REQ_ENABLE_SINCE	The minimal object version supporting this request
REQ_SET_CONTENT_TYPE_SINCE	The minimal object version supporting this request
REQ_SET_CURSOR_RECTANGLE_SINCE	The minimal object version supporting this request
REQ_SET_SURROUNDING_TEXT_SINCE	The minimal object version supporting this request
REQ_SET_TEXT_CHANGE_CAUSE_SINCE	The minimal object version supporting this request