text: Rename text_model to text_input
Also rename text_model_factory to text_input_manager. Signed-off-by: Jan Arne Petersen <jpetersen@openismus.com>
This commit is contained in:
committed by
Kristian Høgsberg
parent
7ef8effca5
commit
78d00e45cc
+32
-29
@@ -26,24 +26,27 @@
|
||||
THIS SOFTWARE.
|
||||
</copyright>
|
||||
|
||||
<interface name="text_model" version="1">
|
||||
<description summary="text model">
|
||||
A model for text input. Adds support for text input and input methods to
|
||||
applications. A text_model object is created from a text_model_factory and
|
||||
corresponds typically to a text entry in an application. Requests are used
|
||||
to activate/deactivate the model and set information like surrounding and
|
||||
selected text or the content type. The information about entered text is
|
||||
sent to the model 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.
|
||||
<interface name="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
|
||||
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.
|
||||
</description>
|
||||
<request name="activate">
|
||||
<description summary="request activation">
|
||||
Requests the model 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
|
||||
model and tracked for focus lost. The activated event is emitted on
|
||||
successful activation.
|
||||
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.
|
||||
</description>
|
||||
<arg name="serial" type="uint"/>
|
||||
<arg name="seat" type="object" interface="wl_seat"/>
|
||||
@@ -51,9 +54,9 @@
|
||||
</request>
|
||||
<request name="deactivate">
|
||||
<description summary="request deactivation">
|
||||
Requests the model to be deactivated (typically when the text entry
|
||||
lost focus). The seat argument is a wl_seat which was used for
|
||||
activation.
|
||||
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>
|
||||
<arg name="seat" type="object" interface="wl_seat"/>
|
||||
</request>
|
||||
@@ -166,15 +169,15 @@
|
||||
</request>
|
||||
<event name="enter">
|
||||
<description summary="enter event">
|
||||
Notify the model when it is activated. Typically in response to an
|
||||
activate request.
|
||||
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 model when it is deactivated. Either in response to a
|
||||
deactivate request or when the assigned surface lost focus or was
|
||||
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>
|
||||
@@ -312,15 +315,15 @@
|
||||
</event>
|
||||
</interface>
|
||||
|
||||
<interface name="text_model_factory" version="1">
|
||||
<description summary="text model factory">
|
||||
A factory for text models. This object is a global singleton.
|
||||
<interface name="text_input_manager" version="1">
|
||||
<description summary="text input manager">
|
||||
A factory for text-input objects. This object is a global singleton.
|
||||
</description>
|
||||
<request name="create_text_model">
|
||||
<description summary="create text model">
|
||||
Creates a new text model object.
|
||||
<request name="create_text_input">
|
||||
<description summary="create text input">
|
||||
Creates a new text-input object.
|
||||
</description>
|
||||
<arg name="id" type="new_id" interface="text_model"/>
|
||||
<arg name="id" type="new_id" interface="text_input"/>
|
||||
</request>
|
||||
</interface>
|
||||
</protocol>
|
||||
|
||||
Reference in New Issue
Block a user