text_input_unstable_v2

• # zwp_text_input_v2

  The zwp_text_input_v2 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 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 valid UTF-8 encoded, indices and lengths are in bytes. Indices have to always point to the first byte of an UTF-8 encoded code point. Lengths are not allowed to contain just a part of an UTF-8 encoded code point. State is sent by the state requests (set_surrounding_text, set_content_type, set_cursor_rectangle and set_preferred_language) and an update_state request. After an enter or an input_method_change event all state information is invalidated and needs to be resent from the client. A reset or entering a new widget on client side also invalidates all current state information.

  Requests

  • #

    destroy

    Destroy the wp_text_input
    void zwp_text_input_v2_destroy(

    struct zwp_text_input_v2* zwp_text_input_v2

    )
    Destroy the wp_text_input object. Also disables all surfaces enabled through this wp_text_input object
  • #

    enable

    enable text input for surface
    void zwp_text_input_v2_enable(

    struct zwp_text_input_v2* zwp_text_input_v2,

    struct wl_surface* surface

    )
    Enable text input in a surface (usually when a text entry inside of it has focus). This can be called before or after a surface gets text (or keyboard) focus via the enter event. Text input to a surface is only active when it has the current text (or keyboard) focus and is enabled.
  • #

    disable

    disable text input for surface
    void zwp_text_input_v2_disable(

    struct zwp_text_input_v2* zwp_text_input_v2,

    struct wl_surface* surface

    )
    Disable text input in a surface (typically when there is no focus on any text entry inside the surface).
  • #

    show_input_panel

    show input panels
    void zwp_text_input_v2_show_input_panel(

    struct zwp_text_input_v2* zwp_text_input_v2

    )
    Requests input panels (virtual keyboard) to show. This should be used for example to show a virtual keyboard again (with a tap) after it was closed by pressing on a close button on the keyboard.
  • #

    hide_input_panel

    hide input panels
    void zwp_text_input_v2_hide_input_panel(

    struct zwp_text_input_v2* zwp_text_input_v2

    )
    Requests input panels (virtual keyboard) to hide.
  • #

    set_surrounding_text

    sets the surrounding text
    void zwp_text_input_v2_set_surrounding_text(

    struct zwp_text_input_v2* zwp_text_input_v2,

    const char* text,

    int32_t cursor,

    int32_t anchor

    )
    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 is the same as cursor. Make sure to always send some text before and after the cursor except when the cursor is at the beginning or end of text. When there was a configure_surrounding_text event take the before_cursor and after_cursor arguments into account for picking how much surrounding text to send. There is a maximum length of wayland messages so text can not be longer than 4000 bytes.
  • #

    set_content_type

    set content purpose and hint
    void zwp_text_input_v2_set_content_type(

    struct zwp_text_input_v2* zwp_text_input_v2,

    uint32_t hint,

    uint32_t purpose

    )
    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 none hint should be assumed.
  • #

    set_cursor_rectangle

    set cursor position
    void zwp_text_input_v2_set_cursor_rectangle(

    struct zwp_text_input_v2* zwp_text_input_v2,

    int32_t x,

    int32_t y,

    int32_t width,

    int32_t height

    )
    Sets the cursor outline as a x, y, width, height rectangle in surface local coordinates. Allows the compositor to put a window with word suggestions near the cursor.
  • #

    set_preferred_language

    sets preferred language
    void zwp_text_input_v2_set_preferred_language(

    struct zwp_text_input_v2* zwp_text_input_v2,

    const char* language

    )
    Sets a specific language. This allows for example a virtual keyboard to show a language specific layout. The "language" argument is a RFC-3066 format language tag. It could be used for example in a word processor to indicate language of currently edited document or in an instant message application which tracks languages of contacts.
  • #

    update_state

    update state
    void zwp_text_input_v2_update_state(

    struct zwp_text_input_v2* zwp_text_input_v2,

    uint32_t serial, /* serial of the enter or input_method_changed event */

    uint32_t reason

    )
    Allows to atomically send state updates from client. This request should follow after a batch of state updating requests like set_surrounding_text, set_content_type, set_cursor_rectangle and set_preferred_language. The flags field indicates why an updated state is sent to the input method. Reset should be used by an editor widget after the text was changed outside of the normal input method flow. For "change" it is enough to send the changed state, else the full state should be send. Serial should be set to the serial from the last enter or input_method_changed event. To make sure to not receive outdated input method events after a reset or switching to a new widget wl_display_sync() should be used after update_state in these cases.

  Events

  • #

    enter

    enter event
    uint32_t serial /* serial to be used by update_state */
    struct wl_surface* surface
    Notification that this seat's text-input focus is on a certain surface. When the seat has the keyboard capability the text-input focus follows the keyboard focus.
  • #

    leave

    leave event
    uint32_t serial
    struct wl_surface* surface
    Notification that this seat's text-input focus is no longer on a certain surface. The leave notification is sent before the enter notification for the new focus. When the seat has the keyboard capability the text-input focus follows the keyboard focus.
  • #

    input_panel_state

    state of the input panel
    uint32_t state
    int32_t x
    int32_t y
    int32_t width
    int32_t height
    Notification that the visibility of the input panel (virtual keyboard) changed. The rectangle x, y, width, height defines the area overlapped by the input panel (virtual keyboard) on the surface having the text focus in surface local coordinates. That can be used to make sure widgets are visible and not covered by a virtual keyboard.
  • #

    preedit_string

    pre-edit
    const char* text
    const char* commit
    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 composing text in some cases (for example when losing focus). The text input should also handle all preedit_style and preedit_cursor events occurring directly before preedit_string.
  • #

    preedit_styling

    pre-edit styling
    uint32_t index
    uint32_t length
    uint32_t style
    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

    pre-edit cursor
    int32_t index
    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. When no preedit_cursor event is sent the cursor will be at the end of the composing text by default. This event is handled as part of a following preedit_string event.
  • #

    commit_string

    commit
    const char* text
    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 be also 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.
  • #

    cursor_position

    set cursor to new position
    int32_t index /* position of cursor */
    int32_t anchor /* position of selection anchor */
    Notify when the cursor or anchor position should be modified. This event should be handled as part of a following commit_string event. The text between anchor and index should be selected.
  • #

    delete_surrounding_text

    delete surrounding text
    uint32_t before_length /* length of text before current cursor position */
    uint32_t after_length /* length of text after current cursor position */
    Notify when the text around the current cursor position should be deleted. BeforeLength and afterLength is the length (in bytes) of text before and after the current cursor position (excluding the selection) to delete. This event should be handled as part of a following commit_string or preedit_string event.
  • #

    modifiers_map

    modifiers map
    struct wl_array* map
    Transfer an array of 0-terminated modifiers names. The position in the array is the index of the modifier as used in the modifiers bitmask in the keysym event.
  • #

    keysym

    keysym
    uint32_t time
    uint32_t sym
    uint32_t state
    uint32_t modifiers
    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 a 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)
  • #

    language

    language
    const char* language
    Sets the language of the input text. The "language" argument is a RFC-3066 format language tag.
  • #

    text_direction

    text direction
    uint32_t direction
    Sets the text direction of input text. It is mainly needed for showing input cursor on correct side of the editor when there is no input yet done and making sure neutral direction text is laid out properly.
  • #

    configure_surrounding_text

    configure amount of surrounding text to be sent
    int32_t before_cursor
    int32_t after_cursor
    Configure what amount of surrounding text is expected by the input method. The surrounding text will be sent in the set_surrounding_text request on the following state information updates.
  • #

    input_method_changed

    Notifies about a changed input method
    uint32_t serial /* serial to be used by update_state */
    uint32_t flags /* currently unused */
    The input method changed on compositor side, which invalidates all current state information. New state information should be sent from the client via state requests (set_surrounding_text, set_content_hint, ...) and update_state.

  Enums

  • #

    content_hint

    content hint
    ZWP_TEXT_INPUT_V2_CONTENT_HINT_NONE /* no special behaviour */
    ZWP_TEXT_INPUT_V2_CONTENT_HINT_AUTO_COMPLETION /* suggest word completions */
    ZWP_TEXT_INPUT_V2_CONTENT_HINT_AUTO_CORRECTION /* suggest word corrections */
    ZWP_TEXT_INPUT_V2_CONTENT_HINT_AUTO_CAPITALIZATION /* switch to uppercase letters at the start of a sentence */
    ZWP_TEXT_INPUT_V2_CONTENT_HINT_LOWERCASE /* prefer lowercase letters */
    ZWP_TEXT_INPUT_V2_CONTENT_HINT_UPPERCASE /* prefer uppercase letters */
    ZWP_TEXT_INPUT_V2_CONTENT_HINT_TITLECASE /* prefer casing for titles and headings (can be language dependent) */
    ZWP_TEXT_INPUT_V2_CONTENT_HINT_HIDDEN_TEXT /* characters should be hidden */
    ZWP_TEXT_INPUT_V2_CONTENT_HINT_SENSITIVE_DATA /* typed text should not be stored */
    ZWP_TEXT_INPUT_V2_CONTENT_HINT_LATIN /* just latin characters should be entered */
    ZWP_TEXT_INPUT_V2_CONTENT_HINT_MULTILINE /* the text input is multiline */
    Content hint is a bitmask to allow to modify the behavior of the text input.
  • #

    content_purpose

    content purpose
    ZWP_TEXT_INPUT_V2_CONTENT_PURPOSE_NORMAL /* default input, allowing all characters */
    ZWP_TEXT_INPUT_V2_CONTENT_PURPOSE_ALPHA /* allow only alphabetic characters */
    ZWP_TEXT_INPUT_V2_CONTENT_PURPOSE_DIGITS /* allow only digits */
    ZWP_TEXT_INPUT_V2_CONTENT_PURPOSE_NUMBER /* input a number (including decimal separator and sign) */
    ZWP_TEXT_INPUT_V2_CONTENT_PURPOSE_PHONE /* input a phone number */
    ZWP_TEXT_INPUT_V2_CONTENT_PURPOSE_URL /* input an URL */
    ZWP_TEXT_INPUT_V2_CONTENT_PURPOSE_EMAIL /* input an email address */
    ZWP_TEXT_INPUT_V2_CONTENT_PURPOSE_NAME /* input a name of a person */
    ZWP_TEXT_INPUT_V2_CONTENT_PURPOSE_PASSWORD /* input a password (combine with password or sensitive_data hint) */
    ZWP_TEXT_INPUT_V2_CONTENT_PURPOSE_DATE /* input a date */
    ZWP_TEXT_INPUT_V2_CONTENT_PURPOSE_TIME /* input a time */
    ZWP_TEXT_INPUT_V2_CONTENT_PURPOSE_DATETIME /* input a date and time */
    ZWP_TEXT_INPUT_V2_CONTENT_PURPOSE_TERMINAL /* input for a terminal */
    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.
  • #

    update_state

    update_state flags
    ZWP_TEXT_INPUT_V2_UPDATE_STATE_CHANGE /* updated state because it changed */
    ZWP_TEXT_INPUT_V2_UPDATE_STATE_FULL /* full state after enter or input_method_changed event */
    ZWP_TEXT_INPUT_V2_UPDATE_STATE_RESET /* full state after reset */
    ZWP_TEXT_INPUT_V2_UPDATE_STATE_ENTER /* full state after switching focus to a different widget on client side */
    Defines the reason for sending an updated state.
  • #

    input_panel_visibility
    ZWP_TEXT_INPUT_V2_INPUT_PANEL_VISIBILITY_HIDDEN /* the input panel (virtual keyboard) is hidden */
    ZWP_TEXT_INPUT_V2_INPUT_PANEL_VISIBILITY_VISIBLE /* the input panel (virtual keyboard) is visible */
  • #

    preedit_style
    ZWP_TEXT_INPUT_V2_PREEDIT_STYLE_DEFAULT /* default style for composing text */
    ZWP_TEXT_INPUT_V2_PREEDIT_STYLE_NONE /* composing text should be shown the same as non-composing text */
    ZWP_TEXT_INPUT_V2_PREEDIT_STYLE_ACTIVE /* composing text might be bold */
    ZWP_TEXT_INPUT_V2_PREEDIT_STYLE_INACTIVE /* composing text might be cursive */
    ZWP_TEXT_INPUT_V2_PREEDIT_STYLE_HIGHLIGHT /* composing text might have a different background color */
    ZWP_TEXT_INPUT_V2_PREEDIT_STYLE_UNDERLINE /* composing text might be underlined */
    ZWP_TEXT_INPUT_V2_PREEDIT_STYLE_SELECTION /* composing text should be shown the same as selected text */
    ZWP_TEXT_INPUT_V2_PREEDIT_STYLE_INCORRECT /* composing text might be underlined with a red wavy line */
  • #

    text_direction
    ZWP_TEXT_INPUT_V2_TEXT_DIRECTION_AUTO /* automatic text direction based on text and language */
    ZWP_TEXT_INPUT_V2_TEXT_DIRECTION_LTR /* left-to-right */
    ZWP_TEXT_INPUT_V2_TEXT_DIRECTION_RTL /* right-to-left */

• # zwp_text_input_manager_v2

  A factory for text-input objects. This object is a global singleton.

  Requests

  • #

    destroy

    Destroy the wp_text_input_manager
    void zwp_text_input_manager_v2_destroy(

    struct zwp_text_input_manager_v2* zwp_text_input_manager_v2

    )
    Destroy the wp_text_input_manager object.
  • #

    get_text_input

    create a new text input object
    struct zwp_text_input_v2* zwp_text_input_manager_v2_get_text_input(

    struct zwp_text_input_manager_v2* zwp_text_input_manager_v2,

    struct wl_seat* seat

    )
    Creates a new text-input object for a given seat.

Copyright Info