THIS SOFTWARE.
</copyright>
-
<interface name="wl_input_method_context" version="1">
<description summary="input method context">
Corresponds to a text model on input method side. An input method context
</request>
<request name="preedit_styling">
<description summary="pre-edit styling">
- Sets styling information on composing text. The style is applied for
- length in bytes from index relative to the beginning of
- the composing text (as byte offset). Multiple styles can
- be applied to a composing text.
+ Set styling information on composing text. The style is applied for
+ length in bytes from index relative to the beginning of the composing
+ text (as byte offset). Multiple styles can be applied to a composing
+ text.
This request should be sent before sending preedit_string request.
</description>
</request>
<request name="preedit_cursor">
<description summary="pre-edit cursor">
- Sets the cursor position inside the composing text (as byte offset)
+ Set the cursor position inside the composing text (as byte offset)
relative to the start of the composing text.
When index is negative no cursor should be displayed.
</request>
<request name="delete_surrounding_text">
<description summary="delete text">
-
-
This request will be handled on text_input side as part of a directly
following commit_string request.
</description>
</request>
<request name="cursor_position">
<description summary="set cursor to a new position">
- Sets the cursor and anchor to a new position. Index is the new cursor
+ Set the cursor and anchor to a new position. Index is the new cursor
position in bytes (when >= 0 relative to the end of inserted text
else relative to beginning of inserted text). Anchor is the new anchor
position in bytes (when >= 0 relative to the end of inserted text, else
<request name="set_toplevel">
<description summary="set the surface type as a keyboard">
- A keyboard surface is only shown, when a text model is active
+ A keyboard surface is only shown, when a text model is active.
</description>
<arg name="output" type="object" interface="wl_output"/>
<arg name="position" type="uint"/>
<interface name="wl_text_input" version="1">
<description summary="text input">
- An object used for text input. Adds support for text input and 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.
</description>
<request name="activate">
<description summary="request activation">
- Requests the text-input object to be activated (typically when the
+ 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
</description>
</request>
<request name="set_surrounding_text">
- <description summary="sets the surrounding text">
- Sets the plain surrounding text around the input position. Text is
+ <description summary="set the surrounding text">
+ Set 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
</enum>
<request name="set_content_type">
<description summary="set content purpose and hint">
- Sets the content purpose and content hint. While the purpose is the
+ Set 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.
<arg name="height" type="int"/>
</request>
<request name="set_preferred_language">
- <description summary="sets preferred 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.
+ <description summary="set preferred language">
+ Set 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.
+ 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.
</description>
<arg name="language" type="string"/>
</request>
</enum>
<request name="set_return_key_type">
<description summary="set return key type">
- Sets the return key type.
+ Set the return key type.
</description>
<arg name="return_key_type" type="uint"/>
</request>
be removed.
The commit text can be used to replace the preedit text on reset
- (for example on unfocus).
+ (for example on unfocus).
- The text input should also handle all preedit_style and preedit_cursor
- events occurring directly before preedit_string.
+ The text input should also handle all preedit_style and preedit_cursor
+ events occurring directly before preedit_string.
</description>
<arg name="serial" type="uint" summary="serial of the latest known text input state"/>
<arg name="text" type="string"/>
</enum>
<event name="preedit_styling">
<description summary="pre-edit styling">
- 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.
+ Set 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.
</description>
</event>
<event name="preedit_cursor">
<description summary="pre-edit cursor">
- Sets the cursor position inside the composing text (as byte
+ Set 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.
</event>
<event name="language">
<description summary="language">
- Sets the language of the input text. The "language" argument is a RFC-3066
+ Set the language of the input text. The "language" argument is a RFC-3066
format language tag.
</description>
<arg name="serial" type="uint" summary="serial of the latest known text input state"/>
</enum>
<event name="text_direction">
<description summary="text direction">
- Sets the text direction of input text.
+ Set 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
projects / platform / core / uifw / wayland-extension.git / commitdiff