From 675bca56ebb21ded28660a95d215bfa44fea2d48 Mon Sep 17 00:00:00 2001 From: ningning <3248127340@qq.com> Date: Tue, 15 Aug 2023 14:07:46 +0800 Subject: [PATCH] update Signed-off-by: ningning <3248127340@qq.com> --- .../js-apis-inputmethod-extension-ability.md | 4 +- .../js-apis-inputmethod-extension-context.md | 12 +- .../apis/js-apis-inputmethod-subtype.md | 6 +- .../reference/apis/js-apis-inputmethod.md | 439 ++++++++++-------- .../apis/js-apis-inputmethodengine.md | 246 +++++----- 5 files changed, 372 insertions(+), 335 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-ability.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-ability.md index 4218b64b14..d12a8e6ff7 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-ability.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-ability.md @@ -1,6 +1,6 @@ # @ohos.InputMethodExtensionAbility (InputMethodExtensionAbility) -开发者可通过继承本模块开发自己的输入法应用并管理输入法应用生命周期。 +本模块支持开发者自行开发输入法应用，以及管理输入法应用的生命周期。 > **说明：** > @@ -18,7 +18,7 @@ import InputMethodExtensionAbility from '@ohos.InputMethodExtensionAbility'; | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| context | [InputMethodExtensionContext](js-apis-inputmethod-extension-context.md) | 是 | 否 | InputMethodExtension的上下文环境，继承自ExtensionContext。 | +| context | [InputMethodExtensionContext](js-apis-inputmethod-extension-context.md) | 是 | 否 | InputMethodExtension的上下文环境，继承于ExtensionContext。 | ## InputMethodExtensionAbility.onCreate diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md index fa5ba2aec0..b5fffe30af 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md @@ -1,8 +1,6 @@ # @ohos.InputMethodExtensionContext (InputMethodExtensionContext) -InputMethodExtensionContext模块是InputMethodExtensionAbility的上下文环境，继承自ExtensionContext。 - -InputMethodExtensionContext模块提供InputMethodExtensionAbility具有的能力和接口，包括启动、停止、绑定、解绑Ability。 +InputMethodExtensionContext模块是InputMethodExtensionAbility的上下文环境，继承于ExtensionContext，提供InputMethodExtensionAbility具有的能力和接口，包括启动、停止、绑定、解绑Ability。 > **说明：** > @@ -31,7 +29,7 @@ class EntryAbility extends InputMethodExtensionAbility { destroy(callback: AsyncCallback\): void -停止输入法应用自身。使用callback异步回调。 +销毁输入法应用。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -39,7 +37,7 @@ destroy(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------------------------------------------ | -| callback | AsyncCallback\ | 是 | 回调函数。当停止输入法应用自身成功时，err为undefined；否则为错误对象。 | +| callback | AsyncCallback\ | 是 | 回调函数。当销毁输入法应用成功时，err为undefined；否则为错误对象。 | **示例：** @@ -53,7 +51,7 @@ this.context.destroy(() => { destroy(): Promise\; -停止输入法应用自身。通过Promise异步回调。 +销毁输入法应用。使用Promise异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -61,7 +59,7 @@ destroy(): Promise\; | 类型 | 说明 | | -------- | -------- | -| Promise\; | 无返回结果的Promise对象。 | +| Promise\ | 无返回结果的Promise对象。 | **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethod-subtype.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethod-subtype.md index b6b13c3106..4a10513465 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethod-subtype.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethod-subtype.md @@ -1,6 +1,6 @@ # @ohos.InputMethodSubtype (输入法子类型) -本模块提供对输入法子类型的属性管理。输入法应用子类型的含义，如：输入法的中文版、英文版、大写模式、小写模式等都属于输入法的子类型。 +本模块提供对输入法子类型的属性管理。输入法子类型允许输入法根据需要显示不用的输入模式或语言，完成模式或语言切换，如：输入法的中文/英文键盘等均属于输入法的子类型。 > **说明：** > @@ -22,11 +22,11 @@ import InputMethodSubtype from '@ohos.InputMethodSubtype'; | -------- | -------- | -------- | -------- | -------- | | label | string | 是 | 否 | 非必填。输入法子类型的标签。 | | labelId10+ | string | 是 | 否 | 非必填。输入法子类型的标签资源号。 | -| name | string | 是 | 否 | 必填。输入法应用的包名。 | +| name | string | 是 | 否 | 必填。输入法子类型所属应用的包名。 | | id | string | 是 | 否 | 必填。输入法子类型的id。 | | mode | string | 是 | 否 | 非必填。输入法子类型的模式，包括upper（大写）和lower（小写）。 | | locale | string | 是 | 否 | 必填。输入法子类型的方言版本。 | | language | string | 是 | 否 | 必填。 输入法子类型的语言。 | | icon | string | 是 | 否 | 非必填。输入法子类型的图标，可以通过iconId查询获取。预留字段，暂不支持使用。 | | iconId | number | 是 | 否 | 非必填。输入法子类型的图标id。 | -| extra | object | 是 | 是 | 非必填。输入法子类型的其他信息。预留字段，当前无具体含义，暂不支持使用。
**说明：** 从API version 10开始改为非必选参数。 | +| extra | object | 是 | 是 | 必填。输入法子类型的其他信息。
说明：
- 从API version 10开始为非必填参数。
- 预留字段，当前无具体含义，暂不支持使用。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md index b374bd9f82..ec4618f023 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md @@ -1,6 +1,6 @@ -# @ohos.inputMethod (输入法框架) +# @ohos.inputMethod (输入法框架) -本模块主要面向普通前台应用（备忘录、信息、设置等系统应用与三方应用），提供对输入法的控制、管理能力，包括显示/隐藏输入法软键盘、切换输入法、获取所有输入法列表等。 +本模块主要面向普通前台应用（备忘录、信息、设置等系统应用与三方应用），提供对输入法（输入法应用）的控制、管理能力，包括显示/隐藏输入法软键盘、切换输入法、获取所有输入法列表等等。 > **说明：** > @@ -38,8 +38,8 @@ import inputMethod from '@ohos.inputMethod'; | icon9+ | string | 是 | 否 | 非必填。输入法图标数据，可以通过iconId查询获取。预留字段，暂不支持使用。| | iconId9+ | number | 是 | 否 | 非必填。输入法图标资源号。 | | extra9+ | object | 是 | 是 | 输入法扩展信息。预留字段，当前无具体含义，暂不支持使用。
- API version 10起：非必填；
- API version 9：必填。| -| packageName(deprecated) | string | 是 | 否 | 输入法包名。必填。
**说明：** 从API version 8开始支持，从API version 9开始废弃，建议使用name替代。 | -| methodId(deprecated) | string | 是 | 否 | 输入法唯一标识。必填。
**说明：** 从API version 8开始支持，从API version 9开始废弃，建议使用id替代。 | +| packageName(deprecated) | string | 是 | 否 | 输入法包名。必填。
说明：从API version 8开始支持，从API version 9开始废弃，建议使用name替代。 | +| methodId(deprecated) | string | 是 | 否 | 输入法唯一标识。必填。
说明：从API version 8开始支持，从API version 9开始废弃，建议使用id替代。 | ## inputMethod.getController9+ @@ -101,9 +101,9 @@ let inputMethodSetting = inputMethod.getSetting(); switchInputMethod(target: InputMethodProperty, callback: AsyncCallback<boolean>): void -切换输入法。使用callback异步回调。 +切换输入法，仅系统应用可用。使用callback异步回调。 -**需要权限：** ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。 +**需要权限：** ohos.permission.CONNECT_IME_ABILITY **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -111,7 +111,7 @@ switchInputMethod(target: InputMethodProperty, callback: AsyncCallback<boolea | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| target | [InputMethodProperty](#inputmethodproperty8) | 是 | 传入要切换的目标输入法。 | +| target | [InputMethodProperty](#inputmethodproperty8) | 是 | 目标输入法。 | | callback | AsyncCallback<boolean> | 是 | 回调函数。当输入法切换成功，err为undefined，data为true；否则为错误对象。 | **错误码：** @@ -146,9 +146,9 @@ try{ ## inputMethod.switchInputMethod9+ switchInputMethod(target: InputMethodProperty): Promise<boolean> -切换输入法。使用promise异步回调。 +切换输入法，仅系统应用可用。使用promise异步回调。 -**需要权限：** ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。 +**需要权限：** ohos.permission.CONNECT_IME_ABILITY **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -156,13 +156,13 @@ switchInputMethod(target: InputMethodProperty): Promise<boolean> | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - |target | [InputMethodProperty](#inputmethodproperty8)| 是 | 传入要切换的目标输入法。 | + |target | [InputMethodProperty](#inputmethodproperty8)| 是 | 目标输入法。 | **返回值：** | 类型 | 说明 | | ----------------------------------------- | ---------------------------- | - | Promise\ | Promise对象。返回true表示切换输入法成功；返回false表示切换输入法失败。 | + | Promise\ | Promise对象。返回true表示切换输入法成功，返回false表示切换输入法失败。 | **错误码：** @@ -196,7 +196,7 @@ try { getCurrentInputMethod(): InputMethodProperty -获取当前输入法扩展应用，提供同步接口，返回当前输入法属性。 +使用同步方法获取当前输入法。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -216,9 +216,13 @@ let currentIme = inputMethod.getCurrentInputMethod(); switchCurrentInputMethodSubtype(target: InputMethodSubtype, callback: AsyncCallback\): void -在当前输入法应用内切换子类型。使用callback异步回调。 +切换当前输入法的子类型。使用callback异步回调。 + +> **说明：** +> +> 在API version 9版本，仅支持系统应用调用；API version 10版本起，支持系统应用和当前输入法应用调用。 -**需要权限：** ohos.permission.CONNECT_IME_ABILITY
**说明：**
- API version 10起，允许系统应用及当前输入法应用调用；
- API version 9，仅系统应用可用。 +**需要权限：** ohos.permission.CONNECT_IME_ABILITY **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -226,7 +230,7 @@ switchCurrentInputMethodSubtype(target: InputMethodSubtype, callback: AsyncCallb | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| target | [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)| 是 | 传入要切换的目标输入法子类型。 | +| target | [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)| 是 | 目标输入法子类型。 | | callback | AsyncCallback<boolean> | 是 | 回调函数。当输入法子类型切换成功，err为undefined，data为true；否则为错误对象。| **错误码：** @@ -272,9 +276,13 @@ try { switchCurrentInputMethodSubtype(target: InputMethodSubtype): Promise<boolean> -在当前输入法应用内切换子类型。使用promise异步回调。 +切换当前输入法的子类型。使用promise异步回调。 -**需要权限：** ohos.permission.CONNECT_IME_ABILITY
**说明：**
- API version 10起，允许系统应用及当前输入法应用调用；
- API version 9，仅系统应用可用。 +> **说明：** +> +> 在API version 9版本，仅支持系统应用调用；API version 10版本起，支持系统应用和当前输入法应用调用。 + +**需要权限：** ohos.permission.CONNECT_IME_ABILITY **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -282,13 +290,13 @@ switchCurrentInputMethodSubtype(target: InputMethodSubtype): Promise<boolean& | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -|target | [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)| 是 | 传入要切换的目标输入法子类型。 | +|target | [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)| 是 | 目标输入法子类型。 | **返回值：** | 类型 | 说明 | | ----------------------------------------- | ---------------------------- | -| Promise\ | Promise对象。返回true表示在当前输入法应用内切换子类型成功；返回false表示在当前输入法应用内切换子类型失败。 | +| Promise\ | Promise对象。返回true表示当前输入法切换子类型成功，返回false表示当前输入法切换子类型成功失败。 | **错误码：** @@ -331,7 +339,7 @@ try { getCurrentInputMethodSubtype(): InputMethodSubtype -获取当前输入法子类型。 +获取当前输入法的子类型。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -351,9 +359,9 @@ let currentImeSubType = inputMethod.getCurrentInputMethodSubtype(); switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype, callback: AsyncCallback\): void -切换至指定输入法应用的指定子类型，用于跨输入法应用切换子类型。使用callback异步回调。 +切换至指定输入法的指定子类型，适用于跨输入法切换子类型，仅系统应用可用。使用callback异步回调。 -**需要权限：** ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。 +**需要权限：** ohos.permission.CONNECT_IME_ABILITY **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -361,8 +369,8 @@ switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inp | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -|inputMethodProperty | [InputMethodProperty](#inputmethodproperty8)| 是 | 传入要切换的目标输入法。 | -|inputMethodSubtype | [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)| 是 | 传入要切换的目标输入法子类型。 | +|inputMethodProperty | [InputMethodProperty](#inputmethodproperty8)| 是 | 目标输入法。 | +|inputMethodSubtype | [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)| 是 | 目标输入法子类型。 | | callback | AsyncCallback<boolean> | 是 | 回调函数。当输入法和子类型切换成功，err为undefined，data为获取到的切换子类型结果true；否则为错误对象。 | **错误码：** @@ -400,9 +408,9 @@ try { switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype): Promise<boolean> -切换至指定输入法应用的指定子类型，用于跨输入法应用切换子类型。使用promise异步回调。 +切换至指定输入法的指定子类型，适用于跨输入法切换子类型，仅系统应用可用。使用promise异步回调。 -**需要权限：** ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。 +**需要权限：** ohos.permission.CONNECT_IME_ABILITY **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -410,14 +418,14 @@ switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inp | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -|inputMethodProperty | [InputMethodProperty](#inputmethodproperty8)| 是 | 传入要切换的目标输入法。 | -|inputMethodSubtype | [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)| 是 | 传入要切换的目标输入法子类型。 | +|inputMethodProperty | [InputMethodProperty](#inputmethodproperty8)| 是 | 目标输入法。 | +|inputMethodSubtype | [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)| 是 | 目标输入法子类型。 | **返回值：** | 类型 | 说明 | | ----------------------------------------- | ---------------------------- | -| Promise\ | Promise对象。返回true表示切换至指定输入法应用的指定子类型成功；返回false表示切换至指定输入法应用的指定子类型失败。 | +| Promise\ | Promise对象。返回true表示切换至指定输入法的指定子类型成功，返回false表示切换至指定输入法的指定子类型失败。 | **错误码：** @@ -516,7 +524,7 @@ let inputMethodSetting = inputMethod.getInputMethodSetting(); ## EnterKeyType10+ -输入法Enter键所代表的功能类型。 +Enter键的功能类型。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -558,7 +566,7 @@ let inputMethodSetting = inputMethod.getInputMethodSetting(); ## ExtendAction10+ -对编辑框中文本的扩展编辑操作类型。 +编辑框中文本的扩展编辑操作类型，如剪切、复制等。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -581,7 +589,7 @@ let inputMethodSetting = inputMethod.getInputMethodSetting(); ## InputAttribute10+ -编辑框属性，包含文本输入类型，Enter键功能类型。 +编辑框属性，包含文本输入类型和Enter键功能类型。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -592,7 +600,7 @@ let inputMethodSetting = inputMethod.getInputMethodSetting(); ## TextConfig10+ -编辑控件配置信息。编辑控件请求绑定输入法应用时传入，将编辑控件相关属性配置信息保存到输入法框架内。 +编辑框的配置信息。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -600,8 +608,8 @@ let inputMethodSetting = inputMethod.getInputMethodSetting(); | -------- | -------- | -------- | -------- | -------- | | inputAttribute10+ | [InputAttribute](#inputattribute10) | 否 | 是 | 编辑框属性。| | cursorInfo10+ | [CursorInfo](#cursorinfo10) | 否 | 否 | 光标信息。| -| selection10+ | [Range](#range10) | 否 | 否 | 文本选区范围。| -| windowId10+ | number | 否 | 否 | 编辑控件所在的窗口Id。| +| selection10+ | [Range](#range10) | 否 | 否 | 文本选中的范围。| +| windowId10+ | number | 否 | 否 | 编辑框所在的窗口Id。| ## CursorInfo10+ @@ -618,7 +626,7 @@ let inputMethodSetting = inputMethod.getInputMethodSetting(); ## Range10+ -描述选中文本的范围。 +文本的选中范围。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -629,13 +637,13 @@ let inputMethodSetting = inputMethod.getInputMethodSetting(); ## Movement10+ -描述进行选中文本动作时光标移动的方向。 +选中文本时，光标移动的方向。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| direction | [Direction](#direction10) | 是 | 是 | 进行选中文本动作时光标移动的方向。| +| direction | [Direction](#direction10) | 是 | 是 | 选中文本时，光标的移动方向。| ## InputWindowInfo10+ @@ -653,15 +661,17 @@ let inputMethodSetting = inputMethod.getInputMethodSetting(); ## InputMethodController -下列API示例中都需使用[getController](#inputmethodgetcontroller9)获取到InputMethodController实例，再通过此实例调用对应方法。 +下列API示例中都需使用[getController](#inputmethodgetcontroller9)获取到InputMethodController实例，再通过实例调用对应方法。 ### attach10+ attach(showKeyboard: boolean, textConfig: TextConfig, callback: AsyncCallback<void>): void -用于自绘控件绑定输入法应用。使用callback异步回调。 +自绘控件绑定输入法。使用callback异步回调。 -必须先调用此接口完成自绘控件与输入法应用的绑定，才可以使用输入法框架的以下功能：显示、隐藏键盘；更新光标信息；更改编辑框选中范围；保存配置信息；监听处理由输入法应用发送的信息或命令等。 +> **说明** +> +> 需要先调用此接口，完成自绘控件与输入法的绑定，才能使用以下功能：显示/隐藏键盘、更新光标信息、更改编辑框选中范围、保存配置信息、监听处理由输入法应用发送的信息或命令等。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -669,8 +679,8 @@ attach(showKeyboard: boolean, textConfig: TextConfig, callback: AsyncCallback< | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| showKeyboard | boolean | 是 | 绑定输入法成功后是否拉起输入法键盘。 | -| textConfig | [TextConfig](#textconfig10) | 是 | 编辑控件配置信息。 | +| showKeyboard | boolean | 是 | 绑定输入法成功后，是否拉起输入法键盘。
- ture表示拉起，false表示不拉起。 | +| textConfig | [TextConfig](#textconfig10) | 是 | 编辑框的配置信息。 | | callback | AsyncCallback<void> | 是 | 回调函数。当绑定输入法成功后，err为undefined；否则为错误对象。 | **错误码：** @@ -708,9 +718,11 @@ try { attach(showKeyboard: boolean, textConfig: TextConfig): Promise<void> -用于自绘控件绑定输入法应用。使用promise异步回调。 +自绘控件绑定输入法。使用promise异步回调。 -必须先调用此接口完成自绘控件与输入法应用的绑定，才可以使用输入法框架的以下功能：显示、隐藏键盘；更新光标信息；更改编辑框选中范围；保存配置信息；监听处理由输入法应用发送的信息或命令等。 +> **说明** +> +> 需要先调用此接口，完成自绘控件与输入法的绑定，才能使用以下功能：显示/隐藏键盘、更新光标信息、更改编辑框选中范围、保存配置信息、监听处理由输入法应用发送的信息或命令等。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -718,8 +730,8 @@ attach(showKeyboard: boolean, textConfig: TextConfig): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| showKeyboard | boolean | 是 | 绑定输入法成功后是否拉起输入法键盘。 | -| textConfig | [TextConfig](#textconfig10) | 是 | 编辑框属性。 | +| showKeyboard | boolean | 是 | 绑定输入法成功后，是否拉起输入法键盘。
- ture表示拉起，false表示不拉起。| +| textConfig | [TextConfig](#textconfig10) | 是 | 编辑框的配置信息。 | **返回值：** @@ -762,7 +774,9 @@ showTextInput(callback: AsyncCallback<void>): void 进入文本编辑状态。使用callback异步回调。 -编辑控件与输入法应用绑定成功后，可调用该接口去拉起软键盘。 +> **说明** +> +> 编辑框与输入法绑定成功后，可调用该接口拉起软键盘，进入文本编辑状态。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -800,7 +814,9 @@ showTextInput(): Promise<void> 进入文本编辑状态。使用promise异步回调。 -编辑控件与输入法应用绑定成功后，可调用该接口去拉起软键盘。 +> **说明** +> +> 编辑框与输入法绑定成功后，可调用该接口拉起软键盘，进入文本编辑状态。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -836,9 +852,11 @@ hideTextInput(callback: AsyncCallback<void>): void 退出文本编辑状态。使用callback异步回调。 -编辑控件可调用该接口退出编辑状态。若调用该接口时当前软键盘处于显示状态，则调用该接口后软键盘会被隐藏。 - -调用该接口不解除与输入法应用的绑定，再次调用[showTextInput](#showtextinput10)时，可重新进入编辑状态。 +> **说明** +> +> 调用接口时，若软键盘处于显示状态，调用接口后软键盘会被隐藏。 +> +> 调用该接口不会解除与输入法的绑定，再次调用[showTextInput](#showtextinput10)时，可重新进入文本编辑状态。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -876,9 +894,11 @@ hideTextInput(): Promise<void> 退出文本编辑状态。使用promise异步回调。 -编辑控件可调用该接口退出编辑状态。若调用该接口时当前软键盘处于显示状态，则调用该接口后软键盘会被隐藏。 - -调用该接口不解除与输入法应用的绑定，再次调用[showTextInput](#showtextinput10)时，可重新进入编辑状态。 +> **说明** +> +> 调用接口时，若软键盘处于显示状态，调用接口后软键盘会被隐藏。 +> +> 调用该接口不会解除与输入法的绑定，再次调用[showTextInput](#showtextinput10)时，可重新进入文本编辑状态。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -912,7 +932,7 @@ inputMethodController.hideTextInput().then(() => { detach(callback: AsyncCallback<void>): void -解除与输入法应用的绑定。使用callback异步回调。 +自绘控件解除与输入法的绑定。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -947,7 +967,7 @@ inputMethodController.detach((err) => { detach(): Promise<void> -解除与输入法应用的绑定。使用promise异步回调。 +自绘控件解除与输入法的绑定。使用promise异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -980,9 +1000,11 @@ inputMethodController.detach().then(() => { setCallingWindow(windowId: number, callback: AsyncCallback<void>): void -设置要避让的窗口。使用callback异步回调。 +设置要避让软键盘的窗口。使用callback异步回调。 -比如：将当前绑定到输入法的应用程序的窗口ID通知系统，正确设置后，客户端所在的窗口可以避开输入法窗口。预留能力，当前暂不支持获取windowId。 +> **说明** +> +> 将绑定到输入法的应用程序所在的窗口Id传入，此窗口可以避让输入法窗口。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -990,7 +1012,7 @@ setCallingWindow(windowId: number, callback: AsyncCallback<void>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| windowId | number | 是 | 要避让的窗口id。 | +| windowId | number | 是 | 绑定输入法应用的应用程序所在的窗口Id。 | | callback | AsyncCallback<void> | 是 | 回调函数。当设置成功时，err为undefined；否则为错误对象。 | **错误码：** @@ -1024,9 +1046,11 @@ try { setCallingWindow(windowId: number): Promise<void> -设置要避让的窗口。使用promise异步回调。 +设置要避让软键盘的窗口。使用promise异步回调。 -比如：将当前绑定到输入法的应用程序的窗口ID通知系统，正确设置后，客户端所在的窗口可以避开输入法窗口。预留能力，当前暂不支持获取windowId。 +> **说明** +> +> 将绑定到输入法的应用程序所在的窗口Id传入，此窗口可以避让输入法窗口。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1034,7 +1058,7 @@ setCallingWindow(windowId: number): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| windowId | number | 是 | 要避让的窗口id。 | +| windowId | number | 是 | 绑定输入法应用的应用程序所在的窗口Id。 | **返回值：** @@ -1071,9 +1095,7 @@ try { updateCursor(cursorInfo: CursorInfo, callback: AsyncCallback<void>): void -更新当前编辑框内光标信息。使用callback异步回调。 - -当光标信息发生变化时，可调用该接口更新光标信息，从而被输入法应用感知到光标变化。 +更新当前编辑框内的光标信息。当光标信息发生变化时，调用该接口使输入法感知到光标变化。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1114,9 +1136,7 @@ try { updateCursor(cursorInfo: CursorInfo): Promise<void> -更新当前编辑控件内的光标信息。使用promise异步回调。 - -当光标信息发生变化时，编辑控件可调用该接口更新光标信息，从而被输入法应用感知到光标变化。 +更新当前编辑框内的光标信息。当光标信息发生变化时，调用该接口使输入法感知到光标变化。使用promise异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1160,7 +1180,7 @@ try { changeSelection(text: string, start: number, end: number, callback: AsyncCallback<void>): void -向输入法应用更新当前编辑框内被选中的文本信息，当选中的文本内容或文本范围发生变化时，可调用该接口更新文本信息。使用callback异步回调。 +更新当前编辑框内被选中的文本信息。当选中的文本内容或文本范围发生变化时，可调用该接口更新文本信息，使输入法应用感知到变化。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1171,7 +1191,7 @@ changeSelection(text: string, start: number, end: number, callback: AsyncCallbac | text | string | 是 | 整个输入文本。 | | start | number | 是 | 所选文本的起始位置。 | | end | number | 是 | 所选文本的结束位置。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当隐藏输入法成功时，err为undefined；否则为错误对象。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当文本信息更新成功时，err为undefined；否则为错误对象。 | **错误码：** @@ -1203,7 +1223,7 @@ try { changeSelection(text: string, start: number, end: number): Promise<void> -向输入法应用更新当前编辑框内被选中的文本信息，当选中的文本内容或文本范围发生变化时，可调用该接口更新文本信息。使用promise异步回调。 +更新当前编辑框内被选中的文本信息。当选中的文本内容或文本范围发生变化时，可调用该接口更新文本信息，使输入法应用感知到变化。使用promise异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1249,7 +1269,7 @@ try { updateAttribute(attribute: InputAttribute, callback: AsyncCallback<void>): void -更新编辑框属性配置信息。使用callback异步回调。 +更新编辑框属性信息。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1257,8 +1277,8 @@ updateAttribute(attribute: InputAttribute, callback: AsyncCallback<void>): | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| attribute | [InputAttribute](#inputattribute10) | 是 | InputAttribute对象，包含的额外信息。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当隐藏输入法成功时，err为undefined；否则为错误对象。 | +| attribute | [InputAttribute](#inputattribute10) | 是 | 编辑框属性对象。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当编辑框属性信息更新成功时，err为undefined；否则为错误对象。 | **错误码：** @@ -1290,7 +1310,7 @@ try { updateAttribute(attribute: InputAttribute): Promise<void> -更新编辑框属性配置信息。使用promise异步回调。 +更新编辑框属性信息。使用promise异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1298,7 +1318,7 @@ updateAttribute(attribute: InputAttribute): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| attribute | [InputAttribute](#inputattribute10) | 是 | InputAttribute对象，包含的额外信息。 | +| attribute | [InputAttribute](#inputattribute10) | 是 | 编辑框属性对象。 | **返回值：** @@ -1336,7 +1356,9 @@ stopInputSession(callback: AsyncCallback<boolean>): void 结束输入会话。使用callback异步回调。 -需要与编辑控件（如：输入框）绑定使用。当点击编辑控件后，才可通过调用该接口结束输入会话。 +> **说明：** +> +> 该接口需要编辑框与输入法绑定时才能调用，即点击编辑控件后，才可调用该接口结束输入会话。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1381,7 +1403,9 @@ stopInputSession(): Promise<boolean> 结束输入会话。使用promise异步回调。 -需要与编辑控件（如：输入框）绑定使用。当点击编辑控件后，才可通过调用该接口结束输入会话。 +> **说明：** +> +> 该接口需要编辑框与输入法绑定时才能调用，即点击编辑控件后，才可调用该接口结束输入会话。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1389,7 +1413,7 @@ stopInputSession(): Promise<boolean> | 类型 | 说明 | | -------- | -------- | -| Promise<boolean> | Promise对象。返回true表示结束输入会话成功；返回false表示结束输入会话失败。 | +| Promise<boolean> | Promise对象。返回true表示结束输入会话成功，返回false表示结束输入会话失败。 | **错误码：** @@ -1422,9 +1446,11 @@ try { showSoftKeyboard(callback: AsyncCallback<void>): void -显示软键盘。使用callback异步回调。 +显示输入法软键盘。使用callback异步回调。 -需要与编辑控件（如：输入框）绑定使用。当点击编辑控件后，才可通过该接口的调用显示出当前输入法的软键盘。 +> **说明：** +> +> 该接口需要编辑框与输入法绑定时才能调用，即点击编辑控件后，才可调用显示当前输入法的软键盘。 **需要权限：** ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。 @@ -1461,9 +1487,11 @@ inputMethodController.showSoftKeyboard((err) => { showSoftKeyboard(): Promise<void> -显示软键盘。使用Promise异步回调。 +显示输入法软键盘。使用Promise异步回调。 -需要与编辑控件（如：输入框）绑定使用。当点击编辑控件后，才可通过该接口的调用显示出当前输入法的软键盘。 +> **说明：** +> +> 该接口需要编辑框与输入法绑定时才能调用，即点击编辑控件后，才可调用显示当前输入法的软键盘。 **需要权限：** ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。 @@ -1498,9 +1526,11 @@ inputMethodController.showSoftKeyboard().then(() => { hideSoftKeyboard(callback: AsyncCallback<void>): void -隐藏软键盘。使用callback异步回调。 +隐藏输入法软键盘。使用callback异步回调。 -需要与编辑控件（如：输入框）绑定使用。当点击编辑控件后，才可通过调用该接口隐藏当前输入法的软键盘。 +> **说明：** +> +> 该接口需要编辑框与输入法绑定时才能调用，即点击编辑控件后，才可调用隐藏当前输入法的软键盘。 **需要权限：** ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。 @@ -1537,9 +1567,11 @@ inputMethodController.hideSoftKeyboard((err) => { hideSoftKeyboard(): Promise<void> -隐藏软键盘。使用Promise异步回调。 +隐藏输入法软键盘。使用Promise异步回调。 -需要与编辑控件（如：输入框）绑定使用。当点击编辑控件后，才可通过调用该接口隐藏当前输入法的软键盘。 +> **说明：** +> +> 该接口需要编辑框与输入法绑定时才能调用，即点击编辑控件后，才可调用隐藏当前输入法的软键盘。 **需要权限：** ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。 @@ -1576,10 +1608,10 @@ stopInput(callback: AsyncCallback<boolean>): void 结束输入会话。使用callback异步回调。 -需要与编辑控件（如：输入框）绑定使用。当点击编辑控件后，才可通过调用该接口结束输入会话。 - > **说明：** -> +> +> 该接口需要编辑框与输入法绑定时才能调用，即点击编辑控件后，才可调用该接口结束输入会话。 +> > 从API version 6开始支持，从API version 9开始废弃，建议使用[stopInputSession()](#stopinputsession9)替代。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1588,7 +1620,7 @@ stopInput(callback: AsyncCallback<boolean>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| callback | AsyncCallback<boolean> | 是 | 回调函数。当输入法隐藏成功，err为undefined，data为true；否则为错误对象。 | +| callback | AsyncCallback<boolean> | 是 | 回调函数。当会话结束成功，err为undefined，data为true；否则为错误对象。 | **示例：** @@ -1612,10 +1644,10 @@ stopInput(): Promise<boolean> 结束输入会话。使用promise异步回调。 -需要与编辑控件（如：输入框）绑定使用。当点击编辑控件后，才可通过调用该接口结束输入会话。 - > **说明：** -> +> +> 该接口需要编辑框与输入法绑定时才能调用，即点击编辑控件后，才可调用该接口结束输入会话。 +> > 从API version 6开始支持，从API version 9开始废弃，建议使用[stopInputSession()](#stopinputsession9)替代。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1624,7 +1656,7 @@ stopInput(): Promise<boolean> | 类型 | 说明 | | -------- | -------- | -| Promise<boolean> | Promise对象。返回true表示输入法隐藏成功；返回false表示输入法隐藏失败。 | +| Promise<boolean> | Promise对象。返回true表示会话结束成功；返回false表示会话结束失败。 | **示例：** @@ -1652,8 +1684,8 @@ on(type: 'insertText', callback: (text: string) => void): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为‘insertText’时表示订阅输入法应用插入文本事件监听。 | -| callback | (text: string) => void | 是 | 回调函数，返回需要插入的文本内容。
开发者需要在回调函数中根据传入的文本内容操作编辑框中的内容。 | +| type | string | 是 | 设置监听类型，固定取值为'insertText'。 | +| callback | (text: string) => void | 是 | 回调函数，返回需要插入的文本内容。
根据传入的文本，在回调函数中操作编辑框中的内容。 | **错误码：** @@ -1687,8 +1719,8 @@ off(type: 'insertText', callback?: (text: string) => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为‘insertText’时表示取消订阅输入法应用插入文本事件监听。 | -| callback | (text: string) => void | 否 | 取消订阅的回调函数，需要与on接口传入的保持一致。当该参数不填写时，取消订阅type对应的所有回调事件。 | +| type | string | 是 | 设置监听类型，固定取值为'insertText'。 | +| callback | (text: string) => void | 否 | 取消订阅的回调函数，需要与on接口传入的保持一致。
参数不填写时，取消订阅type对应的所有回调事件。 | **示例：** @@ -1712,8 +1744,8 @@ on(type: 'deleteLeft', callback: (length: number) => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ----- | ---- | ----- | -| type | string | 是 | 设置监听类型。
- type为`deleteLeft`表示订阅输入法应用向左删除事件监听。 | -| callback | (length: number) => void | 是 | 回调函数，返回需要向左删除的文本的长度。
开发者需要在回调函数中根据传入的删除长度操作编辑框中相应文本。 | +| type | string | 是 | 设置监听类型，固定取值为'deleteLeft'。| +| callback | (length: number) => void | 是 | 回调函数，返回需要向左删除的文本长度。
根据传入的删除长度，在回调函数中操作编辑框中的文本。 | **错误码：** @@ -1735,6 +1767,31 @@ try { } ``` +### off('deleteLeft')10+ + +off(type: 'deleteLeft', callback?: (length: number) => void): void + +取消订阅输入法应用向左删除文本事件。 + +**系统能力：** SystemCapability.MiscServices.InputMethodFramework + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------ | ---- | ------------------------------------------------------------ | +| type | string | 是 | 设置监听，固定取值为'deleteLeft'。 | +| callback | (length: number) => void | 否 | 取消订阅的回调函数，需要与on接口传入的保持一致。
参数不填写时，取消订阅type对应的所有回调事件。 | + +**示例：** + +```js +let onDeleteLeftCallback = (length: number) => { + console.log(`Succeeded in subscribing deleteLeft, length: ${length}`); +}; +inputMethodController.off('deleteLeft', onDeleteLeftCallback); +inputMethodController.off('deleteLeft'); +``` + ### on('deleteRight')10+ on(type: 'deleteRight', callback: (length: number) => void): void @@ -1747,8 +1804,8 @@ on(type: 'deleteRight', callback: (length: number) => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ----- | ---- | ----- | -| type | string | 是 | 设置监听类型。
- type为`deleteRight`表示订阅输入法应用向右删除事件监听。| -| callback | (length: number) => void | 是 | 回调函数，返回需要向右删除的文本的长度。
开发者需要在回调函数中根据传入的删除长度操作编辑框中相应文本。 | +| type | string | 是 | 设置监听类型，固定取值为'deleteRight'。| +| callback | (length: number) => void | 是 | 回调函数，返回需要向右删除的文本长度。
根据传入的删除长度，在回调函数中操作编辑框中的文本。 | **错误码：** @@ -1769,30 +1826,6 @@ try { console.error(`Failed to subscribe deleteRight: ${JSON.stringify(err)}`); } ``` -### off('deleteLeft')10+ - -off(type: 'deleteLeft', callback?: (length: number) => void): void - -取消订阅输入法应用向左删除文本事件。 - -**系统能力：** SystemCapability.MiscServices.InputMethodFramework - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为`deleteLeft`表示取消订阅输入法应用向左删除的事件监听。 | -| callback | (length: number) => void | 否 | 取消订阅的回调函数，需要与on接口传入的保持一致。当该参数不填写时，取消订阅type对应的所有回调事件。 | - -**示例：** - -```js -let onDeleteLeftCallback = (length: number) => { - console.log(`Succeeded in subscribing deleteLeft, length: ${length}`); -}; -inputMethodController.off('deleteLeft', onDeleteLeftCallback); -inputMethodController.off('deleteLeft'); -``` ### off('deleteRight')10+ @@ -1806,8 +1839,8 @@ off(type: 'deleteRight', callback?: (length: number) => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为`deleteRight`表示取消订阅输入法应用向右删除的事件监听。 | -| callback | (length: number) => void | 否 | 取消订阅的回调函数，需要与on接口传入的保持一致。当该参数不填写时，取消订阅type对应的所有回调事件。 | +| type | string | 是 | 设置监听类型，固定取值为`deleteRight`。 | +| callback | (length: number) => void | 否 | 取消订阅的回调函数，需要与on接口传入的保持一致。
参数不填写时，取消订阅type对应的所有回调事件。 | **示例：** @@ -1823,7 +1856,7 @@ inputMethodController.off('deleteRight'); on(type: 'sendKeyboardStatus', callback: (keyboardStatus: KeyboardStatus) => void): void -订阅输入法应用发送键盘状态事件。使用callback异步回调。 +订阅输入法应用发送输入法软键盘状态事件。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1831,8 +1864,8 @@ on(type: 'sendKeyboardStatus', callback: (keyboardStatus: KeyboardStatus) => voi | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ---- | -| type | string | 是 | 设置监听类型。
- type为‘sendKeyboardStatus’时表示订阅输入法应用发送键盘状态事件监听。 | -| callback | (keyboardStatus: [KeyboardStatus](#keyboardstatus10)) => void | 是 | 回调函数，返回键盘状态。
开发者需要在回调函数中根据传入的键盘状态做相应动作。 | +| type | string | 是 | 设置监听类型，固定取值为'sendKeyboardStatus'。 | +| callback | (keyboardStatus: [KeyboardStatus](#keyboardstatus10)) => void | 是 | 回调函数，返回软键盘状态。
根据传入的软键盘状态，在回调函数中做相应操作。 | **错误码：** @@ -1858,7 +1891,7 @@ try { off(type: 'sendKeyboardStatus', callback?: (keyboardStatus: KeyboardStatus) => void): void -取消订阅输入法应用发送键盘状态事件。 +取消订阅输入法应用发送软键盘状态事件。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1866,8 +1899,8 @@ off(type: 'sendKeyboardStatus', callback?: (keyboardStatus: KeyboardStatus) => v | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为‘sendKeyboardStatus’时表示取消订阅输入法应用发送键盘状态事件监听。 | -| callback | (keyboardStatus: [KeyboardStatus](#keyboardstatus10)) => void | 否 | 取消订阅的回调函数，需要与on接口传入的保持一致。当该参数不填写时，取消订阅type对应的所有回调事件。 | +| type | string | 是 | 设置监听类型，固定取值为'sendKeyboardStatus'。 | +| callback | (keyboardStatus: [KeyboardStatus](#keyboardstatus10)) => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。 | **示例：** @@ -1891,8 +1924,8 @@ on(type: 'sendFunctionKey', callback: (functionKey: FunctionKey) => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | ---- | ----- | -| type | string | 是 | 设置监听类型。
- type为‘sendFunctionKey’时表示订阅输入法应用发送功能键事件监听。 | -| callback | (functionKey: [FunctionKey](#functionkey10)) => void | 是 | 回调函数，返回输入法应用发送的功能键信息。
开发者需要根据返回的功能键做相应的操作。 | +| type | string | 是 | 设置监听类型，固定取值为'sendFunctionKey'。| +| callback | (functionKey: [FunctionKey](#functionkey10)) => void | 是 | 回调函数，返回输入法应用发送的功能键信息。
根据返回的功能键信息，做相应操作。 | **错误码：** @@ -1918,7 +1951,7 @@ try { off(type: 'sendFunctionKey', callback?: (functionKey: FunctionKey) => void): void -取消订阅输入法应用发送FunctionKey事件。 +取消订阅输入法应用发送功能键事件。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1926,8 +1959,8 @@ off(type: 'sendFunctionKey', callback?: (functionKey: FunctionKey) => void): voi | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------------------- | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为‘sendFunctionKey’时表示取消订阅输入法应用发送FunctionKey事件监听。 | -| callback | (functionKey: [FunctionKey](#functionkey10)) => void | 否 | 取消订阅的回调函数，需要与on接口传入的保持一致。当该参数不填写时，取消订阅type对应的所有回调事件。 | +| type | string | 是 | 设置监听类型，固定取值为'sendFunctionKey'。 | +| callback | (functionKey: [FunctionKey](#functionkey10)) => void | 否 | 取消订阅的回调函数，需要与on接口传入的保持一致。
参数不填写时，取消订阅type对应的所有回调事件。 | **示例：** @@ -1951,8 +1984,8 @@ on(type: 'moveCursor', callback: (direction: Direction) => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------ | -| type | string | 是 | 设置监听类型。
- type为‘moveCursor’时表示订阅输入法应用移动光标事件监听。 | -| callback | callback: (direction: [Direction10+](#direction10)) => void | 是 | 回调函数，返回光标信息。
开发者需要根据返回的光标移动方向改变光标位置。 | +| type | string | 是 | 设置监听类型，固定取值为'moveCursor'。 | +| callback | callback: (direction: [Direction10+](#direction10)) => void | 是 | 回调函数，返回光标信息。
根据返回的光标移动方向，改变光标位置，如光标向上或向下。 | **错误码：** @@ -1986,8 +2019,8 @@ off(type: 'moveCursor', callback?: (direction: Direction) => void): void | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ---- | -| type | string | 是 | 设置监听类型。
- type为‘moveCursor’时表示取消订阅输入法应用发送移动光标事件监听。 | -| callback | (direction: [Direction10+](#direction10)) => void | 否 | 取消订阅的回调函数，需要与on接口传入的保持一致。当该参数不填写时，取消订阅type对应的所有回调事件。 | +| type | string | 是 | 设置监听类型，固定取值为'moveCursor'。 | +| callback | (direction: [Direction10+](#direction10)) => void | 否 | 取消订阅的回调函数，需要与on接口传入的保持一致。
参数不填写时，取消订阅type对应的所有回调事件。 | **示例：** @@ -2003,7 +2036,7 @@ inputMethodController.off('moveCursor'); on(type: 'handleExtendAction', callback: (action: ExtendAction) => void): void -订阅输入法应用发送扩展操作事件。使用callback异步回调。 +订阅输入法应用发送扩展编辑操作事件。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -2011,8 +2044,8 @@ on(type: 'handleExtendAction', callback: (action: ExtendAction) => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | -------- | -| type | string | 是 | 设置监听类型。
- type为‘handleExtendAction’时表示订阅输入法应用发送扩展操作代码事件监听。 | -| callback | callback: (action: [ExtendAction](#extendaction10)) => void | 是 | 回调函数，返回扩展操作类型。
开发者需要在回调函数中根据传入的扩展操作类型做相应的操作。 | +| type | string | 是 | 设置监听类型，固定取值为'handleExtendAction'。 | +| callback | callback: (action: [ExtendAction](#extendaction10)) => void | 是 | 回调函数，返回扩展编辑操作类型。
根据传入的扩展编辑操作类型，做相应的操作，如剪切、复制等。| **错误码：** @@ -2038,7 +2071,7 @@ try { off(type: 'handleExtendAction', callback?: (action: ExtendAction) => void): void -取消订阅输入法应用发送扩展操作事件。 +取消订阅输入法应用发送扩展编辑操作事件。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -2046,8 +2079,8 @@ off(type: 'handleExtendAction', callback?: (action: ExtendAction) => void): void | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| type | string | 是 | 设置监听类型。
- type为‘handleExtendAction’时表示取消订阅输入法应用发送扩展代码事件监听。 | -| callback | (action: [ExtendAction](#extendaction10)) => void | 否 | 取消订阅的回调函数，需要与on接口传入的保持一致。当该参数不填写时，取消订阅type对应的所有回调事件。 | +| type | string | 是 | 设置监听类型，固定取值为'handleExtendAction'。 | +| callback | (action: [ExtendAction](#extendaction10)) => void | 否 | 取消订阅的回调函数，需要与on接口传入的保持一致。
参数不填写时，取消订阅type对应的所有回调事件。 | **示例：** @@ -2071,8 +2104,8 @@ on(type: 'selectByRange', callback: Callback<Range>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---- | ---- | ------- | -| type | string | 是 | 设置监听类型。
- type为‘selectByRange’时表示订阅输入法应用按范围选中文本事件监听。 | -| callback | Callback<[Range](#range10)> | 是 | 回调函数，返回需要选中的文本的范围。
开发者需要在回调函数中根据传入的范围选中编辑框中相应文本。 | +| type | string | 是 | 设置监听类型，固定取值为'selectByRange'。 | +| callback | Callback<[Range](#range10)> | 是 | 回调函数，返回需要选中的文本范围。
根据传入的文本范围，开发者在回调函数中编辑框中相应文本。| **示例：** @@ -2086,7 +2119,7 @@ inputMethodController.on('selectByRange', (range) => { off(type: 'selectByRange', callback?: Callback<Range>): void -取消订阅输入法应用按范围选中文本事件。 +取消订阅输入法应用按范围选中文本事件。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -2094,8 +2127,8 @@ off(type: 'selectByRange', callback?: Callback<Range>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------- | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为‘selectByRange’时表示取消订阅输入法应用按范围选中文本事件监听。 | -| callback | Callback<[Range](#range10)> | 否 | 取消订阅的回调函数，需要与on接口传入的保持一致。当该参数不填写时，取消订阅type对应的所有回调事件。 | +| type | string | 是 | 设置监听类型，固定取值为'selectByRange'。 | +| callback | Callback<[Range](#range10)> | 否 | 取消订阅的回调函数，需要与on接口传入的保持一致。
参数不填写时，取消订阅type对应的所有回调事件。 | **示例：** @@ -2111,7 +2144,7 @@ inputMethodController.off('selectByRange'); on(type: 'selectByMovement', callback: Callback<Movement>): void -订阅输入法应用按光标动作选中文本事件。使用callback异步回调。 +订阅输入法应用按光标移动方向，选中文本事件。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -2119,8 +2152,8 @@ on(type: 'selectByMovement', callback: Callback<Movement>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ----- | ---- | ------ | -| type | string | 是 | 设置监听类型。
- type为‘selectByMovement’时表示订阅输入法应用按光标移动动作选中文本事件监听。 | -| callback | Callback<[Movement](#movement10)> | 是 | 回调函数，返回需要选中的文本的范围。
开发者需要在回调函数中根据传入的光标动作选中编辑框中相应文本。 | +| type | string | 是 | 设置监听类型，固定取值为'selectByMovement'。 | +| callback | Callback<[Movement](#movement10)> | 是 | 回调函数，返回光标移动的方向。
根据传入的光标移动方向，选中编辑框中相应文本。 | **示例：** @@ -2134,7 +2167,7 @@ inputMethodController.on('selectByMovement', (movement) => { off(type: 'selectByMovement', callback?: Callback<Movement>): void -取消订阅输入法应用按光标动作选中文本事件。 +取消订阅输入法应用按光标移动方向，选中文本事件。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -2142,8 +2175,8 @@ off(type: 'selectByMovement', callback?: Callback<Movement>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为‘selectByMovement’时表示取消订阅输入法应用按范围选中文本事件监听。 | -| callback | Callback<[Movement](#movement10)> | 否 | 取消订阅的回调函数，需要与on接口传入的保持一致。当该参数不填写时，取消订阅type对应的所有回调事件。 | +| type | string | 是 | 设置监听类型，固定取值为'selectByMovement'。 | +| callback | Callback<[Movement](#movement10)> | 否 | 取消订阅的回调函数，需要与on接口传入的保持一致。
参数不填写时，取消订阅type对应的所有回调事件。 | **示例：** @@ -2167,8 +2200,8 @@ on(type: 'getLeftTextOfCursor', callback: (length: number) => string): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | ----- | ---- | ------ | -| type | string | 是 | 设置监听类型。
- type为‘getLeftTextOfCursor’时表示订阅输入法应用获取光标左侧指定长度文本事件监听。 | -| callback | (length: number) => string | 是 | 回调函数，获取光标左侧指定长度文本内容。
开发者需要在该函数中，获取编辑框最新状态下光标左侧指定length长度的文本内容并返回。 | +| type | string | 是 | 设置监听类型，固定取值为'getLeftTextOfCursor'。 | +| callback | (length: number) => string | 是 | 回调函数，获取编辑框最新状态下光标左侧指定长度的文本内容并返回。 | **错误码：** @@ -2196,7 +2229,7 @@ try { off(type: 'getLeftTextOfCursor', callback?: (length: number) => string): void; -取消订阅输入法应用获取光标左侧指定长度文本事件。 +取消订阅输入法应用获取光标左侧指定长度文本事件。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -2204,8 +2237,8 @@ off(type: 'getLeftTextOfCursor', callback?: (length: number) => string): void; | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为‘getLeftTextOfCursor’时表示取消订阅输入法应用获取光标左侧指定长度文本事件监听。 | -| callback | (length: number) => string | 否 | 回调函数，获取光标左侧指定长度文本内容。需要与on接口传入的保持一致。| +| type | string | 是 | 设置监听类型，固定取值为'getLeftTextOfCursor'。 | +| callback | (length: number) => string | 否 | 取消订阅的回调函数，需要与on接口传入的保持一致。
参数不填写时，取消订阅type对应的所有回调事件。| **示例：** @@ -2233,8 +2266,8 @@ on(type: 'getRightTextOfCursor', callback: (length: number) => string): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | ----- | ---- | ------ | -| type | string | 是 | 设置监听类型。
- type为‘getRightTextOfCursor’时表示订阅输入法应用获取光标右侧指定长度文本事件监听。 | -| callback | (length: number) => string | 是 | 回调函数，获取光标右侧指定长度文本内容。
开发者需要在该函数中，获取编辑框最新状态下光标右侧指定length长度的文本内容并返回。 | +| type | string | 是 | 设置监听类型，固定取值为'getRightTextOfCursor'。 | +| callback | (length: number) => string | 是 | 回调函数，获取编辑框最新状态下光标右侧指定长度的文本内容并返回。 | **错误码：** @@ -2262,7 +2295,7 @@ try { off(type: 'getRightTextOfCursor', callback?: (length: number) => string): void; -取消订阅输入法应用获取光标右侧指定长度文本事件。 +取消订阅输入法应用获取光标右侧指定长度文本事件。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -2270,8 +2303,8 @@ off(type: 'getRightTextOfCursor', callback?: (length: number) => string): void; | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为‘getRightTextOfCursor’时表示取消订阅输入法应用获取光标右侧指定长度文本事件监听。 | -| callback | (length: number) => string | 否 | 回调函数，获取光标右侧指定长度文本内容。需要与on接口传入的保持一致。| +| type | string | 是 | 设置监听类型，固定取值为'getRightTextOfCursor'。 | +| callback | (length: number) => string | 否 |取消订阅的回调函数，需要与on接口传入的保持一致。
参数不填写时，取消订阅type对应的所有回调事件。| **示例：** @@ -2299,8 +2332,8 @@ on(type: 'getTextIndexAtCursor', callback: () => number): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | ----- | ---- | ------ | -| type | string | 是 | 设置监听类型。
- type为‘getTextIndexAtCursor’时表示订阅输入法应用获取光标处文本索引事件监听。 | -| callback | () => number | 是 | 回调函数，获取光标处文本索引。
开发者需要在该函数中，获取编辑框最新状态下光标处文本索引并返回。 | +| type | string | 是 | 设置监听类型，固定取值为'getTextIndexAtCursor'。 | +| callback | () => number | 是 | 回调函数，获取编辑框最新状态下光标处文本索引并返回。 | **错误码：** @@ -2328,7 +2361,7 @@ try { off(type: 'getTextIndexAtCursor', callback?: () => number): void; -取消订阅输入法应用获取光标处文本索引事件。 +取消订阅输入法应用获取光标处文本索引事件。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -2336,8 +2369,8 @@ off(type: 'getTextIndexAtCursor', callback?: () => number): void; | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为‘getTextIndexAtCursor’时表示取消订阅输入法应用获取光标处文本索引事件监听。 | -| callback | () => number | 否 | 回调函数，获取光标处文本索引。需要与on接口传入的保持一致。| +| type | string | 是 | 设置监听类型，固定取值为'getTextIndexAtCursor'。 | +| callback | () => number | 否 | 取消订阅的回调函数，需要与on接口传入的保持一致。
参数不填写时，取消订阅type对应的所有回调事件。| **示例：** @@ -2355,7 +2388,7 @@ try { ## InputMethodSetting8+ -下列API示例中都需使用[getSetting](#inputmethodgetsetting9)获取到InputMethodSetting实例，再通过此实例调用对应方法。 +下列API均需使用[getSetting](#inputmethodgetsetting9)获取到InputMethodSetting实例后，通过实例调用。 ### on('imeChange')9+ @@ -2369,8 +2402,8 @@ on(type: 'imeChange', callback: (inputMethodProperty: InputMethodProperty, input | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------- | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为‘imeChange’时表示订阅输入法及子类型变化监听事件。 | -| callback | (inputMethodProperty: [InputMethodProperty](#inputmethodproperty8), inputMethodSubtype: [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)) => void | 是 | 回调函数，返回输入法属性对象及输入法子类型对象。 | +| type | string | 是 | 设置监听类型，固定取值为'imeChange'。 | +| callback | (inputMethodProperty: [InputMethodProperty](#inputmethodproperty8), inputMethodSubtype: [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)) => void | 是 | 回调函数，返回输入法属性对象及子类型对象。 | **示例：** @@ -2392,8 +2425,8 @@ off(type: 'imeChange', callback?: (inputMethodProperty: InputMethodProperty, inp | 参数名 | 类型 | 必填 | 说明 | | -------- | --------- | ---- | --------------- | -| type | string | 是 | 设置监听类型。
- type为‘imeChange’时表示取消订阅输入法及子类型变化监听事件。 | -| callback | (inputMethodProperty: [InputMethodProperty](#inputmethodproperty8), inputMethodSubtype: [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)) => void | 否 | 回调函数，返回取消订阅的输入法属性对象及输入法子类型对象。 | +| type | string | 是 | 设置监听类型，固定取值为'imeChange'。 | +| callback | (inputMethodProperty: [InputMethodProperty](#inputmethodproperty8), inputMethodSubtype: [InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)) => void | 否 | 回调函数，返回取消订阅的输入法属性对象及子类型对象。 | **示例：** @@ -2415,7 +2448,7 @@ on(type: 'imeShow', callback: (info: Array\) => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---- | ---- | ---- | -| type | string | 是 | 设置监听类型。
- type为`imeShow`表示订阅输入法软键盘显示事件。 | +| type | string | 是 | 设置监听类型，固定取值为'imeShow'。 | | callback | (info: Array\) => void | 是 | 回调函数，返回输入法软键盘信息。 | **示例：** @@ -2440,7 +2473,7 @@ on(type: 'imeHide', callback: (info: Array\) => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---- | ---- | ---- | -| type | string | 是 | 设置监听类型。
- type为`imeHide`表示订阅输入法软键盘隐藏事件。 | +| type | string | 是 | 设置监听类型，固定取值为'imeHide'。 | | callback | (info: Array\) => void | 是 | 回调函数，返回输入法软键盘信息。 | **示例：** @@ -2465,8 +2498,8 @@ off(type: 'imeShow', callback?: (info: Array\) => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---- | ---- | ------ | -| type | string | 是 | 设置监听类型。
- type为`imeShow`表示取消订阅输入法软键盘显示事件。 | -| callback | (info: Array\) => void | 否 | 取消订阅的回调函数。当该参数不填写时，取消订阅type对应的所有回调事件。 | +| type | string | 是 | 设置监听类型，固定取值`imeShow`。 | +| callback | (info: Array\) => void | 否 | 取消订阅的回调函数。
参数不填写时，取消订阅type对应的所有回调事件。 | **示例：** @@ -2488,8 +2521,8 @@ off(type: 'imeHide', callback?: (info: Array\) => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---- | ---- | ------ | -| type | string | 是 | 设置监听类型。
- type为`imeHide`表示取消订阅输入法软键盘隐藏事件。 | -| callback | (info: Array\) => void | 否 | 取消订阅的回调函数。当该参数不填写时，取消订阅type对应的所有回调事件。 | +| type | string | 是 | 设置监听类型，固定取值'imeHide'。 | +| callback | (info: Array\) => void | 否 | 取消订阅的回调函数。
参数不填写时，取消订阅type对应的所有回调事件。 | **示例：** @@ -2509,7 +2542,7 @@ listInputMethodSubtype(inputMethodProperty: InputMethodProperty, callback: Async | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------------------------- | ---- | ---------------------- | -| inputMethodProperty | [InputMethodProperty](#inputmethodproperty8)| 是 | 子类型所属的输入法应用。 | +| inputMethodProperty | [InputMethodProperty](#inputmethodproperty8)| 是 | 输入法应用。 | | callback | AsyncCallback<Array<[InputMethodSubtype](./js-apis-inputmethod-subtype.md#inputmethodsubtype)>> | 是 | 回调函数，返回指定输入法应用的所有子类型。 | **错误码：** @@ -2553,7 +2586,7 @@ listInputMethodSubtype(inputMethodProperty: InputMethodProperty): Promise<Arr | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------------------------- | ---- | ---------------------- | -| inputMethodProperty | [InputMethodProperty](#inputmethodproperty8)| 是 | 子类型所属的输入法应用。 | +| inputMethodProperty | [InputMethodProperty](#inputmethodproperty8)| 是 | 输入法应用。 | **返回值：** @@ -2631,7 +2664,7 @@ try { listCurrentInputMethodSubtype(): Promise<Array<InputMethodSubtype>> -查询当前输入法的子类型列表。使用promise异步回调。 +查询当前输入法应用的所有子类型。使用promise异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -2668,9 +2701,13 @@ try { getInputMethods(enable: boolean, callback: AsyncCallback<Array<InputMethodProperty>>): void -获取已激活/未激活输入法列表。使用callback异步回调。 +获取已激活/未激活的输入法应用列表。使用callback异步回调。 -参数enable取true，返回已激活输入法列表；取false返回未激活输入法列表。已激活/未激活为预留概念，当前暂未支持。当前版本中，已激活输入法包括当前使用的输入法，未激活输入法包括当前输入法以外的其他已安装的输入法。 +> **说明** +> +> 已激活输入法包括当前使用的输入法，未激活输入法包括当前输入法以外的其他已安装的输入法。 +> +> 已激活/未激活为预留概念，暂不支持。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -2678,7 +2715,7 @@ getInputMethods(enable: boolean, callback: AsyncCallback<Array<InputMethod | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------------------------- | ---- | ----------------------------- | -| enable | boolean | 是 | 指定返回已激活/未激活。 | +| enable | boolean | 是 |true表示返回已激活输入法列表，false表示返回未激活输入法列表。 | | callback | AsyncCallback<Array<[InputMethodProperty](#inputmethodproperty8)>> | 是 | 回调函数，返回已激活/未激活输入法列表。 | **错误码：** @@ -2710,9 +2747,13 @@ try { getInputMethods(enable: boolean): Promise<Array<InputMethodProperty>> -获取已激活/未激活输入法列表。使用promise异步回调。 +获取已激活/未激活的输入法应用列表。使用promise异步回调。 -参数enable取true，返回已激活输入法列表；取false返回未激活输入法列表。已激活/未激活为预留概念，当前暂未支持。当前版本中，已激活输入法包括当前使用的输入法，未激活输入法包括当前输入法以外的其他已安装的输入法。 +> **说明** +> +> 已激活输入法包括当前使用的输入法，未激活输入法包括当前输入法以外的其他已安装的输入法。 +> +> 已激活/未激活为预留概念，暂不支持。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -2720,7 +2761,7 @@ getInputMethods(enable: boolean): Promise<Array<InputMethodProperty>> | 参数名 | 类型 | 必填 | 说明 | | ------ | ------- | ---- | ----------------------- | -| enable | boolean | 是 | 指定返回已激活/未激活。 | +| enable | boolean | 是 |- true表示返回已激活输入法列表，false表示返回未激活输入法列表。 | **错误码：** @@ -2735,7 +2776,7 @@ getInputMethods(enable: boolean): Promise<Array<InputMethodProperty>> | 类型 | 说明 | | ------------------------------------------------------------ | ----------------------------- | -| Promise> | Promise对象，返回已激活/未激活输入法列表。 | +| Promise\> | Promise对象，返回已激活/未激活输入法列表。 | **示例：** @@ -2801,7 +2842,7 @@ showOptionalInputMethods(): Promise<boolean> | 类型 | 说明 | | -------- | -------- | -| Promise<boolean> | Promise对象。返回true表示输入法选择对话框显示成功；返回false表示输入法选择对话框显示失败。 | +| Promise<boolean> | Promise对象。返回true表示输入法选择对话框显示成功，返回false表示输入法选择对话框显示失败。 | **错误码：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md index 1bff8a6c68..ce3eab648d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md @@ -1,6 +1,6 @@ # @ohos.inputMethodEngine (输入法服务) -本模块面向输入法应用（包括系统输入法应用、三方输入法应用），为输入法应用提供能力，功能包括：创建软键盘窗口、插入/删除字符、选中文本、物理键盘按键事件监听等。 +本模块面向输入法应用（包括系统输入法应用、三方输入法应用），为输入法应用提供能力，包括：创建软键盘窗口、插入/删除字符、选中文本、监听物理键盘按键事件等。 > **说明：** > @@ -56,9 +56,7 @@ import inputMethodEngine from '@ohos.inputMethodEngine'; getInputMethodAbility(): InputMethodAbility -为输入法应用获取输入法应用客户端实例[InputMethodAbility](#inputmethodability)。 -该接口仅限于输入法应用调用。 -输入法应用获取该实例可订阅软键盘显示/隐藏请求事件、创建/销毁输入法应用面板等。 +获取输入法应用客户端实例[InputMethodAbility](#inputmethodability)，仅支持输入法应用调用。
输入法应用获取该实例后，可订阅软键盘显示/隐藏请求事件、创建/销毁输入法面板等。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -78,7 +76,7 @@ let InputMethodAbility = inputMethodEngine.getInputMethodAbility(); getKeyboardDelegate(): KeyboardDelegate -为输入法应用获取客户端编辑事件监听代理实例[KeyboardDelegate](#keyboarddelegate)。输入法应用获取该实例可订阅物理键盘按键事件、选中文本变化事件等。 +获取客户端编辑事件监听代理实例[KeyboardDelegate](#keyboarddelegate)。
输入法应用获取该实例后，可订阅物理键盘按键事件、选中文本变化事件等。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -98,7 +96,7 @@ let KeyboardDelegate = inputMethodEngine.getKeyboardDelegate(); getInputMethodEngine(): InputMethodEngine -为输入法应用获取输入法应用客户端实例[InputMethodEngine](#inputmethodengine-1)。输入法应用获取该实例可订阅软键盘显示/隐藏请求事件等。 +获取输入法应用客户端实例[InputMethodEngine](#inputmethodengine)。
输入法应用获取该实例后，可订阅软键盘显示/隐藏请求事件等。 > **说明：** > @@ -122,7 +120,7 @@ let InputMethodEngine = inputMethodEngine.getInputMethodEngine(); createKeyboardDelegate(): KeyboardDelegate -为输入法应用获取客户端编辑事件监听代理实例[KeyboardDelegate](#keyboarddelegate)。输入法应用获取该实例可订阅物理键盘按键事件、选中文本变化事件等。 +获取客户端编辑事件监听代理实例[KeyboardDelegate](#keyboarddelegate)。输入法应用获取该实例后，可订阅物理键盘按键事件、选中文本变化事件等。 > **说明：** > @@ -144,7 +142,7 @@ let keyboardDelegate = inputMethodEngine.createKeyboardDelegate(); ## InputMethodEngine -下列API示例中都需使用[getInputMethodEngine](#inputmethodenginegetinputmethodenginedeprecated)回调获取到InputMethodEngine实例，再通过此实例调用对应方法。 +下列API均需使用[getInputMethodEngine](#inputmethodenginegetinputmethodenginedeprecated)获取到InputMethodEngine实例后，通过实例调用。 ### on('inputStart') @@ -158,7 +156,7 @@ on(type: 'inputStart', callback: (kbController: KeyboardController, textInputCli | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------- | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为‘inputStart’时表示订阅输入法绑定。 | +| type | string | 是 | 设置监听类型，固定取值为'inputStart'。 | | callback | (kbController: [KeyboardController](#keyboardcontroller), textInputClient: [TextInputClient](#textinputclient)) => void | 是 | 回调函数，返回订阅输入法的KeyboardController和TextInputClient实例。 | **示例：** @@ -182,8 +180,8 @@ off(type: 'inputStart', callback?: (kbController: KeyboardController, textInputC | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------ | -| type | string | 是 | 设置监听类型。
- type为‘inputStart’时表示订阅输入法绑定。 | -| callback | (kbController: [KeyboardController](#keyboardcontroller), textInputClient: [TextInputClient](#textinputclient)) => void | 否 | 回调函数，返回取消订阅的KeyboardController和TextInputClient实例。 | +| type | string | 是 | 设置监听类型，固定取值为'inputStart'。 | +| callback | (kbController: [KeyboardController](#keyboardcontroller), textInputClient: [TextInputClient](#textinputclient)) => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。| **示例：** @@ -197,7 +195,7 @@ inputMethodEngine.getInputMethodEngine().off('inputStart', (kbController, textIn on(type: 'keyboardShow'|'keyboardHide', callback: () => void): void -订阅输入法事件。使用callback异步回调。 +订阅输入法软键盘显示或隐藏事件。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -205,7 +203,7 @@ on(type: 'keyboardShow'|'keyboardHide', callback: () => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为'keyboardShow'，表示订阅输入法显示。
- type为'keyboardHide'，表示订阅输入法隐藏。 | +| type | string | 是 | 设置监听类型。
-'keyboardShow'表示显示输入法软键盘。
-'keyboardHide'表示隐藏输入法软键盘。 | | callback | () => void | 是 | 回调函数。 | **示例：** @@ -223,7 +221,7 @@ inputMethodEngine.getInputMethodEngine().on('keyboardHide', () => { off(type: 'keyboardShow'|'keyboardHide', callback?: () => void): void -取消订阅输入法事件。使用callback异步回调。 +取消订阅输入法软键盘显示或隐藏事件。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -231,8 +229,8 @@ off(type: 'keyboardShow'|'keyboardHide', callback?: () => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为'keyboardShow'，表示订阅输入法显示。
- type为'keyboardHide'，表示订阅输入法隐藏。 | -| callback | () => void | 否 | 回调函数。 | +| type | string | 是 | 要取消监听的输入法软键盘类型。
-'keyboardShow'表示显示输入法软键盘。
-'keyboardHide'表示隐藏输入法软键盘。| +| callback | () => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。 | **示例：** @@ -243,7 +241,7 @@ inputMethodEngine.getInputMethodEngine().off('keyboardHide'); ## InputMethodAbility -下列API示例中都需使用[getInputMethodAbility](#inputmethodenginegetinputmethodability9)回调获取到InputMethodAbility实例，再通过此实例调用对应方法。 +下列API均需使用[getInputMethodAbility](#inputmethodenginegetinputmethodability9)获取到InputMethodAbility实例后，通过实例调用。 ### on('inputStart')9+ @@ -257,7 +255,7 @@ on(type: 'inputStart', callback: (kbController: KeyboardController, inputClient: | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------- | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为‘inputStart’时表示订阅输入法绑定。 | +| type | string | 是 | 设置监听类型，固定取值为'inputStart'。 | | callback | (kbController: [KeyboardController](#keyboardcontroller), inputClient: [InputClient](#inputclient9)) => void | 是 | 回调函数，返回输入法操作相关实例。 | **示例：** @@ -281,8 +279,8 @@ off(type: 'inputStart', callback?: (kbController: KeyboardController, inputClien | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------ | -| type | string | 是 | 设置监听类型。
- type为‘inputStart’时表示订阅输入法绑定。 | -| callback | (kbController: [KeyboardController](#keyboardcontroller), inputClient: [InputClient](#inputclient9)) => void | 否 | 回调函数，返回输入法操作相关实例。 | +| type | string | 是 | 设置监听类型，固定取值为'inputStart'。 | +| callback | (kbController: [KeyboardController](#keyboardcontroller), inputClient: [InputClient](#inputclient9)) => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。| **示例：** @@ -302,8 +300,8 @@ on(type: 'inputStop', callback: () => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为‘inputStop’时表示订阅停止输入法应用事件。 | -| callback | () => void | 是 | 回调函数。 | +| type | string | 是 | 设置监听类型，固定取值为'inputStop'。 | +| callback | () => void | 是 | 回调函数。 | **示例：** @@ -325,8 +323,8 @@ off(type: 'inputStop', callback: () => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为‘inputStop’时表示订阅停止输入法应用事件。 | -| callback | () => void | 是 | 回调函数。 | +| type | string | 是 | 设置监听类型，固定取值为'inputStop'。 | +| callback | () => void | 是 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。 | **示例：** @@ -348,8 +346,8 @@ on(type: 'setCallingWindow', callback: (wid: number) => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为‘setCallingWindow’时表示订阅设置调用窗口事件。 | -| callback | (wid: number) => void | 是 | 回调函数，返回调用方window id。 | +| type | string | 是 | 设置监听类型，固定取值为'setCallingWindow'。 | +| callback | (wid: number) => void | 是 | 回调函数，返回调用方窗口的Id。 | **示例：** @@ -371,8 +369,8 @@ off(type: 'setCallingWindow', callback: (wid:number) => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为‘setCallingWindow’时表示订阅设置调用窗口事件。 | -| callback | (wid:number) => void | 是 | 回调函数，返回调用方window id。 | +| type | string | 是 | 设置监听类型，固定取值为'setCallingWindow'。| +| callback | (wid:number) => void | 是 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。 | **示例：** @@ -386,7 +384,7 @@ inputMethodEngine.getInputMethodAbility().off('setCallingWindow', (wid) => { on(type: 'keyboardShow'|'keyboardHide', callback: () => void): void -订阅输入法事件。使用callback异步回调。 +订阅输入法软键盘显示或隐藏事件。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -394,7 +392,7 @@ on(type: 'keyboardShow'|'keyboardHide', callback: () => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为'keyboardShow'，表示订阅显示键盘事件。
- type为'keyboardHide'，表示订阅隐藏键盘事件。 | +| type | string | 是 | 设置监听类型。
- 'keyboardShow'表示显示输入法软键盘。
- 'keyboardHide'表示隐藏输入法软键盘。 | | callback | () => void | 是 | 回调函数。 | **示例：** @@ -420,8 +418,8 @@ off(type: 'keyboardShow'|'keyboardHide', callback?: () => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为'keyboardShow'，表示取消订阅显示键盘事件。
- type为'keyboardHide'，表示取消订阅隐藏键盘事件。 | -| callback | () => void | 否 | 回调函数。 | +| type | string | 是 | 设置监听类型。
- 'keyboardShow'表示显示键盘。
- 'keyboardHide'表示隐藏键盘。 | +| callback | () => void | 否 | 回调函数。 | **示例：** @@ -446,8 +444,8 @@ on(type: 'setSubtype', callback: (inputMethodSubtype: InputMethodSubtype) => voi | 参数名 | 类型 | 必填 | 说明 | | -------- | --- | ---- | --- | -| type | string | 是 | 设置监听类型。
- type为'setSubtype'，表示订阅输入法子类型的设置事件。 | -| callback | (inputMethodSubtype: [InputMethodSubtype](js-apis-inputmethod-subtype.md)) => void | 是 | 回调函数，返回设置的输入法子类型。 | +| type | string | 是 | 设置监听类型，固定取值为'setSubtype'。 | +| callback | (inputMethodSubtype: [InputMethodSubtype](js-apis-inputmethod-subtype.md)) => void | 是 | 回调函数，返回设置的输入法子类型。 | **示例：** @@ -461,7 +459,7 @@ inputMethodEngine.getInputMethodAbility().on('setSubtype', (inputMethodSubtype) off(type: 'setSubtype', callback?: (inputMethodSubtype: InputMethodSubtype) => void): void -取消订阅输入法子类型事件。使用callback异步回调。 +取消订阅输入法软键盘显示或隐藏事件。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -469,8 +467,8 @@ off(type: 'setSubtype', callback?: (inputMethodSubtype: InputMethodSubtype) => v | 参数名 | 类型 | 必填 | 说明 | | ------- | ----- | ---- | ---- | -| type | string | 是 | 设置监听类型。
- type为'setSubtype'，表示取消订阅输入法子类型的设置事件。 | -| callback | (inputMethodSubtype: [InputMethodSubtype](js-apis-inputmethod-subtype.md)) => void | 否 | 回调函数，返回设置的输入法子类型。 | +| type | string | 是 | 设置监听类型，固定取值为'setSubtype'。 | +| callback | (inputMethodSubtype: [InputMethodSubtype](js-apis-inputmethod-subtype.md)) => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。 | **示例：** @@ -484,9 +482,7 @@ inputMethodEngine.getInputMethodAbility().off('setSubtype', () => { createPanel(ctx: BaseContext, info: PanelInfo, callback: AsyncCallback\): void -创建输入法应用面板。使用callback异步回调。 - -仅支持输入法应用调用。单个输入法应用仅仅允许创建一个SOFT_KEYBOARD及一个STATUS_BAR类型的面板。 +创建输入法面板，仅支持输入法应用调用。使用callback异步回调。
单个输入法应用仅允许创建一个[软键盘类型](#paneltype10)和[状态栏类型](#paneltype10)的面板。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -495,7 +491,7 @@ createPanel(ctx: BaseContext, info: PanelInfo, callback: AsyncCallback\): | 参数名 | 类型 | 必填 | 说明 | | ------- | ----------- | ---- | ------------------------ | | ctx | [BaseContext](js-apis-inner-application-baseContext.md) | 是 | 当前输入法应用上下文信息。 | -| info | [PanelInfo](#panelinfo10) | 是 | 输入法面板信息。 | +| info | [PanelInfo](#panelinfo10) | 是 | 输入法应用信息。 | | callback | AsyncCallback\<[Panel](#panel10)> | 是 | 回调函数。当输入法面板创建成功，返回当前创建的输入法面板对象。 | **错误码：** @@ -528,9 +524,7 @@ try { createPanel(ctx: BaseContext, info: PanelInfo): Promise\ -创建输入法应用面板。使用promise异步回调。 - -仅支持输入法应用调用。单个输入法应用仅仅允许创建一个SOFT_KEYBOARD及一个STATUS_BAR类型的面板。 +创建输入法面板，仅支持输入法应用调用。使用promise异步回调。
单个输入法应用仅允许创建一个[软键盘类型](#paneltype10)和[状态栏类型](#paneltype10)的面板。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -570,7 +564,7 @@ inputMethodEngine.getInputMethodAbility().createPanel(this.context, panelInfo).t destroyPanel(panel: Panel, callback: AsyncCallback\): void; -销毁输入法应用面板。使用callback异步回调。 +销毁输入法面板。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -578,7 +572,7 @@ destroyPanel(panel: Panel, callback: AsyncCallback\): void; | 参数名 | 类型 | 必填 | 说明 | | ------- | ----------- | ---- | ------------------------ | -| panel | [Panel](#panel10) | 是 | 要销毁的panel对象。 | +| panel | [Panel](#panel10) | 是 | 要销毁的面板对象。 | | callback | AsyncCallback\ | 是 | 回调函数。当输入法面板销毁成功，err为undefined，否则为错误对象。 | **示例：** @@ -618,7 +612,7 @@ try { destroyPanel(panel: Panel): Promise\; -销毁输入法应用面板。使用promise异步回调。 +销毁输入法面板。使用promise异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -626,7 +620,7 @@ destroyPanel(panel: Panel): Promise\; | 参数名 | 类型 | 必填 | 说明 | | ---------| ----------- | ---- | ------------------------ | -| panel | [Panel](#panel10) | 是 | 要销毁的panel对象。 | +| panel | [Panel](#panel10) | 是 | 要销毁的面板对象。 | **返回值：** | 类型 | 说明 | @@ -666,13 +660,13 @@ try { ## KeyboardDelegate -下列API示例中都需使用[getKeyboardDelegate](#inputmethodenginegetkeyboarddelegate9)回调获取到KeyboardDelegate实例，再通过此实例调用对应方法。 +下列API均需使用[getKeyboardDelegate](#inputmethodenginegetkeyboarddelegate9)获取到KeyboardDelegate实例后，通过实例调用。 ### on('keyDown'|'keyUp') on(type: 'keyDown'|'keyUp', callback: (event: KeyEvent) => boolean): void -订阅硬键盘（即物理键盘）事件。使用callback异步回调。 +订阅硬键盘（即物理键盘）上物理按键的按下或抬起事件。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -680,7 +674,7 @@ on(type: 'keyDown'|'keyUp', callback: (event: KeyEvent) => boolean): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------- | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为'keyDown'，表示订阅硬键盘按下事件。
- type为'keyUp'，表示订阅硬键盘抬起事件。 | +| type | string | 是 | 设置监听类型。
- 'keyDown'表示键盘按下。
- 'keyUp'表示键盘抬起。 | | callback | (event: [KeyEvent](#keyevent)) => boolean | 是 | 回调函数，返回按键信息。 | **示例：** @@ -702,7 +696,7 @@ inputMethodEngine.getKeyboardDelegate().on('keyDown', (keyEvent) => { off(type: 'keyDown'|'keyUp', callback?: (event: KeyEvent) => boolean): void -取消订阅硬键盘（即物理键盘）事件。使用callback异步回调。 +取消订阅硬键盘（即物理键盘）上物理按键的按下或抬起事件。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -710,8 +704,8 @@ off(type: 'keyDown'|'keyUp', callback?: (event: KeyEvent) => boolean): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------- | ---- | ----- | -| type | string | 是 | 设置监听类型。
- type为'keyDown'，表示取消订阅硬键盘按下事件。
- type为'keyUp'，表示取消订阅硬键盘抬起事件。 | -| callback | (event: [KeyEvent](#keyevent)) => boolean | 否 | 回调函数，返回按键信息。 | +| type | string | 是 | 设置监听类型。
- 'keyDown'表示键盘按下。
- 'keyUp'表示键盘抬起。 | +| callback | (event: [KeyEvent](#keyevent)) => boolean | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。 | **示例：** @@ -738,8 +732,8 @@ on(type: 'keyEvent', callback: (event: InputKeyEvent) => boolean): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为'keyEvent'，表示订阅硬键盘按键事件。 | -| callback | function | 是 | 回调函数，入参为按键事件信息，返回值类型为布尔类型。
- 入参按键事件信息的数据类型为[InputKeyEvent](js-apis-keyevent.md#KeyEvent)。
- 若按键事件被事件订阅者消费，则callback应返回true，否则返回false。 | +| type | string | 是 | 设置监听类型，固定取值为'keyEvent'。 | +| callback | function | 是 | 回调函数，入参为按键事件信息，返回值类型为布尔类型。
- 入参按键事件信息的数据类型为[InputKeyEvent](js-apis-keyevent.md#KeyEvent)。
- 若按键事件被事件订阅者消费，则callback应返回true，否则返回false。| **示例：** @@ -764,8 +758,8 @@ off(type: 'keyEvent', callback?: (event: InputKeyEvent) => boolean): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | ---- | ------------------------------------------------------------ | -| type | string | 是 | 设置监听类型。
- type为'keyEvent'，表示取消订阅硬键盘按键事件。 | -| callback | function | 否 | 回调函数，入参为按键事件信息，返回值类型为布尔类型。
- 入参按键事件信息的数据类型为[InputKeyEvent](js-apis-keyevent.md#KeyEvent)。
- 若按键事件被事件订阅者消费，则callback应返回true，否则返回false。
- 可选参数，若填写表示不再回调此函数，若不填写则取消注册该事件所有回调函数。 | +| type | string | 是 | 设置监听类型，固定取值为'keyEvent'。 | +| callback | function | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。| **示例：** @@ -789,8 +783,8 @@ on(type: 'cursorContextChange', callback: (x: number, y:number, height:number) = | 参数名 | 类型 | 必填 | 说明 | | -------- | ---- | ---- | ----- | -| type | string | 是 | 光标变化事件。
- type为‘cursorContextChange’时，表示订阅光标变化事件。 | -| callback | (x: number, y: number, height: number) => void | 是 | 回调函数，返回光标信息。
- x为光标上端的的x坐标值。
- y为光标上端的y坐标值。
- height为光标的高度值。 | +| type | string | 是 | 光标变化事件，固定取值为'cursorContextChange'。 | +| callback | (x: number, y: number, height: number) => void | 是 | 回调函数，返回光标信息。
-x为光标上端的的x坐标值，y为光标上端的y坐标值，height为光标的高度值。 | **示例：** @@ -814,8 +808,8 @@ off(type: 'cursorContextChange', callback?: (x: number, y: number, height: numbe | 参数名 | 类型 | 必填 | 说明 | | -------- | ---- | ---- | ------ | -| type | string | 是 | 光标变化事件。
- type为‘cursorContextChange’时，表示光标变化。 | -| callback | (x: number, y:number, height:number) => void | 否 | 回调函数，返回光标信息。
- x为光标上端的的x坐标值。
- y为光标上端的y坐标值。
- height为光标的高度值。
| +| type | string | 是 | 光标变化事件，固定取值为'cursorContextChange' | +| callback | (x: number, y:number, height:number) => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。 | **示例：** @@ -829,7 +823,7 @@ inputMethodEngine.getKeyboardDelegate().off('cursorContextChange', (x, y, height on(type: 'selectionChange', callback: (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void): void -订阅文本选择变化事件。使用callback异步回调。 +订阅文本选择范围变化事件。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -837,8 +831,8 @@ on(type: 'selectionChange', callback: (oldBegin: number, oldEnd: number, newBegi | 参数名 | 类型 | 必填 | 说明 | | -------- | ----- | ---- | ---- | -| type | string | 是 | 文本选择变化事件。
- type为‘selectionChange’时，表示选择文本变化。 | -| callback | (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void | 是 | 回调函数，返回文本选择信息。
- oldBegin为变化之前被选中文本的起始下标。
- oldEnd为变化之前被选中文本的终止下标。
- newBegin为变化之后被选中文本的起始下标。
- newEnd为变化之后被选中文本的终止下标。 | +| type | string | 是 | 文本选择变化事件，固定取值为'selectionChange'。 | +| callback | (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void | 是 | 回调函数，返回文本选择信息。
- oldBegin为变化前被选中文本的起始下标，oldEnd为变化前被选中文本的终止下标。
- newBegin为变化后被选中文本的起始下标，newEnd为变化后被选中文本的终止下标。| **示例：** @@ -855,7 +849,7 @@ inputMethodEngine.getKeyboardDelegate().on('selectionChange', (oldBegin, oldEnd, off(type: 'selectionChange', callback?: (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void): void -取消订阅文本选择变化事件。使用callback异步回调。 +取消订阅文本选择范围变化事件。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -863,8 +857,8 @@ off(type: 'selectionChange', callback?: (oldBegin: number, oldEnd: number, newBe | 参数名 | 类型 | 必填 | 说明 | | -------- | ------- | ---- | ------- | -| type | string | 是 | 文本选择变化事件。
- type为‘selectionChange’时，表示选择文本变化。 | -| callback | (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void | 否 | 回调函数，返回文本选择信息。
- oldBegin为变化之前被选中文本的起始下标。
- oldEnd为变化之前被选中文本的终止下标。
- newBegin为变化之后被选中文本的起始下标。
- newEnd为变化之后被选中文本的终止下标。
| +| type | string | 是 | 文本选择变化事件，固定取值为'selectionChange'。 | +| callback | (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。| **示例：** @@ -879,7 +873,7 @@ inputMethodEngine.getKeyboardDelegate().off('selectionChange', (oldBegin, oldEnd on(type: 'textChange', callback: (text: string) => void): void -订阅文本变化事件。使用callback异步回调。 +订阅文本内容变化事件。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -887,7 +881,7 @@ on(type: 'textChange', callback: (text: string) => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 文本变化事件。
- type为‘textChange’时，表示订阅文本变化事件。 | +| type | string | 是 | 文本变化事件，固定取值为'textChange'。 | | callback | (text: string) => void | 是 | 回调函数，返回订阅的文本内容。| **示例：** @@ -902,7 +896,7 @@ inputMethodEngine.getKeyboardDelegate().on('textChange', (text) => { off(type: 'textChange', callback?: (text: string) => void): void -取消订阅文本变化事件。使用callback异步回调。 +取消订阅文本内容变化事件。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -910,8 +904,8 @@ off(type: 'textChange', callback?: (text: string) => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 文本变化事件。
- type为‘textChange’时，表示取消订阅文本变化事件。 | -| callback | (text: string) => void | 否 | 回调函数，返回取消订阅的文本内容。 | +| type | string | 是 | 文本变化事件，固定取值为'textChange'。 | +| callback | (text: string) => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。| **示例：** @@ -933,8 +927,8 @@ on(type: 'editorAttributeChanged', callback: (attr: EditorAttribute) => void): v | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 文本变化事件。
- type为‘editorAttributeChanged’时，表示订阅编辑框属性变化事件。 | -| callback | (attr: EditorAttribute) => void | 是 | 用于接受编辑框属性变化的回调函数。| +| type | string | 是 | 文本变化事件，固定取值为'editorAttributeChanged'。 | +| callback | (attr: EditorAttribute) => void | 是 | 回调函数，返回变化的编辑框属性。| **示例：** @@ -948,7 +942,7 @@ inputMethodEngine.getKeyboardDelegate().on('editorAttributeChanged', (attr) => { off(type: 'editorAttributeChanged', callback?: (attr: EditorAttribute) => void): void -取消订阅编辑框属性变化事件。 +取消订阅编辑框属性变化事件。使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -956,8 +950,8 @@ off(type: 'editorAttributeChanged', callback?: (attr: EditorAttribute) => void): | 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------------------------------------------------------ | -| type | string | 是 | 文本变化事件。
- type为‘editorAttributeChanged’时，表示取消订阅编辑框属性变化事件。 | -| callback | (attr: EditorAttribute) => void | 否 | 所要取消订阅的回调处理函数，和on接口参数对应。 | +| type | string | 是 | 文本变化事件，固定取值为'editorAttributeChanged'。 | +| callback | (attr: EditorAttribute) => void | 否 | 所要取消订阅的回调处理函数。参数不填写时，取消订阅type对应的所有回调事件。 | **示例：** @@ -967,13 +961,13 @@ inputMethodEngine.getKeyboardDelegate().off('editorAttributeChanged'); ## Panel10+ -下列API示例中都需使用[createPanel](#createpanel10)回调获取到Panel实例，再通过此实例调用对应方法。 +下列API均需使用[createPanel](#createpanel10)获取到Panel实例后，通过实例调用。 ### setUiContent10+ setUiContent(path: string, callback: AsyncCallback\): void -为当前面板加载具体页面内容，使用callback异步回调。 +为当前的输入法面板加载具体页面内容，使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -981,7 +975,7 @@ setUiContent(path: string, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | -------- | -| path | string | 是 | 设置加载页面的路径。 | +| path | string | 是 | 具体页面的路径。 | | callback | AsyncCallback\ | 是 | 回调函数。当面板页面内容加载成功，err为undefined，否则err为错误对象。 | **示例：** @@ -1004,7 +998,7 @@ try { setUiContent(path: string): Promise\ -为当前面板加载具体页面内容，使用Promise异步回调。 +为当前的输入法面板加载具体页面内容，使用Promise异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1012,7 +1006,7 @@ setUiContent(path: string): Promise\ | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | -------- | -| path | string | 是 | 设置加载页面的路径。 | +| path | string | 是 | 具体页面的路径。 | **返回值：** @@ -1039,7 +1033,7 @@ try { setUiContent(path: string, storage: LocalStorage, callback: AsyncCallback\): void -为当前面板加载与LocalStorage相关联的具体页面内容，使用callback异步回调。 +为当前的输入法面板加载与LocalStorage相关联的具体页面内容，使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1047,8 +1041,8 @@ setUiContent(path: string, storage: LocalStorage, callback: AsyncCallback\ | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | -------- | -| path | string | 是 | 设置加载页面的路径。 | -| storage | [LocalStorage](../arkui-ts/ts-state-management.md#localstorage9) | 是 | 存储单元，为应用程序范围内的可变状态属性和非可变状态属性提供存储。| +| path | string | 是 | LocalStorage相关联的具体页面的路径。 | +| storage | [LocalStorage](../arkui-ts/ts-state-management.md#localstorage9) | 是 | 存储单元，为应用程序范围内的可变和不可变状态属性提供存储。| | callback | AsyncCallback\ | 是 | 回调函数。当面板页面内容加载成功，err为undefined，否则err为错误对象。 | **示例：** @@ -1111,9 +1105,11 @@ try { resize(width: number, height: number, callback: AsyncCallback\): void -改变当前面板大小，使用callback异步回调。 +改变当前输入法面板的大小，使用callback异步回调。 -面板存在大小限制，面板宽度不超出屏幕宽度，面板高度不高于屏幕高度的二分之一。 +> **说明** +> +> 面板宽度不超出屏幕宽度，面板高度不高于屏幕高度的0.6倍。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1145,9 +1141,11 @@ try { resize(width: number, height: number): Promise\; -改变当前面板大小，使用Promise异步回调。 +改变当前输入法面板的大小，使用Promise异步回调。 -面板存在大小限制，面板宽度不超出屏幕宽度，面板高度不高于屏幕高度的二分之一。 +> **说明** +> +> 面板宽度不超出屏幕宽度，面板高度不高于屏幕高度的0.6倍。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1183,9 +1181,7 @@ try { moveTo(x: number, y: number, callback: AsyncCallback\): void -移动面板位置，使用callback异步回调。 - -对FLG_FIXED状态的panel不产生实际移动效果。 +移动面板位置，使用callback异步回调。[面板状态](#panelflag10)为固定态时，不产生实际移动效果。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1193,8 +1189,8 @@ moveTo(x: number, y: number, callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | -------- | -| x | number | 是 | 面板在x轴方向移动的值，值为正表示右移，单位为px。| -| y | number | 是 | 面板在y轴方向移动的值，值为正表示下移，单位为px。| +| x | number | 是 | x轴方向移动的值，值大于0表示右移，单位为px。| +| y | number | 是 | y轴方向移动的值，值大于0表示下移，单位为px。| | callback | AsyncCallback\ | 是 | 回调函数。当面板位置移动成功，err为undefined，否则err为错误对象。 | **示例：** @@ -1217,9 +1213,7 @@ try { moveTo(x: number, y: number): Promise\ -移动面板位置。使用promise异步回调。 - -对FLG_FIXED状态的panel不产生实际移动效果。 +移动面板位置，使用promise异步回调。[面板状态](#panelflag10)为固定态时，不产生实际移动效果。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1227,8 +1221,8 @@ moveTo(x: number, y: number): Promise\ | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | -------- | -| x | number | 是 | 面板在x轴方向移动的值，值为正表示右移，单位为px。| -| y | number | 是 | 面板在y轴方向移动的值，值为正表示下移，单位为px。| +| x | number | 是 |x轴方向移动的值，值大于0表示右移，单位为px。| +| y | number | 是 |y轴方向移动的值，值大于0表示下移，单位为px。| **返回值：** @@ -1255,7 +1249,7 @@ try { show(callback: AsyncCallback\): void -显示当前面板，使用callback异步回调。 +显示当前输入法面板，使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1281,7 +1275,7 @@ panel.show((err) => { show(): Promise\ -显示当前面板，使用promise异步回调。 +显示当前输入法面板，使用promise异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1306,7 +1300,7 @@ promise.then(() => { hide(callback: AsyncCallback\): void -隐藏当前面板，使用callback异步回调。 +隐藏当前输入法面板，使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1332,7 +1326,7 @@ panel.hide((err) => { hide(): Promise\ -隐藏当前面板，使用promise异步回调。 +隐藏当前输入法面板，使用promise异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1365,7 +1359,7 @@ on(type: 'show', callback: () => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | -------- | -| type | string | 是 | 监听当前面板的状态类型。
- type为`show`表示显示状态。 | +| type | string | 是 | 监听当前面板的状态类型，固定取值为'show'。 | | callback | () => void | 是 | 回调函数。 | **示例：** @@ -1388,7 +1382,7 @@ on(type: 'hide', callback: () => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | -------- | -| type | string | 是 | 监听当前面板的状态类型。
- type为`hide`表示隐藏状态。 | +| type | string | 是 | 监听当前面板的状态类型，固定取值为'hide'。 | | callback | () => void | 是 | 回调函数。 | **示例：** @@ -1403,7 +1397,7 @@ panel.on('hide', () => { off(type: 'show', callback?: () => void): void -取消监听当前面板显示状态，使用callback异步回调。 +取消监听当前输入法面板的隐藏状态，使用callback异步回调。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1411,8 +1405,8 @@ off(type: 'show', callback?: () => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | -------- | -| type | string | 是 | 要取消监听的当前面板状态类型。
- type为`show`表示显示状态。 | -| callback | () => void | 否 | 回调函数。 | +| type | string | 是 | 取消监听当前面板的状态类型，固定取值为'show'。 | +| callback | () => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。 | **示例：** @@ -1432,8 +1426,8 @@ off(type: 'hide', callback?: () => void): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | -------- | -| type | string | 是 | 要取消监听的当前面板状态类型。
- type为`hide`表示隐藏状态。 | -| callback | () => void | 否 | 回调函数。 | +| type | string | 是 | 要取消监听的当前面板状态类型，固定取值为'hide'。 | +| callback | () => void | 否 | 取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。 | **示例：** @@ -1445,7 +1439,7 @@ panel.off('hide'); changeFlag(flag: PanelFlag): void -改变面板状态为固定态或者悬浮态。仅对SOFT_KEYBOARD类型生效。 +将输入法应用的面板状态改变为固定态或者悬浮态，仅对[SOFT_KEYBOARD](#paneltype10)生效。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1453,7 +1447,7 @@ changeFlag(flag: PanelFlag): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | -------- | -| flag | [PanelFlag](#panelflag10) | 是 | 要切换到的面板状态类型。 | +| flag | [PanelFlag](#panelflag10) | 是 | 目标面板状态类型。 | **示例：** @@ -1464,7 +1458,7 @@ panel.changeFlag(panelFlag); ## KeyboardController -下列API示例中都需使用[on('inputStart')](#oninputstart9)回调获取到KeyboardController实例，再通过此实例调用对应方法。 +下列API均需使用[on('inputStart')](#oninputstart9)获取到KeyboardController实例后，通过实例调用。 ### hide9+ @@ -1592,7 +1586,7 @@ keyboardController.hideKeyboard().then(() => { ## ExtendAction10+ -对编辑框中文本的扩展编辑操作类型。 +编辑框中文本的扩展编辑操作类型，如剪切、复制等。 **系统能力**: SystemCapability.MiscServices.InputMethodFramework @@ -1605,7 +1599,7 @@ keyboardController.hideKeyboard().then(() => { ## Direction10+ -输入法光标移动方向。 +光标的移动方向。 **系统能力**: SystemCapability.MiscServices.InputMethodFramework @@ -1618,7 +1612,7 @@ keyboardController.hideKeyboard().then(() => { ## Range10+ -描述选中文本的范围。 +选中的文本范围。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -1629,17 +1623,17 @@ keyboardController.hideKeyboard().then(() => { ## Movement10+ -描述进行选中文本动作时光标移动的方向。 +选中文本时，光标移动的方向 **系统能力：** SystemCapability.MiscServices.InputMethodFramework | 名称 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| direction | [Direction](#direction10) | 是 | 是 | 进行选中文本动作时光标移动的方向。| +| direction | [Direction](#direction10) | 是 | 是 | 选中文本时，光标的移动方向。| ## InputClient9+ -下列API示例中都需使用[on('inputStart')](#oninputstart9)回调获取到InputClient实例，再通过此实例调用对应方法。 +下列API均需使用[on('inputStart')](#oninputstart9)获取到InputClient实例后，通过实例调用。 ### sendKeyFunction9+ @@ -1653,7 +1647,7 @@ sendKeyFunction(action:number, callback: AsyncCallback<boolean>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| action | number | 是 | 功能键键值。
- 当值为0时，表示无效按键；
- 当值为1时，表示确认键（即回车键）。 | +| action | number | 是 | 功能键键值。
- 当值为0时，表示无效按键。
- 当值为1时，表示确认键（即回车键）。 | | callback | AsyncCallback<boolean> | 是 | 回调函数。当功能键发送成功，err为undefined，data为true；否则为错误对象。 | **错误码：** @@ -2096,7 +2090,7 @@ insertText(text:string, callback: AsyncCallback<boolean>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| text | string | 是 | 文本。 | +| text | string | 是 | 文本内容。 | | callback | AsyncCallback<boolean> | 是 | 回调函数。当文本插入成功，err为undefined，data为true；否则为错误对象。 | **错误码：** @@ -2560,7 +2554,9 @@ sendExtendAction(action: ExtendAction, callback: AsyncCallback<void>): voi 发送扩展编辑操作。使用callback异步回调。 -输入法应用调用该接口向编辑控件（如：输入框）发送扩展编辑操作，编辑控件监听相应事件[on(handleExtendAction)](./js-apis-inputmethod.md#onhandleextendaction10)，从而进一步做出处理。 +> **说明** +> +> 输入法应用调用该接口向编辑框发送扩展编辑操作，编辑框监听相应事件[on('handleExtendAction')](./js-apis-inputmethod.md#onhandleextendaction10)，从而进一步做出处理。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework @@ -2602,7 +2598,9 @@ sendExtendAction(action: ExtendAction): Promise<void> 发送扩展编辑操作。使用promise异步回调。 -输入法应用调用该接口向编辑控件（如：输入框）发送扩展编辑操作，编辑控件监听相应事件[on(handleExtendAction)](./js-apis-inputmethod.md#onhandleextendaction10)，从而进一步做出处理。 +>**说明** +> +> 输入法应用调用该接口向编辑框发送扩展编辑操作，编辑框监听相应事件[on('handleExtendAction')](./js-apis-inputmethod.md#onhandleextendaction10)，从而进一步做出处理。 **系统能力：** SystemCapability.MiscServices.InputMethodFramework -- GitLab