doc: add some more text protocol documentation

Signed-off-by: Jan Arne Petersen <jpetersen@openismus.com>
Jan Arne Petersen 12 years ago committed by Kristian Høgsberg
parent a75a789fc1
commit 8746ba0d29
  1. 20
      protocol/text.xml

@ -145,6 +145,8 @@
to commit could be either just a single character after a key press to commit could be either just a single character after a key press
or the result of some composing (pre-edit). It also sets the new or the result of some composing (pre-edit). It also sets the new
cursor position (as byte index) relative to the inserted text. cursor position (as byte index) relative to the inserted text.
Any previously set composing text should be removed.
</description> </description>
<arg name="serial" type="uint"/> <arg name="serial" type="uint"/>
<arg name="text" type="string"/> <arg name="text" type="string"/>
@ -154,8 +156,10 @@
<description summary="pre-edit"> <description summary="pre-edit">
Notify when a new composing text (pre-edit) should be set around the Notify when a new composing text (pre-edit) should be set around the
current cursor position. Any previously set composing text should current cursor position. Any previously set composing text should
be removed. It also sets the cursor position (as byte index) relative be removed.
to the start of the composing text.
The commit text can be used to replace the preedit text on reset
(for example on unfocus).
</description> </description>
<arg name="serial" type="uint"/> <arg name="serial" type="uint"/>
<arg name="text" type="string"/> <arg name="text" type="string"/>
@ -181,6 +185,15 @@
<entry name="incorrect" value="7"/> <entry name="incorrect" value="7"/>
</enum> </enum>
<event name="preedit_styling"> <event name="preedit_styling">
<description summary="pre-edit styling">
Sets styling information on composing text. The style is applied for
length (in bytes) characters from index relative to the beginning of
the composing text (as byte index). Multiple styles can be applied
to a composing text.
This event should be handled as part of a following preedit_string
event.
</description>
<arg name="serial" type="uint"/> <arg name="serial" type="uint"/>
<arg name="index" type="uint"/> <arg name="index" type="uint"/>
<arg name="length" type="uint"/> <arg name="length" type="uint"/>
@ -190,6 +203,9 @@
<description summary="pre-edit cursor"> <description summary="pre-edit cursor">
Sets the cursor position inside the composing text (as byte index) Sets the cursor position inside the composing text (as byte index)
relative to the start of the composing text. relative to the start of the composing text.
This event should be handled as part of a following preedit_string
event.
</description> </description>
<arg name="serial" type="uint"/> <arg name="serial" type="uint"/>
<arg name="index" type="int"/> <arg name="index" type="int"/>

Loading…
Cancel
Save