<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
- is created on text model activation on the input method side. It allows to
- receive information about the text model from the application via events.
+ Corresponds to a text input on input method side. An input method context
+ is created on text input activation on the input method side. It allows to
+ receive information about the text input from the application via events.
Input method contexts do not keep state after deactivation and should be
destroyed after deactivation is handled.
<description summary="keysym">
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_surrounfing_text, etc. The key event follows the wl_keyboard key
- event convention. Sym is a XKB keysym, state a wl_keyboard key_state.
+ delete_surrounding_text, etc. The key event follows the wl_keyboard key
+ event convention. Sym is an XKB keysym, state is a wl_keyboard key_state.
</description>
<arg name="serial" type="uint" summary="serial of the latest known text input state"/>
<arg name="time" type="uint"/>
</request>
<request name="grab_keyboard">
<description summary="grab hardware keyboard">
- Allows an input method to receive hardware keyboard input and process
+ Allow an input method to receive hardware keyboard input and process
key events to generate text events (with pre-edit) over the wire. This
allows input methods which compose multiple key events for inputting
text like it is done for CJK languages.
<interface name="wl_input_method" version="1">
<description summary="input method">
- An input method object is responsible to compose text in response to
+ An input method object is responsible for composing text in response to
input from hardware or virtual keyboards. There is one input method
object per seat. On activate there is a new input method context object
- created which allows the input method to communicate with the text model.
+ created which allows the input method to communicate with the text input.
</description>
<event name="activate">
<description summary="activate event">
- A text model was activated. Creates an input method context object
- which allows communication with the text model.
+ A text input was activated. Creates an input method context object
+ which allows communication with the text input.
</description>
<arg name="id" type="new_id" interface="wl_input_method_context"/>
<arg name="text_input_id" type="uint"/>
</event>
<event name="deactivate">
<description summary="deactivate event">
- The text model corresponding to the context argument was deactivated.
+ The text input corresponding to the context argument was deactivated.
The input method context should be destroyed after deactivation is
handled.
</description>
<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 input is active.
</description>
<arg name="output" type="object" interface="wl_output"/>
<arg name="position" type="uint"/>
<request name="set_overlay_panel">
<description summary="set the surface type as an overlay panel">
An overlay panel is shown near the input cursor above the application
- window when a text model is active.
+ window when a text input is active.
</description>
</request>
<interface name="wl_text_input" version="1">
<description summary="text 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
+ 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
+
+ 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 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.
<request name="destroy" type="destructor"/>
<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
- text-input object and tracked for focus lost. The enter event
+ text_input object and tracked for focus lost. The enter event
is emitted on successful activation.
</description>
<arg name="seat" type="object" interface="wl_seat"/>
</request>
<request name="deactivate">
<description summary="request deactivation">
- Requests the text-input object to be deactivated (typically when the
+ 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.
</description>
<request name="set_preferred_language">
<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
+ 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 language of
</request>
<event name="enter">
<description summary="enter event">
- Notify the text-input object when it received focus. Typically in
+ Notify the text_input object when it received focus. Typically in
response to an activate request.
</description>
<arg name="surface" type="object" interface="wl_surface"/>
</event>
<event name="leave">
<description summary="leave event">
- Notify the text-input object when it lost focus. Either in response
+ 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.
</description>
</event>
<event name="language">
<description summary="language">
- Set the language of the input text. The "language" argument is a RFC-3066
+ Set the language of the input text. The "language" argument is an RFC-3066
format language tag.
</description>
<arg name="serial" type="uint" summary="serial of the latest known text input state"/>
<interface name="wl_text_input_manager" version="1">
<description summary="text input manager">
- A factory for text-input objects. This object is a global singleton.
+ A factory for text_input objects. This object is a global singleton.
</description>
<request name="create_text_input">
<description summary="create text input">
- Creates a new text-input object.
+ Creates a new text_input object.
</description>
<arg name="id" type="new_id" interface="wl_text_input"/>
</request>
projects / platform / core / uifw / wayland-extension.git / commitdiff