Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
fb32c64b
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
fb32c64b
编写于
8月 26, 2022
作者:
O
openharmony_ci
提交者:
Gitee
8月 26, 2022
浏览文件
操作
浏览文件
下载
差异文件
!8547 输入法框架新增接口说明与文档完整性正确性修正
Merge pull request !8547 from 赵凌岚/master
上级
717d2746
7822b713
变更
3
隐藏空白更改
内联
并排
Showing
3 changed file
with
167 addition
and
7 deletion
+167
-7
zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md
...v/reference/apis/js-apis-inputmethod-extension-context.md
+6
-0
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
+5
-6
zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md
...plication-dev/reference/apis/js-apis-inputmethodengine.md
+156
-1
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md
浏览文件 @
fb32c64b
...
...
@@ -9,6 +9,12 @@ InputMethodExtensionContext模块提供InputMethodExtensionAbility具有的能
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 导入模块
```
import InputMethodExtensionContext from '@ohos.inputmethodextensioncontext';
```
## 使用说明
在使用InputMethodExtensionContext的功能前,需要通过InputMethodExtensionAbility子类实例获取。
...
...
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
浏览文件 @
fb32c64b
...
...
@@ -77,12 +77,11 @@ getInputMethodSetting(): InputMethodSetting
```
## inputMethod.switchInputMethod<sup>9+</sup>
switchInputMethod(target: Input
methodProperty, callback: AsyncCallback
<
boolean
>
): void;
switchInputMethod(target: Input
MethodProperty, callback: AsyncCallback
<
boolean
>
): void
切换输入法。此接口仅可在Stage模型下使用。使用callback形式返回结果。参数个数为2,否则抛出异常。
**系统能力**
:SystemCapability.Miscservices.InputMethodFramework
**系统能力**
:SystemCapability.MiscServices.InputMethodFramework
**参数:**
...
...
@@ -108,11 +107,11 @@ inputmethod.switchInputMethod({packageName:"com.example.kikakeyboard", methodId:
});
```
## inputMethod.switchInputMethod<sup>9+</sup>
switchInputMethod(target: Input
m
ethodProperty): Promise
<
boolean
>
switchInputMethod(target: Input
M
ethodProperty): Promise
<
boolean
>
切换输入法。此接口仅可在Stage模型下使用。使用promise形式返回结果。参数个数为1,否则抛出异常。
**系统能力**
: SystemCapability.Misc
s
ervices.InputMethodFramework
**系统能力**
: SystemCapability.Misc
S
ervices.InputMethodFramework
**参数:**
...
...
@@ -340,7 +339,7 @@ InputMethodSetting.listInputMethod((err,data) => {
### listInputMethod
listInputMethod(): Promise
<Array
<
InputMethodProperty
>
>
;
listInputMethod(): Promise
<
Array
<InputMethodProperty>
>
;
查询已安装的输入法列表。使用promise形式返回结果。参数个数为0,否则抛出异常。
...
...
zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md
浏览文件 @
fb32c64b
...
...
@@ -45,6 +45,11 @@ import inputMethodEngine from '@ohos.inputmethodengine';
| FLAG_SINGLE_LINE | number | 是 | 否 | 编辑框为单行。 |
| DISPLAY_MODE_PART | number | 是 | 否 | 编辑框显示为半屏。 |
| DISPLAY_MODE_FULL | number | 是 | 否 | 编辑框显示为全屏。 |
| CURSOR_UP
<sup>
9+
</sup>
| number | 是 | 否 | 光标上移。 |
| CURSOR_DOWN
<sup>
9+
</sup>
| number | 是 | 否 | 光标下移。 |
| CURSOR_LEFT
<sup>
9+
</sup>
| number | 是 | 否 | 光标左移。 |
| CURSOR_RIGHT
<sup>
9+
</sup>
| number | 是 | 否 | 光标右移。 |
| WINDOW_TYPE_INPUT_METHOD_FLOAT
<sup>
9+
</sup>
| number | 是 | 否 | 输入法应用窗口风格标识。 |
## inputMethodEngine.getInputMethodEngine<a name="getInputMethodEngine"></a>
...
...
@@ -139,6 +144,98 @@ off(type: 'inputStart', callback?: (kbController: KeyboardController, textInputC
});
```
### on('inputStop')<sup>9+</sup>
on(type: 'inputStop', callback: () => void): void
订阅停止输入法应用事件,使用callback回调。
**系统能力**
: SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 设置监听类型。
<br/>
-type为‘inputStop’时表示订阅停止输入法应用事件。 |
| callback | void | 是 | 回调函数。 |
**示例:**
```
js
InputMethodEngine
.
getInputMethodEngine
().
on
(
'
inputStop
'
,
()
=>
{
console
.
log
(
"
inputMethodEngine inputStop
"
);
});
```
### off('inputStop')<sup>9+</sup>
off(type: 'inputStop', callback: () => void): void
取消订阅停止输入法应用事件。使用callback回调。
**系统能力**
: SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 设置监听类型。
<br/>
-type为‘inputStop’时表示订阅停止输入法应用事件。 |
| callback | void | 是 | 回调函数。 |
**示例:**
```
js
InputMethodEngine
.
getInputMethodEngine
().
off
(
'
inputStop
'
,
()
=>
{
console
.
log
(
"
inputMethodEngine delete inputStop notification.
"
);
});
```
### on('setCallingWindow')<sup>9+</sup>
on(type: 'setCallingWindow', callback: (wid:number) => void): void
订阅设置调用窗口事件,使用callback回调。
**系统能力**
: SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 设置监听类型。
<br/>
-type为‘setCallingWindow’时表示订阅设置调用窗口事件。 |
| callback | number | 是 | 调用方window id。 |
**示例:**
```
js
InputMethodEngine
.
getInputMethodEngine
().
on
(
'
setCallingWindow
'
,
(
wid
)
=>
{
console
.
log
(
"
inputMethodEngine setCallingWindow
"
);
});
```
### off('setCallingWindow')<sup>9+</sup>
off(type: 'setCallingWindow', callback: (wid:number) => void): void
取消订阅设置调用窗口事件。使用callback回调。
**系统能力**
: SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 设置监听类型。
<br/>
-type为‘setCallingWindow’时表示订阅设置调用窗口事件。 |
| callback | number | 是 | 调用方window id。 |
**示例:**
```
js
InputMethodEngine
.
getInputMethodEngine
().
off
(
'
setCallingWindow
'
,
()
=>
{
console
.
log
(
"
inputMethodEngine delete setCallingWindow notification.
"
);
});
```
### on('keyboardShow'|'keyboardHide')
on(type: 'keyboardShow'|'keyboardHide', callback: () => void): void
...
...
@@ -883,7 +980,7 @@ getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void
### getEditorAttribute
getEditorAttribute(): Promise
<EditorAttribute>
getEditorAttribute(): Promise
<
EditorAttribute
>
获取编辑框属性值。使用promise形式返回结果。参数个数为0,否则抛出异常。
...
...
@@ -908,6 +1005,64 @@ getEditorAttribute(): Promise<EditorAttribute>
}
```
### moveCursor<sup>9+</sup>
moveCursor(direction: number, callback: AsyncCallback
<
void
>
): void
移动光标。使用callback形式返回结果。参数个数为1,否则抛出异常。
**系统能力**
: SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | -------------- |
| direction | number | 是 | 光标移动方向。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
**示例:**
```
js
TextInputClient
.
moveCursor
(
inputMethodEngine
.
CURSOR_xxx
,
(
err
)
=>
{
if
(
err
==
undefined
)
{
console
.
error
(
"
moveCursor callback result---err:
"
+
err
.
msg
);
return
;
}
});
```
### moveCursor<sup>9+</sup>
moveCursor(direction: number): Promise
<
void
>
移动光标。使用promise形式返回结果。参数个数为1,否则抛出异常。
**系统能力**
: SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | -------------- |
| direction | number | 是 | 光标移动方向。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise
<
void
>
| 无返回结果的Promise对象。 |
**示例:**
```
js
async
function
InputMethodEngine
()
{
await
TextInputClient
.
moveCursor
(
inputMethodEngine
.
CURSOR_xxx
).
then
(
async
(
err
)
=>
{
console
.
log
(
'
moveCursor success
'
);
}).
catch
((
err
)
=>
{
console
.
error
(
"
moveCursor success err:
"
+
err
.
msg
);
});
}
```
## EditorAttribute<a name="EditorAttribute"></a>
编辑框属性值。
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录