awtk/docs/manual/input_engine_t.md

105 lines
2.7 KiB
Markdown
Raw Normal View History

2018-12-20 17:33:31 +08:00
## input\_engine\_t
### 概述
2019-11-15 11:33:43 +08:00
输入法引擎接口。
常见的实现方式有以下几种:
* 空实现。用于不需要输入法的嵌入式平台。
* 拼音输入法实现。用于需要输入法的嵌入式平台。
![image](images/input_engine_t_0.png)
2019-10-16 09:02:32 +08:00
2019-01-15 14:34:05 +08:00
----------------------------------
2018-12-20 17:33:31 +08:00
### 函数
<p id="input_engine_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
2018-12-21 12:11:40 +08:00
| <a href="#input_engine_t_input_engine_create">input\_engine\_create</a> | 创建输入法引擎对象。 |
2019-01-02 15:29:25 +08:00
| <a href="#input_engine_t_input_engine_destroy">input\_engine\_destroy</a> | 销毁输入法引擎对象。 |
2018-12-21 12:11:40 +08:00
| <a href="#input_engine_t_input_engine_input">input\_engine\_input</a> | 输入新的按键,并更新候选字。 |
| <a href="#input_engine_t_input_engine_reset_input">input\_engine\_reset\_input</a> | 清除所有输入的按键组合和候选字。 |
2018-12-20 17:33:31 +08:00
### 属性
<p id="input_engine_t_properties">
2019-01-17 15:56:15 +08:00
| 属性名称 | 类型 | 说明 |
2018-12-20 17:33:31 +08:00
| -------- | ----- | ------------ |
#### input\_engine\_create 函数
2018-12-21 18:29:29 +08:00
-----------------------
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="input_engine_t_input_engine_create">创建输入法引擎对象。
2019-10-16 09:02:32 +08:00
2018-12-21 18:29:29 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
input_engine_t* input_engine_create ();
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | input\_engine\_t* | 返回输入法引擎对象。 |
2018-12-21 18:29:29 +08:00
#### input\_engine\_destroy 函数
-----------------------
2018-12-21 11:39:05 +08:00
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="input_engine_t_input_engine_destroy">销毁输入法引擎对象。
2019-10-16 09:02:32 +08:00
2018-12-20 17:33:31 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
ret_t input_engine_destroy (input_engine_t* engine);
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| engine | input\_engine\_t* | 输入法引擎对象。 |
2018-12-21 18:29:29 +08:00
#### input\_engine\_input 函数
-----------------------
2018-12-21 11:39:05 +08:00
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="input_engine_t_input_engine_input">输入新的按键,并更新候选字。
2019-10-16 09:02:32 +08:00
2018-12-20 17:33:31 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
ret_t input_engine_input (input_engine_t* engine, int key);
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| engine | input\_engine\_t* | 输入法引擎对象。 |
| key | int | 键值。 |
2018-12-21 18:29:29 +08:00
#### input\_engine\_reset\_input 函数
-----------------------
2018-12-21 11:39:05 +08:00
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="input_engine_t_input_engine_reset_input">清除所有输入的按键组合和候选字。
2019-10-16 09:02:32 +08:00
2018-12-20 17:33:31 +08:00
2018-12-21 11:39:05 +08:00
* 函数原型:
```
ret_t input_engine_reset_input (input_engine_t* engine);
```
* 参数说明:
2018-12-20 17:33:31 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| engine | input\_engine\_t* | 输入法引擎对象。 |