Data Structures | Macros | Enumerations | Functions
The zwp_text_input_v1 interface

An object used for text input. More...

Data Structures

struct  zwp_text_input_v1_listener
 

Macros

#define ZWP_TEXT_INPUT_V1_ENTER_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_LEAVE_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_MODIFIERS_MAP_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_INPUT_PANEL_STATE_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_PREEDIT_STRING_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_PREEDIT_STYLING_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_PREEDIT_CURSOR_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_COMMIT_STRING_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_CURSOR_POSITION_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_DELETE_SURROUNDING_TEXT_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_KEYSYM_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_LANGUAGE_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_TEXT_DIRECTION_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_ACTIVATE_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_DEACTIVATE_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_SHOW_INPUT_PANEL_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_HIDE_INPUT_PANEL_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_RESET_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_SET_SURROUNDING_TEXT_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_SET_CONTENT_TYPE_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_SET_CURSOR_RECTANGLE_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_SET_PREFERRED_LANGUAGE_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_COMMIT_STATE_SINCE_VERSION   1
 
#define ZWP_TEXT_INPUT_V1_INVOKE_ACTION_SINCE_VERSION   1
 

Enumerations

enum  zwp_text_input_v1_content_hint {
  ZWP_TEXT_INPUT_V1_CONTENT_HINT_NONE = 0x0,
  ZWP_TEXT_INPUT_V1_CONTENT_HINT_DEFAULT = 0x7,
  ZWP_TEXT_INPUT_V1_CONTENT_HINT_PASSWORD = 0xc0,
  ZWP_TEXT_INPUT_V1_CONTENT_HINT_AUTO_COMPLETION = 0x1,
  ZWP_TEXT_INPUT_V1_CONTENT_HINT_AUTO_CORRECTION = 0x2,
  ZWP_TEXT_INPUT_V1_CONTENT_HINT_AUTO_CAPITALIZATION = 0x4,
  ZWP_TEXT_INPUT_V1_CONTENT_HINT_LOWERCASE = 0x8,
  ZWP_TEXT_INPUT_V1_CONTENT_HINT_UPPERCASE = 0x10,
  ZWP_TEXT_INPUT_V1_CONTENT_HINT_TITLECASE = 0x20,
  ZWP_TEXT_INPUT_V1_CONTENT_HINT_HIDDEN_TEXT = 0x40,
  ZWP_TEXT_INPUT_V1_CONTENT_HINT_SENSITIVE_DATA = 0x80,
  ZWP_TEXT_INPUT_V1_CONTENT_HINT_LATIN = 0x100,
  ZWP_TEXT_INPUT_V1_CONTENT_HINT_MULTILINE = 0x200
}
 content hint More...
 
enum  zwp_text_input_v1_content_purpose {
  ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_NORMAL = 0,
  ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_ALPHA = 1,
  ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_DIGITS = 2,
  ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_NUMBER = 3,
  ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_PHONE = 4,
  ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_URL = 5,
  ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_EMAIL = 6,
  ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_NAME = 7,
  ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_PASSWORD = 8,
  ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_DATE = 9,
  ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_TIME = 10,
  ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_DATETIME = 11,
  ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_TERMINAL = 12
}
 content purpose More...
 

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)
 

Detailed Description

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.

Enumeration Type Documentation

◆ zwp_text_input_v1_content_hint

content hint

Content hint is a bitmask to allow to modify the behavior of the text input.

Enumerator
ZWP_TEXT_INPUT_V1_CONTENT_HINT_NONE 

no special behaviour

ZWP_TEXT_INPUT_V1_CONTENT_HINT_DEFAULT 

auto completion, correction and capitalization

ZWP_TEXT_INPUT_V1_CONTENT_HINT_PASSWORD 

hidden and sensitive text

ZWP_TEXT_INPUT_V1_CONTENT_HINT_AUTO_COMPLETION 

suggest word completions

ZWP_TEXT_INPUT_V1_CONTENT_HINT_AUTO_CORRECTION 

suggest word corrections

ZWP_TEXT_INPUT_V1_CONTENT_HINT_AUTO_CAPITALIZATION 

switch to uppercase letters at the start of a sentence

ZWP_TEXT_INPUT_V1_CONTENT_HINT_LOWERCASE 

prefer lowercase letters

ZWP_TEXT_INPUT_V1_CONTENT_HINT_UPPERCASE 

prefer uppercase letters

ZWP_TEXT_INPUT_V1_CONTENT_HINT_TITLECASE 

prefer casing for titles and headings (can be language dependent)

ZWP_TEXT_INPUT_V1_CONTENT_HINT_HIDDEN_TEXT 

characters should be hidden

ZWP_TEXT_INPUT_V1_CONTENT_HINT_SENSITIVE_DATA 

typed text should not be stored

ZWP_TEXT_INPUT_V1_CONTENT_HINT_LATIN 

just latin characters should be entered

ZWP_TEXT_INPUT_V1_CONTENT_HINT_MULTILINE 

the text input is multiline

◆ zwp_text_input_v1_content_purpose

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.

Enumerator
ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_NORMAL 

default input, allowing all characters

ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_ALPHA 

allow only alphabetic characters

ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_DIGITS 

allow only digits

ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_NUMBER 

input a number (including decimal separator and sign)

ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_PHONE 

input a phone number

ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_URL 

input an URL

ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_EMAIL 

input an email address

ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_NAME 

input a name of a person

ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_PASSWORD 

input a password (combine with password or sensitive_data hint)

ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_DATE 

input a date

ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_TIME 

input a time

ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_DATETIME 

input a date and time

ZWP_TEXT_INPUT_V1_CONTENT_PURPOSE_TERMINAL 

input for a terminal

Function Documentation

◆ zwp_text_input_v1_activate()

static void zwp_text_input_v1_activate ( struct zwp_text_input_v1 *  zwp_text_input_v1,
struct wl_seat *  seat,
struct wl_surface *  surface 
)
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.

◆ zwp_text_input_v1_deactivate()

static void zwp_text_input_v1_deactivate ( struct zwp_text_input_v1 *  zwp_text_input_v1,
struct wl_seat *  seat 
)
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.

◆ zwp_text_input_v1_set_surrounding_text()

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 
)
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.

◆ zwp_text_input_v1_set_content_type()

static void zwp_text_input_v1_set_content_type ( struct zwp_text_input_v1 *  zwp_text_input_v1,
uint32_t  hint,
uint32_t  purpose 
)
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.

◆ zwp_text_input_v1_set_preferred_language()

static void zwp_text_input_v1_set_preferred_language ( struct zwp_text_input_v1 *  zwp_text_input_v1,
const char *  language 
)
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.