fdo-mirrors/wayland-protocols
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland-protocols.git synced 2025-12-24 18:20:09 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

unstable/text-input: Add preedit text hints

Browse source 
There seems to be some demand from input methods to be able
to style different parts of the preedit string differently.
Since the reasons to do that are many, and vary between IMs
and languages, there may not ever be a closed semantic list
of hints.

But even though some IMs would much want to be able to specify
colors, they lack the context to know what choice of colors
provides enough contrast and legibility embedded on foreign
UIs (e.g. accounting things like themes, accessibility, ...).

This MR meets at a middle ground, and provides a set of wildly
generic semantic values, so that clients may theme these
specifically, and the IM is able to provide some hints rather
than none.

Control over underlining is given to the IMs, since that is
less controversial.

Signed-off-by: Carlos Garnacho <carlosg@gnome.org>
This commit is contained in:
Carlos Garnacho 2023-07-07 16:30:39 +02:00
parent 681c33c854
commit b022fe55e4
1 changed files with 80 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

81
unstable/text-input/text-input-unstable-v3.xml
View file

@ -47,7 +47,7 @@
interface version number is reset.
</description>
<interface name="zwp_text_input_v3" version="1">
<interface name="zwp_text_input_v3" version="2">
<description summary="text input">
The zwp_text_input_v3 interface represents text input and input methods
associated with a seat. It provides enter/leave events to follow the
@ -433,6 +433,85 @@
</description>
<arg name="serial" type="uint"/>
</event>
<!-- Version 2 additions -->
<enum name="preedit_underline">
<description summary="style of preedit underline">
Underline style to apply to sections of the preedit string.
</description>
<entry name="single" value="0" summary="single underline"/>
<entry name="double" value="1" summary="double underline"/>
<entry name="error" value="2" summary="error underline"/>
</enum>
<event name="preedit_underline" since="2">
<description summary="pre-edit underline">
Notify of underlining style hints for the pre-edit string. This
event is always sent together with a zwp_text_input_v3.preedit_string
event.
The parameters begin and end are counted in bytes relative to the
beginning of the text buffer submitted through
zwp_text_input_v3.preedit_string.
Multiple events may be submitted if the preedit string has different
sections. Compositors must not send multiple
zwp_text_input_v3.preedit_underline events with overlapping extents.
Clients may optionally honor this request. For parts of the preedit
string that are not covered by any zwp_text_input_v3.preedit_underline
event, or if no events were sent, the text will be considered not
underlined.
Values set with this event are double-buffered. They must be applied
and reset on the next zwp_text_input_v3.done event.
</description>
<arg name="begin" type="int"/>
<arg name="end" type="int"/>
<arg name="underline" type="int" enum="preedit_underline"/>
</event>
<enum name="preedit_hint">
<description summary="context hint for preedit">
Context hints to identify sections of the preedit string.
</description>
<entry name="info1" value="0" summary="info level 1"/>
<entry name="info2" value="1" summary="info level 2"/>
<entry name="info3" value="2" summary="info level 3"/>
<entry name="warning1" value="3" summary="warning level 1"/>
<entry name="warning2" value="4" summary="warning level 2"/>
<entry name="warning3" value="5" summary="warning level 3"/>
<entry name="error1" value="6" summary="error level 1"/>
<entry name="error2" value="7" summary="error level 2"/>
<entry name="error3" value="8" summary="error level 3"/>
</enum>
<event name="preedit_hint" since="2">
<description summary="pre-edit">
Notify of contextual hints for the pre-edit string. This
event is always sent together with a zwp_text_input_v3.preedit_string
event.
The parameters begin and end are counted in bytes relative to the
beginning of the text buffer submitted through
zwp_text_input_v3.preedit_string.
Multiple events may be submitted if the preedit string has different
sections. Compositors must not send multiple
zwp_text_input_v3.preedit_underline events with overlapping extents.
Clients are free to pick any visuals to represent the available hints,
including none at all. For parts of the preedit string that are not
covered by any zwp_text_input_v3.preedit_hint event, or if no events
were sent, the text will be considered unhinted.
Values set with this event are double-buffered. They must be applied
and reset on the next zwp_text_input_v3.done event.
</description>
<arg name="begin" type="int"/>
<arg name="end" type="int"/>
<arg name="hint" type="int" enum="preedit_hint"/>
</event>
</interface>
<interface name="zwp_text_input_manager_v3" version="1">