Input method v2

发送提交字符串文本以插入到应用程序中。

在当前光标位置插入字符串（参见提交事件序列）。要提交的字符串可以是按键后的单个字符，也可以是某些组合的结果。

参数 text 是包含要插入字符串的缓冲区。wayland 消息有最大长度限制，因此 text 不能超过 4000 字节。

通过此事件设置的值是双缓冲的。它们必须在下一次 zwp_text_input_v3.commit 请求时应用并重置为初始值。

text 的初始值为空字符串。

向应用程序文本输入发送预编辑字符串文本。

在当前光标位置放置新的组合文本（预编辑）。必须移除之前设置的任何组合文本。必须移除之前存在的任何选定文本。光标移动到预编辑字符串中的新位置。

参数 text 是包含预编辑字符串的缓冲区。wayland 消息有最大长度限制，因此 text 不能超过 4000 字节。

参数 cursor_begin 和 cursor_end 以字节为单位相对于提交字符串缓冲区的开头计算。当两者都等于 -1 时，文本输入应隐藏光标。

cursor_begin 表示光标的开始位置。cursor_end 表示光标的结束位置。它可以等于或不同于 cursor_begin。

通过此事件设置的值是双缓冲的。它们必须在下一次 zwp_input_method_v2.commit 事件时应用。

text 的初始值为空字符串。cursor_begin 和 cursor_end 的初始值均为 0。

移除周围文本。

before_length 和 after_length 是当前光标索引之前和之后要删除的字节数（不包括预编辑文本）。

如果存在预编辑文本，则为此事件的目的将其替换为光标。实际上，before_length 从预编辑文本的开头计算，after_length 从其结尾计算（参见提交事件序列）。

通过此事件设置的值是双缓冲的。它们必须在下一次 zwp_input_method_v2.commit 请求时应用并重置为初始值。

before_length 和 after_length 的初始值均为 0。

应用来自 commit_string、set_preedit_string 和 delete_surrounding_text 请求的状态更改。

与这些事件相关的状态是双缓冲的，每个事件都会修改待处理状态。此请求用待处理状态替换当前状态。

连接的文本输入应按以下顺序评估更改：

1. 用光标替换现有的预编辑字符串。 2. 删除请求的周围文本。 3. 在光标所在位置插入提交字符串。 4. 计算要发送的周围文本。 5. 在光标位置插入新的预编辑文本。 6. 将光标放置在预编辑文本内。

序列号反映客户端已知的 zwp_input_method_v2 对象的最后状态。serial 参数的值必须等于该对象已发出的 done 事件数量。当合成器收到的 commit 请求的序列号与过去的 done 事件数量不同时，它必须照常进行，但不应更改 zwp_input_method_v2 对象的当前状态。

创建一个新的 zwp_input_popup_surface_v2 对象来包装给定的表面。

该表面被分配"input_popup"角色。如果该表面已有分配的角色，合成器必须发出协议错误。

允许输入法接收硬件键盘输入并处理按键事件以在线生成文本事件（带预编辑）。这允许多个按键事件组合输入文本的输入法，如 CJK 语言所做的那样。

合成器应将 seat 上的所有键盘事件通过返回的 wl_keyboard 对象发送给 grab 持有者。尽管如此，合成器可以决定不转发任何特定事件。在事件被转发给 grab 持有者后，合成器不得进一步处理该事件。

释放生成的 wl_keyboard 对象即释放 grab。

销毁 zwp_text_input_v2 对象及任何关联的子对象，即 zwp_input_popup_surface_v2 和 zwp_input_method_keyboard_grab_v2。

通知此 seat 上聚焦的文本输入请求激活输入法。

此事件的目的是为合成器提供活动的输入法。

此事件重置与之前 enable、disable、surrounding_text、text_change_cause 和 content_type 事件相关的所有状态，以及与 set_preedit_string、commit_string 和 delete_surrounding_text 请求相关的状态。此外，它将 zwp_input_method_v2 对象标记为活动状态，并使任何现有的 zwp_input_popup_surface_v2 对象可见。

如果文本输入支持相应功能，surrounding_text 和 content_type 事件必须在下一个 done 事件之前发送。

通过此事件设置的状态是双缓冲的。它将在下一个 zwp_input_method_v2.done 事件时应用，并保持有效直到被更改。

通知当前没有聚焦的文本输入需要在此 seat 上激活输入法。

此事件将 zwp_input_method_v2 对象标记为非活动状态。合成器必须使所有现有的 zwp_input_popup_surface_v2 对象不可见，直到下一个 activate 事件。

通过此事件设置的状态是双缓冲的。它将在下一个 zwp_input_method_v2.done 事件时应用，并保持有效直到被更改。

更新光标周围的纯文本，不包括预编辑文本。

如果存在预编辑文本，则为此事件的目的将其替换为光标。

参数 text 是包含预编辑字符串的缓冲区，必须包含光标位置和完整选择范围。它应在这些内容前后包含额外的字符。wayland 消息有最大长度限制，因此 text 不能超过 4000 字节。

cursor 是 text 缓冲区中光标的字节偏移量。

anchor 是 text 缓冲区中选择锚点的字节偏移量。如果没有选定文本，anchor 必须与 cursor 相同。

如果此事件在第一个 done 事件之前未到达，输入法可以假设文本输入不支持此功能，并忽略后续的 surrounding_text 事件。

通过此事件设置的值是双缓冲的。它们将在下一个 zwp_input_method_v2.done 事件时应用并设置为初始值。

受影响字段的初始状态为空，表示文本输入不支持发送周围文本。如果应用了空值，后续更改它们的尝试可能不会生效。

告诉输入法光标周围的文本为何发生变化。

每当客户端检测到文本、光标或锚点位置的外部变化时，它必须向合成器发出此请求。此请求旨在给输入法一个机会以适当的方式更新预编辑文本，例如当用户开始用键盘输入时将其移除。

cause 描述了变化的来源。

通过此事件设置的值是双缓冲的。它将在下一个 zwp_input_method_v2.done 事件时应用并设置为初始值。

cause 的初始值为 input_method。

指示当前 zwp_input_method_v2 实例的内容类型和提示。

通过此事件设置的值是双缓冲的。它们将在下一个 zwp_input_method_v2.done 事件时应用。

hint 的初始值为 none，purpose 的初始值为 normal。

原子性地应用最近发送到客户端的状态更改。

done 事件建立并更新客户端的状态，必须在任何更改后发出以应用它们。

文本输入状态（内容用途、内容提示、周围文本和更改原因）在输入法上下文中是概念性双缓冲的。

事件修改待处理状态，而不是输入法正在使用的当前状态。done 事件原子性地应用所有待处理状态，替换当前状态。done 之后，新的待处理状态如每个相关请求所记录。

事件必须按到达顺序应用。

除非另有说明，否则当前状态和待处理状态均不会被修改。

输入法不再可用。

如果在创建时有另一个 input_method 对象关联到同一个 seat，合成器必须将此事件作为该对象上的唯一事件发出。

当对象不再可用时（例如由于 seat 被移除），合成器必须发出此请求。

输入法上下文变为惰性状态，应在处理停用后销毁。除了 destroy 请求外，任何进一步的请求和事件都必须被忽略。

通知文本输入区域的位置，以表面局部坐标中的矩形表示。

这是对输入法的提示，告诉它正在输入的文本的相对位置。

此事件向客户端提供一个文件描述符，可以将其内存映射以提供键盘映射描述。

按键被按下或释放。 time 参数是毫秒精度的时间戳，基准未定义。

通知客户端修饰键和/或组状态已更改，客户端应更新其本地状态。

通知客户端键盘的重复速率和延迟。

此事件在 zwp_input_method_keyboard_grab_v2 对象创建后立即发送，并保证在任何按键事件之前被客户端接收。

rate 或 delay 的负值是非法的。速率为零将禁用任何重复（无论 delay 的值如何）。

如果需要，此事件稍后也可以使用新值发送，因此客户端应在 zwp_input_method_keyboard_grab_v2 创建后继续监听该事件。

请求一个新的与给定 seat 关联的 zwp_input_method_v2 对象。

销毁 zwp_input_method_manager_v2 对象。

由此产生的 zwp_input_method_v2 对象仍然有效。