text_input_unstable_v1

# zwp_text_input_v1

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.

Requests
- #
  activate
  
  request activation
  
  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). 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.
- #
  deactivate
  
  request deactivation
  
  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). The seat argument is a wl_seat which was used for activation.
- #
  show_input_panel
  
  show input panels
  
  void zwp_text_input_v1_show_input_panel(
  struct zwp_text_input_v1* zwp_text_input_v1
  )
  
  Requests input panels (virtual keyboard) to show.
- #
  hide_input_panel
  
  hide input panels
  
  void zwp_text_input_v1_hide_input_panel(
  struct zwp_text_input_v1* zwp_text_input_v1
  )
  
  Requests input panels (virtual keyboard) to hide.
- #
  reset
  
  reset
  
  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.
- #
  set_surrounding_text
  
  sets the surrounding text
  
  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. 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.
- #
  set_content_type
  
  set content purpose and hint
  
  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. 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.
- #
  set_cursor_rectangle
  
  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
  )
- #
  set_preferred_language
  
  sets preferred language
  
  void zwp_text_input_v1_set_preferred_language(
  struct zwp_text_input_v1* zwp_text_input_v1,
  
  const char* language
  )
  
  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.
- #
  commit_state
  
  void zwp_text_input_v1_commit_state(
  struct zwp_text_input_v1* zwp_text_input_v1,
  
  uint32_t serial /* used to identify the known state */
  )
- #
  invoke_action
  
  void zwp_text_input_v1_invoke_action(
  struct zwp_text_input_v1* zwp_text_input_v1,
  
  uint32_t button,
  
  uint32_t index
  )
Events
- #
  enter
  
  enter event
  
  struct wl_surface* surface
  
  Notify the text_input object when it received focus. Typically in response to an activate request.
- #
  leave
  
  leave event
  
  Notify the text_input object when it lost focus. Either in response to a deactivate request or when the assigned surface lost focus or was destroyed.
- #
  modifiers_map
  
  modifiers map
  
  struct wl_array* map
  
  Transfer an array of 0-terminated modifier names. The position in the array is the index of the modifier as used in the modifiers bitmask in the keysym event.
- #
  input_panel_state
  
  state of the input panel
  
  uint32_t state
  
  Notify when the visibility state of the input panel changed.
- #
  preedit_string
  
  pre-edit
  
  uint32_t serial /* serial of the latest known text input state */
  
  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 preedit text on reset (for example on unfocus). 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. This event is handled as part of a following preedit_string event.
- #
  commit_string
  
  commit
  
  uint32_t serial /* serial of the latest known text input state */
  
  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 also be 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
  
  int32_t anchor
  
  Notify when the cursor or anchor position should be modified. This event should be handled as part of a following commit_string event.
- #
  delete_surrounding_text
  
  delete surrounding text
  
  int32_t index
  
  uint32_t length
  
  Notify when the text around the current cursor position should be deleted. Index is relative to the current cursor (in bytes). Length is the length of deleted text (in bytes). This event should be handled as part of a following commit_string event.
- #
  keysym
  
  keysym
  
  uint32_t serial /* serial of the latest known text input state */
  
  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 an 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
  
  uint32_t serial /* serial of the latest known text input state */
  
  const char* language
  
  Sets the language of the input text. The "language" argument is an RFC-3066 format language tag.
- #
  text_direction
  
  text direction
  
  uint32_t serial /* serial of the latest known text input state */
  
  uint32_t direction
  
  Sets the text direction of input text. It is mainly needed for showing an input cursor on the correct side of the editor when there is no input done yet and making sure neutral direction text is laid out properly.
Enums
- #
  content_hint
  
  content hint
  
  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 */
  
  Content hint is a bitmask to allow to modify the behavior of the text input.
- #
  content_purpose
  
  content purpose
  
  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 */
  
  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.
- #
  preedit_style
  
  ZWP_TEXT_INPUT_V1_PREEDIT_STYLE_DEFAULT /* default style for composing text */
  
  ZWP_TEXT_INPUT_V1_PREEDIT_STYLE_NONE /* style should be the same as in non-composing text */
  
  ZWP_TEXT_INPUT_V1_PREEDIT_STYLE_ACTIVE
  
  ZWP_TEXT_INPUT_V1_PREEDIT_STYLE_INACTIVE
  
  ZWP_TEXT_INPUT_V1_PREEDIT_STYLE_HIGHLIGHT
  
  ZWP_TEXT_INPUT_V1_PREEDIT_STYLE_UNDERLINE
  
  ZWP_TEXT_INPUT_V1_PREEDIT_STYLE_SELECTION
  
  ZWP_TEXT_INPUT_V1_PREEDIT_STYLE_INCORRECT
- #
  text_direction
  
  ZWP_TEXT_INPUT_V1_TEXT_DIRECTION_AUTO /* automatic text direction based on text and language */
  
  ZWP_TEXT_INPUT_V1_TEXT_DIRECTION_LTR /* left-to-right */
  
  ZWP_TEXT_INPUT_V1_TEXT_DIRECTION_RTL /* right-to-left */
# zwp_text_input_manager_v1

A factory for text_input objects. This object is a global singleton.

Requests
- #
  create_text_input
  
  create text input
  
  struct zwp_text_input_v1* zwp_text_input_manager_v1_create_text_input(
  struct zwp_text_input_manager_v1* zwp_text_input_manager_v1
  )
  
  Creates a new text_input object.

Copyright Info

Copyright © 2012, 2013 Intel Corporation Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

text_input_unstable_v1

# zwp_text_input_v1

Requests

Events

Enums

# zwp_text_input_manager_v1

Requests

Copyright Info